Objects
Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.
API Site
Fields
| Name | Description |
|---|---|
apiType(APIType) | The API type effected by this brownout. |
disablesRequestsTo(NonEmptyString) | For GraphQL APIs this will be a field identifier in the format |
endsAt(NonEmptyString) | The iso formatted datetime at which this brownout will end. |
startsAt(NonEmptyString) | The iso formatted datetime at which this brownout will take effect. |
status(APIBrownoutStatus) | The current status of this brownout. |
Example
{
"disablesRequestsTo": NonEmptyString,
"status": "SCHEDULED",
"apiType": "GRAPHQL",
"startsAt": NonEmptyString,
"endsAt": NonEmptyString
}APIBrownoutConnection
Paginator of API brownouts.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([APIBrownoutEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": APIBrownoutEdge,
"totalCount": 1,
"edgeCount": 1
}APIBrownoutEdge
A Relay edge containing a APIBrownout and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(APIBrownout) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
context(JSONString) | Storage for the API client to submit any contextual information. |
correlationId(String!) | The request's correlation id. |
createdAt(DateTime!) | |
id(ID!) | |
inputData(JSONString) | Input data for the API call if any. |
operationName(String!) | Free field for the API caller to categorise their own operation name. This field can be used to filter entries on the UI. |
response(JSONString) | The response from the API call if any. |
Example
{
"id": "abc123",
"correlationId": "abc123",
"operationName": "abc123",
"inputData": {"key": "value"},
"response": {"key": "value"},
"context": {"key": "value"},
"createdAt": "2020-01-01T00:00:00.000Z"
}APIExceptionConnectionTypeConnection
Paginator of API exceptions.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([APIExceptionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": APIExceptionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}APIExceptionConnectionTypeEdge
A Relay edge containing a APIExceptionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(APIExceptionType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
category(String!) | The category of the event. |
context(JSONString) | A JSON context to be provided with the event, if any. |
createdAt(DateTime!) | |
description(String) | A description of the event. |
eventType(String!) | The type of the event. |
id(ID!) |
Example
{
"id": "abc123",
"eventType": "abc123",
"category": "abc123",
"description": "abc123",
"context": {"key": "value"},
"createdAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
body(String!) | The content of the API Exception note. |
createdAt(DateTime!) | Timestamp of when the API Exception note was created. |
id(ID!) | The ID of the API Exception note. |
Example
{
"id": "abc123",
"body": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
accountNumber(String) | The account number provided to the exception. |
apiCalls([APICallType]) | The API calls associated with this exception if any. |
assignedUser(AssignedUserType) | The user assigned to handle this exception if any. |
category(APIExceptionCategories) | Category associated with this exception. |
channel(String!) | 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. |
context(JSONString) | Storage for the API client to submit any contextual information. |
createdAt(DateTime!) | |
customerContact(String) | The customer contact provided to the exception. |
events([APIExceptionEventType]) | The events associated with this exception if any. |
externalIdentifier(String!) | External identifier submitted by the API client to track this exception on their end. |
id(ID!) | |
keyDate(Date) | The key date associated with the exception, if available. |
notes([APIExceptionNoteType]) | Notes associated with this exception if any. |
operationsTeam(OperationsTeamType) | The operations team assigned to this exception if any. |
priority(APIExceptionPriority!) | The current priority for the API exception. |
resolutionStatus(APIExceptionResolutionStatus!) | The current resolution status for the API exception. |
resolutionType(APIExceptionResolutionType!) | The current resolution type for the API exception. |
supplyPointIdentifier(String) | The supply point identifier provided to the exception. |
tags([APIExceptionTags]) | Tags associated with this exception if any. |
userId(BigInt) | The user id provided to the exception. |
Example
{
"id": "abc123",
"externalIdentifier": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"channel": "abc123",
"category": "ACCOUNT",
"accountNumber": "abc123",
"userId": 1,
"customerContact": "abc123",
"supplyPointIdentifier": "abc123",
"resolutionStatus": "ASSIGNED",
"resolutionType": "AUTOMATIC",
"priority": "LOW",
"tags": "MOVE_IN",
"context": {"key": "value"},
"keyDate": "2020-01-01"
}Fields
| Name | Description |
|---|---|
promiseId(String) | Promise id for polling async results. |
result(AcceptChangeContractQuoteRequestResultOutput) | Data returned for sync or completed async results. |
Example
{
"promiseId": "abc123",
"result": AcceptChangeContractQuoteRequestResultOutput
}Fields
| Name | Description |
|---|---|
accepted(Boolean!) | True if the modify contract quote was accepted. |
Example
{
"accepted": true
}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 |
|---|---|
goodsPurchase(GoodsPurchase) | Goods purchase created. |
possibleErrors([PossibleErrorType]) | 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.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
offer(OfferType) | Accepted quoting offer. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"offer": OfferType
}Fields
| Name | Description |
|---|---|
promiseId(String) | Promise id for polling async results. |
result(AcceptRegradeQuoteRequestResultOutput) | Data returned for sync or completed async results. |
Example
{
"promiseId": "abc123",
"result": AcceptRegradeQuoteRequestResultOutput
}Fields
| Name | Description |
|---|---|
accepted(Boolean!) | True if the regrade was accepted. |
Example
{
"accepted": true
}Fields
| Name | Description |
|---|---|
promiseId(String) | Promise id for polling async results. |
result(AcceptRenewalIntentionResultOutput) | Data returned for sync or completed async results. |
Example
{
"promiseId": "abc123",
"result": AcceptRenewalIntentionResultOutput
}Fields
| Name | Description |
|---|---|
accepted(Boolean!) | True if the renewal was accepted. |
Example
{
"accepted": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountApplicationConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountApplicationConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountApplicationConnectionTypeEdge
A Relay edge containing a AccountApplicationConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountApplicationType) | The item at the end of the edge |
Example
{
"node": AccountApplicationType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
coolingOffEndDate(Date) | 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. |
dateOfSale(Date) | Date at which this account decided to switch to us. |
isMigrated(Boolean) | Whether this account application represents a migration into the current system or a regular gain. |
migrationSource(String) | The source system for a migrated account. This could be the previous supplier or the previous account management system. |
preferredSsd(Date) | Preferred supply start date. If null, it means ASAP. |
salesChannel(String!) | |
salesSubchannel(String) | The sales subchannel used when signing up. This could for example be a price comparison site. |
status(AccountApplicationStatus!) |
Example
{
"status": "CURRENT",
"salesChannel": "abc123",
"salesSubchannel": "abc123",
"dateOfSale": "2020-01-01",
"coolingOffEndDate": "2020-01-01",
"isMigrated": true,
"migrationSource": "abc123",
"preferredSsd": "2020-01-01"
}Fields
| Name | Description |
|---|---|
accountCharge(AccountChargeType) | Debit details. |
accountCredit(AccountCreditType) | Credit details. |
id(ID) | Balance transfer ID. |
reason(String) | The reason for the balance transfer. |
Example
{
"id": "abc123",
"accountCharge": AccountChargeType,
"accountCredit": AccountCreditType,
"reason": "abc123"
}AccountCampaignConnectionTypeConnection
Paginator of Account Campaigns
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountCampaignConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountCampaignConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountCampaignConnectionTypeEdge
A Relay edge containing a AccountCampaignConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountCampaignType) | The item at the end of the edge |
Example
{
"node": AccountCampaignType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
campaignExpiryDate(Date) | The date on which the associated campaign itself concludes. |
expiryDate(Date) | The date on which the account's participation in the campaign ends. |
name(String) | The name of the campaign. |
slug(String) | The slug of the campaign. |
startDate(Date) | The date that the account's link to the campaign started. |
Example
{
"campaignExpiryDate": "2020-01-01",
"name": "abc123",
"slug": "abc123",
"expiryDate": "2020-01-01",
"startDate": "2020-01-01"
}Fields
| Name | Description |
|---|---|
data(JSONString) | A JSON object containing unstructured data about the account charge. |
updatedAt(DateTime) | The date and time the metadata was last updated. |
Example
{
"data": {"key": "value"},
"updatedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
cclAmount(BigInt) | The climate change levy amount of the charge. |
displayNote(String) | The display note for the charge. |
grossAmount(BigInt) | The gross amount of the charge. |
id(ID) | The ID of the account charge. |
metadata(AccountChargeMetadataType) | JSON metadata containing unstructured data about the account charge. |
netAmount(BigInt) | The net amount of the charge. |
note(String) | The note for the charge. |
reason(String) | The reason for the charge. |
salesTaxAmount(BigInt) | The sales tax amount of the charge. |
Example
{
"id": "abc123",
"netAmount": 1,
"grossAmount": 1,
"salesTaxAmount": 1,
"cclAmount": 1,
"reason": "abc123",
"note": "abc123",
"displayNote": "abc123",
"metadata": AccountChargeMetadataType
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountConnectionTypeEdge
A Relay edge containing a AccountConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(TelcoAccountType) | The item at the end of the edge |
Example
{
"node": TelcoAccountType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
data(JSONString!) | |
updatedAt(DateTime!) |
Example
{
"data": {"key": "value"},
"updatedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
grossAmount(BigInt!) | |
id(ID!) | |
metadata(AccountCreditMetadataType) | |
netAmount(BigInt!) | |
note(String!) | |
reason(String!) | |
salesTaxAmount(BigInt!) |
Example
{
"id": "abc123",
"grossAmount": 1,
"netAmount": 1,
"salesTaxAmount": 1,
"note": "abc123",
"reason": "abc123",
"metadata": AccountCreditMetadataType
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountEventConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountEventConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountEventConnectionTypeEdge
A Relay edge containing a AccountEventConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountEvent) | The item at the end of the edge |
Example
{
"node": EmailEventType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
category(String!) | |
fetchUrl(String) | |
filename(String!) | |
id(ID!) | The ID of the object |
isReady(Boolean) | Is the file ready for use / downloadable? |
isUploaded(Boolean) | Is the file uploaded to S3? |
sizeInBytes(Int) |
Example
{
"id": "abc123",
"filename": "abc123",
"category": "abc123",
"isUploaded": true,
"isReady": true,
"fetchUrl": "abc123",
"sizeInBytes": 1
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountFileAttachmentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountFileAttachmentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountFileAttachmentConnectionTypeEdge
A Relay edge containing a AccountFileAttachmentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountFileAttachment) | The item at the end of the edge |
Example
{
"node": AccountFileAttachment,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
loyaltyPoints(Int) | The number of loyalty points the account (or user with the given id) has. |
totalMonetaryAmount(Int) | The net monetary value of the loyalty points in the currency's sub-units. |
Example
{
"loyaltyPoints": 1,
"totalMonetaryAmount": 1
}Example
{
"body": "abc123",
"isPinned": true,
"createdAt": "2020-01-01T00:00:00.000Z",
"unpinAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountPaymentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountPaymentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountPaymentConnectionTypeEdge
A Relay edge containing a AccountPaymentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountPaymentType) | The item at the end of the edge |
Example
{
"node": AccountPaymentType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amount(BigInt!) | Amount of payment in the currency's minor unit |
id(ID!) | |
paymentDate(Date!) | The date this payment is scheduled to be debited |
paymentInstruction(PaymentInstructionType) | The payment instruction that was used to make this payment. |
reference(String!) | |
status(AccountPaymentStatusOptions) | The current status of the payment. |
surchargeAmount(Int) | Surcharge amount generated by this payment. |
transactionType(AccountPaymentTransactionTypeChoices) | The transaction type of the payment. |
Example
{
"id": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"reference": "abc123",
"transactionType": "DD_FIRST_COLLECTION",
"status": "SCHEDULED",
"paymentInstruction": PaymentInstructionType,
"surchargeAmount": 1
}Fields
| Name | Description |
|---|---|
account(TelcoAccountType!) | |
createdAt(DateTime!) | |
namespace(String!) | |
updatedAt(DateTime!) | |
value(String!) |
Example
{
"namespace": "abc123",
"value": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"account": TelcoAccountType
}Fields
| Name | Description |
|---|---|
cancelledReferrals(Int) | Number of cancelled referrals. |
paidReferrals(Int) | Number of paid referrals. |
pendingReferrals(Int) | Number of pending referrals. |
referralCode(String) | Referral code of the account. |
Example
{
"referralCode": "abc123",
"pendingReferrals": 1,
"paidReferrals": 1,
"cancelledReferrals": 1
}Fields
| Name | Description |
|---|---|
content(String) | Reminder content. |
dueAt(DateTime) | When the reminder is due. |
reminderType(AccountReminderTypes) | The reminder type. |
Example
{
"reminderType": "AD_HOC",
"content": "abc123",
"dueAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountReminderConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountReminderConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountReminderConnectionTypeEdge
A Relay edge containing a AccountReminderConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Reminder) | The item at the end of the edge |
Example
{
"node": Reminder,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountRepaymentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountRepaymentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountRepaymentConnectionTypeEdge
A Relay edge containing a AccountRepaymentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountRepaymentType) | The item at the end of the edge |
Example
{
"node": AccountRepaymentType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amount(BigInt!) | Amount of payment in the currency's minor unit |
id(ID!) | |
paymentDate(Date!) | The date this payment is scheduled to be debited |
status(AccountRepaymentStatusOptions) | The current status of the repayment. |
Example
{
"id": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"status": "REQUESTED"
}AccountSearchItemType
A single account search hit
Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | The account found. |
score(Decimal) | How well the account matched the search terms. |
Example
{
"account": TelcoAccountType,
"score": "1.0"
}Fields
| Name | Description |
|---|---|
accountNumber(String!) | Account number. |
Example
{
"accountNumber": "abc123"
}AccountUserCommsPreferences
Information about the preferences set up for a user.
Fields
| Name | Description |
|---|---|
emailFormat(EmailFormats) | What format the user would like to receive their emails in. |
fontSizeMultiplier(Float) | This setting allows the user to adjust the default font size of the communications sent to them. |
isOptedInMeterReadingConfirmations(Boolean) | Whether the user has opted in to receive meter reading confirmation emails. |
isOptedInToClientMessages(Boolean) | 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. |
isOptedInToLifeSupportCall(Boolean) | Whether the user is opted in to life support call. |
isOptedInToOfferMessages(Boolean) | Whether a user has opted in to receive messages offering discounts or other services not directly related to the services the client provides. |
isOptedInToRecommendedMessages(Boolean) | 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. |
isOptedInToSmsMessages(Boolean) | Whether the user has opted in to receive SMS messages. |
isOptedInToThirdPartyMessages(Boolean) | Whether a user has opted in to receive messages from the client's preferred third parties. |
isOptedInToUpdateMessages(Boolean) | Whether a user has opted in to receive messages updating them on client activities. |
isUsingInvertedEmailColours(Boolean) | 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. |
preferredHoldMusic(Songs) | Song which will be used as hold music for the user. |
smsOptInLastChangeDate(DateTime) | 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": 1.0,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"preferredHoldMusic": "NO_SONG_PREFERRED",
"smsOptInLastChangeDate": "2020-01-01T00:00:00.000Z",
"isOptedInToLifeSupportCall": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountUserConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountUserConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountUserConnectionTypeEdge
A Relay edge containing a AccountUserConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountUserType) | The item at the end of the edge |
Example
{
"node": AccountUserType,
"cursor": "abc123"
}AccountUserConsents
Information about the consents for an account user.
Fields
| Name | Description |
|---|---|
consents([ConsentType!]!) | Consents linked to this user. |
Example
{
"consents": ConsentType
}Fields
| Name | Description |
|---|---|
isSensitive(Boolean) | Whether the value is sensitive and encrypted. |
namespace(String) | The namespace for the property. |
value(String) | The property value. |
Example
{
"namespace": "abc123",
"value": "abc123",
"isSensitive": true
}AccountUserPermission
Holds information about a specific permission.
Fields
| Name | Description |
|---|---|
permission(String) | The short name of the permission. |
Example
{
"permission": "abc123"
}AccountUserRoleType
The role a user has in association with one account.
Fields
| Name | Description |
|---|---|
account(TelcoAccountType!) | |
id(ID!) | |
role(RoleString) | The account role. |
user(AccountUserType!) |
Example
{
"id": "abc123",
"user": AccountUserType,
"account": TelcoAccountType,
"role": RoleString
}AccountUserType
User objects are the core of the authentication system. They typically represent a customer who manages a portfolio of one or more accounts.
Fields
| Name | Description |
|---|---|
accountUserRoles([AccountUserRoleType]) | List of roles a user has for each account they're linked to. Arguments
Optionally filter the user's account roles to only return those linked to specific accounts. |
accounts([AccountInterface]) | List of accounts that the user is linked to either via portfolio role or account role. Arguments
Optionally filter the user's accounts to only return those linked to portfolios on the specified brands.
Optionally exclude accounts with any of the given account types.
Optionally exclude accounts that have never had an agreement.
Optionally restrict user accounts to only return those with the specified account numbers.
Optionally restrict user accounts to only return those linked to portfolios on public facing brands. |
address(RichAddressType) | This user's address. |
alternativePhoneNumbers([String]) | List of alternative phone numbers for the account user. |
businesses(BusinessConnectionTypeConnection) | List of businesses that the user has access to through their granted roles. |
consents([ConsentType!]!) | Consents linked to this user. |
createdAt(DateTime!) | |
dateOfBirth(Date) | AccountUser's date of birth. |
details([AccountUserDetailType]) | List of details linked to this user. |
displayName(String) | We recommend you use fullName instead of this field. Deprecated The 'displayName' field is deprecated. |
email(String!) | |
familyName(String!) | |
firstName(String) | We recommend you use preferredName or fullName instead of this field. Deprecated The 'firstName' field is deprecated. |
fullName(String) | The user's full name. |
givenName(String!) | |
hasFamilyIssues(Boolean) | Whether there are family issues. |
id(ID!) | |
isActive(Boolean) | Whether this user is active. |
isDeceased(Boolean!) | Designates whether this user is deceased. |
isInHardship(Boolean) | True if user is linked to an account with an active hardship agreement. |
label(String) | A free text field to help identifying the customer (e.g. for a job title). |
landline(String!) | |
landlinePhoneNumber(String) | The user's landline phone number. Deprecated The 'landlinePhoneNumber' field is deprecated. |
lastName(String) | We recommend you use preferredName or fullName instead of this field. Deprecated The 'lastName' field is deprecated. |
liveSecretKey(String) | The user's secret key to access the Developer API. |
mobile(String!) | |
number(String) | A code that uniquely identifies the account user. |
paymentMethods(PaymentInstructionConnectionTypeConnection) | List payment instructions linked to this user. |
permissions([AccountUserPermission]) | Holds information about the permissions of the current viewer. |
portfolioId(ID) | We recommend you use portfolioIds instead of this field. Deprecated The 'portfolioId' field is deprecated. |
portfolioIds([ID]) | List of portfolio ids that the user is linked to via their portfolio roles. Arguments
Optionally filter the user's portfolios to only return those linked to specified brands.
Optionally restrict the user portfolios to only return those linked to public facing brands. |
portfolioUserRoles([PortfolioUserRoleType]) | List of roles a user has for each portfolio they're linked to. |
portfolios(PortfolioConnectionTypeConnection) | List of portfolios that the user is linked to via their portfolio roles. Arguments
Optionally filter the user's portfolios to only return those linked to specified brands.
Optionally restrict the user portfolios to only return those linked to public facing brands. |
preferences(AccountUserCommsPreferences) | |
preferredName(String) | The user's preferred name. |
pronouns(String) | The user's pronouns e.g. 'she/her', 'he/him', 'they/them'. |
specialCircumstances(SpecialCircumstancesType) | |
title(String) |
Example
{
"id": "abc123",
"number": "abc123",
"accounts": AccountInterface,
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"mobile": "abc123",
"landline": "abc123",
"title": "abc123",
"pronouns": "abc123",
"isDeceased": true,
"liveSecretKey": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"permissions": [AccountUserPermission],
"displayName": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"fullName": "abc123",
"preferredName": "abc123",
"isActive": true,
"address": RichAddressType,
"portfolioId": "abc123",
"portfolioIds": ["abc123"],
"portfolios": PortfolioConnectionTypeConnection,
"businesses": BusinessConnectionTypeConnection,
"specialCircumstances": SpecialCircumstancesType,
"preferences": AccountUserCommsPreferences,
"dateOfBirth": "2020-01-01",
"label": "abc123",
"landlinePhoneNumber": "abc123",
"alternativePhoneNumbers": ["abc123"],
"hasFamilyIssues": true,
"isInHardship": true,
"accountUserRoles": [AccountUserRoleType],
"portfolioUserRoles": [PortfolioUserRoleType],
"details": [AccountUserDetailType],
"consents": ConsentType,
"paymentMethods": PaymentInstructionConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
activeDunningProcessId(Int) | Active dunning process id for the account. |
activeDunningProcessPathName(String) | Active dunning process path name for the account. |
Example
{
"activeDunningProcessId": 1,
"activeDunningProcessPathName": "abc123"
}AddBusinessToSegmentMutation
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11107: Unauthorized.
- KT-CT-11111: Segment does not exist.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
businessSegmentPeriod(BusinessSegmentPeriodType) | The business segment period that was created. |
possibleErrors([PossibleErrorType]) | 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-1111: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-7427: No campaign found with given slug.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
campaignAdded(Boolean) | Whether the campaign was successfully added. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"campaignAdded": true
}AddChildToProperty
Add a child property to a parent property in a hierarchy.
If the child is already in the hierarchy with a different parent, it will be reparented. If the child is already a child of the specified parent, this operation is idempotent and does nothing.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-6622: Unauthorized.
- KT-CT-6634: Unable to add child to property.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
child(PropertyType) | The child property that was added to the parent. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"child": PropertyType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
riskIdentifiers([RiskListItemType]) | List of successfully added risk identifiers. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
note(InkNote) | The ink conversation note. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}AddParentToProperty
Add a parent property to a child property in a hierarchy.
If the child is already in the hierarchy with a different parent, it will be reparented. If the child is already a child of the specified parent, this operation is idempotent and does nothing.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-6622: Unauthorized.
- KT-CT-6635: Unable to add parent to property.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
parent(PropertyType) | The parent property that was added to the child. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"parent": PropertyType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
property(PropertyType) | The property that was added to the account. |
Example
{
"possibleErrors": [PossibleErrorType],
"property": PropertyType
}AddPropertyToHierarchy
Add a property to a hierarchy as a root node.
If the property is already a root node in the hierarchy, this operation is idempotent. If the property is already in the hierarchy as a child, an error will be raised.
The possible errors that can be raised are:
- KT-CT-6622: Unauthorized.
- KT-CT-6633: Property is already in the hierarchy as a child.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
property(PropertyType) | The property that was added to the hierarchy. |
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 |
|---|---|
accountReferral(ReferralType) | The created account referral instance. |
possibleErrors([PossibleErrorType]) | 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-7651: Only one storyline entry can be marked as the root cause.
- KT-CT-7657: The provided analyzer result data is invalid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
storyline(InkStoryline) | The storyline that was added to the conversation. |
Example
{
"possibleErrors": [PossibleErrorType]
}AddTelcoQuoteToAccount
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-1111: Unauthorized.
- KT-CT-10917: Account does not have an account application.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
accountNumber(String) | The account number to which the quote has been added. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
quotingCode(String) | The quoting code of the quote that has been added to the account. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountNumber": "abc123",
"quotingCode": "abc123"
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
lengthInMonths(Int) | Validity period in months. |
price(FinancialAmount) | Discount price excluding VAT. |
priceWithVat(FinancialAmount) | Discount price including VAT. |
Example
{
"lengthInMonths": 1,
"price": FinancialAmount,
"priceWithVat": FinancialAmount
}Fields
| Name | Description |
|---|---|
countryCode(String) | Country code of billing address. |
line1(String) | Line 1 of address. |
line2(String) | Line 2 of address. |
line3(String) | Line 3 of address. |
line4(String) | Line 4 of address. |
line5(String) | Line 5 of address. |
postcode(String) | Postcode of billing address. |
Example
{
"line1": "abc123",
"postcode": "abc123",
"countryCode": "abc123",
"line2": "abc123",
"line3": "abc123",
"line4": "abc123",
"line5": "abc123"
}AddressType
Address.
Fields
| Name | Description |
|---|---|
allServiceLocations([ServiceLocationType]) | All service location identifiers at this property. |
line1(String) | Line 1 of address. |
line2(String) | Line 2 of address. |
line3(String) | Line 3 of address. |
postalCode(String) | Address postal code. |
serviceLocation(ServiceLocationType) | Service Location (primary). |
Example
{
"line1": "abc123",
"line2": "abc123",
"line3": "abc123",
"postalCode": "abc123",
"serviceLocation": ServiceLocationType,
"allServiceLocations": [ServiceLocationType]
}AffiliateAudioRecordingPresignedPostType
Metadata returned when generating a pre-signed post URL for an affiliate.
Fields
| Name | Description |
|---|---|
bucket(String!) | The S3 bucket. |
fields(JSONString!) | The fields to be included in the pre-signed post. |
key(String!) | The S3 bucket key. |
preSignedUrl(String!) | The pre-signed S3 URL. |
Example
{
"key": "abc123",
"bucket": "abc123",
"fields": {"key": "value"},
"preSignedUrl": "abc123"
}AffiliateLinkType
Affiliate link for the organization.
Fields
| Name | Description |
|---|---|
contactEmail(String!) | |
contactName(String!) | |
id(ID!) | |
isBusiness(Boolean!) | |
landingUrl(String!) | |
organisation(AffiliateOrganisationType) | Affiliate Organisation. |
subdomain(String!) | |
trainingStatus(LinkTrainingStatus!) |
Example
{
"id": "abc123",
"subdomain": "abc123",
"trainingStatus": "NOT_APPLICABLE",
"isBusiness": true,
"contactName": "abc123",
"contactEmail": "abc123",
"landingUrl": "abc123"
}Fields
| Name | Description |
|---|---|
allowAlternativePaymentMethods(Boolean) | Is this partner allowed to specify payment methods other than Direct Debit in the import csv or API. |
canRegisterBusinessMeterPoints(Boolean) | Are meter point registrations limited for profile classes 1 and 2 for registrations from csv or API. |
canRegisterCustomersWithoutEmailAddress(Boolean) | Allow registration requests with customers without an email address. |
canRegisterPortfolioAccounts(Boolean) | Allow registration requests with exiting account user emails to add to the portfolio belonging to the account user. |
canRenewTariffs(Boolean) | Allow performing tariff renewals via API. |
canUseIvrSupportApi(Boolean) | Allow this partner access to the IVR support API (modify their own IVR handling through third party 'IVR Flow Editor'). |
contactEmail(String!) | The primary contact email for the organisation. |
defaultAccountType(AccountTypeChoices) | Default Account Type. |
id(ID!) | |
isFieldSalesOnlyProduct(Boolean) | Restrict to field-sales-only products? This is only allowed for the 'field-sales' and 'events' sales channels. |
name(String!) | |
number(String) | Unique identifier for the organisation in the format O-XXXXXXXX. |
salesChannel(SalesChannelChoices) | Sales Channel. Deprecated The 'salesChannel' field is deprecated. |
salesChannelCode(String) | Sales Channel Code. |
skipMeterPointAddressValidation(Boolean) | Allow this partner to skip validation that ensures all meter points belong to the same address. |
Example
{
"id": "abc123",
"number": "abc123",
"name": "abc123",
"contactEmail": "abc123",
"canRenewTariffs": true,
"defaultAccountType": "BUSINESS",
"allowAlternativePaymentMethods": true,
"canRegisterBusinessMeterPoints": true,
"canRegisterPortfolioAccounts": true,
"canRegisterCustomersWithoutEmailAddress": true,
"canUseIvrSupportApi": true,
"skipMeterPointAddressValidation": true,
"salesChannel": "DIRECT",
"salesChannelCode": "abc123",
"isFieldSalesOnlyProduct": true
}AffiliateSessionType
A tracked session for the affiliate link.
Fields
| Name | Description |
|---|---|
id(ID!) | |
ipAddress(String) | |
link(AffiliateLinkType) | Affiliate Link. |
queryParams(JSONString!) | |
userAgent(String!) |
Example
{
"id": "abc123",
"ipAddress": "abc123",
"userAgent": "abc123",
"queryParams": {"key": "value"}
}Fields
| Name | Description |
|---|---|
id(ID) | The ID of the agent call center status. |
mostRecentCallId(Int) | The ID of the most recent call handled by the agent. If the agent status is BUSY then this will be the ID of the current call. |
status(String) | The current status of the agent in the call center. |
updatedAt(DateTime) | The timestamp when the status was last updated. |
Example
{
"id": "abc123",
"status": "abc123",
"updatedAt": "2020-01-01T00:00:00.000Z",
"mostRecentCallId": 1
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AgreementEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AgreementEdge,
"totalCount": 1,
"edgeCount": 1
}AgreementEdge
A Relay edge containing a Agreement and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CommonAgreementType) | The item at the end of the edge |
Example
{
"node": CommonAgreementType,
"cursor": "abc123"
}AgreementRescissionType
Details of an agreement rescission
Fields
| Name | Description |
|---|---|
agreement(CommonAgreementType!) | |
createdAt(DateTime!) | |
failureReason(String!) | |
flowReference(String) | |
id(ID!) | |
status(AgreementRescissionStatus) | The current status of the agreement rescission. |
stepName(String) | |
stepSlug(String) | |
updatedAt(DateTime!) |
Example
{
"id": "abc123",
"agreement": CommonAgreementType,
"status": "IN_PROGRESS",
"failureReason": "abc123",
"stepSlug": "abc123",
"stepName": "abc123",
"flowReference": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
actualSendDate(Date) | |
agreement(CommonAgreementType!) | |
createdAt(DateTime!) | |
expectedSendDate(Date!) | |
failureReason(String!) | |
id(ID!) | |
number(String!) | |
params(JSONString!) | |
quoteRequests([MarketSupplyQuoteRequestType!]!) | |
rolledOnTo(CommonAgreementType) | |
rolloverType(AgreementRolloverRolloverType!) | |
status(AgreementRolloverStatus!) | |
suppressComms(Boolean!) | |
tags([String]) | List of tag names associated with this agreement rollover. |
updatedAt(DateTime!) |
Example
{
"id": "abc123",
"number": "abc123",
"agreement": CommonAgreementType,
"rolledOnTo": CommonAgreementType,
"rolloverType": "DEFAULT",
"expectedSendDate": "2020-01-01",
"status": "PENDING",
"params": {"key": "value"},
"failureReason": "abc123",
"actualSendDate": "2020-01-01",
"suppressComms": true,
"tags": ["abc123"],
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
allocationAmount(Int!) | 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). |
allocationReason(String) | Reason for the allocation intention. |
transactionAmount(Int!) | 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). |
transactionId(Int!) | ID of the allocated transaction. |
transactionType(TransactionTypes!) | The type of the transaction. |
Example
{
"transactionId": 1,
"transactionType": "CREDIT",
"transactionAmount": 1,
"allocationAmount": 1,
"allocationReason": "abc123"
}AllocationType
Represents an allocation of a fulfilment to an obligation.
Fields
| Name | Description |
|---|---|
amount(Int!) | The amount of the allocation (in minor currency units), unsigned. |
fulfilment(FulfilmentType!) | The fulfilment that is allocated. |
Example
{
"amount": 1,
"fulfilment": FulfilmentType
}AllowRepaymentSubmission
Allow a repayment to be submitted.
The possible errors that can be raised are:
- KT-CT-3944: Account repayment does not exist.
- KT-CT-3945: Unable to allow a repayment to be submitted.
- KT-CT-3950: The provided reason text is too long.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
repaymentId(ID) | The repayment ID. |
repaymentIntervention(RepaymentInterventionType) | Resulting Repayment Intervention details. |
Example
{
"possibleErrors": [PossibleErrorType],
"repaymentId": "abc123"
}AlreadyLinkedError
Returned when an account already has a LINE account linked to it.
Fields
| Name | Description |
|---|---|
type(LineLinkErrorType!) | The type of error that occurred. |
Example
{
"type": "NO_MATCHING_LINE_LINK"
}Fields
| Name | Description |
|---|---|
matchResult(MatchResultType) | Alternative switch option. |
Example
{
"matchResult": MatchResultType
}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 |
|---|---|
payment(AccountPaymentType) | |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
accessibilityHidden(Boolean) | Whether the element is hidden from view. |
accessibilityLabel(String) | Accessible description of the element. |
horizontalAlignment(Alignment) | The horizontal alignment of the media. |
id(ID) | Unique identifier of the object. |
mediaUrl(String!) | The resource URL of the media. |
typename(String) | The name of the object's type. |
width(ItemSizeType) | The measurement of the element. |
Example
{
"width": FractionSizeType,
"mediaUrl": "abc123",
"horizontalAlignment": "START",
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AnnualStatementConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AnnualStatementConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AnnualStatementConnectionTypeEdge
A Relay edge containing a AnnualStatementConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AnnualStatementType) | The item at the end of the edge |
Example
{
"node": AnnualStatementType,
"cursor": "abc123"
}AnnualStatementType
Annual statements that are sent to the account. They summarize important information about usage and tariffs.
Example
{
"periodStartsAt": "2020-01-01T00:00:00.000Z",
"periodEndsAt": "2020-01-01T00:00:00.000Z",
"id": "abc123",
"pdfUrl": "abc123"
}AnnulmentBillingDocumentType
An annulment is a billing document that annuls another billing document.
Fields
| Name | Description |
|---|---|
annulledBillingDocumentId(Int!) | ID of the billing document annulled by this annulment. |
firstIssued(DateTime) | First time the annulment was issued. |
id(Int!) | ID for the annulment billing document. |
pdfUrl(String) | URL to the PDF of the annulment. |
Example
{
"id": 1,
"annulledBillingDocumentId": 1,
"firstIssued": "2020-01-01T00:00:00.000Z",
"pdfUrl": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AppSessionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AppSessionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AppSessionConnectionTypeEdge
A Relay edge containing a AppSessionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AppSessionType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | |
addressLine1(String!) | |
addressLine2(String!) | |
addressLine3(String!) | |
addressLine4(String!) | Post town |
addressLine5(String!) | County |
createdAt(DateTime!) | |
id(UUID!) | |
isArchived(Boolean) | |
link(AffiliateLinkType!) | |
locationAt(DateTime) | |
locationHorizontalAccuracy(Int) | The location accuracy level in meters |
locationLatitude(Decimal) | |
locationLongitude(Decimal) | |
outcomes([OutcomeType]) | A list of outcomes associated with the app session. |
postcode(String!) | |
salesMode(AppSessionSalesMode) | |
startedAt(DateTime!) | |
stoppedAt(DateTime!) | |
type(AppSessionType) | |
updatedAt(DateTime!) |
Example
{
"startedAt": "2020-01-01T00:00:00.000Z",
"stoppedAt": "2020-01-01T00:00:00.000Z",
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "abc123",
"addressLine4": "abc123",
"addressLine5": "abc123",
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"isArchived": true,
"postcode": "abc123",
"account": TelcoAccountType,
"locationAt": "2020-01-01T00:00:00.000Z",
"locationHorizontalAccuracy": 1,
"locationLatitude": "1.0",
"locationLongitude": "1.0",
"salesMode": "DOOR",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
repayment(AccountRepaymentType) | 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 |
|---|---|
collectionProcessProcessed(AssessCollectionProcessRecordForPauseOutputType) | Details of collection process after running the pause assessment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}AssessCollectionProcessRecordForPauseOutputType
Output for assessing a Collection process for pause.
Fields
| Name | Description |
|---|---|
isPaused(Boolean) | The pause status of the collection process. |
number(String) | The number of the collection process record. |
Example
{
"number": "abc123",
"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 |
|---|---|
bucket(InkBucket!) | The bucket that the conversation will be assigned to. |
conversation(InkConversation!) | The conversation that will be assigned to the bucket. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"conversation": InkConversation
}Fields
| Name | Description |
|---|---|
id(ID!) | The ID of the assigned user. |
username(String!) | The username of the assigned user. |
Example
{
"id": "abc123",
"username": "abc123"
}AssistanceAgreementType
A single Assistance Agreement.
Fields
| Name | Description |
|---|---|
activeFrom(Date) | The start datetime of the agreement. |
activeTo(Date) | The end datetime of the agreement, if any. |
assistanceType(String) | The type of assistance provided by the agreement. |
Example
{
"assistanceType": "abc123",
"activeFrom": "2020-01-01",
"activeTo": "2020-01-01"
}AssociateCallWithAccount
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11802: Call not found.
- KT-CT-11808: Unable to associate account to call.
- KT-CT-11817: Invalid call ID.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
call(InboundCallType) | The call. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
collectionProcessAssociatedItem(AssociateItemToCollectionProcessOutputType) | Item associated to the collection process. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
itemId(ID) | Associated item identifier. |
number(String) | The number of the collection process record. |
Example
{
"number": "abc123",
"itemId": "abc123"
}Fields
| Name | Description |
|---|---|
quoteToken(ID!) | The token for the quote being generated. |
Example
{
"quoteToken": "abc123"
}Fields
| Name | Description |
|---|---|
isComplete(Boolean!) | Is the quote complete. |
percentComplete(Float!) | How complete is the quote. |
quoteCode(String) | Once complete, this will show the code for the quote. The full quote can be retrieved using this code and the Query.createdTelcoQuoteRequest query. |
quoteToken(ID!) | The token for the quote being generated. |
status(AsyncQuoteStatusEnum!) | The status of the quote, whether it is complete or in progress. |
Example
{
"quoteToken": "abc123",
"status": "IN_PROGRESS",
"isComplete": true,
"percentComplete": 1.0,
"quoteCode": "abc123"
}AttachmentType
Represents a file to attach to a communication
Fields
| Name | Description |
|---|---|
filename(String!) | |
id(ID!) | |
temporaryUrl(String) | Temporary URL at which the attachment is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). |
Example
{
"id": "abc123",
"filename": "abc123",
"temporaryUrl": "abc123"
}AttemptToWithdrawCollectionProcess
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11213: No active collection process found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
withdrawSuccessful(Boolean) | Whether the collection process was withdrawn successfully. |
Example
{
"possibleErrors": [PossibleErrorType],
"withdrawSuccessful": true
}AttemptToWithdrawDunning
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11302: No active dunning process found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
withdrawSuccessful(Boolean) | Whether the dunning process was withdrawn successfully. |
Example
{
"possibleErrors": [PossibleErrorType],
"withdrawSuccessful": true
}Fields
| Name | Description |
|---|---|
appSession(AppSessionType) | The app session associated with this audio recording. |
contentType(String!) | |
createdAt(DateTime!) | |
duration(Float!) | |
fileSize(Int!) | |
id(UUID!) | |
s3Bucket(String!) | |
s3Key(String!) | |
startedAt(DateTime!) | |
stoppedAt(DateTime!) | |
updatedAt(DateTime!) |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"contentType": "abc123",
"duration": 1.0,
"fileSize": 1,
"startedAt": "2020-01-01T00:00:00.000Z",
"stoppedAt": "2020-01-01T00:00:00.000Z",
"s3Bucket": "abc123",
"s3Key": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
clientId(String) | The client ID of the application. |
name(String) | The name of the application. |
Example
{
"name": "abc123",
"clientId": "abc123"
}AvailableFaultAppointmentSlotsResultType
Result containing available fault appointment slots.
Fields
| Name | Description |
|---|---|
slots([FaultAppointmentSlotType]!) | List of available appointment slots. |
Example
{
"slots": FaultAppointmentSlotType
}Fields
| Name | Description |
|---|---|
availableInstallationAppointments([InstallationAppointmentType]) | Available installation appointments. |
Example
{
"availableInstallationAppointments": [InstallationAppointmentType]
}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-9211: Invalid reason for loyalty points award.
- KT-CT-9212: Points exceed maximum limit.
- KT-CT-9219: Loyalty points user not found.
- KT-CT-9221: Idempotency key already used on ledger entry.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
ledgerEntry(LoyaltyPointLedgerEntryType) | The ledger entry for the awarded loyalty points. |
pointsAwarded(Int) | The number of loyalty points that were awarded. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsAwarded": 1,
"ledgerEntry": LoyaltyPointLedgerEntryType
}BackendScreenEvent
Returns an Action to perform, e.g. a screen to load.
BackendScreenEvents are specific types of Action which trigger a mutation in the Kraken backend. They return an action (any type), such as a ScreenActionType (which is then used to load the next screen). Any action registered in the registry should really be an "event" with some side-effect in the backend.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-8002: No event found.
- KT-CT-8003: Event has no execute function.
- KT-CT-8004: Error executing event in the backend.
- KT-CT-8007: Incorrect or missing parameters for backend screen event.
- KT-GB-9310: Account ineligible for joining Octoplus.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
action(ActionType) | An action to perform. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"action": DeeplinkActionType
}BackendScreenEventActionType
An action which triggers some event in the Kraken backend.
Fields
| Name | Description |
|---|---|
eventId(String!) | The ID of the event to trigger. |
id(ID) | Unique identifier of the object. |
params([BackendScreenParam]!) | List of key-value pairs to pass as parameters to the event. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"eventId": "abc123",
"params": BackendScreenParam
}BackendScreenParam
A key-value pair (both Strings) which is passed as a parameter to a screen.
Example
{
"key": "abc123",
"value": "abc123"
}Fields
| Name | Description |
|---|---|
balanceThreshold(Int) | The ledger balance (in minor currency unit) which when passed will trigger a payment. |
targetBalance(Int) | The target balance (in minor currency unit) for the ledger. |
Example
{
"balanceThreshold": 1,
"targetBalance": 1
}Fields
| Name | Description |
|---|---|
areValid(Boolean!) | Indicates whether the provided bank details are valid. |
message(String) | Provides additional information about validation result. |
Example
{
"areValid": true,
"message": "abc123"
}BasketSummaryOutputType
Output type for the selected offerings from the quoted offerings.
Fields
| Name | Description |
|---|---|
address(AddressType) | Address where installation will take place. |
installationAppointment(InstallationAppointmentType) | The installation appointment that has been booked. |
quotingCode(String) | The code of the quote created. |
selectedOffering(QuotedCatalogOffering) | The selected offering. |
Example
{
"quotingCode": "abc123",
"selectedOffering": QuotedCatalogOffering,
"installationAppointment": InstallationAppointmentType,
"address": AddressType
}BillCharge
A charge to the customer from the energy retailer.
Fields
| Name | Description |
|---|---|
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
consumption(Consumption) | 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). |
createdAt(DateTime) | The date time when the transaction is created. |
detail(ChargeDetail) | Supporting information about this charge (if any is available). |
id(ID) | The unique identifier for the transaction. |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | The date the transaction was posted. |
reasonCode(String) | Returns the reason. |
title(String) | A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123",
"consumption": Consumption,
"detail": SupplyOrServiceCharge
}BillConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BillConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}BillConnectionTypeEdge
A Relay edge containing a BillConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BillInterface) | The item at the end of the edge |
Example
{
"node": BillInterface,
"cursor": "abc123"
}BillCredit
A credit to the customer from the energy retailer.
Fields
| Name | Description |
|---|---|
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
createdAt(DateTime) | The date time when the transaction is created. |
id(ID) | The unique identifier for the transaction. |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | The date the transaction was posted. |
reasonCode(String) | Returns the reason. |
title(String) | A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123"
}BillPayment
A payment from the customer to the energy supplier.
Fields
| Name | Description |
|---|---|
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
createdAt(DateTime) | The date time when the transaction is created. |
id(ID) | The unique identifier for the transaction. |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | The date the transaction was posted. |
reasonCode(String) | Returns the reason. |
title(String) | A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123"
}BillRefund
A refund to the customer from the energy supplier.
Fields
| Name | Description |
|---|---|
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
createdAt(DateTime) | The date time when the transaction is created. |
id(ID) | The unique identifier for the transaction. |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | The date the transaction was posted. |
reasonCode(String) | Returns the reason. |
title(String) | A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123"
}BillRepresentationConnectionTypeConnection
A connection that can provide links to the representations of a bill.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BillRepresentationConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillRepresentationConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}BillRepresentationConnectionTypeEdge
A Relay edge containing a BillRepresentationConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BillRepresentationType) | The item at the end of the edge |
Example
{
"node": BillRepresentationType,
"cursor": "abc123"
}BillRepresentationType
representations are associated with a bill files and can be used to provide additional information to the customer.
Fields
| Name | Description |
|---|---|
code(String) | The type of representation. |
filename(String) | The name of the file. |
temporaryUrl(String) | The |
temporaryUrlExpiresAt(DateTime) | The expiry datetime field of the temporary URL. |
version(Int) | The version of the representation. |
Example
{
"code": "abc123",
"version": 1,
"temporaryUrl": "abc123",
"temporaryUrlExpiresAt": "2020-01-01T00:00:00.000Z",
"filename": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BillTransactionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillTransactionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}BillTransactionConnectionTypeEdge
A Relay edge containing a BillTransactionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BillTransactionType) | The item at the end of the edge |
Example
{
"node": BillTransactionType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
targetBalance(Int) | The target balance (in minor currency unit) for the ledger. |
Example
{
"targetBalance": 1
}Fields
| Name | Description |
|---|---|
frequencyMultiplier(Int) | The multiple of months at which payments are taken, if specified. |
paymentDay(Int) | The day of the month at which to take payment, if specified. |
Example
{
"paymentDay": 1,
"frequencyMultiplier": 1
}BillingAttachmentConnectionTypeConnection
A connection that can provide links to the attachments of the bill.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BillingAttachmentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillingAttachmentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}BillingAttachmentConnectionTypeEdge
A Relay edge containing a BillingAttachmentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BillingAttachmentType) | The item at the end of the edge |
Example
{
"node": BillingAttachmentType,
"cursor": "abc123"
}BillingAttachmentType
Attachments are associated with a bill files and can be used to provide additional information to the customer.
Fields
| Name | Description |
|---|---|
filename(String) | The name of the file. |
temporaryUrl(String) | The |
temporaryUrlExpiresAt(DateTime) | The expiry datetime field of the temporary URL. |
Example
{
"temporaryUrl": "abc123",
"temporaryUrlExpiresAt": "2020-01-01T00:00:00.000Z",
"filename": "abc123"
}Fields
| Name | Description |
|---|---|
allocationIntentions([AllocationIntentionType]!) | Allocation intentions for the billing document. |
allocations([AllocationType]!) | Allocations for the billing document. |
dueDate(Date!) | The date when the payment is due for the billing document. |
expectedAmount(Int!) | The expected amount for the billing document (in minor currency units). |
remainingAmount(Int!) | The amount that remains to be paid for the billing document (in minor currency units). |
Example
{
"dueDate": "2020-01-01",
"expectedAmount": 1,
"remainingAmount": 1,
"allocationIntentions": AllocationIntentionType,
"allocations": AllocationType
}BillingOperationFrequency
A billing operation frequency definition.
Fields
| Name | Description |
|---|---|
frequency(BillingTriggerFrequency!) | The billing frequency. |
multiplier(Int!) | The frequency multiplier (e.g., 2 for bi-monthly). |
operationType(BillingTriggerOperationType!) | The type of billing operation. |
targetType(BillingTriggerTargetType!) | The type of target this definition applies to. |
temporalParams([BillingOperationTemporalParamsType!]!) | Temporal parameters for operation parameters. |
triggerAtStartDay(Int!) | Day of the month when billing is triggered (1-31). |
triggerAtStartMonth(Int!) | Month of the year when billing starts (1-12). |
Example
{
"operationType": "CHARGE_TARGET",
"targetType": "CHARGING_LEDGER",
"frequency": "DAILY",
"multiplier": 1,
"triggerAtStartDay": 1,
"triggerAtStartMonth": 1,
"temporalParams": BillingOperationTemporalParamsType
}BillingOperationTemporalParamsType
Temporal parameters for billing frequency operations.
Fields
| Name | Description |
|---|---|
paramKey(String!) | The key of the parameter (e.g., charge_to). |
startDay(Int!) | Day of the month (1-31). |
startMonth(Int!) | Month of the year (1-12). |
Example
{
"paramKey": "abc123",
"startDay": 1,
"startMonth": 1
}BillingOptionsType
Information about an account's billing schedule.
Fields
| Name | Description |
|---|---|
currentBillingPeriodEndDate(Date) | The date on which the current billing cycle will end. Null if the account is on flexible billing. |
currentBillingPeriodStartDate(Date) | The date on which the current billing cycle started. |
isFixed(Boolean!) | 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. |
nextBillingDate(Date) | 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. |
periodLength(AccountBillingOptionsPeriodLength) | |
periodLengthMultiplier(Int) | |
periodStartDay(Int) | The day of the month on which the account's billing period should start. |
Example
{
"periodStartDay": 1,
"periodLength": "MONTHLY",
"periodLengthMultiplier": 1,
"isFixed": true,
"currentBillingPeriodStartDate": "2020-01-01",
"currentBillingPeriodEndDate": "2020-01-01",
"nextBillingDate": "2020-01-01"
}BillingTriggerConfiguration
A billing trigger configuration with its effective period and operation frequencies.
This represents a complete billing configuration for a target, including effective period and what operations should be performed at what frequencies.
Fields
| Name | Description |
|---|---|
effectiveFrom(DateTime!) | When this configuration becomes effective. |
effectiveTo(DateTime) | When this configuration stops being effective (null if no end date). |
isActive(Boolean!) | Whether this configuration is currently active. |
nextIssueDate(Date) | Next date when a billing document will be issued (null if not calculable). |
operationFrequencies([BillingOperationFrequency!]!) | List of billing operation frequencies in this configuration. |
targetType(BillingTriggerTargetType!) | The type of target this configuration applies to. |
Example
{
"effectiveFrom": "2020-01-01T00:00:00.000Z",
"effectiveTo": "2020-01-01T00:00:00.000Z",
"isActive": true,
"targetType": "CHARGING_LEDGER",
"operationFrequencies": BillingOperationFrequency,
"nextIssueDate": "2020-01-01"
}BillingTriggerConfigurationsConnection
Pagination object for billing trigger configurations.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BillingTriggerConfigurationsEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillingTriggerConfigurationsEdge,
"totalCount": 1,
"edgeCount": 1
}BillingTriggerConfigurationsEdge
A Relay edge containing a BillingTriggerConfigurations and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BillingTriggerConfigurationsForTarget) | The item at the end of the edge |
Example
{
"node": BillingTriggerConfigurationsForTarget,
"cursor": "abc123"
}BillingTriggerConfigurationsForTarget
Billing trigger configurations for a single target.
Fields
| Name | Description |
|---|---|
configurations([BillingTriggerConfiguration!]!) | List of billing trigger configurations for this target. |
target(BillingTriggerTargetReference!) | Reference to the target entity for these billing configurations. |
Example
{
"target": BillingTriggerTargetReference,
"configurations": BillingTriggerConfiguration
}BillingTriggerTargetReference
A reference to a billing trigger target.
Fields
| Name | Description |
|---|---|
id(ID!) | The database ID of the target. |
number(String) | The account or portfolio number (null for ledgers). |
targetType(BillingTriggerTargetType!) | The type of target (ACCOUNT, PORTFOLIO, or CHARGING_LEDGER). |
Example
{
"targetType": "CHARGING_LEDGER",
"number": "abc123",
"id": "abc123"
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
repaymentId(ID) | The repayment ID. |
repaymentIntervention(RepaymentInterventionType) | Resulting Repayment Intervention details. |
Example
{
"possibleErrors": [PossibleErrorType],
"repaymentId": "abc123"
}BookFaultAppointmentOutput
Output for booking a fault appointment.
Fields
| Name | Description |
|---|---|
appointment(FaultAppointment) | The booked fault appointment. |
Example
{
"appointment": FaultAppointment
}BookInstallationAppointment
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-4620: Badly formed hexadecimal UUID string.
- KT-CT-4914: Unable to complete installation request.
- KT-CT-4927: Invalid requested installation date provided.
- KT-CT-4928: Invalid installation appointment notes provided.
- KT-CT-4929: Invalid hazard notes provided.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
installationAppointment(InstallationAppointmentType) | The book installation appointment response. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"installationAppointment": InstallationAppointmentType
}Fields
| Name | Description |
|---|---|
promiseId(String) | The promise ID. |
result(InstallationAppointmentType) | The installation appointment. |
Example
{
"promiseId": "abc123",
"result": InstallationAppointmentType
}Fields
| Name | Description |
|---|---|
appointmentId(ID) | The ID of the appointment. |
installationDate(Date) | The date of the appointment. |
installationRequired(Boolean) | Whether an installation is required. |
installationStatus(String) | The status of the installation. |
installationTimeFrom(Time) | The start time of the appointment. |
installationTimeTo(Time) | The end time of the appointment. |
Example
{
"appointmentId": "abc123",
"installationRequired": true,
"installationStatus": "abc123",
"installationDate": "2020-01-01",
"installationTimeFrom": "00:00:00.000Z",
"installationTimeTo": "00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
cancellationAt(DateTime) | The date and time when the order was cancelled. |
cancellationReason(String) | The reason for cancelling the order. |
cancellationSubreason(String) | The detailed reason for cancelling the order. |
orderId(String) | The ID of the order. |
orderType(String) | The type of the order. |
orderedAt(DateTime) | The date and time the order was placed. |
products([TelcoProductType]) | Products associated with this broadband order. |
proposedAt(DateTime) | The date and the time the order is proposed to be activated. |
startAt(DateTime) | The date the product order will commence. |
status(String) | The status of the order. |
Example
{
"orderId": "abc123",
"orderType": "abc123",
"orderedAt": "2020-01-01T00:00:00.000Z",
"proposedAt": "2020-01-01T00:00:00.000Z",
"status": "abc123",
"cancellationReason": "abc123",
"cancellationSubreason": "abc123",
"cancellationAt": "2020-01-01T00:00:00.000Z",
"startAt": "2020-01-01T00:00:00.000Z",
"products": [TelcoProductType]
}Fields
| Name | Description |
|---|---|
code(String) | The code of the product. |
downstreamSpeedMbps(Int) | The quoted downstream speed of the product. |
isHidden(Boolean) | Whether the product is hidden. |
monthlyPrice(FinancialAmount) | The monthly price of the product. |
monthlyPriceWithTaxes(FinancialAmount) | The monthly price of the product extra with taxes. |
name(String) | The name of the product. |
upstreamSpeedMbps(Int) | The quoted upstream speed of the product. |
wholesaleProductOfferingInfo(WholesaleProductOfferingInfo) | Information about the wholesale product offering. When certain, |
Example
{
"name": "abc123",
"code": "abc123",
"wholesaleProductOfferingInfo": WholesaleProductOfferingInfo,
"isHidden": true,
"upstreamSpeedMbps": 1,
"downstreamSpeedMbps": 1,
"monthlyPrice": FinancialAmount,
"monthlyPriceWithTaxes": FinancialAmount
}BulkAwardLoyaltyPoints
Bulk award Loyalty Points.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9212: Points exceed maximum limit.
- KT-CT-9221: Idempotency key already used on ledger entry.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
failed([BulkAwardLoyaltyPointsFailedItemResult]) | Failed loyalty point awards. |
inserted([BulkAwardLoyaltyPointsInsertedItemResult]) | Successfully inserted loyalty point awards. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"inserted": [BulkAwardLoyaltyPointsInsertedItemResult],
"failed": [BulkAwardLoyaltyPointsFailedItemResult]
}Fields
| Name | Description |
|---|---|
accountNumber(String) | The account number for this failed item. |
errorCode(String) | Error code for failed items. |
errorMessage(String) | Error message for failed items. |
idempotencyKey(UUID) | The idempotency key for this failed item. |
Example
{
"accountNumber": "abc123",
"idempotencyKey": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"errorCode": "abc123",
"errorMessage": "abc123"
}Fields
| Name | Description |
|---|---|
accountNumber(String) | The account number for this item. |
ledgerEntry(LoyaltyPointLedgerEntryType) | The created loyalty point ledger entry when successful. |
pointsAwarded(Int) | The number of points awarded for this item when successful. |
Example
{
"accountNumber": "abc123",
"pointsAwarded": 1,
"ledgerEntry": LoyaltyPointLedgerEntryType
}BusinessConnectionTypeConnection
Paginator of Businesses
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BusinessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BusinessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}BusinessConnectionTypeEdge
A Relay edge containing a BusinessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BusinessType) | The item at the end of the edge |
Example
{
"node": BusinessType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
key(String!) | The key of the business detail. |
value(String) | The value of the business detail. |
Example
{
"key": "abc123",
"value": "abc123"
}Fields
| Name | Description |
|---|---|
endAt(DateTime) | The end date and time of the segment period. |
id(ID!) | The ID of the business segment period. |
segment(SegmentType!) | The segment associated with this period. |
startAt(DateTime) | The start date and time of the segment period. |
Example
{
"id": "abc123",
"segment": SegmentType,
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
billingAddress(RichAddressType) | The billing address of the business. |
businessType(BusinessTypeOptions) | The company type of a business account. |
details([BusinessDetailType]) | The details of the business. |
id(ID!) | The business ID. |
legalAddress(RichAddressType) | The legal address of the business. |
linkedAccountNumber(ID!) | Account number linked to this business. The possible errors that can be raised are:
Deprecated The 'linkedAccountNumber' field is deprecated. |
linkedAccountNumbers([ID]!) | Account numbers linked to this business. |
name(String!) | The business' name. |
number(String!) | The business' number. |
paymentMethods(PaymentInstructionConnectionTypeConnection) | List payment instructions owned by this business. |
sectors([BusinessSectorString!]!) | The sectors the business operates in. |
segmentName(String) | The segment this business is assigned to. |
Example
{
"id": "abc123",
"name": "abc123",
"number": "abc123",
"businessType": "SOLE_TRADER",
"sectors": BusinessSectorString,
"details": [BusinessDetailType],
"billingAddress": RichAddressType,
"legalAddress": RichAddressType,
"linkedAccountNumber": "abc123",
"linkedAccountNumbers": "abc123",
"segmentName": "abc123",
"paymentMethods": PaymentInstructionConnectionTypeConnection
}CPEDeliveryFeeType
Represents a CPE delivery fee term in a contract.
Fields
| Name | Description |
|---|---|
description(NonEmptyString) | The description of the term. |
displayName(NonEmptyString) | The display name of the term. |
identifier(NonEmptyString) | The identifier of the term. |
isVariable(Boolean) | Whether the term is variable. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}Fields
| Name | Description |
|---|---|
cpeFamily(String) | Desired CPE option family. |
currentQuantity(Int) | Current active quantity for CPE option. |
supportedQuantities([Int]) | List of supported quantities for CPE option. |
Example
{
"cpeFamily": "abc123",
"currentQuantity": 1,
"supportedQuantities": [1]
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([CallDetailRecordEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": CallDetailRecordEdge,
"totalCount": 1,
"edgeCount": 1
}CallDetailRecordEdge
A Relay edge containing a CallDetailRecord and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CallDetailRecordType) | The item at the end of the edge |
Example
{
"node": CallDetailRecordType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
billed(Boolean!) | Whether this Call Detail Record has been billed. |
billedDuration(Int!) | Billed duration in seconds. |
bundleName(String) | Name of the bundle used. |
callDuration(Int!) | Duration in seconds. |
callId(ID!) | The call_id of the Call Detail Record. |
callStart(DateTime!) | Start time of the call. |
cli(String!) | Calling Line Identification. |
destination(String) | Destination of the call. |
dialledNumber(String!) | The number dialled. |
direction(String!) | Direction of the call. |
grossCharge(Money) | The Gross Charge for the call. |
itemisationGroup(String) | Group for itemisation. |
params(JSONString!) | Collection of attributes (params) as a JSON object. |
timeband(String) | The timeband of the call. |
Example
{
"callId": "abc123",
"cli": "abc123",
"dialledNumber": "abc123",
"direction": "abc123",
"callStart": "2020-01-01T00:00:00.000Z",
"callDuration": 1,
"billedDuration": 1,
"timeband": "abc123",
"itemisationGroup": "abc123",
"grossCharge": Money,
"bundleName": "abc123",
"destination": "abc123",
"billed": true,
"params": {"key": "value"}
}Fields
| Name | Description |
|---|---|
key(String!) | The key of the call metadata item. |
value(String!) | The value of the call metadata item. |
Example
{
"key": "abc123",
"value": "abc123"
}CallTagConnectionTypeConnection
Paginator of Call Tags
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([CallTagConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": CallTagConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}CallTagConnectionTypeEdge
A Relay edge containing a CallTagConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CallTagType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
id(ID) | ID of the call tag. |
isActive(Boolean) | Whether the tag can currently be used to tag calls. |
name(String) | Name of the tag that will be used to identify it. |
Example
{
"id": "abc123",
"name": "abc123",
"isActive": true
}Fields
| Name | Description |
|---|---|
canAmendPayments(Boolean) | Whether or not the account can amend payments. |
canCancelPayments(Boolean) | Whether or not the account can cancel payments. |
Example
{
"canAmendPayments": true,
"canCancelPayments": true
}CancelContract
The possible errors that can be raised are:
- KT-CT-10013: Requested termination date is invalid.
- KT-CT-4178: No account found with given account number.
- KT-CT-10003: Contract not found.
- KT-CT-10028: Contract market mismatch.
- KT-CT-10027: There is an ongoing provider switch.
- KT-CT-10008: The contract is currently undergoing an active journey.
- KT-CT-10015: Supply point termination context is not serializable.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
cancelContract(CancellationContractType) | Cancel contract for the chosen contract. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"cancelContract": CancellationContractType
}CancelEngineer
Cancel an existing fault appointment. The trouble ticket is updated by this mutation.
The possible errors that can be raised are:
- KT-CT-10901: Invalid data.
- KT-CT-10952: Telco fault not found.
- KT-CT-10954: Fault appointment not found.
- KT-CT-10961: Failed to cancel trouble ticket with network provider.
- KT-CT-10962: Trouble ticket cancellation temporarily unavailable.
- KT-CT-10963: Appointment not linked to fault.
- KT-CT-10972: Unable to cancel the trouble ticket as in a terminal state.
- KT-CT-10974: The provided cancellation 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 |
|---|---|
appointment(FaultAppointment) | The cancelled fault appointment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"appointment": FaultAppointment
}CancelOnSiteJobsAppointment
The possible errors that can be raised are:
- KT-CT-13001: Appointment does not exist.
- KT-CT-13019: Vendor not found.
- KT-CT-13017: Appointment cancellation not supported.
- KT-CT-13053: Failed to cancel the appointment with the agent.
- KT-CT-13018: Unable to record cancellationcategory/cancellationsub_category.
- KT-CT-13043: Cannot update appointment as it has terminal status.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The Appointment that was cancelled. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
promiseId(String) | Promise id for polling async results. |
result(CancelOrderResultOutput) | Data returned for sync or completed async results. |
Example
{
"promiseId": "abc123",
"result": CancelOrderResultOutput
}Fields
| Name | Description |
|---|---|
cancelledOrderId(String!) | The ID of the order that was cancelled. |
Example
{
"cancelledOrderId": "abc123"
}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 |
|---|---|
payment(AccountPaymentType) | The cancelled payment. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
repaymentRequest(CancelRepaymentRequestOutputType) | The cancelled repayment/refund request. |
Example
{
"possibleErrors": [PossibleErrorType],
"repaymentRequest": CancelRepaymentRequestOutputType
}CancelRepaymentRequestOutputType
Output from cancelling a repayment or refund request.
Fields
| Name | Description |
|---|---|
requestId(String) | The ID of the cancelled request. |
status(RepaymentRequestStatus) | The current status of the cancelled request. |
Example
{
"requestId": "abc123",
"status": "REQUESTED"
}CancelReturnsBagReorder
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-10969: Equipment returns bag reorder not found.
- KT-CT-10970: Equipment returns bag reorder has not been submitted.
- KT-CT-10908: Unable to cancel order.
- KT-CT-10910: Order already cancelled.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
status(String) | The result of the operation. |
Example
{
"possibleErrors": [PossibleErrorType],
"status": "abc123"
}Fields
| Name | Description |
|---|---|
cancellationDate(Date) | The date of the cancellation. |
status(String) | The status of the cancellation. |
Example
{
"status": "abc123",
"cancellationDate": "2020-01-01"
}CardComponentType
A card containing a list of items
Fields
| Name | Description |
|---|---|
accessibilityHidden(Boolean) | Whether the element is hidden from view. |
accessibilityLabel(String) | Accessible description of the element. |
id(ID) | Unique identifier of the object. |
items([CardItemType]!) | The list of components. |
typename(String) | The name of the object's type. |
Example
{
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123",
"items": TextType
}Fields
| Name | Description |
|---|---|
cards([CardComponentType]!) | The list of cards. |
id(ID) | Unique identifier of the object. |
typename(String) | The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"cards": CardComponentType
}Fields
| Name | Description |
|---|---|
code(String) | Characteristic code. |
defaultValue(String) | Default value for characteristic. |
description(String) | Customer facing description for characteristic. |
name(String) | Customer facing name for characteristic. |
selectedValue(String) | Selected characteristic value if within selected offering. |
unit(String) | Unit of value eg: 'Mbps'. |
valueOptions([String]) | List of only possible values if provided. |
Example
{
"code": "abc123",
"name": "abc123",
"description": "abc123",
"unit": "abc123",
"valueOptions": ["abc123"],
"defaultValue": "abc123",
"selectedValue": "abc123"
}Fields
| Name | Description |
|---|---|
catalogProducts([CatalogProduct]) | Products within offering. |
catalogTerms([CatalogTerm]) | Terms within offering. |
description(String) | Customer facing description for offering. |
identifier(String) | Unique identifier for offering. |
name(String) | Customer facing name for offering. |
Example
{
"identifier": "abc123",
"name": "abc123",
"description": "abc123",
"catalogTerms": [CatalogTerm],
"catalogProducts": [CatalogProduct]
}Fields
| Name | Description |
|---|---|
characteristics([CatalogCharacteristic]) | List of characteristics for product. |
description(String) | Customer facing description for product. |
identifier(String) | Unique identifier for catalog product. |
initialQuantity(Int) | Initial quantity selected for product within range [minimumquantity ... maximumquantity]. |
maximumQuantity(Int) | Maximum quantity that can be selected for product. |
minimumQuantity(Int) | Minimum quantity that can be selected for product. |
name(String) | Customer facing name for product. |
prices([ProductOfferingPrice!]!) | Prices (one or many) applicable to a product offering. |
selectedQuantity(Int) | Selected quantity for product. |
tags([ProductTag]) | The tags associated with this product. |
Example
{
"identifier": "abc123",
"name": "abc123",
"description": "abc123",
"characteristics": [CatalogCharacteristic],
"minimumQuantity": 1,
"maximumQuantity": 1,
"initialQuantity": 1,
"selectedQuantity": 1,
"prices": ProductOfferingPrice,
"tags": [ProductTag]
}CatalogProductType
Represents a product in the catalog.
Fields
| Name | Description |
|---|---|
code(String!) | Unique identifier of the component. |
customerDescription(String!) | Customer-facing description of the product. |
customerName(String!) | Customer-facing name of the product. |
identifier(ID!) | Unique identifier of the product. |
internalName(String!) | Internal name of the product. |
marketName(String!) | The market the product is associated with. |
sourceProductType(ProductType) | The type of product. |
tags([TagType]) | Tags associated with this product for classification. |
Example
{
"identifier": "abc123",
"internalName": "abc123",
"customerName": "abc123",
"customerDescription": "abc123",
"code": "abc123",
"marketName": "abc123",
"sourceProductType": "SUPPLY"
}Fields
| Name | Description |
|---|---|
description(String) | Customer facing description for term. |
name(String) | Customer facing name for term. |
termData(JSONString) | Data belonging to term type eg: {'length': 18, 'unitoftime': 'MONTH'}. |
termType(String) | Type of term eg: 'MINIMUMCONTRACTLENGTH'. |
Example
{
"name": "abc123",
"description": "abc123",
"termType": "abc123",
"termData": {"key": "value"}
}Fields
| Name | Description |
|---|---|
krakenOrderId(String!) | The ID of the order that was created to change the broadband speed. |
Example
{
"krakenOrderId": "abc123"
}CharacteristicType
A characteristic associated with a product.
Fields
| Name | Description |
|---|---|
code(String!) | The code of the characteristic. |
description(String!) | The description of the characteristic. |
name(String!) | The name of the characteristic. |
values([CharacteristicValueUnion]!) | The possible values for the characteristic (can be strings or integers). |
Example
{
"code": "abc123",
"name": "abc123",
"description": "abc123",
"values": StringCharacteristicValueType
}CharacteristicVariant
The characteristic and value associated to a specific offering variant.
Fields
| Name | Description |
|---|---|
name(String!) | Customer facing name for characteristic. |
value(String!) | Characteristic value within selected offering. |
Example
{
"name": "abc123",
"value": "abc123"
}Charge
A charge to the customer.
Fields
| Name | Description |
|---|---|
accountNumber(String) | Unique identifier of the account the transaction belongs to. |
amount(Int) | Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
balanceCarriedForward(Int) | The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
billingDocumentIdentifier(ID) | 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. |
consumption(Consumption) | 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). |
createdAt(DateTime) | The date time when the transaction is created. |
detail(ChargeDetail) | Supporting information about this charge (if any is available). |
hasStatement(Boolean) | Returns True if the transaction is linked with a statement. |
id(ID) | Unique identifier for the transaction. |
isAccountCharge(Boolean) | Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
isAccountPayment(Boolean) | Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
isCredit(Boolean) | Deprecated. Deprecated The 'isCredit' field is deprecated. |
isHeld(Boolean) | 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. |
isIssued(Boolean) | 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. |
isReversed(Boolean!) | |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | Date when the transaction was posted to the account. |
reasonCode(String) | Returns the reason. |
statementId(ID) | Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
title(String) | Human-readable title describing the transaction. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123",
"consumption": Consumption,
"detail": SupplyOrServiceCharge
}Fields
| Name | Description |
|---|---|
code(String) | The charge reason code. |
display(String) | The charge reason display text. |
group(String) | The group the charge reason belongs to (if applicable). |
isDeprecated(Boolean) | Whether the charge reason is deprecated. |
isHidden(Boolean) | Whether the charge reason is hidden. |
isTaxExempt(Boolean) | Whether the charge reason is sales tax exempt. |
Example
{
"code": "abc123",
"display": "abc123",
"isDeprecated": true,
"isTaxExempt": true,
"isHidden": true,
"group": "abc123"
}ChargesBreakdownConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ChargesBreakdownConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ChargesBreakdownConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ChargesBreakdownConnectionTypeEdge
A Relay edge containing a ChargesBreakdownConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ChargesBreakdownType) | The item at the end of the edge |
Example
{
"node": ChargesBreakdownType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
charge(Int) | Charge in minor currency. |
periodEnd(Date) | The end date of the period the charge is for (exclusive). |
periodStart(Date) | The start date of the period the charge is for (inclusive). |
Example
{
"periodStart": "2020-01-01",
"periodEnd": "2020-01-01",
"charge": 1
}CheckResultType
GraphQL type for check result.
Fields
| Name | Description |
|---|---|
context(String) | Additional context about the check. |
name(String) | Name of the check. |
status(CheckResultStatus) | Status of the check. |
Example
{
"name": "abc123",
"status": "PASSED",
"context": "abc123"
}ChooseTelcoProduct
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4625: Multiple quoted supply points found for the given quote code.
- KT-CT-4910: No product exists with the given input.
- KT-CT-4624: Unable to accept the given product code.
- KT-CT-4620: Badly formed hexadecimal UUID string.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
availableExtras([TelcoProductExtrasType]) | Available extras for the chosen product. |
availableInstallationAppointments([InstallationAppointmentType]) | Available installation appointments. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"availableExtras": [TelcoProductExtrasType],
"availableInstallationAppointments": [InstallationAppointmentType]
}ChooseTelcoProductExtras
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-4620: Badly formed hexadecimal UUID string.
- KT-CT-4913: No product extra families exist for the given input code.
- KT-CT-4912: No product extras exist for the given input.
- KT-CT-4914: Unable to complete installation request.
- KT-CT-4915: Quote information not found.
- KT-CT-4910: No product exists with the given input.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
orderDetails(QuotedTelcoProductOutputType) | The selected product and extras for the quote. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"orderDetails": QuotedTelcoProductOutputType
}ChooseTelcoProductExtrasForAccount
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-4912: No product extras exist for the given input.
- KT-CT-4913: No product extra families exist for the given input code.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
orderDetails(QuotedTelcoProductOutputType) | The selected product and extras for the quote. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"orderDetails": QuotedTelcoProductOutputType
}ChooseTelcoProductForAccount
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4625: Multiple quoted supply points found for the given quote code.
- KT-CT-4910: No product exists with the given input.
- KT-CT-4624: Unable to accept the given product code.
- KT-CT-4620: Badly formed hexadecimal UUID string.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
availableExtras([TelcoProductExtrasType]) | Available extras for the chosen product. |
availableInstallationAppointments([InstallationAppointmentType]) | Available installation appointments. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"availableExtras": [TelcoProductExtrasType],
"availableInstallationAppointments": [InstallationAppointmentType]
}CloseActionType
Closes the screen.
Fields
| Name | Description |
|---|---|
accessibilityHidden(Boolean) | Whether the element is hidden from view. |
accessibilityLabel(String) | Accessible description of the element. |
id(ID) | Unique identifier of the object. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"accessibilityHidden": true,
"accessibilityLabel": "abc123"
}CloseDCAProceeding
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-11602: Could not find DCA with that name.
- KT-CT-11603: Could not stop debt collection proceeding.
- KT-CT-11604: Active debt collection proceeding does not exist for account.
- KT-CT-11605: Multiple active Proceeding's found for same agency and campaign on account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
dcaProceedingClosureStatus(DCAProceedingClosureStatus) | Whether the closure could be applied. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}CloseInkConversation
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 |
|---|---|
conversation(InkConversation) | The conversation that was closed. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"conversation": InkConversation
}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-7652: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
liveChatConversation(InkLiveChatConversation) | The live chat conversation. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
printBatch(PrintBatchType) |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
payment(CollectDepositOutput) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
paymentDate(Date) | |
status(CollectDepositStatusChoices) |
Example
{
"status": "APPROVED",
"paymentDate": "2020-01-01"
}CollectPayment
The possible errors that can be raised are:
- KT-CT-3932: Invalid data.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
payment(AccountPaymentType) | 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. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}CollectUpFrontPayment
The possible errors that can be raised are:
- KT-CT-3921: Account not found.
- KT-CT-3943: Invalid ledger.
- KT-CT-10903: Invalid Amount.
- KT-CT-3922: Ledger not found for the account.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
payment(UpfrontPaymentDetails) | Details of any upfront payment required. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": UpfrontPaymentDetails
}Fields
| Name | Description |
|---|---|
description(String) | The description of the collection. |
fields([FunnelField]) | The fields of the collection. |
name(String) | The name of the collection. |
order(Int) | The order of the collection. |
Example
{
"name": "abc123",
"description": "abc123",
"order": 1
}CollectionProcessDetailsType
Collection process details type
Fields
| Name | Description |
|---|---|
associatedItems([CollectionProcessRecordAssociatedItemType]) | Items associated to the collection process. |
collectionProcessRecordNumber(String) | The collection process record number. |
collectionProcessType(CollectionProcessTypes) | The type of the collection process (ACCOUNT, LEDGER, or BILLING_DOCUMENT). |
completionType(String) | What kind of completion happened. |
isActive(Boolean) | The active status of the collection process. |
isComplete(Boolean) | The completion status of the collection process. |
isPaused(Boolean) | The pause status of the collection process. |
pausedDays(Int) | Total number of days collection process were on pause. |
targetObjectIdentifier(String) | The identifier of the target object (account number, ledger number, or billing document ID) based on the collection process type. |
Example
{
"collectionProcessRecordNumber": "abc123",
"isPaused": true,
"isComplete": true,
"isActive": true,
"completionType": "abc123",
"pausedDays": 1,
"collectionProcessType": "ACCOUNT",
"targetObjectIdentifier": "abc123"
}CollectionProcessEventOutputType
Output for creating a collection process event.
Fields
| Name | Description |
|---|---|
number(String) | The number of the collection process record this event belongs to. |
Example
{
"number": "abc123"
}CollectionProcessPauseStatusRecord
Collection process pause record
Fields
| Name | Description |
|---|---|
name(String) | Collection process pause name. |
pausedAt(DateTime) | Start of pause period. |
reason(String) | Reason for pausing. |
resumedAt(DateTime) | End of pause period. |
resumedReason(String) | Reason for ending pause period. |
Example
{
"name": "abc123",
"reason": "abc123",
"pausedAt": "2020-01-01T00:00:00.000Z",
"resumedAt": "2020-01-01T00:00:00.000Z",
"resumedReason": "abc123"
}CollectionProcessRecordAssociatedItemType
Item associated to collection process
Fields
| Name | Description |
|---|---|
extraDetails(JSONString) | Additional details of the item. |
itemReference(String!) | Unique reference of item. |
itemType(String!) | Type of item. |
occurredAt(DateTime!) | Datetime of when action that resulted in item happened. |
Example
{
"itemType": "abc123",
"itemReference": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"extraDetails": {"key": "value"}
}Fields
| Name | Description |
|---|---|
attachments(BillingAttachmentConnectionTypeConnection) | |
billType(BillTypeEnum) | The type of the bill. |
constituents(ConstituentConnection) | Constituents of the bill. |
fromDate(Date) | The date of the bill is covered from. |
id(ID) | The ID of the bill. |
issuedDate(Date) | The date the bill was sent to the customer. |
reversalsAfterClose(StatementReversalsAfterClose!) | How many charges have been reversed after the close date. |
temporaryUrl(String) | 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. |
toDate(Date) | The date of the bill is covered to. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"constituents": ConstituentConnection
}Fields
| Name | Description |
|---|---|
fieldSpecificRateLimits(FieldSpecificRateLimitInformationConnectionTypeConnection!) | Information about the current state of the rate limiting for rate limited fields at the time of the request. |
pointsAllowanceRateLimit(PointsAllowanceRateLimitInformation) | 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 |
|---|---|
dcaProceedingCommencementStatus(DCAProceedingCommencementStatus) | Whether the commencement could be applied. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}CommitmentEndDateType
Represents a commitment end date term in a contract.
Fields
| Name | Description |
|---|---|
commitmentEndDate(Date) | The commitment end date for this contract term. |
description(NonEmptyString) | The description of the term. |
displayName(NonEmptyString) | The display name of the term. |
identifier(NonEmptyString) | The identifier of the term. |
isVariable(Boolean) | Whether the term is variable. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true,
"commitmentEndDate": "2020-01-01"
}Fields
| Name | Description |
|---|---|
account(TelcoAccountType!) | The account associated with the agreement. |
agreedAt(DateTime) | |
agreedFrom(DateTime) | The datetime the agreement was entered. |
agreedTo(DateTime) | The datetime the agreement was terminated. |
characteristicValues([CharacteristicValueInterface]) | The characteristic values associated with the agreement. Arguments
The datetime to check the characteristic value at. |
id(ID!) | |
isActive(Boolean) | Whether the agreement is currently active. |
isRevoked(Boolean) | Whether the agreement is revoked. |
params(JSONString) | General parameters providing additional information about the agreement. |
product(SupplyProductType) | The product associated with the agreement. |
rescissionDeadlineAt(DateTime) | The deadline until which the customer is allowed to rescind this agreement. If it is null, rescission is not permitted. |
supplyPoint(SupplyPointType!) | The agreement's supply point. |
terminatedAt(DateTime) | |
validFrom(DateTime!) | |
validTo(DateTime) |
Example
{
"id": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"agreedAt": "2020-01-01T00:00:00.000Z",
"terminatedAt": "2020-01-01T00:00:00.000Z",
"rescissionDeadlineAt": "2020-01-01T00:00:00.000Z",
"account": TelcoAccountType,
"supplyPoint": SupplyPointType,
"product": SupplyProductType,
"isActive": true,
"characteristicValues": CharacteristicValueInterface,
"agreedFrom": "2020-01-01T00:00:00.000Z",
"agreedTo": "2020-01-01T00:00:00.000Z",
"isRevoked": true,
"params": {"key": "value"}
}ComplaintConnectionTypeConnection
Paginator of Complaint type.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ComplaintConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ComplaintConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ComplaintConnectionTypeEdge
A Relay edge containing a ComplaintConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ComplaintType) | The item at the end of the edge |
Example
{
"node": ComplaintType,
"cursor": "abc123"
}ComplaintContactConnectionTypeConnection
Paginator of Complaint contact type.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ComplaintContactConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ComplaintContactConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ComplaintContactConnectionTypeEdge
A Relay edge containing a ComplaintContactConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ComplaintContactType) | The item at the end of the edge |
Example
{
"node": ComplaintContactType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
actionTaken(String!) | Description of action taken. |
createdAt(DateTime!) | Created at for contact. |
email(String) | Complaint email. |
landline(String) | Complaint landline. |
mobile(String) | Complaint phone. |
name(String!) | Complainant name. |
preferredCommunicationMethod(String) | Complaint preferred method. |
status(String!) | Status of complaint. |
summary(String) | Complaint summary. |
Example
{
"name": "abc123",
"actionTaken": "abc123",
"status": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"mobile": "abc123",
"email": "abc123",
"landline": "abc123",
"preferredCommunicationMethod": "abc123",
"summary": "abc123"
}Fields
| Name | Description |
|---|---|
assigneeId(ID) | Complaint Assignee. |
contacts(ComplaintContactConnectionTypeConnection) | Complaint contacts. |
creationDate(Date) | Complaint creation date. |
id(ID!) | |
resolutionDate(Date) | Complaint resolution date. |
subtype(String) | Complaint subtype. |
type(String) | Complaint type. |
Example
{
"id": "abc123",
"contacts": ComplaintContactConnectionTypeConnection,
"type": "abc123",
"subtype": "abc123",
"creationDate": "2020-01-01",
"resolutionDate": "2020-01-01",
"assigneeId": "abc123"
}CompleteReturnsBagReorder
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-10969: Equipment returns bag reorder not found.
- KT-CT-10970: Equipment returns bag reorder has not been submitted.
- KT-CT-10971: Unable to complete returns bag reorder.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
status(String) | The result of the operation. |
Example
{
"possibleErrors": [PossibleErrorType],
"status": "abc123"
}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 |
|---|---|
payment(CompleteStandalonePaymentOutput) | The completed standalone payment. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
status(PaymentIntentCompletionStatus!) | The status of the standalone payment. |
Example
{
"status": "CLEARED"
}CompleteTelcoSignUp
The possible errors that can be raised are:
- KT-CT-4345: Unable to get KF user for given account.
- KT-CT-4619: Quote with given code not found.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-3943: Invalid ledger.
- KT-CT-4618: Unable to accept given quote.
- KT-CT-4641: Unable to find an account from a given QuoteRequest.
- KT-CT-4644: Multiple financial users found for account.
- KT-CT-4917: Invalid requested activation date provided.
- KT-CT-10001: Party is already under contract.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
accountNumber(String) | The new account's account number. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountNumber": "abc123"
}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 |
|---|---|
accessibilityHidden(Boolean) | Whether the element is hidden from view. |
accessibilityLabel(String) | Accessible description of the element. |
id(ID) | Unique identifier of the object. |
items([ItemType]!) | The list of components. Deprecated The 'items' field is deprecated. |
name(String!) | The name of the screen. |
refreshFrequency(Int) | The refresh / polling frequency in milliseconds. |
screenData(String) | Serialized JSON representation of the screen. |
typename(String) | The name of the object's type. |
Example
{
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123",
"name": "abc123",
"refreshFrequency": 1,
"screenData": "abc123",
"items": TextType
}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 |
|---|---|
consent(ConsentType) | The consent that was created or updated. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}ConnectAiAgentToCall
The possible errors that can be raised are:
- KT-CT-11802: Call not found.
- KT-CT-11815: Unable to connect a call to an AI agent.
- KT-CT-11817: Invalid call ID.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
call(InboundCallType) | The call the AI agent was connected to. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
code(String) | The code of the consent type. |
value(String) | The value to update the consent to. |
Example
{
"code": "abc123",
"value": "abc123"
}ConsentType
A consent given by a signing identity for a consent type.
Fields
| Name | Description |
|---|---|
code(String!) | Unique code given to this consent type. |
id(BigInt!) | id of the consent. |
type(ConsentTypeType) | The type of the consent. |
value(ConsentValue!) | Value of the consent. |
Example
{
"id": 1,
"code": "abc123",
"value": "ACCEPTED",
"type": ConsentTypeType
}ConsentTypeType
A type of consent that a signing identity can accept or reject to.
Fields
| Name | Description |
|---|---|
code(String!) | Unique code given to this consent type. |
defaultValue(ConsentValue!) | Default value of the consent type. |
description(String!) | Description of the consent type. |
name(String!) | Name of the consent type. |
Example
{
"code": "abc123",
"description": "abc123",
"name": "abc123",
"defaultValue": "ACCEPTED"
}ConstituentConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ConstituentEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ConstituentEdge,
"totalCount": 1,
"edgeCount": 1
}ConstituentEdge
A Relay edge containing a Constituent and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ConstituentInterface) | The item at the end of the edge |
Example
{
"node": ConstituentInterface,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
endDate(Date) | End date of the consumption period. |
quantity(Decimal) | Amount of energy or resource consumed. |
startDate(Date) | Start date of the consumption period. |
supplyCharge(Int) | Supply charge amount in minor currency units. |
unit(ConsumptionUnit) | |
usageCost(Int) | Cost for the consumption usage in minor currency units. |
Example
{
"startDate": "2020-01-01",
"endDate": "2020-01-01",
"quantity": "1.0",
"unit": "kWh",
"usageCost": 1,
"supplyCharge": 1
}ConsumptionBreakdownConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ConsumptionBreakdownConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ConsumptionBreakdownConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ConsumptionBreakdownConnectionTypeEdge
A Relay edge containing a ConsumptionBreakdownConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ConsumptionBreakdownType) | The item at the end of the edge |
Example
{
"node": ConsumptionBreakdownType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
charges(ChargesBreakdownConnectionTypeConnection) | Charges grouped per displayed period. |
marketName(String) | Name of the market the charges are for. |
Example
{
"marketName": "abc123",
"charges": ChargesBreakdownConnectionTypeConnection
}Contract
A legally binding relationship agreed with a subject (e.g. an account).
Fields
| Name | Description |
|---|---|
cancelledAt(DateTime) | Date when the contract was cancelled, null if not cancelled. |
identifier(NonEmptyString) | Unique identifier for the contract. |
lifecycle(ContractVersion) | The current version information for this contract. |
notes([ContractNoteType]) | Notes associated with this contract. |
party(ContractParty) | The party (Account or Business) that entered into this contract. |
signedAt(DateTime) | Date when the contract was signed. |
status(ContractStatus) | The status of the contract. |
subject([TelcoAccountType]) | The accounts impacted by this contract. |
terms([TermInterface]) | The terms of the contract. |
title(String) | Title of the contract. |
validFrom(DateTime) | Date from which the contract is valid. |
validTo(DateTime) | Date until which the contract is valid, null if the contract is rolling. |
Example
{
"identifier": NonEmptyString,
"title": "abc123",
"party": TelcoAccountType,
"subject": [TelcoAccountType],
"status": "REVOKED",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"signedAt": "2020-01-01T00:00:00.000Z",
"cancelledAt": "2020-01-01T00:00:00.000Z",
"lifecycle": ContractVersion,
"terms": TermInterface
}ContractCreationContext
Represents a version of a contract with its effective date.
Fields
| Name | Description |
|---|---|
confirmedValidityPeriod(ValidityPeriod) | The confirmed validity period for the associated contract. |
requestedValidityPeriod(ValidityPeriod) | The requested validity period for the associated contract. |
Example
{
}ContractCreationJourneyType
Represents a Contract Creation Journey.
Fields
| Name | Description |
|---|---|
context(ContractCreationContext) | The context data for the contract creation journey. |
contractDetails(ContractDetails) | The details of the associated contract. |
journeyType(ContractJourneyType) | The type of the contract journey. |
notes([ContractNoteType]) | Notes associated with this contract journey. |
number(NonEmptyString!) | The number of the contract journey. |
orderReference(String) | The order reference associated with the contract journey. |
requestedAt(DateTime) | The date and time when the contract journey was requested. |
status(ContractJourneyStatus) | The status of the contract journey. |
Example
{
"number": NonEmptyString,
"status": "IN_PROGRESS",
"contractDetails": ContractDetails,
"journeyType": "CONTRACT_CREATION",
"requestedAt": "2020-01-01T00:00:00.000Z",
"orderReference": "abc123"
}ContractDetails
Details of a contract excluding terms.
Fields
| Name | Description |
|---|---|
cancelledAt(DateTime) | Date when the contract was cancelled, null if not cancelled. |
identifier(NonEmptyString) | Unique identifier for the contract. |
lifecycle(ContractVersion) | The current version information for this contract. |
notes([ContractNoteType]) | Notes associated with this contract. |
party(ContractParty) | The party (Account or Business) that entered into this contract. |
signedAt(DateTime) | Date when the contract was signed. |
status(ContractStatus) | The status of the contract. |
subject([TelcoAccountType]) | The accounts impacted by this contract. |
title(String) | Title of the contract. |
validFrom(DateTime) | Date from which the contract is valid. |
validTo(DateTime) | Date until which the contract is valid, null if the contract is rolling. |
Example
{
"identifier": NonEmptyString,
"title": "abc123",
"party": TelcoAccountType,
"subject": [TelcoAccountType],
"status": "REVOKED",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"signedAt": "2020-01-01T00:00:00.000Z",
"cancelledAt": "2020-01-01T00:00:00.000Z",
"lifecycle": ContractVersion
}ContractInfoType
Represents the package that a contract has agreed to. This consists of a product catalog offering identifier, and references to the contract information and contract summary documents created and shared with the contract party.
Fields
| Name | Description |
|---|---|
contractInfoPdfUrl(String) | A link to download the contract info about this contract. |
contractSummaryPdfUrl(String) | A link to download the contract summary about this contract. |
description(NonEmptyString) | The description of the term. |
displayName(NonEmptyString) | The display name of the term. |
identifier(NonEmptyString) | The identifier of the term. |
isVariable(Boolean) | Whether the term is variable. |
offering(CatalogOffering) | The offering subscribed to in this contract. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true,
"offering": CatalogOffering,
"contractInfoPdfUrl": "abc123",
"contractSummaryPdfUrl": "abc123"
}Fields
| Name | Description |
|---|---|
href(String) | Contract information PDF. |
Example
{
"href": "abc123"
}ContractNoteReasonType
A reason that can be associated with a contract note.
Fields
| Name | Description |
|---|---|
activityTypes([ContractActivityTypeOptions]) | The contract activity types this reason applies to. |
description(String) | Human-readable description of this reason. |
slug(String) | Unique slug identifier for this reason. |
Example
{
"slug": "abc123",
"description": "abc123",
"activityTypes": "ALL_ACTIVITY_TYPES"
}ContractNoteType
A note associated with a contract or contract journey.
Fields
| Name | Description |
|---|---|
activityType(ContractActivityTypeOptions) | The contract activity type this note is associated with. |
createdAt(DateTime) | When the note was created. |
note(String) | The content of the note. |
reason(ContractNoteReasonType) | The reason associated with this note. |
Example
{
"note": "abc123",
"activityType": "ALL_ACTIVITY_TYPES",
"createdAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
href(String) | Contract PDF Summary. |
Example
{
"href": "abc123"
}ContractTerminationInstigated
Contract termination was successfully instigated.
Fields
| Name | Description |
|---|---|
message(String!) | The message to display to the user on termination instigation. |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
allOrders([BroadbandOrderType]) | A list of the all orders associated with this Contract. |
isActive(Boolean) | Whether the contract is currently active. |
meshAddon(MeshAddonType) | The mesh addon, if applicable. |
outOfContractPrice(OutOfContractPriceType) | The out of contract price. The possible errors that can be raised are:
|
pendingAppointment(BroadbandInstallationAppointmentType) | The most recent pending appointment associated with this Contract. |
pendingOrders([BroadbandOrderType]) | A list of the pending orders associated with this Contract. |
products([BroadbandProductType]) | A list of the products within this Contract. |
signedAt(DateTime) | When the contract was signed. |
termLengthMonths(Int) | The term length of the contract. |
validFrom(DateTime) | When the contract is valid from. |
validTo(DateTime) | When the contract is valid until. |
Example
{
"termLengthMonths": 1,
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"isActive": true,
"signedAt": "2020-01-01T00:00:00.000Z",
"products": [BroadbandProductType],
"meshAddon": MeshAddonType,
"pendingOrders": [BroadbandOrderType],
"pendingAppointment": BroadbandInstallationAppointmentType,
"outOfContractPrice": OutOfContractPriceType,
"allOrders": [BroadbandOrderType]
}ContractVersion
Represents a version of a contract with its effective date.
Fields
| Name | Description |
|---|---|
effectiveFrom(DateTime) | The date from which this version of the contract becomes effective. |
versionReference(Int) | The reference number for this contract version. |
Example
{
"versionReference": 1,
"effectiveFrom": "2020-01-01T00:00:00.000Z"
}ContributionAgreementType
A single Contribution Agreement.
Fields
| Name | Description |
|---|---|
activeFrom(DateTime) | The start datetime of the agreement. |
activeTo(DateTime) | The end datetime of the agreement, if any. |
amount(Int) | The amount contributed per interval. Note, this is in the smallest domination that the currecy support. e.g. Pence, Cents, Yen, etc. |
contributionScheme(ContributionSchemeType) | The scheme to which the agreement contributes. |
id(ID!) | |
interval(Interval) | The frequency of contributions. |
periods(ContributionPeriodConnection) | The periods over which contributions have been made. |
Example
{
"id": "abc123",
"contributionScheme": ContributionSchemeType,
"interval": "MONTHLY",
"activeFrom": "2020-01-01T00:00:00.000Z",
"activeTo": "2020-01-01T00:00:00.000Z",
"amount": 1,
"periods": ContributionPeriodConnection
}ContributionPeriodConnection
Pagination for contribution periods.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ContributionPeriodEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ContributionPeriodEdge,
"totalCount": 1,
"edgeCount": 1
}ContributionPeriodEdge
A Relay edge containing a ContributionPeriod and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ContributionPeriodType) | The item at the end of the edge |
Example
{
"node": ContributionPeriodType,
"cursor": "abc123"
}ContributionPeriodType
A single Contribution Period.
Fields
| Name | Description |
|---|---|
agreement(ContributionAgreementType!) | |
fulfilledAt(DateTime) | When the contribution was fulfilled |
id(ID!) | |
periodFrom(DateTime) | The datetime the marks the beginning of the period. |
periodTo(DateTime) | The datetime the marks the end of the period. |
Example
{
"id": "abc123",
"agreement": ContributionAgreementType,
"fulfilledAt": "2020-01-01T00:00:00.000Z",
"periodFrom": "2020-01-01T00:00:00.000Z",
"periodTo": "2020-01-01T00:00:00.000Z"
}ContributionSchemeType
A single Contribution Scheme.
Fields
| Name | Description |
|---|---|
acceptingContributions(Boolean!) | Is this scheme currently accepting contributions? |
code(String!) | |
displayName(String!) | |
id(ID!) | |
taxable(Boolean!) | Are contributions to this scheme taxable? |
Example
{
"id": "abc123",
"code": "abc123",
"displayName": "abc123",
"taxable": true,
"acceptingContributions": true
}Example
{
"latitude": 1.0,
"longitude": 1.0
}CoreSiteworksAppointmentType
An appointment linked to a request
Fields
| Name | Description |
|---|---|
appointmentDate(Date) | The date of the appointment in local time. |
createdAt(DateTime!) | |
externalReference(String!) | |
id(UUID!) | |
jobType(String) | The type of job for the appointment. |
status(OnSiteJobsAppointmentStatus) | The current status of the appointment. |
timeSlotEnd(Time) | The end time of the appointment slot in local time. |
timeSlotStart(Time) | The start time of the appointment slot in local time. |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"externalReference": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"status": "PENDING",
"appointmentDate": "2020-01-01",
"timeSlotStart": "00:00:00.000Z",
"timeSlotEnd": "00:00:00.000Z",
"jobType": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([CoreSiteworksRequestConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": CoreSiteworksRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}CoreSiteworksRequestConnectionTypeEdge
A Relay edge containing a CoreSiteworksRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CoreSiteworksRequestType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}CoreSiteworksRequestType
A Siteworks Request
Fields
| Name | Description |
|---|---|
appointments([CoreSiteworksAppointmentType]) | List of appointments linked to this request. |
createdAt(DateTime!) | |
id(UUID!) | |
lastStatusUpdateAt(DateTime!) | When the request status was last updated. |
marketSupplyPoints(SupplyPointConnectionTypeConnection) | List of supply points on request. |
reason(String!) | |
status(String!) |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"status": "abc123",
"reason": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"lastStatusUpdateAt": "2020-01-01T00:00:00.000Z",
"appointments": [CoreSiteworksAppointmentType],
"marketSupplyPoints": SupplyPointConnectionTypeConnection
}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 |
|---|---|
apiCall(APICallType) | The created APICall. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
apiException(APIExceptionType) | The created APIException. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
apiExceptionEvent(APIExceptionEventType) | The created APIExceptionEvent. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
apiException(APIExceptionType) | The created APIExceptionNote. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
accountCharge(AccountChargeType) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountCharge": AccountChargeType
}Fields
| Name | Description |
|---|---|
clientMutationId(String) | |
postRequest(UploadPostRequest) |
Example
{
"postRequest": UploadPostRequest,
"clientMutationId": "abc123"
}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(TelcoAccountType) | Account, which has the added note. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": TelcoAccountType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
schedule(PaymentScheduleType!) | 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 |
|---|---|
accountReference(AccountReferenceType) | |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
accountReminder(AccountReminder) | Account reminder. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
affiliateLink(AffiliateLinkType) | The created affiliate link. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
affiliateOrganisation(AffiliateOrganisationType) | The created affiliate organisation. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}CreateAffiliateSession
Create a session for an affiliate link.
Fields
| Name | Description |
|---|---|
affiliateSession(AffiliateSessionType) | The created affiliate session. |
Example
{
}CreateAgreement
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4719: No supply point found for identifier provided.
- KT-CT-4910: No product exists with the given input.
- KT-CT-1503: Agreement validto date must be later than validfrom date.
- KT-CT-1509: Unable to create agreement.
- KT-CT-1511: Cannot create overlapping agreement.
- KT-CT-1512: Account type does not support agreements.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
agreement(CommonAgreementType) | The created agreement. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"agreement": CommonAgreementType
}CreateAgreementRollover
The possible errors that can be raised are:
- KT-CT-1501: Agreement not found.
- KT-CT-4910: No product exists with the given input.
- KT-CT-4924: Unauthorized.
- KT-CT-13701: An active agreement rollover already exists for this agreement.
- KT-CT-13702: Expected send date cannot be in the past.
- KT-CT-13703: Rollover date cannot be in the past.
- KT-CT-13704: Unable to create agreement rollover.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
agreementRollover(AgreementRolloverType) | The new agreement rollover. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"agreementRollover": AgreementRolloverType
}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 |
|---|---|
audioRecording(AudioRecordingType) | The created audio recording. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
business(BusinessType) | The created business. |
possibleErrors([PossibleErrorType]) | 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-11817: Invalid call ID.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
call(CallInterface) | The call metadata was attached to. |
possibleErrors([PossibleErrorType]) | 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-4178: No account found with given account number.
- KT-CT-11501: Voice campaign not found.
- 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-11506: Invalid campaign ID.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
batchIdentifier(String) | The identifier for this batch of items to assist in tracking and logging. |
campaignItems([VoiceCampaignItemType]) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"batchIdentifier": "abc123"
}Fields
| Name | Description |
|---|---|
quotedOfferings([QuotedCatalogOffering]) | Quoted offerings for quote created. |
quotingCode(String) | The code of the quote created. |
Example
{
"quotingCode": "abc123",
"quotedOfferings": [QuotedCatalogOffering]
}Fields
| Name | Description |
|---|---|
promiseId(String) | Promise ID for incomplete async results. |
result(CreateChangeContractQuoteForOfferingsBaseOutput) | Sync or completed async results. |
Example
{
"promiseId": "abc123",
"result": CreateChangeContractQuoteForOfferingsBaseOutput
}CreateCollectionProcessEvent
Create a collection process event.
This mutation allows creating event records for collection processes to track significant events like reactivations and errors.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- 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 |
|---|---|
collectionProcessEvent(CollectionProcessEventOutputType) | The created collection process event. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
complaint(ComplaintType) | The complaint that has been created. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
identifier(NonEmptyString) | Unique identifier for the created contract. |
wasCreated(Boolean!) | Indicates whether a new contract was created (True) or an existing contract was matched (False). When False, the mutation is idempotent and returns the existing contract that matches the provided parameters. |
Example
{
"identifier": NonEmptyString,
"wasCreated": true
}CreateContractSummary
The possible errors that can be raised are:
- KT-CT-4122: Invalid email.
- KT-CT-4619: Quote with given code not found.
- KT-CT-4910: No product exists with the given input.
- KT-CT-4620: Badly formed hexadecimal UUID string.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
contractInformation(ContractInformationOutput) | The contract information created. |
contractSummary(ContractSummaryOutput) | The contract summary created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"contractSummary": ContractSummaryOutput,
"contractInformation": ContractInformationOutput
}CreateContractSummaryForAccount
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4910: No product exists with the given input.
- KT-CT-4620: Badly formed hexadecimal UUID string.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
contractInformation(ContractInformationOutput) | The contract information created. |
contractSummary(ContractSummaryOutput) | The contract summary created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"contractSummary": ContractSummaryOutput,
"contractInformation": ContractInformationOutput
}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 |
|---|---|
contributionAgreement(ContributionAgreementType) | The created contribution agreement. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
validFrom(DateTime) | Datetime when the credit transfer permission is valid. |
Example
{
"possibleErrors": [PossibleErrorType],
"validFrom": "2020-01-01T00:00:00.000Z"
}CreateCustomerFeedback
The possible errors that can be raised are:
- KT-CT-5516: Invalid data.
- KT-CT-1111: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
customerFeedback(CustomerFeedbackType) | The created customer feedback object. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
depositAgreement(CreateDepositAgreementOutput) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Example
{
"depositRequired": true,
"depositAmount": 1
}CreateExternalAccountEvent
Create an external account event.
The possible errors that can be raised are:
- KT-CT-7123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
event(ExternalAccountEvent) | The new event data. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
event(ExternalAccountUserEvent) | The new event data. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}CreateExternalMessage
Create an external message to record communications sent by external vendors.
This allows you to import messages, such as emails, sent using other tools into Kraken.
The possible errors that can be raised are:
- KT-CT-14201: Vendor is empty.
- KT-CT-14202: Vendor message ID is empty.
- KT-CT-14203: Account number is empty.
- KT-CT-14204: Message already exists.
- KT-CT-14205: Unable to create the external message.
- KT-CT-14206: An email body is missing.
- KT-CT-14207: To email is empty.
- KT-CT-14208: To email is not a valid email address.
- KT-CT-14209: From email is empty.
- KT-CT-14210: From email is an invalid format.
- KT-CT-14211: A reply to email address is empty.
- KT-CT-14212: A reply to email address is not a valid email address.
- KT-CT-14213: The external messaging API is not enabled.
- KT-CT-14214: An account number was provided, but no corresponding account could be found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
externalMessage(ExternalMessageType) | The external message that was created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}CreateFault
The possible errors that can be raised are:
- KT-CT-10901: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
fault(FaultType) | The fault that has been created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"fault": FaultType
}CreateFixedPaymentPlan
Mutation to create a payment plan
The possible errors that can be raised are:
- KT-CT-4623: Unauthorized.
- NOT_IMPLEMENTED: Not implemented.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
account(AccountInterface) | Account with a newly created payment plan. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}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 |
|---|---|
goodsPurchase(GoodsPurchase) | Goods purchase created. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
goodsQuote(GoodsQuote) | Goods quote created for the customer. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
goodsQuote(GoodsQuote) | Goods quote created for the customer. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
call(InboundCallType) | The call that was created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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-7653: Account numbers on the message and message type must match if both are supplied.
- KT-CT-7654: An account number was provided, but no corresponding account could be found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
message(InkMessage!) | The Ink message that was created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"message": InkEmail
}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-7622: Attachment bucket is invalid.
- KT-CT-7623: Attachment path is invalid.
- KT-CT-7621: Attachment not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
liveChatConversation(InkLiveChatConversation) | The live chat conversation. |
messageRelayId(String!) | The ID of the Ink Live Chat message that was created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"liveChatConversation": InkLiveChatConversation,
"messageRelayId": "abc123"
}CreateInternalCompany
The possible errors that can be raised are:
- KT-CT-14402: Duplicated internal company.
- KT-CT-14403: Invalid address.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
internalCompany(CreateInternalCompanyResultType) | The result of the create internal company operation. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}CreateInternalCompanyResultType
The result of the create internal company mutation.
Fields
| Name | Description |
|---|---|
id(ID!) | The ID of the internal company that was created. |
Example
{
"id": "abc123"
}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-8934: Lead contact details missing communications contact.
- KT-CT-8935: National ID bad input.
- KT-CT-4121: Invalid phone number.
- KT-CT-8913: Organisation is not valid to be assigned.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
leadNumber(String) | The unique number of the lead. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"leadNumber": "abc123"
}CreateMetadata
Create metadata on an object.
The possible errors that can be raised are:
- KT-CT-8412: Invalid data.
- KT-CT-8414: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
metadata(Metadata) | |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
deviceEmail(String) | Email address to send the MFA code by default. |
devicePhone(String) | Phone number to send the MFA code by default. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
totpSecret(String) | Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceEmail": "abc123",
"devicePhone": "abc123",
"totpSecret": "abc123"
}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 |
|---|---|
agreement(CommonAgreementType) | The new agreement created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"agreement": CommonAgreementType
}CreateOfferGroupForQuoting
Create a quoting offer group.
The possible errors that can be raised are:
- KT-CT-12401: Unable to create offer group.
- KT-CT-12405: Missing rates for quoting.
- KT-CT-12406: Product not configured correctly for quoting.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
offerGroup(CreateOfferGroupType) | Quoting Offer Group. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"offerGroup": CreateOfferGroupType
}Fields
| Name | Description |
|---|---|
identifier(ID) | Identifier of the Offer Group. |
offers([OfferType]) | One or more Offers contained in the Offer Group. |
Example
{
"identifier": "abc123",
"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-13056: Appointment cannot be rescheduled.
- KT-CT-13044: Failed to update appointment slot.
- KT-CT-13001: Appointment does not exist.
- KT-CT-13063: Failed to derive property for the given supply points.
- KT-CT-13006: No properties found for the given supply points.
- KT-CT-13064: Provided supply point(s) not supported by the On-Site Jobs market manager.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The created On-Site Jobs appointment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}CreateOnSiteJobsAppointmentWithDate
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-13057: Date booking mode is not applicable for this request.
- KT-CT-13023: Appointment booking checks failed.
- KT-CT-13024: Appointment booking checks returned warnings.
- 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-13036: Booking service currently unavailable.
- KT-CT-13037: Appointment reference not provided by booking service.
- KT-CT-13027: Booking system error occurred.
- KT-CT-13063: Failed to derive property for the given supply points.
- KT-CT-13064: Provided supply point(s) not supported by the On-Site Jobs market manager.
- KT-CT-13006: No properties found for the given supply points.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The created On-Site Jobs appointment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 cancellationcategory/cancellationsub_category.
- KT-CT-13039: Cancellation fields require CANCELLED status.
- KT-CT-13027: Booking system error occurred.
- KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_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-13062: Datetime field must be timezone-aware.
- KT-CT-13044: Failed to update appointment slot.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The created Appointment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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-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-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 supplypointidentifiertomarketnamemapping and supplypointinternal_ids.
- KT-CT-13049: Neither supplypointidentifiertomarketnamemapping nor supplypointinternal_ids provided.
- KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_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-13058: Reason approval details are required when the reason requires approval.
- KT-CT-13059: Emergency approval details are required when the emergency requires approval.
- KT-CT-13060: Reason approval details should not be provided when the reason does not require approval.
- KT-CT-13061: Emergency approval details should not be provided when the emergency does not require approval.
- KT-CT-13063: Failed to derive property for the given supply points.
- KT-CT-13064: Provided supply point(s) not supported by the On-Site Jobs market manager.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
onSiteJobsRequest(OnSiteJobsRequestType) | The created request. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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-8935: National ID bad input.
- KT-CT-4121: Invalid phone number.
- KT-CT-8931: Extra detail value is invalid.
- KT-CT-9017: Consent type not found.
- KT-CT-8913: Organisation is not valid to be assigned.
- KT-CT-8936: Only one address is required to create an opportunity.
- KT-CT-8937: One or more Supply Points cannot be validated.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
dateOfCreation(DateTime) | The date the opportunity was created. |
funnelCode(String) | The code of the funnel. |
opportunityNumber(String) | The unique number of the opportunity. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
stage(String) | The stage of the opportunity. |
Example
{
"possibleErrors": [PossibleErrorType],
"opportunityNumber": "abc123",
"dateOfCreation": "2020-01-01T00:00:00.000Z",
"stage": "abc123",
"funnelCode": "abc123"
}Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
result(String) | Whether the operation was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"result": "abc123"
}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-8936: Only one address is required to create an opportunity.
- KT-CT-8931: Extra detail value is invalid.
- KT-CT-8937: One or more Supply Points cannot be validated.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
dateOfCreation(DateTime) | The date the opportunity was created. |
opportunityNumber(String) | The unique number of the opportunity. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"opportunityNumber": "abc123",
"dateOfCreation": "2020-01-01T00:00:00.000Z"
}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 |
|---|---|
loyaltyCard(LoyaltyCardType) | Created or updated loyalty card. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}CreateOrUpdateTimeSeriesEntries
Summary information on the time series and associated variants once the creation and update operations have been completed.
Fields
| Name | Description |
|---|---|
code(String!) | The time series code. |
description(String) | The time series description. |
meta(JSONString) | The time series meta information. |
name(String!) | The time series display name. |
periodSize(String!) | The time series period size value. |
productCode(String) | The product code associated to the time series. |
unit(String!) | The time series unit value. |
variants([VariantProfile!]!) | The existing time series variants based on the prices created. |
Example
{
"code": "abc123",
"productCode": "abc123",
"name": "abc123",
"description": "abc123",
"unit": "abc123",
"periodSize": "abc123",
"meta": {"key": "value"},
"variants": VariantProfile
}CreatePaymentActionIntent
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3980: Invalid ledger identifier.
- KT-CT-3981: Unauthorized.
- KT-CT-3982: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
token(ID!) | The action intent token. |
Example
{
"possibleErrors": [PossibleErrorType],
"token": "abc123"
}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 |
|---|---|
portfolio(PortfolioType) | The created portfolio. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
portfolioUserRole(PortfolioUserRoleType) | The created role for a user in association with a portfolio. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
createdEventsCount(Int) | Number of events successfully created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"createdEventsCount": 1
}CreateProductOutput
Output type for creating a product.
Fields
| Name | Description |
|---|---|
product(SupplyProductType) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
quoteRequest(MarketSupplyQuoteRequestType) | Returns a quote request. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
referredAccountRewardAmount(Int) | The reward amount to be issued to the referred account, in smallest currency subunits. |
Example
{
"possibleErrors": [PossibleErrorType],
"referredAccountRewardAmount": 1
}Fields
| Name | Description |
|---|---|
promiseId(String) | Promise id for polling async results. |
result(CreateRegradeQuoteRequestResultOutput) | Data returned for sync or completed async results. |
Example
{
"promiseId": "abc123",
"result": CreateRegradeQuoteRequestResultOutput
}Fields
| Name | Description |
|---|---|
code(String) | The code of the quote request created. |
currentProductExtras([TelcoProductExtrasType]!) | Product extras on the current agreement. |
telcoProducts([TelcoProducts]!) | The products available for the quote. |
Example
{
"code": "abc123",
"telcoProducts": TelcoProducts,
"currentProductExtras": TelcoProductExtrasType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
reminder(Reminder) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
scheduledTransactions([ScheduledTransactionType]) |
Example
{
"possibleErrors": [PossibleErrorType],
"scheduledTransactions": [ScheduledTransactionType]
}CreateShellAccountPayload
Create a shell account (a billable account with no property/energy supply).
Fields
| Name | Description |
|---|---|
account(AccountInterface) | |
billingAddressLine1(String) | |
billingAddressLine2(String) | |
billingAddressLine3(String) | |
billingAddressLine4(String) | |
billingAddressLine5(String) | |
billingName(String) | |
billingPeriodDay(Int) | Day to fixed bill on if billingperiodlength set. |
billingPeriodLength(String) | For fixed billing accounts only, the length of their billing period. Can be MONTHLY or QUARTERLY. |
billingPeriodMonth(Int) | Month to start billing from if billingperiodlength set to QUARTERLY or the multiplier is > 1. |
billingPeriodMultiplier(Int) | 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. |
billingPostcode(String) | |
billingRichAddress(String) | This must be a string-ified version of the JSON representation of RichAddressInput type. |
brand(String) | |
businessType(String) | |
clientMutationId(String) | |
companyName(String) | |
companyNumber(String) | |
dateOfBirth(Date) | |
email(String!) | |
errors([ErrorType]) | |
familyName(String!) | |
givenName(String!) | |
isBusinessAccount(Boolean) | |
landline(String) | |
mobile(String) | |
password(String) | |
passwordUpdateToken(String) | |
portfolioNumber(String) | |
urn(String) |
Example
{
"portfolioNumber": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"billingName": "abc123",
"email": "abc123",
"mobile": "abc123",
"landline": "abc123",
"brand": "abc123",
"dateOfBirth": "2020-01-01",
"billingAddressLine1": "abc123",
"billingAddressLine2": "abc123",
"billingAddressLine3": "abc123",
"billingAddressLine4": "abc123",
"billingAddressLine5": "abc123",
"billingPostcode": "abc123",
"billingRichAddress": "abc123",
"billingPeriodLength": "abc123",
"billingPeriodMultiplier": 1,
"billingPeriodDay": 1,
"billingPeriodMonth": 1,
"isBusinessAccount": true,
"companyName": "abc123",
"companyNumber": "abc123",
"businessType": "abc123",
"password": "abc123",
"passwordUpdateToken": "abc123",
"urn": "abc123",
"errors": [ErrorType],
"account": AccountInterface,
"clientMutationId": "abc123"
}CreateSwitchMatchRequest
The possible errors that can be raised are:
- KT-GB-10603: Empty postcode and address line provided.
- KT-GB-10604: Invalid UPRN, length exceeds 12 digits.
- KT-GB-10605: Invalid UPRN, uprn must only contain digits.
- KT-GB-10606: Invalid postcode, does not align with UK postcode rules.
- KT-GB-10607: Services cannot be empty. At least one service must be selected for switching.
- KT-GB-10608: Surname must be a valid string.
- KT-GB-10609: Invalid losing RCPID.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
matchRequestId(String) | Switch match request ID. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"matchRequestId": "abc123"
}CreateTelcoQuote
The possible errors that can be raised are:
- KT-CT-4410: Invalid postcode.
- KT-CT-4616: Unable to create a quote.
- KT-CT-4627: No products are available for this quote.
- KT-CT-10925: OSS did not return any quotes.
- KT-CT-10926: OSS currently unavailable.
- KT-CT-10927: Made invalid request to OSS.
- KT-CT-10928: OSS API failure.
- KT-CT-10940: More than one sales channel found for affiliate organisation.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
telcoQuote(CreateTelcoQuoteOutput) | The telco quote created. |
Example
{
"possibleErrors": [PossibleErrorType],
"telcoQuote": CreateTelcoQuoteOutput
}CreateTelcoQuoteForAccount
The possible errors that can be raised are:
- KT-CT-4410: Invalid postcode.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
telcoQuote(CreateTelcoQuoteOutput) | The telco quote created. |
Example
{
"possibleErrors": [PossibleErrorType],
"telcoQuote": CreateTelcoQuoteOutput
}Fields
| Name | Description |
|---|---|
quotedOfferings([QuotedCatalogOffering]) | Quoted offerings for quote created. |
quotingCode(String) | The code of the quote created. |
Example
{
"quotingCode": "abc123",
"quotedOfferings": [QuotedCatalogOffering]
}Fields
| Name | Description |
|---|---|
promiseId(String) | Promise ID for incomplete async results. |
result(CreateTelcoQuoteForOfferingsBaseOutput) | Sync or completed async results. |
Example
{
"promiseId": "abc123",
"result": CreateTelcoQuoteForOfferingsBaseOutput
}Fields
| Name | Description |
|---|---|
code(String) | The code of the quote created. |
telcoProducts([TelcoProducts]) | The products available for the quote. |
Example
{
"code": "abc123",
"telcoProducts": [TelcoProducts]
}Fields
| Name | Description |
|---|---|
code(String!) | The code of the quote created. |
currentProductExtras([TelcoProductExtrasType]!) | Product extras on the current agreement. |
newContractStartDate(Date!) | The start date of the future contract after renewal. |
telcoProducts([TelcoProducts]!) | The products available for the quote. |
Example
{
"code": "abc123",
"telcoProducts": TelcoProducts,
"currentProductExtras": TelcoProductExtrasType,
"newContractStartDate": "2020-01-01"
}Fields
| Name | Description |
|---|---|
promiseId(String) | Promise id for polling async results. |
result(CreateTelcoRenewalQuoteBaseOutput) | Data returned for sync or completed async results. |
Example
{
"promiseId": "abc123",
"result": CreateTelcoRenewalQuoteBaseOutput
}CreateTimeSeriesPrices
Time series information and existing variants based on the prices created.
Fields
| Name | Description |
|---|---|
code(String!) | The time series code. |
description(String) | The time series description. |
meta(JSONString) | The time series meta information. |
name(String!) | The time series display name. |
periodSize(String!) | The time series period size value. |
productCode(String) | The product code associated to the time series. |
unit(String!) | The time series unit value. |
variants([VariantProfile!]!) | The existing time series variants based on the prices created. |
Example
{
"code": "abc123",
"productCode": "abc123",
"name": "abc123",
"description": "abc123",
"unit": "abc123",
"periodSize": "abc123",
"meta": {"key": "value"},
"variants": VariantProfile
}Credit
A credit to the customer from the energy retailer.
Fields
| Name | Description |
|---|---|
accountNumber(String) | Unique identifier of the account the transaction belongs to. |
amount(Int) | Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
balanceCarriedForward(Int) | The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
billingDocumentIdentifier(ID) | 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. |
createdAt(DateTime) | The date time when the transaction is created. |
hasStatement(Boolean) | Returns True if the transaction is linked with a statement. |
id(ID) | Unique identifier for the transaction. |
isAccountCharge(Boolean) | Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
isAccountPayment(Boolean) | Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
isCredit(Boolean) | Deprecated. Deprecated The 'isCredit' field is deprecated. |
isHeld(Boolean) | 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. |
isIssued(Boolean) | 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. |
isReversed(Boolean!) | |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | Date when the transaction was posted to the account. |
reasonCode(String) | Returns the reason. |
statementId(ID) | Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
title(String) | Human-readable title describing the transaction. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123"
}Fields
| Name | Description |
|---|---|
code(String) | The credit reason code. |
display(String) | The credit reason display text. |
group(String) | The group the credit reason belongs to (if applicable). |
isDeprecated(Boolean) | Whether the credit reason is deprecated. |
isHidden(Boolean) | Whether the credit reason is hidden. |
isTaxExempt(Boolean) | Whether the credit reason is sales tax exempt. |
Example
{
"code": "abc123",
"display": "abc123",
"isDeprecated": true,
"isTaxExempt": true,
"isHidden": true,
"group": "abc123"
}Fields
| Name | Description |
|---|---|
accountNumber(String) | The number of the account linked to this permission. |
ledgerNumber(String) | The number of the ledger linked to this permission. |
validFrom(DateTime) | The datetime from which the permission is valid. |
validTo(DateTime) | The datetime to which the permission is valid. |
Example
{
"ledgerNumber": "abc123",
"accountNumber": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
accountNumber(String) | The number of the account linked to this permission. |
ledgerNumber(String) | The number of the ledger linked to this permission. |
validFrom(DateTime) | The datetime from which the permission is valid. |
validTo(DateTime) | The datetime to which the permission is valid. |
Example
{
"ledgerNumber": "abc123",
"accountNumber": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
fromSourceLedgers([CreditTransferPermissionFromSourceLedgerType]) | Permissions for credit transfers when the ledger is the target. |
toTargetLedgers([CreditTransferPermissionToTargetLedgerType]) | Permissions for credit transfers when the ledger is the source. |
Example
{
"fromSourceLedgers": [CreditTransferPermissionFromSourceLedgerType],
"toTargetLedgers": [CreditTransferPermissionToTargetLedgerType]
}Fields
| Name | Description |
|---|---|
isEligible(Boolean) | The current eligibility status for a deposit return. |
reasonsForIneligibility([String]) | The reasons why the account is currently ineligible for a deposit return. |
Example
{
"isEligible": true,
"reasonsForIneligibility": ["abc123"]
}CustomerAssetType
Customer asset type for GraphQL
Fields
| Name | Description |
|---|---|
accountNumber(String) | Account number. |
activeFrom(DateTime) | When the customer asset became active. |
activeTo(DateTime) | When device became inactive (null if active). |
id(ID) | Customer asset ID. |
name(String) | Asset name. |
physicalId(String) | Physical device ID (e.g., VIN for a vehicle). |
type(String) | Asset type. |
Example
{
"id": "abc123",
"physicalId": "abc123",
"name": "abc123",
"type": "abc123",
"activeFrom": "2020-01-01T00:00:00.000Z",
"activeTo": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123"
}CustomerContactType
Customer contact details for a fault appointment.
Fields
| Name | Description |
|---|---|
email(String) | Contact email address. |
firstName(String) | Contact first name. |
lastName(String) | Contact last name. |
name(String) | Contact full name. Deprecated: use firstName and lastName instead. Deprecated The 'name' field is deprecated. |
phone(String) | Contact phone number. |
Example
{
"name": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"phone": "abc123",
"email": "abc123"
}CustomerFeedbackFormConnectionTypeConnection
Paginator of Customer Feedback Form.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([CustomerFeedbackFormConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": CustomerFeedbackFormConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}CustomerFeedbackFormConnectionTypeEdge
A Relay edge containing a CustomerFeedbackFormConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CustomerFeedbackFormType) | The item at the end of the edge |
Example
{
"node": CustomerFeedbackFormType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
id(ID) | The unique identifier for the customer feedback form. |
name(String) | The name of the customer feedback form. |
Example
{
"id": "abc123",
"name": "abc123"
}Fields
| Name | Description |
|---|---|
id(ID!) | |
rawScore(Int) | The value attached to the source |
submittedAt(DateTime) | The datetime the feedback was submitted |
Example
{
"id": "abc123",
"rawScore": 1,
"submittedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
accountNumber(String!) | The account number. |
ledgerNumber(String) | The ledger identifier. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123"
}Fields
| Name | Description |
|---|---|
accountNumber(String!) | The account number. |
agency(String!) | The agency. |
campaign(String!) | The campaign. |
commencementStatus(Boolean!) | Whether the commencement could be applied. |
ledgerNumber(String) | The ledger identifier. |
Example
{
"commencementStatus": true,
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"agency": "abc123",
"campaign": "abc123"
}Fields
| Name | Description |
|---|---|
accountNumber(String!) | The account number. |
commencementStatus(Boolean!) | Whether the update has been applied. |
Example
{
"commencementStatus": true,
"accountNumber": "abc123"
}Dashboard
A list of components which comprise a dashboard screen.
Fields
| Name | Description |
|---|---|
dashboardItems([SectionType]!) | The list of sections for a dashboard. |
id(ID) | Unique identifier of the object. |
serialisedDashboardItems(String!) | The serialised dashboard items. |
typename(String) | The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"dashboardItems": SectionType,
"serialisedDashboardItems": "abc123"
}Example
{
"name": "abc123",
"code": "abc123",
"isActive": true
}Fields
| Name | Description |
|---|---|
code(String!) | |
deprecatedAt(DateTime) | |
displayName(String!) | |
requiresFieldVisit(Boolean!) |
Example
{
"code": "abc123",
"displayName": "abc123",
"deprecatedAt": "2020-01-01T00:00:00.000Z",
"requiresFieldVisit": true
}Fields
| Name | Description |
|---|---|
agency(DebtCollectionAgencyType) | The agency responsible for the collection proceedings. |
amount(Int) | |
campaign(CollectionCampaignType) | The campaign type of the collection proceedings. Deprecated The 'campaign' field is deprecated. |
collectionCampaign(DebtCollectionCampaignType) | The campaign type of the collection proceedings. |
startedAt(DateTime!) | |
stopReason(DebtCollectionProceedingStopReason) | |
stoppedAt(DateTime) |
Example
{
"campaign": "NONE",
"amount": 1,
"startedAt": "2020-01-01T00:00:00.000Z",
"stoppedAt": "2020-01-01T00:00:00.000Z",
"stopReason": "BANKRUPT"
}DecimalType
Graphene type object to represent float values
Fields
| Name | Description |
|---|---|
decimalValue(Decimal!) | 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 |
|---|---|
ledgerEntry(LoyaltyPointLedgerEntryType) | The ledger entry for the deducted loyalty points. |
pointsDeducted(Int) | The number of loyalty points that were deducted. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsDeducted": 1,
"ledgerEntry": LoyaltyPointLedgerEntryType
}DeeplinkActionType
An action which navigates to the URL of another backend screen.
Fields
| Name | Description |
|---|---|
id(ID) | Unique identifier of the object. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
url(String!) | The URL to navigate to. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"url": "abc123"
}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 |
|---|---|
accountReference(DeleteAccountReferenceType) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
namespace(String!) | The namespace associated with the removed AccountReference. |
Example
{
"namespace": "abc123"
}DeleteMfaDevice
Delete a multi-factor authentication (MFA) device for the authenticated user.
The possible errors that can be raised are:
- KT-CT-1150: MFA device not found.
- KT-CT-1154: Unable to delete MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
deviceDeleted(Boolean) | Flag to indicate if the MFA device has been successfully deleted. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceDeleted": true
}DeletePropertyDescendants
Delete all descendants of a property in a hierarchy.
This permanently deletes all descendant nodes (children, grandchildren, etc.) but keeps the property node itself in the hierarchy. This operation is idempotent - if the property is not in the hierarchy or has no descendants, it will succeed without error.
The possible errors that can be raised are:
- KT-CT-6622: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
property(PropertyType) | The property whose descendants were deleted. |
Example
{
"possibleErrors": [PossibleErrorType],
"property": PropertyType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
status(DeletePushNotificationBindingOutput) |
Example
{
"possibleErrors": [PossibleErrorType],
"status": "SUCCESSFUL"
}Fields
| Name | Description |
|---|---|
line1(String) | Line 1 of address. |
line2(String) | Line 2 of address. |
line3(String) | Line 3 of address. |
postalCode(String) | Address postal code. |
Example
{
"line1": "abc123",
"line2": "abc123",
"line3": "abc123",
"postalCode": "abc123"
}Fields
| Name | Description |
|---|---|
acceptedAt(DateTime) | The timestamp at which the customer accepted the deposit agreement. |
collectionDate(Date) | The date on which a payment is requested for deposit collection (defaults to current date, if not specified in the deposit policy). |
currentEligibilityStatus(CurrentEligibilityStatusOutput) | The current eligibility status for a deposit return. |
depositAmount(Int) | The deposit agreement amount. |
depositKey(String) | The deposit agreement key (unique). |
dueDate(Date) | 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). |
fulfilledAt(DateTime) | The timestamp at which the deposit agreement was fulfilled. |
returnStrategy(String) | The return strategy used to return the deposit. |
Example
{
"depositKey": "abc123",
"depositAmount": 1,
"acceptedAt": "2020-01-01T00:00:00.000Z",
"fulfilledAt": "2020-01-01T00:00:00.000Z",
"collectionDate": "2020-01-01",
"dueDate": "2020-01-01",
"returnStrategy": "abc123"
}Fields
| Name | Description |
|---|---|
amount(Int) | The amount to be returned in this installment. |
dueDate(Date) | The date by which the deposit return installment is due. |
status(String) | The status of this return installment. |
Example
{
"dueDate": "2020-01-01",
"amount": 1,
"status": "abc123"
}Fields
| Name | Description |
|---|---|
deviceIdentifier(String) | The id of the device. This field can only be provided in the output if device level readings are also requested. |
readings(Readings) | Get readings from a readable device e.g., a supply point, device, or register. Arguments
The exclusive end of the time period as an isoformatted string.
Get readings of only this type.
The inclusive start of the time period as an isoformatted string.
Time buckets to group readings into.
The timezone in which to return readings.
Optional filter to return readings only for specific list of units or unit (e.g., KILOWATTHOURS, METERSCUBED, LITER, etc.). |
registers(RegistersConnection) | The registers associated with this device. |
Example
{
"readings": Readings,
"deviceIdentifier": "abc123",
"registers": RegistersConnection
}Fields
| Name | Description |
|---|---|
readings(Readings) | Get readings from a readable device e.g., a supply point, device, or register. Arguments
The exclusive end of the time period as an isoformatted string.
Get readings of only this type.
The inclusive start of the time period as an isoformatted string.
Time buckets to group readings into.
The timezone in which to return readings.
Optional filter to return readings only for specific list of units or unit (e.g., KILOWATTHOURS, METERSCUBED, LITER, etc.). |
registerIdentifier(String) | The id of the register. This field can only be provided in the output if register level readings are also requested. |
Example
{
"readings": Readings,
"registerIdentifier": "abc123"
}DevicesConnection
Pagination for devices.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([DevicesEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": DevicesEdge,
"totalCount": 1,
"edgeCount": 1
}DevicesEdge
A Relay edge containing a Devices and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Device) | The item at the end of the edge |
Example
{
"node": Device,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([DirectDebitInstructionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": DirectDebitInstructionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}DirectDebitInstructionConnectionTypeEdge
A Relay edge containing a DirectDebitInstructionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(DirectDebitInstructionType) | The item at the end of the edge |
Example
{
"node": DirectDebitInstructionType,
"cursor": "abc123"
}DirectDebitInstructionType
Direct Debit Instructions
Fields
| Name | Description |
|---|---|
accountHolder(String!) | |
cardExpiryMonth(Int) | |
cardExpiryYear(Int) | |
cardPaymentNetwork(String) | |
iban(String!) | |
id(ID!) | |
instructionType(String!) | |
lastFourDigitsOfAccountNumber(String) | The last four digits of the account number. Deprecated The 'lastFourDigitsOfAccountNumber' field is deprecated. |
maskedAccountIdentifier(String) | A masked reference to a recurring payment method. |
maskedIban(String) | A masked version of the IBAN. |
owners([PaymentInstructionOwnerType]) | The owners of the financial account this instruction represents. |
sortCode(String!) | |
status(String!) |
Example
{
"id": "abc123",
"status": "abc123",
"sortCode": "abc123",
"iban": "abc123",
"accountHolder": "abc123",
"instructionType": "abc123",
"cardPaymentNetwork": "abc123",
"cardExpiryMonth": 1,
"cardExpiryYear": 1,
"lastFourDigitsOfAccountNumber": "abc123",
"maskedAccountIdentifier": "abc123",
"maskedIban": "abc123",
"owners": [PaymentInstructionOwnerType]
}DiscountGroupType
Represents a discount group term in a contract.
Fields
| Name | Description |
|---|---|
description(NonEmptyString) | The description of the term. |
displayName(NonEmptyString) | The display name of the term. |
identifier(NonEmptyString) | The identifier of the term. |
isVariable(Boolean) | Whether the term is variable. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}Fields
| Name | Description |
|---|---|
amount(Decimal) | The amount of the fee. |
Example
{
"amount": "1.0"
}Fields
| Name | Description |
|---|---|
deviceId(String) | The identifier of the device associated to this reading. |
marketSupplyPointId(String) | The identifier of the market supply point associated to this reading. |
readingDirection(ReadingDirectionType) | Reading direction is based on the utility generated or consumed by the customer. |
readingFrequencyType(ReadingFrequencyType) | The frequency of the reading. |
readingQuality(ReadingQualityType) | |
registerId(String) | The identifier of the register associated to this reading. |
Example
{
"readingDirection": "CONSUMPTION",
"registerId": "abc123",
"readingQuality": "ACTUAL",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123"
}EmailAttachmentType
Represents a file to attach to a email message.
Fields
| Name | Description |
|---|---|
filename(String!) | The filename of the attachment. |
id(ID!) | The ID of the attachment. |
temporaryUrl(String) | Temporary URL at which the attachment is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). |
Example
{
"id": "abc123",
"filename": "abc123",
"temporaryUrl": "abc123"
}Fields
| Name | Description |
|---|---|
eventType(String!) | |
id(ID!) | The ID of the object |
message(EmailType) | Email message of the email event. Returns null for message's sent/received by other user's on the account. |
occurredAt(DateTime!) |
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": EmailType
}EmailType
Represents an email communication
Fields
| Name | Description |
|---|---|
attachments([EmailAttachmentType]) | Attachments of the email message. |
channel(String!) | |
createdAt(DateTime!) | The date and time the email was created. |
fromEmail(String!) | The address the email was sent from. |
fromNumber(String!) | |
htmlBody(String) | HTML body of the email message. |
id(ID!) | The ID of the email. |
recipient(String) | Email recipient. |
sender(String) | Email sender. |
sentAt(DateTime) | The date and time the email was sent. |
subject(String) | Subject line of the email message. |
supportSiteUrl(String) | URL to view the email in the support site. |
templateCode(String!) | The email template code. |
textBody(String) | Text body of the email message. |
toAddress(String!) | The email address of the recipient. |
toNumber(String!) |
Example
{
"id": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"sentAt": "2020-01-01T00:00:00.000Z",
"templateCode": "abc123",
"toAddress": "abc123",
"fromEmail": "abc123",
"subject": "abc123",
"attachments": [EmailAttachmentType],
"textBody": "abc123",
"htmlBody": "abc123",
"supportSiteUrl": "abc123",
"toNumber": "abc123",
"fromNumber": "abc123",
"channel": "abc123",
"sender": "abc123",
"recipient": "abc123"
}Fields
| Name | Description |
|---|---|
email(String!) | The email address to be checked. |
status(VerificationRequestStatus) | The status of verification for associated email. |
Example
{
"email": "abc123",
"status": "NOT_SENT"
}Fields
| Name | Description |
|---|---|
deviceId(String) | The identifier of the device associated to this reading. |
marketSupplyPointId(String) | The identifier of the market supply point associated to this reading. |
readingDirection(ReadingDirectionType) | Reading direction is based on the utility generated or consumed by the customer. |
readingFrequencyType(ReadingFrequencyType) | The frequency of the reading. |
readingQuality(ReadingQualityType) | |
registerId(String) | The identifier of the register associated to this reading. |
Example
{
"readingDirection": "CONSUMPTION",
"registerId": "abc123",
"readingQuality": "ACTUAL",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123"
}EmbeddedNetworkType
Represents an embedded network that holds multiple embedded properties.
Fields
| Name | Description |
|---|---|
embeddedProperties([EmbeddedPropertyType]) | Get details about properties in an embedded network. |
id(ID!) | |
name(String!) | A unique name/code for the network |
Example
{
"id": "abc123",
"name": "abc123"
}EmbeddedPropertyType
Represents an embedded property in an embedded network.
Fields
| Name | Description |
|---|---|
embeddedNetwork(EmbeddedNetworkType!) | |
id(ID!) | |
propertyId(ID) | The id of the physical property related to this embedded property type. |
Example
{
"id": "abc123",
"embeddedNetwork": EmbeddedNetworkType,
"propertyId": "abc123"
}EndContributionAgreement
The possible errors that can be raised are:
- KT-CT-9603: Unable to find contribution agreement.
- KT-CT-4123: Unauthorized.
- KT-CT-9604: Unable to end contribution agreement.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
contributionAgreement(ContributionAgreementType) | The created contribution agreement. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"contributionAgreement": ContributionAgreementType
}EndOfContractPriceRiseGroupType
Represents an end of contract price rise group term in a contract.
Fields
| Name | Description |
|---|---|
description(NonEmptyString) | The description of the term. |
displayName(NonEmptyString) | The display name of the term. |
identifier(NonEmptyString) | The identifier of the term. |
isVariable(Boolean) | Whether the term is variable. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}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-11817: Invalid call ID.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
call(InboundCallType) | The call that was enqueued. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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(EnrollAccountInLoyaltyProgramOutcome) | Outcome of the loyalty points campaign enrollment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"outcome": EnrollAccountInLoyaltyProgramOutcome
}Fields
| Name | Description |
|---|---|
hasEnrolled(Boolean) | Whether or not this account has been enrolled in the loyalty points campaign. |
Example
{
"hasEnrolled": true
}EnrollmentCancelled
Enrollment was successfully cancelled.
Fields
| Name | Description |
|---|---|
enrollmentProcess(EnrollmentProcess!) | The Enrollment process that was cancelled. |
message(String!) | The message to display to the user on Enrollment initiation. |
Example
{
"message": "abc123",
"enrollmentProcess": JoinSupplierProcessType
}EnrollmentInitiated
Enrollment was successfully initiated.
Fields
| Name | Description |
|---|---|
enrollmentProcesses([EnrollmentProcess]!) | The Enrollment processes that were initiated. |
message(String!) | The message to display to the user on Enrollment initiation. |
Example
{
"enrollmentProcesses": JoinSupplierProcessType,
"message": "abc123"
}EnrollmentReversed
Enrollment was successfully reversed.
Fields
| Name | Description |
|---|---|
enrollmentProcess(EnrollmentProcess!) | The Enrollment process that was reversed. |
message(String!) | The message to display to the user on reversal. |
Example
{
"message": "abc123",
"enrollmentProcess": JoinSupplierProcessType
}EquipmentItemType
Equipment item details.
Fields
| Name | Description |
|---|---|
createdAt(DateTime!) | |
description(String!) | Public facing description of the equipment item. |
id(ID!) | |
ownedAt(DateTime!) | |
ownership(EquipmentItemOwnership) | |
serialNumber(String) | The serial number for this equipment item (not necessarily unique). |
sku(String!) | |
status(String!) | |
updatedAt(DateTime) |
Example
{
"id": "abc123",
"serialNumber": "abc123",
"sku": "abc123",
"description": "abc123",
"status": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"ownership": "CUSTOMER_OWNED",
"ownedAt": "2020-01-01T00:00:00.000Z"
}EquipmentOrderLineType
Equipment order line details.
Fields
| Name | Description |
|---|---|
createdAt(DateTime!) | |
description(String!) | Public facing description of what is being shipped. |
meta(JSONString) | |
order(EquipmentOrderType!) | |
quantity(Int!) | |
serialNumber(String!) | |
shipment(ShipmentType) | Shipment details. |
sku(String!) | Unique identifier for what is being shipped. |
uuid(UUID!) | Public identifier for the order line. |
Example
{
"uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"order": EquipmentOrderType,
"shipment": ShipmentType,
"sku": "abc123",
"description": "abc123",
"quantity": 1,
"serialNumber": "abc123",
"meta": {"key": "value"},
"createdAt": "2020-01-01T00:00:00.000Z"
}EquipmentOrderType
Equipment order details.
Fields
| Name | Description |
|---|---|
createdAt(DateTime!) | |
deliveryAddress(JSONString) | |
orderLines([EquipmentOrderLineType]) | Equipment order lines. |
supplyPoint(SupplyPointType) | |
updatedAt(DateTime) | |
uuid(UUID!) | Public identifier for the order. |
Example
{
"uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"supplyPoint": SupplyPointType,
"deliveryAddress": {"key": "value"},
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"orderLines": [EquipmentOrderLineType]
}Fields
| Name | Description |
|---|---|
field(String!) | |
messages([String!]!) |
Example
{
"field": "abc123",
"messages": "abc123"
}Fields
| Name | Description |
|---|---|
costCurrency(String!) | Monetary currency of the statistic in ISO-4217 format. |
estimatedAmount(Decimal!) | |
pricePerUnit(PricePerUnit) | Net price per unit of the statistic if applicable. |
Example
{
"estimatedAmount": "1.0",
"costCurrency": "abc123",
"pricePerUnit": PricePerUnit
}Fields
| Name | Description |
|---|---|
createdAt(DateTime) | The date when the event was created. |
eventType(String) | The type of the event. |
source(String) | The step associated with the event. |
supportUser(String) | The support user associated with the event. |
Example
{
"eventType": "abc123",
"source": "abc123",
"supportUser": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z"
}ExportReadingsConnection
Pagination for readings representing outgoing utility flow e.g., solar generation.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ExportReadingsEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ExportReadingsEdge,
"totalCount": 1,
"edgeCount": 1
}ExportReadingsEdge
A Relay edge containing a ExportReadings and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Reading) | The item at the end of the edge |
Example
{
"node": Reading,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
category(String!) | |
content(JSONString) | |
description(String) | |
eventType(String!) | |
id(ID!) | |
occurredAt(DateTime!) | |
subcategory(String!) |
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"category": "abc123",
"subcategory": "abc123",
"description": "abc123",
"content": {"key": "value"}
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ExternalAccountEventConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ExternalAccountEventConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ExternalAccountEventConnectionTypeEdge
A Relay edge containing a ExternalAccountEventConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ExternalAccountEvent) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
category(String!) | |
content(JSONString) | |
description(String) | |
eventType(String!) | |
id(ID!) | |
occurredAt(DateTime!) | |
subcategory(String!) |
Example
{
"id": "abc123",
"eventType": "abc123",
"category": "abc123",
"subcategory": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"description": "abc123",
"content": {"key": "value"}
}ExternalMessageType
An external message, which is a record of a communication such as an email, sent by an external messaging vendor.
Fields
| Name | Description |
|---|---|
id(ID!) | The ID in Kraken of the external message. |
sentAt(DateTime!) | The date and time this message was sent. |
vendor(String!) | The name of the external messaging vendor that sent this message. |
vendorMessageId(String!) | The unique ID of the message in the external vendor's system. |
Example
{
"id": "abc123",
"vendor": "abc123",
"vendorMessageId": "abc123",
"sentAt": "2020-01-01T00:00:00.000Z"
}ExternalProviderProductInfo
Represents a single provider and externalproductid pair.
Fields
| Name | Description |
|---|---|
externalProductId(String) | The external product ID for the product. |
provider(String) | The provider of the wholesale product offering. |
Example
{
"provider": "abc123",
"externalProductId": "abc123"
}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 |
|---|---|
salesRecordIdentifier(String) | The unique identifier for the sales record. |
Example
{
"salesRecordIdentifier": "abc123"
}Fields
| Name | Description |
|---|---|
field(FunnelField) | The extra detail metadata associated with the opportunity. |
key(String) | The key of the extra detail item. |
value(GenericScalar) | The value of the extra detail item. |
Example
{
"key": "abc123",
"value": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}Fields
| Name | Description |
|---|---|
description(String) | Description of the extra for the parent node. |
label(String) | Display label of the extra for the parent node. |
value(String) | Value of the extra. |
Example
{
"label": "abc123",
"description": "abc123",
"value": "abc123"
}FaultAppointment
A fault appointment for an engineer visit.
Fields
| Name | Description |
|---|---|
appointmentType(FaultAppointmentType!) | Type of fault appointment. |
cancelledAt(DateTime) | When the appointment was cancelled. |
confirmedAt(DateTime) | When the appointment was confirmed. |
createdAt(DateTime!) | When the record was created. |
customerContact(CustomerContactType) | Customer contact details. |
endsAt(DateTime!) | End time of the appointment. |
id(ID!) | Unique identifier for the appointment. |
notes(FaultAppointmentNotesType) | Notes associated with the appointment. |
provider(FaultAppointmentProvider!) | Provider responsible for the engineer visit. |
providerReference(String) | Reference ID from the external provider. |
requestedAt(DateTime) | When the appointment was requested. |
startsAt(DateTime!) | Start time of the appointment. |
status(AppointmentStatusNames!) | Current status of the appointment. |
updatedAt(DateTime!) | When the record was last updated. |
Example
{
"id": "abc123",
"appointmentType": "NETWORK",
"status": "PENDING",
"startsAt": "2020-01-01T00:00:00.000Z",
"endsAt": "2020-01-01T00:00:00.000Z",
"provider": "OPENREACH",
"providerReference": "abc123",
"customerContact": CustomerContactType,
"notes": FaultAppointmentNotesType,
"requestedAt": "2020-01-01T00:00:00.000Z",
"confirmedAt": "2020-01-01T00:00:00.000Z",
"cancelledAt": "2020-01-01T00:00:00.000Z",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}FaultAppointmentNotesType
Notes associated with a fault appointment.
Fields
| Name | Description |
|---|---|
accessNotes(String) | Notes for engineer access. |
faultDescription(String) | Description of the fault. |
Example
{
"faultDescription": "abc123",
"accessNotes": "abc123"
}FaultAppointmentSlotType
An available time slot for a fault appointment.
Fields
| Name | Description |
|---|---|
endsAt(DateTime!) | End time of the appointment slot. |
startsAt(DateTime!) | Start time of the appointment slot. |
Example
{
"startsAt": "2020-01-01T00:00:00.000Z",
"endsAt": "2020-01-01T00:00:00.000Z"
}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 |
|---|---|
fingerprint(String) | Fetched or generated fingerprint from vendor. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
vendor(String) | Vendor name. |
Example
{
"possibleErrors": [PossibleErrorType],
"fingerprint": "abc123",
"vendor": "abc123"
}FetchPreSignedLinkForOpportunityAttachment
The possible errors that can be raised are:
- KT-CT-8933: Opportunity file attachment not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
opportunityFileAttachment(OpportunityFileAttachment) | The opportunity file attachment with pre-signed URL. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}FieldSalesPropertyType
Property information for use by a field sales app (.e.g Sales Navigator)
Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | Property's current telco account. |
addressKey(String!) | A unique ID per address using part of the address with spaces removed. |
addressType(AddressTypeEnum) | The type of address (domestic, business or unknown). |
display(String!) | The complete and human-legible address in a single string. |
fieldSalesVisits([FieldSalesVisitType]) | Previous field sales visits and related affiliate links. |
line1(String!) | Line 1 of the address. This is generally the house number and street name. |
line2(String!) | Line 2 of the address. This is generally the area or village. |
line3(String!) | Line 3 of the address. This is generally the area or village. |
line4(String!) | Line 4 of the address. This is generally the city. |
line5(String!) | Line 5 of the address. This is generally the county. |
postcode(String!) | Address postal code. |
propertyIdentifier(String!) | The unique identifier of the property, often the UPRN. |
Example
{
"addressKey": "abc123",
"addressType": "DOMESTIC",
"display": "abc123",
"line1": "abc123",
"line2": "abc123",
"line3": "abc123",
"line4": "abc123",
"line5": "abc123",
"postcode": "abc123",
"propertyIdentifier": "abc123",
"account": TelcoAccountType
}FieldSalesVisitOutcomeType
The specific outcome of a field sales visit at an address.
Fields
| Name | Description |
|---|---|
category(AppSessionOutcomeCategory) | |
reason(String) | |
type(AppSessionOutcomeType!) |
Example
{
"type": "SALE",
"category": "SUCCESS",
"reason": "abc123"
}FieldSalesVisitType
A field sales visit at an address.
Fields
| Name | Description |
|---|---|
addressLine1(String!) | |
addressLine2(String!) | |
addressLine3(String!) | |
addressLine4(String!) | Post town |
addressLine5(String!) | County |
affiliateLink(AffiliateLinkType) | Affiliate Link. |
outcome(AppSessionOutcome) | |
outcomes([FieldSalesVisitOutcomeType]) | Field Sales Outcomes. |
startedAt(DateTime!) | |
stoppedAt(DateTime!) |
Example
{
"startedAt": "2020-01-01T00:00:00.000Z",
"stoppedAt": "2020-01-01T00:00:00.000Z",
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "abc123",
"addressLine4": "abc123",
"addressLine5": "abc123",
"outcome": "SWITCHED"
}Fields
| Name | Description |
|---|---|
field(String) | The name of the GraphQL field for which the rate is limited. |
isBlocked(Boolean) | Whether the viewer is currently blocked from making requests to this field due to exceeding the allowed request rate. |
rate(String) | Indicates the rate limit allowed for this field (e.g. 10/m). |
ttl(Int) | Time to live: The time remaining before the user is unblocked from making requests to this field. |
Example
{
"field": "abc123",
"rate": "abc123",
"ttl": 1,
"isBlocked": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([FieldSpecificRateLimitInformationConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": FieldSpecificRateLimitInformationConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}FieldSpecificRateLimitInformationConnectionTypeEdge
A Relay edge containing a FieldSpecificRateLimitInformationConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(FieldSpecificRateLimitInformation) | The item at the end of the edge |
Example
{
"node": FieldSpecificRateLimitInformation,
"cursor": "abc123"
}Example
{
"amount": 1,
"currency": "abc123"
}Fields
| Name | Description |
|---|---|
identifierType(String) | The ID type. Currently only 'meter_point' is supported. |
identifierValue(ID) | The ID to be checked. |
isInRiskList(Boolean) | Returns True if the risk identifier is in the risk list. |
riskLevel(Decimal) | Returns the level of risk for the supplied object between |
Example
{
"identifierValue": "abc123",
"identifierType": "abc123",
"riskLevel": "1.0",
"isInRiskList": true
}FloatType
Graphene type object to represent float values
Fields
| Name | Description |
|---|---|
floatValue(Float!) | Value of this field. |
Example
{
"floatValue": 1.0
}Fields
| Name | Description |
|---|---|
effectiveAt(DateTime!) | The time at which forced reauthentication is effective. Kraken and refresh tokens issued before this time will be invalid. |
tokensInvalidated(Boolean!) | Reports whether the mutation applied successfully. Should always be 'true'. |
Example
{
"tokensInvalidated": true,
"effectiveAt": "2020-01-01T00:00:00.000Z"
}FormScreenType
A screen type for forms with input fields.
Combines display items with input fields (TextField, Checkbox, Toggle), and provides primary/secondary buttons for form submission.
Note: header and footer are embedded in screenData and not exposed as separate GraphQL fields, following the pattern of ComponentListType.
Fields
| Name | Description |
|---|---|
accessibilityHidden(Boolean) | Whether the element is hidden from view. |
accessibilityLabel(String) | Accessible description of the element. |
id(ID) | Unique identifier of the object. |
name(String!) | The name of the screen. |
refreshFrequency(Int) | The refresh / polling frequency in milliseconds. |
screenData(String) | Serialized JSON representation of the screen. |
typename(String) | The name of the object's type. |
Example
{
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123",
"name": "abc123",
"refreshFrequency": 1,
"screenData": "abc123"
}Fields
| Name | Description |
|---|---|
content(JSONString) | |
errors([SerializerFieldErrorsType]) | |
id(Int) |
Example
{
"id": 1,
"content": {"key": "value"},
"errors": [SerializerFieldErrorsType]
}FractionSizeType
A fractional measurement.
Fields
| Name | Description |
|---|---|
fraction(Decimal!) | The fractional value. |
id(ID) | Unique identifier of the object. |
typename(String) | The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"fraction": "1.0"
}Fields
| Name | Description |
|---|---|
isInSuspiciousList(Boolean) | Returns True if the meter point ID is in the list of suspicious meter point IDs. |
meterPointId(String) | The meter point ID. |
Example
{
"meterPointId": "abc123",
"isInSuspiciousList": true
}FulfilmentType
Represents an amount of money that can be used to fulfil an obligation.
Fields
| Name | Description |
|---|---|
amount(Int!) | The amount of the fulfilment (in minor currency units), unsigned. |
sourceIdentifier(String) | The database ID of the fulfilment source, e.g. the database ID of the payment. |
sourceType(FulfilmentSourceType) | The type of the fulfilment source, e.g. PAYMENT. |
Example
{
"sourceType": "UNKNOWN",
"sourceIdentifier": "abc123",
"amount": 1
}FundingSourceAmountConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([FundingSourceAmountConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": FundingSourceAmountConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}FundingSourceAmountConnectionTypeEdge
A Relay edge containing a FundingSourceAmountConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(FundingSourceAmountType) | The item at the end of the edge |
Example
{
"node": FundingSourceAmountType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amount(Int) | Amount used from a funding source in minor currency. |
reason(String) | Reason why the funding source was used. |
Example
{
"reason": "abc123",
"amount": 1
}Fields
| Name | Description |
|---|---|
code(String!) | The code of the field. |
deprecated(Boolean!) | Whether the field is deprecated. |
fieldType(FieldTypeChoices!) | The type of the field. |
name(String!) | The name of the field. |
orderInCollection(Int) | The order of the field in the collection. |
textChoices([String]) | The choices for the field if applicable. |
Example
{
"code": "abc123",
"name": "abc123",
"fieldType": "STR",
"textChoices": ["abc123"],
"deprecated": true,
"orderInCollection": 1
}GasFiltersOutput
Filter measurements by gas parameters.
Fields
| Name | Description |
|---|---|
deviceId(String) | The identifier of the device associated to this reading. |
marketSupplyPointId(String) | The identifier of the market supply point associated to this reading. |
readingFrequencyType(ReadingFrequencyType) | The frequency of the reading. |
registerId(String) | The identifier of the register associated to this reading. |
Example
{
"registerId": "abc123",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123"
}GenerateAffiliatesAudioRecordingPreSignedUrl
Generate a pre-signed URL for uploading a audio file for use with affiliates.
Fields
| Name | Description |
|---|---|
affiliatesAudioRecordingPreSignedUrl(AffiliateAudioRecordingPresignedPostType) | Input fields required to generate a presigned S3 post for affiliates audio recording. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
fields(JSONString!) | Presigned post fields required to upload the file. |
key(String!) | The key for the item. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
uploadUrl(String!) | A presigned URL for the user to upload to the quarantine bucket. |
Example
{
"possibleErrors": [PossibleErrorType],
"uploadUrl": "abc123",
"key": "abc123",
"fields": {"key": "value"}
}GenerateLeadsFileAttachmentDownloadPreSignedUrl
Generate a pre-signed URL for downloading a leads attachment file.
The possible errors that can be raised are:
- KT-CT-8933: Opportunity file attachment not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
leadsFileAttachmentDownloadPreSignedUrl(LeadsFileAttachmentDownloadPresignedUrlType) | Pre-signed S3 URL for downloading the leads file attachment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}GenerateLeadsFileAttachmentsPreSignedUrl
Generate a pre-signed URL for uploading a leads attachment file.
Fields
| Name | Description |
|---|---|
leadsFileAttachmentPreSignedUrl(LeadsFileAttachmentPresignedPostType) | Input fields required to generate a presigned S3 post for leads file attachment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
scope(PreSignedTokenScope) | |
token(String) | |
tokenExpiryDatetime(DateTime) |
Example
{
"possibleErrors": [PossibleErrorType],
"token": "abc123",
"tokenExpiryDatetime": "2020-01-01T00:00:00.000Z",
"scope": "SUBMIT_METER_READINGS"
}GenericBackendScreen
A generic backend screen that can be used to define any type of screen.
Fields
| Name | Description |
|---|---|
name(String!) | The name of the screen. |
refreshFrequency(Int) | The refresh / polling frequency in milliseconds. |
screenData(String) | Serialized JSON representation of the screen. |
Example
{
"name": "abc123",
"refreshFrequency": 1,
"screenData": "abc123"
}Fields
| Name | Description |
|---|---|
canAmendOrder(Boolean!) | Indicates whether the order can be amended for appointment/activation date changes. This field depends on the client configuration and the last OSS event received. |
cancellationReason(String) | The reason for the cancellation of the order. |
cancellationSubreason(String) | The subreason for the cancellation of the order. |
orderId(String!) | The order ID of the product order. |
orderType(String!) | The type of the product order. |
orderedAt(DateTime) | The date when the product order was created. |
products([TelcoProductType]) | Products associated with this broadband order. |
status(String!) | The status of the product order. |
Example
{
"orderId": "abc123",
"orderType": "abc123",
"orderedAt": "2020-01-01T00:00:00.000Z",
"status": "abc123",
"cancellationReason": "abc123",
"cancellationSubreason": "abc123",
"products": [TelcoProductType],
"canAmendOrder": true
}Fields
| Name | Description |
|---|---|
accountInDunning(Boolean) | Account in dunning. |
adminFeesForEarlyRenewal(Boolean) | Admin fees for early renewal. |
openCeaseOrder(Boolean) | Account have an open cease order. |
suspectedFraud(Boolean) | Account suspected of fraud check. |
suspendedServices(Boolean) | Suspended services on account. |
Example
{
"adminFeesForEarlyRenewal": true,
"suspectedFraud": true,
"accountInDunning": true,
"openCeaseOrder": true,
"suspendedServices": true
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
secretKey(String) |
Example
{
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}GetEmbeddedSecretForNewPaymentInstructionWithoutAccount
Get the client secret needed to create a new stored payment instruction using an embedded form.
This mutation is specifically for saving payment methods for future use, without immediately creating a payment instruction tied to a specific ledger or account.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
secretKey(String) | The client secret needed to create a new stored payment instruction. |
Example
{
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}GetHostedUrlForNewPaymentInstruction
Get external URL where the user can set up a payment instruction.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3979: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
url(String) | URL at which payment instruction can be set up. |
Example
{
"possibleErrors": [PossibleErrorType],
"url": "abc123"
}GetOrCreateAgreement
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4719: No supply point found for identifier provided.
- KT-CT-4910: No product exists with the given input.
- KT-CT-1503: Agreement validto date must be later than validfrom date.
- KT-CT-1509: Unable to create agreement.
- KT-CT-1511: Cannot create overlapping agreement.
- KT-CT-1512: Account type does not support agreements.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
agreement(CommonAgreementType) | The agreement that was retrieved or created. |
created(Boolean) | Indicates whether a new agreement was created (true) or an existing agreement was returned (false). |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"created": true,
"agreement": CommonAgreementType
}Fields
| Name | Description |
|---|---|
cancellationReason(String) | The reason for the cancellation of the order. |
cancellationSubreason(String) | The subreason for the cancellation of the order. |
orderId(String!) | The order ID of the product order. |
orderType(String!) | The type of the product order. |
products([TelcoProductType]) | Products associated with this broadband order. |
status(String!) | The status of the product order. |
workflows([WorkflowOutput]) | List of workflows associated with the product order. |
Example
{
"orderId": "abc123",
"orderType": "abc123",
"status": "abc123",
"cancellationReason": "abc123",
"cancellationSubreason": "abc123",
"workflows": [WorkflowOutput],
"products": [TelcoProductType]
}Fields
| Name | Description |
|---|---|
currency(String) | Currency. |
grossAmount(Float) | Gross amount. |
netAmount(Float) | Net amount. |
type(String) | Grant type. |
Example
{
"type": "abc123",
"netAmount": 1.0,
"grossAmount": 1.0,
"currency": "abc123"
}Fields
| Name | Description |
|---|---|
availableFrom(Date) | Product available from. |
availableTo(Date) | Product available to. |
code(String) | Product code. |
currency(String) | Currency. |
customerName(String) | Product customer name. |
description(String) | Product description. |
grossPricePerUnit(Float) | Gross price per unit. |
id(Int) | Product ID. |
internalName(String) | Product internal name. |
marketName(String) | Market of the product. |
notes(String) | Product notes. |
pricePerUnit(Float) | Price per unit. |
productType(GoodsProductType) | Type of the product. |
Example
{
"id": 1,
"marketName": "abc123",
"productType": GoodsProductType,
"code": "abc123",
"internalName": "abc123",
"customerName": "abc123",
"notes": "abc123",
"description": "abc123",
"availableFrom": "2020-01-01",
"availableTo": "2020-01-01",
"pricePerUnit": 1.0,
"grossPricePerUnit": 1.0,
"currency": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([GoodsProductConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": GoodsProductConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}GoodsProductConnectionTypeEdge
A Relay edge containing a GoodsProductConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(GoodsProduct) | The item at the end of the edge |
Example
{
"node": GoodsProduct,
"cursor": "abc123"
}Example
{
"code": "abc123",
"internalName": "abc123"
}Fields
| Name | Description |
|---|---|
clientParams(JSONString) | Client parameters of the purchase. |
code(String) | Purchase code. |
goodsGrants([GoodsGrant]) | Grants that apply in this purchase. |
goodsSaleItems([GoodsSaleItem]) | Sale items in this purchase. |
ledgerId(ID) | Ledger ID associated to the purchase. Deprecated The 'ledgerId' field is deprecated. |
ledgerNumber(String) | The ledger number associated to the purchase. |
marketName(String!) | Market name of the purchase. |
marketParams(JSONString) | Market parameters of the purchase. |
Example
{
"code": "abc123",
"ledgerId": "abc123",
"ledgerNumber": "abc123",
"goodsSaleItems": [GoodsSaleItem],
"goodsGrants": [GoodsGrant],
"marketName": "abc123",
"marketParams": {"key": "value"},
"clientParams": {"key": "value"}
}Fields
| Name | Description |
|---|---|
code(String) | Code of the quote. |
goodsQuotedProducts([GoodsQuotedProduct]) | Products of this quote. |
hasQuoteExpired(Boolean) | Indicates whether or not the quote is expired. |
id(ID) | ID of the quote. |
quotedAt(DateTime) | Date and time when the quote was created. |
totalNetAmount(Int) | Total net amount of the quote in cents. |
Example
{
"id": "abc123",
"code": "abc123",
"totalNetAmount": 1,
"quotedAt": "2020-01-01T00:00:00.000Z",
"goodsQuotedProducts": [GoodsQuotedProduct],
"hasQuoteExpired": true
}Fields
| Name | Description |
|---|---|
currency(String) | Currency. |
netAmount(Int) | Net amount. |
numberOfUnits(Int) | Number of units. |
pricePerUnit(Int) | Price per unit. |
product(String) | Product code. |
Example
{
"product": "abc123",
"numberOfUnits": 1,
"pricePerUnit": 1,
"netAmount": 1,
"currency": "abc123"
}Fields
| Name | Description |
|---|---|
currency(String) | Currency. |
grossAmount(Float) | Gross amount. |
netAmount(Float) | Net amount. |
numberOfUnits(Int) | Number of units. |
pricePerUnit(Float) | Price per unit. |
product(String) | Product code. |
Example
{
"product": "abc123",
"numberOfUnits": 1,
"pricePerUnit": 1.0,
"netAmount": 1.0,
"grossAmount": 1.0,
"currency": "abc123"
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}GroupType
Represents a group of components presented as a choice.
Fields
| Name | Description |
|---|---|
customerDescription(String!) | Customer-facing description of the group. |
customerName(String!) | Customer-facing name for the group. |
identifier(ID!) | Unique identifier of the group. |
internalName(String!) | Internal name for the group. |
maxCardinality(Int!) | Maximum number of components that can be selected from this group. |
minCardinality(Int!) | Minimum number of components that must be selected from this group. |
offeringComponents([OfferingComponentType]) | Nested offering components within this group. |
productComponents([ProductComponentType]) | Product components within this group. |
Example
{
"identifier": "abc123",
"internalName": "abc123",
"customerName": "abc123",
"customerDescription": "abc123",
"minCardinality": 1,
"maxCardinality": 1
}HardshipAgreementType
Represents a Hardship Agreement for a particular Account.
Fields
| Name | Description |
|---|---|
createdAt(DateTime!) | |
endDate(Date) | |
exitReason(HardshipAgreementExitReason) | |
exitReasonDetails(String) | Extra details for the exit reason |
hardshipDetails(String!) | These are internal notes detailing the hardship. |
hardshipEntryReason(HardshipAgreementHardshipEntryReason) | |
hardshipType(HardshipAgreementHardshipType!) | |
id(ID!) | |
paymentPlanDetails(String!) | |
startDate(Date!) |
Example
{
"id": "abc123",
"hardshipType": "DEATH_IN_FAMILY",
"hardshipDetails": "abc123",
"hardshipEntryReason": "SELF_IDENTIFIED",
"paymentPlanDetails": "abc123",
"startDate": "2020-01-01",
"endDate": "2020-01-01",
"exitReason": "INITIAL_PAYMENT_PLAN_NOT_ESTABLISHED",
"exitReasonDetails": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
pastDeliveries([PastDeliveryType]) | Past CPE deliveries for the property. |
upcomingDeliveries([UpcomingDeliveryType]) | Upcoming CPE deliveries for the property. |
Example
{
"upcomingDeliveries": [UpcomingDeliveryType],
"pastDeliveries": [PastDeliveryType]
}Fields
| Name | Description |
|---|---|
isHeld(Boolean) | Whether a statement is currently held. |
reason(String) | Reason for statement being held. |
Example
{
"isHeld": true,
"reason": "abc123"
}Fields
| Name | Description |
|---|---|
time(Time!) | The time for starting/ending homework time. |
weekday(Weekday!) | The weekday for starting/ending homework time. |
Example
{
"weekday": "MONDAY",
"time": "00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
startedAt(HomeworkDateTimeType!) | The start time for setting homework time. |
terminatedAt(HomeworkDateTimeType!) | The end time for setting homework time. |
Example
{
"startedAt": HomeworkDateTimeType,
"terminatedAt": HomeworkDateTimeType
}ImageType
A media element containing an image.
Fields
| Name | Description |
|---|---|
accessibilityHidden(Boolean) | Whether the element is hidden from view. |
accessibilityLabel(String) | Accessible description of the element. |
horizontalAlignment(Alignment) | The horizontal alignment of the media. |
id(ID) | Unique identifier of the object. |
mediaUrl(String!) | The resource URL of the media. |
typename(String) | The name of the object's type. |
width(ItemSizeType) | The measurement of the element. |
Example
{
"width": FractionSizeType,
"mediaUrl": "abc123",
"horizontalAlignment": "START",
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123"
}Fields
| Name | Description |
|---|---|
sentBy(String) | Specifies the expected date and time the implications will be sent to the customer. |
sentMethod(String) | Communication type
i.e. |
sentTo(String) | Communication type identifier. |
Example
{
"sentMethod": "abc123",
"sentBy": "abc123",
"sentTo": "abc123"
}ImportReadingsConnection
Pagination for readings representing incoming utility flow e.g., usage or consumption..
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ImportReadingsEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ImportReadingsEdge,
"totalCount": 1,
"edgeCount": 1
}ImportReadingsEdge
A Relay edge containing a ImportReadings and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Reading) | The item at the end of the edge |
Example
{
"node": Reading,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
recent(Int) | The average number of seconds passed before an inbound call is answered. This value represents the calls received in the last 30 minutes. |
yesterday(Int) | The average number of seconds passed before an inbound call is answered. This value represents the calls received on the previous day. |
Example
{
"yesterday": 1,
"recent": 1
}Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | 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. |
id(ID!) | The ID of the call. |
initialCallerIdentification(PhoneNumberIdentificationType!) | When an inbound call is received, we identify all entities linked to the phone number of the caller. |
metadata([CallMetadataItemType]!) | Metadata related to the call, for example metrics or data passed via an interactive voice response (IVR). |
Example
{
"id": "abc123",
"account": TelcoAccountType
}Fields
| Name | Description |
|---|---|
accountNumber(String) | The account number of the newly created account or the existing account to be re-used. |
isNewAccount(Boolean) | Was a new account created. |
Example
{
"isNewAccount": true,
"accountNumber": "abc123"
}Fields
| Name | Description |
|---|---|
isNewUser(Boolean) | Was a new user created. |
userNumber(String) | The user number of the newly created user or the existing user to be re-used. |
Example
{
"isNewUser": true,
"userNumber": "abc123"
}InitiateHostedStandalonePayment
Initiate a standalone payment and return the url where the customer can complete it.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3943: Invalid ledger.
- KT-CT-3957: No collection method provided.
- KT-CT-3958: Provide either ledger ID or ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
payment(InitiateHostedStandalonePaymentOutput) | The details required to refer to and complete a hosted payment. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
retrievalToken(String!) | The retrieval token for this standalone payment. |
url(String!) | The url for the customer to complete the payment. |
Example
{
"retrievalToken": "abc123",
"url": "abc123"
}InitiateProductSwitch
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4619: Quote with given code not found.
- KT-CT-4624: Unable to accept the given product code.
- KT-CT-4924: Unauthorized.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-4719: No supply point found for identifier provided.
- KT-CT-1509: Unable to create agreement.
- KT-CT-1507: Agreement product switch date is not within the acceptable range.
- KT-CT-4640: Unable to get market or client params from quoted product.
- KT-CT-4627: No products are available for this quote.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
productCode(String!) | The selected product for a specific product switch. |
switchDate(Date!) | The date at which the product switch becomes effective. |
Example
{
"possibleErrors": [PossibleErrorType],
"productCode": "abc123",
"switchDate": "2020-01-01"
}InitiateStandalonePayment
Initiate a standalone payment and return the client secret required to complete it.
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3943: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
payment(InitiateStandalonePaymentOutput) | |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
retrievalToken(String!) | The retrieval token for this standalone payment. |
secretToken(String!) | The secret used to collect the payment. |
Example
{
"retrievalToken": "abc123",
"secretToken": "abc123"
}Fields
| Name | Description |
|---|---|
icon(String) | The icon code point. |
id(ID!) | The ID of the object |
name(String!) | The ink bucket name. |
Example
{
"id": "abc123",
"name": "abc123",
"icon": "abc123"
}Fields
| Name | Description |
|---|---|
all([InkContactChannelIdentity!]!) | All contacts for this conversation. |
default(InkContactChannelIdentity) | The default contact for this conversation. |
Example
{
"default": InkContactChannelIdentity,
"all": InkContactChannelIdentity
}Fields
| Name | Description |
|---|---|
channel(InkCommunicationChannel!) | The channel of the contact. |
displayName(String!) | The name to display to the user. |
handle(String!) | The handle. |
Example
{
"channel": "EMAIL",
"handle": "abc123",
"displayName": "abc123"
}Fields
| Name | Description |
|---|---|
accountNumber(String) | The number of the Kraken account that the conversation is from. |
accountUsers([AccountUserType!]) | The account users on the conversation. |
buckets([InkBucket!]) | The buckets the conversation is currently in. |
contactChannelIdentities(InkContactChannelIdentities!) | The contact channel identities associated with this conversation. |
events(InkConversationEventsConnection!) | Conversation events. |
id(ID!) | |
status(InkConversationStatus!) | The status of the conversation. |
tags([InkTag!]) | The tags on the conversation. |
Example
{
"id": "abc123",
"status": "OPEN",
"contactChannelIdentities": InkContactChannelIdentities,
"accountUsers": [AccountUserType],
"accountNumber": "abc123",
"events": InkConversationEventsConnection
}Fields
| Name | Description |
|---|---|
edges([InkConversationEventsEdge!]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
Example
{
"pageInfo": PageInfo,
"edges": InkConversationEventsEdge
}InkConversationEventsEdge
A Relay edge containing a InkConversationEvents and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(InkConversationEvent!) | The item at the end of the edge |
Example
{
"node": InkNewMessage,
"cursor": "abc123"
}InkEmail
This type wraps around the Message type for emails.
Fields
| Name | Description |
|---|---|
attachments([InkMessageAttachment!]!) | Attachments on the message. |
cc([String!]!) | CC recipients on the message. |
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
conversationId(Int!) | The integer ID of the conversation this message belongs to. |
conversationRelayId(String!) | The relay ID of the conversation this message belongs to. |
delivery(InkMessageDelivery!) | The delivery status of the message. |
direction(InkMessageDirection!) | The direction of the email. |
displayContent(String!) | The content of the message. |
fromHandle(String!) | From email address. |
isChannelEmail(Boolean!) | Is this an message an email. |
occurredAt(DateTime!) | The time the message was sent/received. |
subject(String!) | The email subject. |
tags([InkTag!]!) | All Tags associated with a message. |
toHandles([String!]) | The addresses that the message was sent to. |
Example
{
"direction": "INBOUND",
"toHandles": ["abc123"],
"fromHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"subject": "abc123",
"displayContent": "abc123",
"attachments": InkMessageAttachment,
"cc": "abc123",
"isChannelEmail": true,
"conversationId": 1,
"conversationRelayId": "abc123"
}InkGenericMessage
This message type is used for messages that belong to contact channels without a more granular message type.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
conversationId(Int!) | The integer ID of the conversation this message belongs to. |
conversationRelayId(String!) | The relay ID of the conversation this message belongs to. |
delivery(InkMessageDelivery!) | The delivery status. |
direction(InkMessageDirection!) | The direction of the message. |
displayContent(String!) | The content of the message. |
fromHandle(String!) | The identity the message was sent from. |
id(ID!) | The ID of the object |
occurredAt(DateTime!) | The time the message was sent/received at. |
toHandle(String!) | The identity the message was sent to. |
Example
{
"id": "abc123",
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"displayContent": "abc123",
"conversationId": 1,
"conversationRelayId": "abc123"
}InkLine
This type wraps around the Message type for LINE message.
Fields
| Name | Description |
|---|---|
attachments([InkMessageAttachment!]!) | Attachments on the LINE message. |
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
delivery(InkMessageDelivery!) | The delivery status of the message. |
direction(InkMessageDirection!) | The direction of the message. |
fromHandle(String!) | From LINE id. |
isChannelLine(Boolean!) | Is this a LINE message. |
lineMessage(LineMessage!) | The line message content. |
occurredAt(DateTime!) | The time the message was sent/received. |
tags([InkTag!]!) | All Tags associated with a message. |
toHandle(String!) | To LINE id. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"lineMessage": LineTextMessage,
"isChannelLine": true,
"attachments": InkMessageAttachment
}InkLiveChatConversation
Ink live chat
Fields
| Name | Description |
|---|---|
relayId(ID!) | The relay ID of the live chat conversation. |
Example
{
"relayId": "abc123"
}InkLiveChatMessage
This type wraps around the Message type for a Live Chat message.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
delivery(InkMessageDelivery!) | The delivery status. |
direction(InkMessageDirection!) | The direction of the message. |
displayContent(String!) | The content of the message. |
fromHandle(String!) | The identity the message was sent from. |
id(ID!) | The ID of the object |
occurredAt(DateTime!) | The time the message was sent/received at. |
toHandle(String!) | The identity the message was sent to. |
Example
{
"id": "abc123",
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"displayContent": "abc123"
}Fields
| Name | Description |
|---|---|
fetchUrl(String) | The url for fetching the attachment. |
filename(String!) | The filename. |
sizeInBytes(Int) | The size in bytes. |
Example
{
"filename": "abc123",
"fetchUrl": "abc123",
"sizeInBytes": 1
}Fields
| Name | Description |
|---|---|
accountType(String) | The type of the account linked to the conversation of the message. |
accounts([String!]!) | The list of accounts related to the message. |
buckets([String!]) | The list of the buckets the message is in. |
conversationId(Int!) | The ID of the conversation this message belongs to. |
hourOccurredAt(Int!) | The hour at which the message arrived in Ink. |
hoursWaiting(Int!) | The number of hours the customer has been waiting for a response to their previous message. |
isAssignedToUserBucket(Boolean!) | Whether the conversation that the message belongs to is assigned to a user bucket. |
isFirstFromContact(Boolean!) | Whether the message is the first one sent by the contact. |
isNewThread(Boolean!) | Whether the message starts a new thread in its conversation. |
opsTeam(String) | The operation team that handles the message. |
recentlyReceivedAutoReplies([String!]!) | The codes of the auto replies that have been sent to the contact in the last 6 months. |
replyToCommsSms(String) | The body of the latest comms SMS message sent to the customer, if the message is an sms. |
weekDayOccurredAt(Int!) | The week day at which the message arrived in Ink. |
Example
{
"accounts": "abc123",
"accountType": "abc123",
"buckets": ["abc123"],
"conversationId": 1,
"hourOccurredAt": 1,
"hoursWaiting": 1,
"isAssignedToUserBucket": true,
"isFirstFromContact": true,
"isNewThread": true,
"opsTeam": "abc123",
"recentlyReceivedAutoReplies": "abc123",
"replyToCommsSms": "abc123",
"weekDayOccurredAt": 1
}Fields
| Name | Description |
|---|---|
status(InkMessageDeliveryStatus!) | Message delivery status. |
Example
{
"status": "PENDING"
}InkNewMessage
This types is used for both the message-received and message-sent conversation events.
Fields
| Name | Description |
|---|---|
message(InkMessage!) | The message. |
occurredAt(DateTime!) | The time the conversation event occurred. |
Example
{
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": InkEmail
}Fields
| Name | Description |
|---|---|
content(String!) | The content of the ink note. |
id(ID!) | The ID of the object |
isPinned(Boolean!) | The note is pinned, so that it's always visible in the conversation. |
occurredAt(DateTime!) | The datetime at which the conversation note occurred. |
Example
{
"id": "abc123",
"content": "abc123",
"isPinned": true,
"occurredAt": "2020-01-01T00:00:00.000Z"
}InkPost
This type wraps around the Message type for Post.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
conversationId(Int!) | The integer ID of the conversation this message belongs to. |
conversationRelayId(String!) | The relay ID of the conversation this message belongs to. |
displayContent(String!) | The notes left when a message was uploaded. |
fromHandle(String!) | The from property id. |
isChannelPost(Boolean!) | Determine if the message is a post message. |
rawPlainTextContent(String!) | The content of the message. |
toHandle(String!) | The to property id. |
Example
{
"fromHandle": "abc123",
"toHandle": "abc123",
"displayContent": "abc123",
"rawPlainTextContent": "abc123",
"isChannelPost": true,
"contactChannelIdentity": InkContactChannelIdentity,
"conversationId": 1,
"conversationRelayId": "abc123"
}InkSMS
This type wraps around the Message type for SMS.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
delivery(InkMessageDelivery!) | The delivery status. |
direction(InkMessageDirection!) | The direction of the message. |
displayContent(String!) | The content of the message. |
fromHandle(String!) | The phone number the message was sent from. |
isChannelSms(Boolean!) | Is this an SMS message. |
occurredAt(DateTime!) | The time the message was sent/received at. |
tags([InkTag!]!) | All Tags associated with a message. |
toHandle(String!) | The phone number the message was sent to. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"displayContent": "abc123",
"isChannelSms": true
}Fields
| Name | Description |
|---|---|
analyzerResults([InkStorylineAnalyzerResult!]!) | The analyzer results for this storyline. |
createdAt(DateTime!) | |
entries([InkStorylineEntry!]!) | The entries in the storyline. |
generatedAt(DateTime!) | When the storyline was generated. |
id(ID!) | The ID of the object |
knowledgeArticleIds([BigInt!]) | |
neuralinkRequestId(UUID!) | |
summary(String!) | |
topic(String!) | |
updatedAt(DateTime!) |
Example
{
"id": "abc123",
"topic": "abc123",
"summary": "abc123",
"generatedAt": "2020-01-01T00:00:00.000Z",
"neuralinkRequestId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"knowledgeArticleIds": [1],
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
analyzerType(String!) | |
createdAt(DateTime!) | |
data(JSONString!) | |
id(ID!) | The ID of the object |
schemaVersion(String!) | |
updatedAt(DateTime!) |
Example
{
"id": "abc123",
"analyzerType": "abc123",
"schemaVersion": "abc123",
"data": {"key": "value"},
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
content(String!) | The content of the storyline entry. |
contentId(BigInt) | The optional related object ID of the entry. |
entryType(String!) | The type of the storyline entry. |
id(ID!) | The ID of the object |
isRootCause(Boolean) | Whether this entry is identified as the root cause of the issue. |
occurredAt(DateTime!) | The time the storyline entry occurred. |
url(String) | Optional URL related to the storyline entry. |
Example
{
"id": "abc123",
"entryType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"content": "abc123",
"url": "abc123",
"contentId": 1,
"isRootCause": true
}Example
{
"id": "abc123",
"name": "abc123"
}InkTwilioWhatsApp
This type wraps around the Message type for a Twilio WhatsApp message.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | Twilio WhatsApp message contact channel identity. |
delivery(InkMessageDelivery!) | Message delivery status. |
direction(InkMessageDirection!) | The direction of the message. |
fromHandle(String!) | From WhatsApp number. |
occurredAt(DateTime!) | Date when the conversation event was created. |
tags([InkTag!]!) | All Tags associated with a message. |
toHandle(String!) | To WhatsApp number. |
vendorId(String) | The vendor id. |
whatsappContent(WhatsAppTextMessage!) | Whatsapp message content. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"vendorId": "abc123",
"whatsappContent": WhatsAppTextMessage
}InkWhatsApp
This type wraps around the Message type for WhatsApp message.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | Whatsapp message contact channel identity. |
delivery(InkMessageDelivery!) | Whatsapp message delivery status. |
direction(InkMessageDirection!) | The direction of the message. |
fromHandle(String!) | From WhatsApp phone number. |
isChannelWhatsapp(Boolean!) | Whether or not the message is a whatsapp message. |
occurredAt(DateTime!) | Date when the conversation event was created. |
tags([InkTag!]!) | All Tags associated with a message. |
toHandle(String!) | Whatsapp contact phone number. |
vendorId(String) | The vendor id. |
whatsappContent(WhatsAppTextMessage!) | Whatsapp message content. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"vendorId": "abc123",
"whatsappContent": WhatsAppTextMessage,
"isChannelWhatsapp": true
}InputFieldErrorType
Represents a validation error for a specific input field.
Fields
| Name | Description |
|---|---|
errorMessage(String!) | The error message to display for this field. |
inputFieldKey(String!) | The key of the input field with the error. |
inputFieldValue(String!) | The value that was submitted for the field. |
Example
{
"inputFieldKey": "abc123",
"inputFieldValue": "abc123",
"errorMessage": "abc123"
}Fields
| Name | Description |
|---|---|
endDateTime(DateTime) | Installation appointment end time in UTC. |
identifier(String) | Installation appointment identifier. |
startDateTime(DateTime) | Installation appointment start time in UTC. |
Example
{
"startDateTime": "2020-01-01T00:00:00.000Z",
"endDateTime": "2020-01-01T00:00:00.000Z",
"identifier": "abc123"
}InstigateContractVariationOutput
Output type for instigating a contract variation.
Fields
| Name | Description |
|---|---|
contract(Contract) | The contract with the varied terms. |
Example
{
"contract": Contract
}InstigateSuspendServicesForAccount
Mutation to instigate a suspend service processes
The possible errors that can be raised are:
- KT-CT-4623: Unauthorized.
- KT-CT-10334: No active service found.
- KT-CT-10335: Active suspend order already exists.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
accountNumber(String!) | The account number with suspended services. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountNumber": "abc123"
}InstigateUnSuspendServicesForAccount
Mutation to instigate an unsuspend service processes
The possible errors that can be raised are:
- KT-CT-4623: Unauthorized.
- KT-CT-10334: No active service found.
- KT-CT-10336: Active unsuspend order already exists.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
accountNumber(String!) | The account number with unsuspended services. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountNumber": "abc123"
}Fields
| Name | Description |
|---|---|
characteristic(CharacteristicType) | The product characteristic. |
integerValue(Int!) | The integer value of the characteristic. |
value(String) | A string representation of a characteristic value, for convenience. |
Example
{
"value": "abc123",
"characteristic": CharacteristicType,
"integerValue": 1
}IntegerType
Graphene type object to represent integer values
Fields
| Name | Description |
|---|---|
integerValue(Int!) | Value of this field. |
Example
{
"integerValue": 1
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([InternalCompanyConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": InternalCompanyConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}InternalCompanyConnectionTypeEdge
A Relay edge containing a InternalCompanyConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(InternalCompanyType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}InternalCompanyType
Represents an internal company.
Fields
| Name | Description |
|---|---|
displayableNumber(String!) | The internal company's displayable number, which is a human-friendly identifier. |
id(ID!) | The internal company's ID. |
legalAddress(RichAddressType) | The legal address of the internal company. |
name(String!) | The internal company's name. |
primaryRegistrationNumber(String) | The primary registration number of the internal company. |
primaryTaxIdentifierNumber(String) | The primary tax identifier number of the internal company. |
secondaryRegistrationNumber(String) | The secondary registration number of the internal company. |
Example
{
"id": "abc123",
"displayableNumber": "abc123",
"name": "abc123",
"primaryRegistrationNumber": "abc123",
"secondaryRegistrationNumber": "abc123",
"primaryTaxIdentifierNumber": "abc123",
"legalAddress": RichAddressType
}Fields
| Name | Description |
|---|---|
accumulation(Decimal) | Deprecated The 'accumulation' field is deprecated. |
durationInSeconds(Int!) | The duration of the measurement. |
endAt(DateTime!) | The end datetime of the measurement. |
metaData(MeasurementsMetadataOutput) | This type will return more granular data about the measurement. |
readAt(DateTime!) | The datetime the measurement was taken. |
source(String!) | The data source of the measurement. |
startAt(DateTime!) | The start datetime of the measurement. |
unit(String!) | The unit of the measurement. |
value(Decimal!) | The value of the measurement. |
Example
{
"source": "abc123",
"metaData": MeasurementsMetadataOutput,
"value": "1.0",
"unit": "abc123",
"readAt": "2020-01-01T00:00:00.000Z",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z",
"durationInSeconds": 1,
"accumulation": "1.0"
}InvalidatePaymentInstruction
Invalidates a payment instruction.
The possible errors that can be raised are:
- KT-CT-3926: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
instruction(InvalidatePaymentInstructionOutput) | |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
id(Int) |
Example
{
"id": 1
}InvalidatePreSignedToken
Invalidate a previously issued expiring/pre-signed token.
This mutation can be used to invalidate the token itself.
To invalidate tokens issued to a particular user, use InvalidatePreSignedTokensForUser mutation.
The possible errors that can be raised are:
- KT-CT-1129: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
token(PreSignedToken) |
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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
tokens([PreSignedToken]) |
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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
token(RefreshToken) |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
tokens([RefreshToken]) |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([InvoiceBillingDocumentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": InvoiceBillingDocumentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}InvoiceBillingDocumentConnectionTypeEdge
A Relay edge containing a InvoiceBillingDocumentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(InvoiceBillingDocumentType) | The item at the end of the edge |
Example
{
"node": InvoiceBillingDocumentType,
"cursor": "abc123"
}InvoiceBillingDocumentType
An invoice is a bill that contains individual transactions (i.e. charges, credits, payments, and repayments). These may come from any period of time.
Fields
| Name | Description |
|---|---|
annulledBy(AnnulmentBillingDocumentType) | Billing document that annuls this invoice. |
documentDebtPosition(BillingDocumentPositionType) | Position of the billing document in the delinquent debt tracking system. |
firstIssued(DateTime) | First time the invoice was issued. |
id(Int) | Unique identifier for the invoice billing document. |
invoicedAmount(Int) | The invoiced amount of the billing document. |
number(String) | The unique billing document's reference that can be used for identifying it externally. |
paymentDueDate(Date) | The date due for payment for the invoice. |
pdfUrl(String) | URL to the PDF of the Invoice. |
totalCharges(InvoiceTotalType) | The total amounts for all charges on the invoice. |
totalCredits(InvoiceTotalType) | The total amounts for all credits on the invoice. |
transactions(BillTransactionConnectionTypeConnection) | Transactions on the invoice Arguments
The order in which to return the transactions. |
Example
{
"id": 1,
"firstIssued": "2020-01-01T00:00:00.000Z",
"pdfUrl": "abc123",
"annulledBy": AnnulmentBillingDocumentType,
"number": "abc123",
"invoicedAmount": 1,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"transactions": BillTransactionConnectionTypeConnection,
"documentDebtPosition": BillingDocumentPositionType,
"paymentDueDate": "2020-01-01"
}Fields
| Name | Description |
|---|---|
grossTotal(Int) | The gross total amount for the statement (in minor currency units). |
netTotal(Int) | The net total amount for the statement (in minor currency units). |
taxTotal(Int) | The total amount of tax on the statement (in minor currency units). |
Example
{
"netTotal": 1,
"taxTotal": 1,
"grossTotal": 1
}Fields
| Name | Description |
|---|---|
attachments(BillingAttachmentConnectionTypeConnection) | |
billType(BillTypeEnum) | The type of the bill. |
fromDate(Date) | The date of the bill is covered from. |
grossAmount(Int) | This field returns the total gross amount of the bill in pence. |
id(ID) | The ID of the bill. |
identifier(String) | 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. |
isAnnulled(Boolean!) | Whether the billing document has been annulled. |
issuedDate(Date) | The date the bill was sent to the customer. |
representations(BillRepresentationConnectionTypeConnection) | |
reversalsAfterClose(StatementReversalsAfterClose!) | How many charges have been reversed after the close date. |
temporaryUrl(String) | 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. |
toDate(Date) | The date of the bill is covered to. |
totalCharges(InvoiceTotalType) | The total amounts for all charges on the invoice. |
totalCredits(InvoiceTotalType) | The total amounts for all credits on the invoice. |
totalPayments(Int) | The sum of all previous payments made that are included towards this invoice. |
transactions(BillTransactionConnectionTypeConnection) | Transactions on the given billing document. Arguments
When provided, only entries that are linked to that ledger are returned.
The order in which to return the transactions.
Include only these specific transaction types in the result. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"identifier": "abc123",
"grossAmount": 1,
"isAnnulled": true,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"totalPayments": 1,
"transactions": BillTransactionConnectionTypeConnection,
"representations": BillRepresentationConnectionTypeConnection
}JoinSupplierAcceptTermsAndConditions
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4501: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean) | Indicator that the mutation has completed successfully. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([JoinSupplierLedgerAssignmentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": JoinSupplierLedgerAssignmentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}JoinSupplierLedgerAssignmentConnectionTypeEdge
A Relay edge containing a JoinSupplierLedgerAssignmentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(JoinSupplierLedgerAssignmentType) | The item at the end of the edge |
Example
{
"node": JoinSupplierLedgerAssignmentType,
"cursor": "abc123"
}JoinSupplierLedgerAssignmentType
A ledger with its associated supply points.
Multiple supply points may be assigned to the same ledger. This type groups them for convenient querying.
Fields
| Name | Description |
|---|---|
ledgerName(String) | The ledger name. |
ledgerNumber(String) | The ledger number. |
ledgerSupplyPoints([LedgerSupplyPointType]) | The supply points associated with the ledger. |
ledgerType(String) | The ledger type. |
Example
{
"ledgerNumber": "abc123",
"ledgerType": "abc123",
"ledgerName": "abc123",
"ledgerSupplyPoints": [LedgerSupplyPointType]
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([JoinSupplierProcessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": JoinSupplierProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}JoinSupplierProcessConnectionTypeEdge
A Relay edge containing a JoinSupplierProcessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(JoinSupplierProcessType) | The item at the end of the edge |
Example
{
"node": JoinSupplierProcessType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
affiliateLink(AffiliateLinkType) | Affiliate link for the join supplier journey. |
note(String) | The note associated with this join supplier process data. |
offerGroupIdentifier(NonEmptyString) | Unique identifier for the offer group. |
paymentScheduleData(PaymentScheduleDataType) | The payment schedule details chosen for this join supplier journey. |
requestedAt(DateTime!) | When the journey was requested. |
salesChannel(String) | Sales channel. |
salesSubchannel(String) | Sales subchannel. |
storedPaymentMethodDetailsReference(String) | Reference to the stored payment method details. |
supplyPointContexts([SupplyPointContextDataInterface]) | The supply point context data. |
Example
{
"requestedAt": "2020-01-01T00:00:00.000Z",
"salesChannel": "abc123",
"salesSubchannel": "abc123",
"offerGroupIdentifier": NonEmptyString,
"supplyPointContexts": SupplyPointContextDataInterface,
"note": "abc123",
"storedPaymentMethodDetailsReference": "abc123",
"paymentScheduleData": PaymentScheduleDataType
}JoinSupplierProcessType
Represents a Join Supplier process.
Fields
| Name | Description |
|---|---|
contractIdentifiers([String]) | Contract identifiers associated with this join supplier process. |
currentProcessData(JoinSupplierProcessDataType) | The current process data associated with the Join Supplier process. |
id(ID) | The ID or the primary key of the lifecycle process. |
ledgerAssignments(JoinSupplierLedgerAssignmentConnectionTypeConnection) | The ledgers associated with the supply points in the process. |
number(String) | The unique identifier of the process. |
status(LifecycleSupplyPointProcessStatus) | The status of the process. |
subtype(String) | The subtype of the process. |
supplyPoints(SupplyPointConnectionTypeConnection!) | The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"supplyPoints": SupplyPointConnectionTypeConnection,
"number": "abc123",
"subtype": "abc123",
"contractIdentifiers": ["abc123"],
"currentProcessData": JoinSupplierProcessDataType,
"ledgerAssignments": JoinSupplierLedgerAssignmentConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
allowListUrls([String]!) | The URLs that are allow listed for KidsSafe. |
denyListUrls([String]!) | The URLs that are denied listed for KidsSafe. |
networkCategories([NetworkCategoryType]!) | The network categories that are blocked for KidsSafe. |
Example
{
"allowListUrls": "abc123",
"denyListUrls": "abc123",
"networkCategories": NetworkCategoryType
}Fields
| Name | Description |
|---|---|
identifier(String) | The unique identifier for the sales record. |
opportunityNumber(String) | The opportunity code associated with the sales record. |
Example
{
"identifier": "abc123",
"opportunityNumber": "abc123"
}Fields
| Name | Description |
|---|---|
affiliateOrganisationName(String) | The name of the affiliate organisation associated with the sales record. |
identifier(String) | The unique identifier for the sales record. |
salesChannel(String) | The sales channel associated with the sales record. |
Example
{
"identifier": "abc123",
"salesChannel": "abc123",
"affiliateOrganisationName": "abc123"
}KrakenVersionType
Information about what version of Kraken is being executed by this service.
Fields
| Name | Description |
|---|---|
SHA(String) | The git commit SHA that is being executed. |
isPinned(Boolean) | Whether this version is pinned to a specific version. |
number(String) | The version number that is being executed. |
Example
{
"number": "abc123",
"SHA": "abc123",
"isPinned": true
}Fields
| Name | Description |
|---|---|
allAttemptsTriedAndFailed(Boolean) | Whether all payment attempts have been tried and failed. |
isFirstAttempt(Boolean!) | Is this initial payment or representation. |
maxAttemptsAllowed(Int) | The maximum number of attempts to request payment, initial plus re-presentations. |
Example
{
"maxAttemptsAllowed": 1,
"allAttemptsTriedAndFailed": true,
"isFirstAttempt": true
}Fields
| Name | Description |
|---|---|
assignedToOrganization(AffiliateOrganisationType) | Affiliate organization assigned to this lead. |
assignedToUsername(String) | The username of the user the lead is assigned to. |
consents([ConsentOutput]) | List of consents for the lead. |
contacts([LeadContactDetailsType]) | The contacts for the lead. Arguments
Input fields for retrieving contacts. |
leadType(String) | The type of the lead. |
nationalId(String) | National Identifier of the lead. |
number(String!) | Lead number. |
opportunities([OpportunityOutput]) | List of opportunities for the lead. Arguments
Input fields for retrieving opportunities. |
salesChannel(SalesChannelType) | The sales channel that this lead was captured by. |
salesFunnel(SalesFunnel) | The sales funnel this lead is in. |
stage(SalesFunnelStage) | The current stage of the sales funnel that this lead is in. |
Example
{
"number": "abc123",
"nationalId": "abc123",
"leadType": "abc123",
"assignedToUsername": "abc123",
"consents": [ConsentOutput]
}Fields
| Name | Description |
|---|---|
blockListHits([String]) | List of block list hits found. |
valid(Boolean) | Indicates if the block list validation passed. |
Example
{
"valid": true,
"blockListHits": ["abc123"]
}Fields
| Name | Description |
|---|---|
email(String) | The email address of the contact. |
familyName(String) | The family name of the contact. |
givenName(String) | The given name of the contact. |
phoneNumber(String) | The phone number of the contact. |
roles([LeadContactRoles]) | The roles of the contact. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"roles": "LEGAL_CONTACT"
}Fields
| Name | Description |
|---|---|
leadId(ID!) | The ID of the lead. Deprecated The 'leadId' field is deprecated. |
number(String!) | The number of the lead. |
Example
{
"leadId": "abc123",
"number": "abc123"
}Fields
| Name | Description |
|---|---|
accountNumber(String) | Lead's linked account number. |
assignedToAffiliateNumber(String) | The affiliate's name this opportunity is assigned to. |
assignedToTeam(String) | Team assigned to this lead. |
assignedToUser(String) | User assigned to this lead. |
billingAddress(AddressOutput) | Lead billing address. |
billingName(String) | Lead billing name. |
billingRichAddress(RichAddressType) | Lead billing rich address. |
brand(String) | Lead brand. |
consents([ConsentOutput]) | List of consents for the lead. |
email(String) | Lead legal contact email. |
extraDetailItems([ExtraDetail]) | Extra details about the lead as key/value pairs. |
extraDetails(JSONString) | Extra details about the lead. Deprecated The 'extraDetails' field is deprecated. |
familyName(String) | Lead legal family name. |
funnel(SalesFunnel) | The lead funnel this lead is in. |
givenName(String) | Lead legal given name. |
leadId(ID) | Lead ID. |
leadType(String) | The type of the lead. |
nationalId(String) | National Identifier of the lead. |
number(String) | Lead number. |
phoneNumber(String) | Lead legal contact phone number. |
salesChannel(String) | Lead sales channel. |
stage(String) | Current stage in a funnel. |
Example
{
"leadId": "abc123",
"accountNumber": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"billingName": "abc123",
"billingRichAddress": RichAddressType,
"email": "abc123",
"phoneNumber": "abc123",
"number": "abc123",
"stage": "abc123",
"extraDetails": {"key": "value"},
"brand": "abc123",
"salesChannel": "abc123",
"assignedToTeam": "abc123",
"assignedToUser": "abc123",
"nationalId": "abc123",
"leadType": "abc123",
"consents": [ConsentOutput],
"assignedToAffiliateNumber": "abc123"
}Fields
| Name | Description |
|---|---|
externalIdentifier(String) | Supply point identifier. |
marketName(String) | Market code of the supply point. |
Example
{
"externalIdentifier": "abc123",
"marketName": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([LeadsEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
LeadsEdge
A Relay edge containing a Leads and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Lead) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}LeadsFileAttachmentDownloadPresignedUrlType
Metadata returned when generating a pre-signed download URL for a leads file attachment.
Fields
| Name | Description |
|---|---|
preSignedUrl(String!) | The pre-signed S3 download URL. |
Example
{
"preSignedUrl": "abc123"
}LeadsFileAttachmentPresignedPostType
Metadata returned when generating a pre-signed post URL for a leads file attachment.
Fields
| Name | Description |
|---|---|
bucket(String!) | The S3 bucket. |
fields(JSONString!) | The fields to be included in the pre-signed post. |
key(String!) | The S3 bucket key. |
preSignedUrl(String!) | The pre-signed S3 URL. |
Example
{
"key": "abc123",
"bucket": "abc123",
"preSignedUrl": "abc123",
"fields": {"key": "value"}
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([LeavePropertyProcessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": LeavePropertyProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}LeavePropertyProcessConnectionTypeEdge
A Relay edge containing a LeavePropertyProcessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(LeavePropertyProcessType) | The item at the end of the edge |
Example
{
"node": LeavePropertyProcessType,
"cursor": "abc123"
}LeavePropertyProcessType
Represents a Leave Property process.
Fields
| Name | Description |
|---|---|
id(ID) | The ID or the primary key of the lifecycle process. |
status(LifecycleSupplyPointProcessStatus) | The status of the process. |
supplyPoints(SupplyPointConnectionTypeConnection!) | The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"supplyPoints": SupplyPointConnectionTypeConnection
}LeaveSupplierCancelled
Output of a LeaveSupplier journey cancellation.
Fields
| Name | Description |
|---|---|
message(String!) | The message to display to the user on cancellation. |
Example
{
"message": "abc123"
}LeaveSupplierInstigated
Termination was successfully initiated.
Fields
| Name | Description |
|---|---|
leaveSupplierProcessId(ID) | The ID of the newly created or existing leave supplier process. Deprecated The 'leaveSupplierProcessId' field is deprecated. |
message(String!) | The message to display to the user on termination initiation. |
number(ID!) | The number of the newly created or existing leave supplier process. |
Example
{
"number": "abc123",
"leaveSupplierProcessId": "abc123",
"message": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([LeaveSupplierProcessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": LeaveSupplierProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}LeaveSupplierProcessConnectionTypeEdge
A Relay edge containing a LeaveSupplierProcessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(LeaveSupplierProcessType) | The item at the end of the edge |
Example
{
"node": LeaveSupplierProcessType,
"cursor": "abc123"
}LeaveSupplierProcessType
Represents a Leave Supplier process. Conceptually, it contains information related to supply points that are associated with a Leave Supplier journey.
Fields
| Name | Description |
|---|---|
id(ID) | The ID or the primary key of the lifecycle process. |
number(String) | The unique identifier of the process. |
status(LifecycleSupplyPointProcessStatus) | The status of the process. |
subtype(String) | The subtype of the process. |
supplyPoints(SupplyPointConnectionTypeConnection!) | The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"number": "abc123",
"supplyPoints": SupplyPointConnectionTypeConnection,
"subtype": "abc123"
}LeaveSupplierReversed
Output of a LeaveSupplier journey reversal.
Fields
| Name | Description |
|---|---|
message(String!) | The message to display to the user on reversal. |
Example
{
"message": "abc123"
}LeaveSupplierUpdated
Leave supplier was successfully updated.
Fields
| Name | Description |
|---|---|
message(String!) | The message to display to the user on leave supplier update. |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
externalIdentifier(String) | Supply point external identifier. Empty string if not set. |
marketName(String) | Market name for the supply point. |
Example
{
"externalIdentifier": "abc123",
"marketName": "abc123"
}LedgerType
Ledgers provide the foundation of Kraken’s bookkeeping functionality. Similar to a bank account, they allow us to keep track of financial activity on a particular Kraken account.
Fields
| Name | Description |
|---|---|
acceptsPayments(Boolean) | Whether payments can be posted onto this ledger. |
affectsAccountBalance(Boolean) | Whether this ledger's balance contributes to the account's balance. |
agreements(AgreementConnection) | The charged supply agreements of the ledger. |
amountOwedByCustomer(Int) | 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. |
balance(Int) | The current balance on the ledger in minor units of currency. |
billingTriggerConfiguration(BillingTriggerConfiguration) | The active billing trigger configuration for the ledger. The possible errors that can be raised are:
|
creditTransferPermissionsData(CreditTransferPermissionsDataType) | Permissions data for credit transfers involving the given ledger. |
currentDirectDebitInstructionInvalidatedWithVendor(Boolean) | True if the current direct debit instruction has been invalidated by vendor. False otherwise. |
debtLedger(LedgerType) | The debt ledger assigned to this ledger. |
id(ID) | Deprecated The 'ledgerId' field is deprecated. |
invoices(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. Arguments
Exclude invoices that were issued by external systems. Does not apply to legacy bills.
The id of the invoice.
The order the invoices should be returned in. |
ledgerType(String) | The ledger type code. |
name(String) | The display name of the ledger. |
number(String) | The canonical name of the ledger. |
paymentAdequacy(PaymentAdequacyDetailsType) | |
paymentPreferenceAtTime(PaymentPreferenceUnion) | The customer's preferred payment method at a point in time. The possible errors that can be raised are:
Arguments
The time at which to know the payment preference. |
paymentPreferences(PaymentPreferenceConnectionTypeConnection) | The customer's preferred payment methods. |
paymentsWithNonConcludedRePresentation(PaymentWithNonConcludedRePresentationConnectionTypeConnection) | Payments with non-concluded re-presentation. |
refundRequests(RefundRequestConnectionTypeConnection) | Refund requests for a given ledger. |
repaymentRequests(RepaymentRequestConnectionTypeConnection) | Repayment requests for a given ledger. |
statements(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. |
supportsInvoices(Boolean) | Is it possible for this ledger to contain invoices. |
supportsStatements(Boolean) | Is it possible for this ledger to contain statements. |
transactions(TransactionConnectionTypeConnection) | Transactions on the given ledger. Arguments
Optional date representing the beginning of the postedDate range filter. This date value is inclusive.
The order in which to return the transactions.
Optional date representing the end of the postedDate range filter. This date value is exclusive.
Include only these specific transaction types in the result. |
usablePaymentInstructions(PaymentInstructionConnectionTypeConnection) | The usable payment instructions for this ledger. |
Example
{
"id": "abc123",
"name": "abc123",
"number": "abc123",
"ledgerType": "abc123",
"balance": 1,
"amountOwedByCustomer": 1,
"affectsAccountBalance": true,
"statements": StatementBillingDocumentConnectionTypeConnection,
"invoices": InvoiceBillingDocumentConnectionTypeConnection,
"transactions": TransactionConnectionTypeConnection,
"repaymentRequests": RepaymentRequestConnectionTypeConnection,
"refundRequests": RefundRequestConnectionTypeConnection,
"acceptsPayments": true,
"paymentAdequacy": PaymentAdequacyDetailsType,
"creditTransferPermissionsData": CreditTransferPermissionsDataType,
"paymentPreferences": PaymentPreferenceConnectionTypeConnection,
"paymentPreferenceAtTime": PreferredInstruction,
"debtLedger": LedgerType,
"agreements": AgreementConnection,
"usablePaymentInstructions": PaymentInstructionConnectionTypeConnection,
"billingTriggerConfiguration": BillingTriggerConfiguration,
"supportsStatements": true,
"supportsInvoices": true,
"currentDirectDebitInstructionInvalidatedWithVendor": true,
"paymentsWithNonConcludedRePresentation": PaymentWithNonConcludedRePresentationConnectionTypeConnection
}LegacyItemProfileType
Represents the characteristics and configuration of an ordered item.
Fields
| Name | Description |
|---|---|
characteristics(JSONString) | The characteristic values for this item profile. |
Example
{
"characteristics": {"key": "value"}
}LegacyOrderDetailsType
Represents the details of an Order.
Fields
| Name | Description |
|---|---|
order(LegacyOrderType) | The order details. The possible errors that can be raised are:
|
resources([LegacyOrderResource]) | The resources associated with the order. The possible errors that can be raised are:
|
status(OrderStatus) | The current status of the order. The possible errors that can be raised are:
|
Example
{
"status": "PENDING"
}LegacyOrderItemType
Represents an item being ordered.
Fields
| Name | Description |
|---|---|
code(NonEmptyString) | The code identifying the item. |
marketData(JSONString) | Market-specific data for the item. |
profile(LegacyItemProfileType) | The profile containing characteristics of the item. |
Example
{
"profile": LegacyItemProfileType,
"marketData": {"key": "value"},
"code": NonEmptyString
}LegacyOrderLineDateRangeType
Represents a period defined by specific start and end dates.
Fields
| Name | Description |
|---|---|
end(DateTime) | The end date and time of the period. Null indicates an infinite/rolling period. |
start(DateTime!) | The start date and time of the period. |
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z"
}LegacyOrderLineDurationType
Represents a period defined by duration in seconds.
Fields
| Name | Description |
|---|---|
duration(Float!) | The duration in seconds. |
Example
{
"duration": 1.0
}LegacyOrderLineType
Represents a line item in an order.
Fields
| Name | Description |
|---|---|
item(LegacyOrderItemType) | The item being ordered. |
period(LegacyOrderLinePeriodType) | The period for which this order line is valid. Can be a range or a duration. |
target(TelcoAccountType) | The target customer for this order line. |
terms([TermInterface]) | The terms applicable to this order line. |
Example
{
"item": LegacyOrderItemType,
"period": LegacyOrderLineDateRangeType,
"target": TelcoAccountType,
"terms": TermInterface
}LegacyOrderResource
Represents a resource associated with an order.
Fields
| Name | Description |
|---|---|
resourceIdentifier(NonEmptyString) | The unique identifier of the resource. |
resourceType(NonEmptyString) | The type of the resource. |
Example
{
"resourceType": NonEmptyString,
"resourceIdentifier": NonEmptyString
}LegacyOrderType
Represents an order in the system.
Fields
| Name | Description |
|---|---|
customer(LegacyOrderCustomerType) | The customer who placed the order. |
identifier(NonEmptyString) | Unique identifier for the order. |
lines([LegacyOrderLineType]) | The order lines in this order. |
orderedAt(DateTime) | The date and time when the order was placed. |
sale(SalesRecordType) | The sales record associated with this order, if any. |
source(String) | The source offering that generated this order. |
terms([TermInterface]) | The terms applicable to this order. |
Example
{
"identifier": NonEmptyString,
"customer": TelcoAccountType,
"lines": [LegacyOrderLineType],
"orderedAt": "2020-01-01T00:00:00.000Z",
"terms": TermInterface,
"sale": KrakenDrivenSalesInfoType,
"source": "abc123"
}LegacyProcessOrderOutput
Output type for the result of processing an order.
Fields
| Name | Description |
|---|---|
identifier(NonEmptyString) | The unique identifier of the processed order. |
resources([LegacyOrderResource!]) | The resources associated with the processed order. |
status(OrderStatus) | The status of the order processing. |
Example
{
"status": "PENDING",
"identifier": NonEmptyString
}Fields
| Name | Description |
|---|---|
joinSupplierProcesses(JoinSupplierProcessConnectionTypeConnection) | List of JoinSupplierProcess for an account. |
leavePropertyProcesses(LeavePropertyProcessConnectionTypeConnection) | List of LeavePropertyProcess for an account. |
leaveSupplierProcesses(LeaveSupplierProcessConnectionTypeConnection) | List of LeaveSupplierProcess for an account. |
occupyPropertyProcesses(OccupyPropertyProcessConnectionTypeConnection) | 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 |
|---|---|
activatedAt(DateTime) | DateTime when the offering was activated. |
code(String!) | Unique lifecycle code. |
maxVersion(Int!) | Maximum version number reached. |
previousOffering(ID) | Identifier of the previous version of this offering. |
status(CatalogComponentStatus!) | Current status of the offering. |
version(Int!) | Current version of the offering. |
Example
{
"code": "abc123",
"version": 1,
"maxVersion": 1,
"previousOffering": "abc123",
"status": "DRAFT",
"activatedAt": "2020-01-01T00:00:00.000Z"
}LineCommonError
A base error type. Should be used for general application or lower level errors.
Fields
| Name | Description |
|---|---|
field(String) | The field that for which this error should be associated. |
message(String!) | The error message to display to the user. |
Example
{
"message": "abc123",
"field": "abc123"
}LineEmoji
A LINE specific emoji object. refs: https://developers.line.biz/en/reference/messaging-api/#text-message
Fields
| Name | Description |
|---|---|
emojiId(String!) | The emoji id. |
index(Int!) | The location of the emoji in the message. |
length(Int) | The length of the emoji string placeholder. |
productId(String!) | The product id. |
Example
{
"index": 1,
"length": 1,
"productId": "abc123",
"emojiId": "abc123"
}LineLinkRedirectResponse
Link Successful. Complete link process with LINE.
Fields
| Name | Description |
|---|---|
redirectUrl(String!) |
Example
{
"redirectUrl": "abc123"
}Fields
| Name | Description |
|---|---|
keywords([String!]!) | Keywords describing the sticker. |
packageId(String!) | Sticker package id. |
resourceType(String!) | Sticker resource type. |
stickerId(String!) | Sticker id. |
text(String!) | Text used to customize some stickers. |
Example
{
"packageId": "abc123",
"stickerId": "abc123",
"resourceType": "abc123",
"keywords": "abc123",
"text": "abc123"
}Fields
| Name | Description |
|---|---|
displayContent(String!) | The display content. |
emojis([LineEmoji!]) | The emojis in the message. |
Example
{
"displayContent": "abc123",
"emojis": [LineEmoji]
}LinkAccountToBusiness
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11104: Business role already allocated.
- KT-CT-11105: Business role already allocated.
- KT-CT-11106: Unauthorized.
- KT-CT-11107: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
business(BusinessType) | The business the account was linked to. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
id(ID) | Unique identifier of the object. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
url(String!) | The URL to navigate to. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"url": "abc123"
}LinkTokenNotFound
Returned when no LineAccountLink record matching the parameters exists.
Fields
| Name | Description |
|---|---|
type(LineLinkErrorType!) | The type of error that occurred. |
Example
{
"type": "NO_MATCHING_LINE_LINK"
}Fields
| Name | Description |
|---|---|
averageMonthlyCharge(Int) | The combined average montly cost for all markets based on usage. |
balanceAdjustment(Int) | Suggested temporary adjustment to ongoing usage amount to cover debt or overpayment. |
consumption(ConsumptionBreakdownConnectionTypeConnection) | Breakdown of customer's estimated or real usage per market and per month. |
currentBalance(Int) | The balance the ledger has at the time of review. |
existingMonthlyAmount(Int) | The amount the customer is paying monthly at the time of the review. |
reviewedOn(Date) | The date that we used to calculate the review of the ledger. |
suggestedNewMonthlyAmount(Int) | The suggested monthly payment amount in minor currency following the payment adequacy review. |
targetBalance(Int) | The balance we expect the ledger to have at the end period of the review. |
Example
{
"suggestedNewMonthlyAmount": 1,
"consumption": ConsumptionBreakdownConnectionTypeConnection,
"averageMonthlyCharge": 1,
"existingMonthlyAmount": 1,
"balanceAdjustment": 1,
"currentBalance": 1,
"targetBalance": 1,
"reviewedOn": "2020-01-01"
}Fields
| Name | Description |
|---|---|
promiseId(String) | Promise ID. |
result(AvailableInstallationAppointmentOutput) | Available installation appointments. |
Example
{
"promiseId": "abc123",
"result": AvailableInstallationAppointmentOutput
}LoyaltyCardType
A loyalty card.
Fields
| Name | Description |
|---|---|
id(ID!) | |
number(String) | The number of the loyalty card. |
scheme(String) | The scheme of the loyalty card. |
status(String) | The status of the loyalty card. |
Example
{
"id": "abc123",
"scheme": "abc123",
"number": "abc123",
"status": "abc123"
}LoyaltyPointLedgerEntryType
A Loyalty Point ledger entry.
Fields
| Name | Description |
|---|---|
accountNumber(String) | The account number associated with the entry. |
balanceBroughtForward(String) | Equal to the |
balanceCarriedForward(String) | Equal to the |
id(ID!) | |
idempotencyKey(UUID) | A unique idempotency key for the operation. |
ledgerType(String) | The |
postedAt(DateTime) | The date the points were added to the ledger. |
reasonCode(String) | The reason the entry was being added. |
value(String) | The value of the charge or credit. |
Example
{
"id": "abc123",
"ledgerType": "abc123",
"value": "abc123",
"balanceBroughtForward": "abc123",
"balanceCarriedForward": "abc123",
"reasonCode": "abc123",
"idempotencyKey": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"postedAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123"
}Fields
| Name | Description |
|---|---|
isEligible(Boolean) | Whether the account is eligible to join the loyalty points program. |
primaryIneligibilityReason(String) | The primary reason for ineligibility, if any. |
Example
{
"isEligible": true,
"primaryIneligibilityReason": "abc123"
}ManageCPEOptions
The possible errors that can be raised are:
- KT-CT-10902: Service not found.
- KT-CT-10904: Service reference not found.
- KT-CT-4178: No account found with given account number.
- KT-CT-4634: Quoted product with given id not found.
- KT-CT-4719: No supply point found for identifier provided.
- KT-CT-11401: Invalid equipment quantity selected.
- KT-CT-11402: Invalid equipment selected.
- KT-CT-11403: Equipment order already in progress.
- KT-CT-11404: OTS switch already in progress.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
status(String) | The result of the operation. |
Example
{
"possibleErrors": [PossibleErrorType],
"status": "abc123"
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
printBatch(PrintBatchType) |
Example
{
"possibleErrors": [PossibleErrorType]
}MarketSupplyQuoteRequestType
A quote request.
Fields
| Name | Description |
|---|---|
acceptedAt(DateTime) | |
code(String) | The code of the created quote. |
quotedSupplyPoints(MarketSupplyQuotedSupplyPointConnectionTypeConnection) | List of quoted supply points. |
requestedAt(DateTime) | |
termsAndConditions(TermsAndConditionsConnectionTypeConnection) | List of terms and conditions applicable to the quote. |
Example
{
"acceptedAt": "2020-01-01T00:00:00.000Z",
"requestedAt": "2020-01-01T00:00:00.000Z",
"code": "abc123",
"quotedSupplyPoints": MarketSupplyQuotedSupplyPointConnectionTypeConnection,
"termsAndConditions": TermsAndConditionsConnectionTypeConnection
}MarketSupplyQuotedProductConnectionTypeConnection
Pagination for quoted products.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([MarketSupplyQuotedProductConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MarketSupplyQuotedProductConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}MarketSupplyQuotedProductConnectionTypeEdge
A Relay edge containing a MarketSupplyQuotedProductConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(MarketSupplyQuotedProductType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}MarketSupplyQuotedProductType
A product quoted for a supply point.
Fields
| Name | Description |
|---|---|
clientParams(JSONString) | A JSON object containing client parameters on the quoted product. |
id(ID!) | |
product(SupplyProductType) | The product associated with the quoted product. |
wasSelected(Boolean!) |
Example
{
"id": "abc123",
"wasSelected": true,
"product": SupplyProductType,
"clientParams": {"key": "value"}
}MarketSupplyQuotedSupplyPointConnectionTypeConnection
Pagination for quoted supply points.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([MarketSupplyQuotedSupplyPointConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MarketSupplyQuotedSupplyPointConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}MarketSupplyQuotedSupplyPointConnectionTypeEdge
A Relay edge containing a MarketSupplyQuotedSupplyPointConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(MarketSupplyQuotedSupplyPointType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}MarketSupplyQuotedSupplyPointType
A supply point quoted as part of a quote request.
Fields
| Name | Description |
|---|---|
clientParams(JSONString) | A JSON object containing client parameters on the quoted product. |
id(ID) | The ID of the quoted supply point. |
identifier(String) | The identifier of the quoted supply point, if one exists. |
marketName(String) | The market this supply point belongs to. |
quotedProducts(MarketSupplyQuotedProductConnectionTypeConnection) | Details of all products quoted for this supply point. |
supplyPoint(SupplyPointType) | The supply point being quoted. |
Example
{
"marketName": "abc123",
"id": "abc123",
"identifier": "abc123",
"quotedProducts": MarketSupplyQuotedProductConnectionTypeConnection,
"supplyPoint": SupplyPointType,
"clientParams": {"key": "value"}
}Fields
| Name | Description |
|---|---|
errors([ErrorType]) | A list of any errors that occurred while running this mutation. |
token(String) | A Kraken Token that can be used to authenticate to the API, masquerading as the desired user. |
Example
{
"token": "abc123",
"errors": [ErrorType]
}Fields
| Name | Description |
|---|---|
services([ServicesType]) | A container of the services requested to be switched. |
switchOrderReference(UUID) | UUID created by the losing provider to represent the match result actions. |
Example
{
"switchOrderReference": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"services": [ServicesType]
}Fields
| Name | Description |
|---|---|
amount(Int) | The maximum amount available to be requested as a refund. |
reasonToRecommendAmount(MaximumRefundReasonChoices) | The reason why a specific amount is the maximum available to be requested as a refund. |
recommendedBalance(Int) | The recommended minimum balance an account should have when asking for a refund. |
Example
{
"amount": 1,
"reasonToRecommendAmount": "MAX_AVAILABLE_AMOUNT",
"recommendedBalance": 1
}MeasurementConnection
Pagination for measurements.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([MeasurementEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MeasurementEdge,
"totalCount": 1,
"edgeCount": 1
}MeasurementEdge
A Relay edge containing a Measurement and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(MeasurementInterface) | The item at the end of the edge |
Example
{
"node": MeasurementInterface,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
metaData(MeasurementsMetadataOutput) | This type will return more granular data about the measurement. |
readAt(DateTime!) | The datetime the measurement was taken. |
source(String!) | The data source of the measurement. |
unit(String!) | The unit of the measurement. |
value(Decimal!) | The value of the measurement. |
Example
{
"source": "abc123",
"metaData": MeasurementsMetadataOutput,
"value": "1.0",
"unit": "abc123",
"readAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
extras([ExtrasOutput]) | Extras relating to the parent measurement node. |
statistics([StatisticOutput]) | Statistics relating to the parent measurement node. |
utilityFilters(UtilityFiltersOutput) | The source information relating to the parent measurement node. |
Example
{
"utilityFilters": ElectricityFiltersOutput,
"statistics": [StatisticOutput],
"extras": [ExtrasOutput]
}Fields
| Name | Description |
|---|---|
amountIncluded(Int) | The number of included mesh routers. |
name(String) | The name of the mesh addon. |
price(FinancialAmount) | The monthly price of the addon. |
priceWithVat(FinancialAmount) | The monthly price of the addon with VAT. |
Example
{
"name": "abc123",
"amountIncluded": 1,
"price": FinancialAmount,
"priceWithVat": FinancialAmount
}Fields
| Name | Description |
|---|---|
channel(Channel!) | The channel that the message was sent through. |
dispatchedAt(DateTime) | The date/time that Kraken dispatched the message to the vendor. |
failedAt(DateTime) | The date/time that the message was confirmed as having failed to send. |
Example
{
"channel": "EMAIL",
"dispatchedAt": "2020-01-01T00:00:00.000Z",
"failedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([MessageEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MessageEdge,
"totalCount": 1,
"edgeCount": 1
}Fields
| Name | Description |
|---|---|
code(String) | A code that represents the nature of the fault. |
severity(String) | Nature of the message. Values will include, 'information', 'warning', 'failure'. |
text(String) | A description of the associated response code. |
Example
{
"code": "abc123",
"text": "abc123",
"severity": "abc123"
}MessageEdge
A Relay edge containing a Message and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Message) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
key(String!) | The key for the metadata. |
value(JSONString) | The metadata value. |
Example
{
"key": "abc123",
"value": {"key": "value"}
}Fields
| Name | Description |
|---|---|
deviceType(String) | The type of MFA device. |
isConfirmed(Boolean) | Whether the MFA device is confirmed or not. |
Example
{
"deviceType": "abc123",
"isConfirmed": true
}MinimumContractLengthType
Represents the minimum term of a contract.
Fields
| Name | Description |
|---|---|
description(NonEmptyString) | The description of the term. |
displayName(NonEmptyString) | The display name of the term. |
identifier(NonEmptyString) | The identifier of the term. |
isVariable(Boolean) | Whether the term is variable. |
length(Int) | The minimum length of the contract. |
type(NonEmptyString) | The type of the term. |
unitOfTime(String) | The unit of time for the contract length. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true,
"length": 1,
"unitOfTime": "abc123"
}Money
Wrapper to describe some price with units.
Inspired by TMF schema see: https://github.com/tmforum-rand/schemas/blob/candidates/Common/Money.schema.json
Note: Main difference with FinancialAmount is the value in Decimal instead of Int due to TMF schema specifications.
Fields
| Name | Description |
|---|---|
unit(String!) | Currency (ISO4217 norm uses 3 letters to define the currency). |
value(Decimal!) | A floating point number, eg: '10.50' for '£10.50' or '-5.00' for £5.00 off. |
Example
{
"unit": "abc123",
"value": "1.0"
}MoveToBucket
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 |
|---|---|
conversation(InkConversation!) | The conversation that was moved to the bucket. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"conversation": InkConversation
}Fields
| Name | Description |
|---|---|
lengthInMonths(Int) | Validity period in months. |
multiplier(Decimal) | Discount multiplier eg: '-0.50' is half price. |
Example
{
"lengthInMonths": 1,
"multiplier": "1.0"
}Fields
| Name | Description |
|---|---|
enabled(Boolean!) | Indicates whether the network category is enabled. |
id(Int!) | The network category ID. |
isMature(Boolean!) | Indicates whether the network category is for mature content. |
name(String!) | The network category name. |
Example
{
"id": 1,
"name": "abc123",
"enabled": true,
"isMature": true
}Fields
| Name | Description |
|---|---|
allInferredRoutingAttributes([String]!) | All inferred routing attributes for team, location, and team groups (e.g., ['OPERATIONSGROUP.TEAM.TeamA', 'OPERATIONSGROUP.LOCATION.London', 'OPERATIONSGROUP.GROUP_B']). Recommended for IVR usage. |
location(TeamLocation!) | Location routing information for the selected team. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
team(Team!) | The next operations team assigned in round-robin sequence. |
teamGroups([TeamGroup]!) | All operations team groups that the selected team belongs to. |
Example
{
"possibleErrors": [PossibleErrorType],
"allInferredRoutingAttributes": "abc123"
}NotifiableApplicationType
Represents an application that can receive push notifications.
Fields
| Name | Description |
|---|---|
bundleId(String!) | Bundle ID or package name of the app. |
description(String!) | |
externalProjectId(String!) | Project ID used in push notification delivery service. (Currently: AWS Pinpoint) |
externalProvider(NotifiableApplicationExternalProvider!) | |
id(ID!) | |
name(String!) | Human readable name for the app. |
pushNotificationBindings([PushNotificationBindingType!]!) | |
service(NotifiableApplicationService!) |
Example
{
"id": "abc123",
"name": "abc123",
"bundleId": "abc123",
"service": "GCM",
"externalProvider": "PINPOINT",
"externalProjectId": "abc123",
"description": "abc123",
"pushNotificationBindings": PushNotificationBindingType
}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 |
|---|---|
payload(GenericScalar!) | The body payload of the Kraken Token. The same information can be obtained by using JWT decoding tools on the value of the |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
refreshExpiresIn(Int) | A Unix timestamp representing the point in time at which the refresh token will expire. |
refreshToken(String) | A token that can be used in a subsequent call to |
token(String!) | The Kraken Token. Can be used in the |
Example
{
"possibleErrors": [PossibleErrorType],
"token": "abc123",
"payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"refreshToken": "abc123",
"refreshExpiresIn": 1
}ObtainLongLivedRefreshToken
Obtain a long-lived refresh token.
This mutation is limited to authorized third-party organizations only.
Account users can only generate short-lived refresh tokens.
The short-lived refresh tokens (for account users) can be obtained from the 'refreshToken' field in 'obtainKrakenToken' mutation.
The possible errors that can be raised are:
- KT-CT-1120: The Kraken Token has expired.
- KT-CT-1121: Please use Kraken Token to issue long-lived refresh tokens.
- KT-CT-1132: Unauthorized.
- KT-CT-1122: Long-lived refresh tokens can only be issued for account users.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
refreshExpiresIn(Int!) | |
refreshToken(String) |
Example
{
"possibleErrors": [PossibleErrorType],
"refreshToken": "abc123",
"refreshExpiresIn": 1
}OccupancyPeriodType
An occupancy period for a property.
Fields
| Name | Description |
|---|---|
accountNumber(String) | Account number associated with this occupancy period. |
effectiveFrom(DateTime) | Date the occupancy period is effective from. |
effectiveTo(DateTime) | Date the occupancy period is effective to. |
id(ID) | The unique ID of the occupancy period. |
isOccupier(Boolean) | Whether the account associated with the occupancy period is an occupier account type. |
numberOfOccupants(Int) | Number of occupants associated with this occupancy period. |
Example
{
"id": "abc123",
"effectiveFrom": "2020-01-01T00:00:00.000Z",
"effectiveTo": "2020-01-01T00:00:00.000Z",
"isOccupier": true,
"accountNumber": "abc123",
"numberOfOccupants": 1
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([OccupyPropertyProcessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": OccupyPropertyProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}OccupyPropertyProcessConnectionTypeEdge
A Relay edge containing a OccupyPropertyProcessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OccupyPropertyProcessType) | The item at the end of the edge |
Example
{
"node": OccupyPropertyProcessType,
"cursor": "abc123"
}OccupyPropertyProcessType
Represents a Occupy Property process.
Fields
| Name | Description |
|---|---|
id(ID) | The ID or the primary key of the lifecycle process. |
occupyAt(DateTime!) | |
status(LifecycleSupplyPointProcessStatus) | The status of the process. |
supplyPoints(SupplyPointConnectionTypeConnection!) | The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"occupyAt": "2020-01-01T00:00:00.000Z",
"supplyPoints": SupplyPointConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
createdAt(DateTime) | The date and time when Offer Group was created. |
createdBy(ActorType) | The Actor who created the Offer Group. |
identifier(ID) | Identifier of the Offer Group. |
offers([OfferType]) | One or more Offers contained in the Offer Group. |
Fields
| Name | Description |
|---|---|
acceptedAt(DateTime) | The date and time when Offer was accepted. |
createdBy(ActorType) | The Actor who created the Offer. |
description(String) | Description of the Offer. |
identifier(ID) | Identifier of the Offer. |
quote(QuoteType_) | The Quote this Offer is related to. |
rejectedAt(DateTime) | The date and time when Offer was rejected. |
validFrom(DateTime) | The date and time from which the Offer becomes valid. |
validTo(DateTime) | The date and time until which the Offer remains valid. |
Example
{
"identifier": "abc123",
"quote": QuoteType_,
"description": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"acceptedAt": "2020-01-01T00:00:00.000Z",
"rejectedAt": "2020-01-01T00:00:00.000Z",
"createdBy": ActorType
}OfferingComponentType
Represents a nested offering component within an offering.
Fields
| Name | Description |
|---|---|
component(OfferingType!) | The offering associated with this component. |
identifier(ID!) | Unique identifier of the component. |
initialQuantity(Int!) | Initial/default quantity for this component. |
maximumQuantity(Int!) | Maximum quantity of this component that can be selected. |
minimumQuantity(Int!) | Minimum quantity of this component that can be selected. |
Example
{
"identifier": "abc123",
"minimumQuantity": 1,
"maximumQuantity": 1,
"initialQuantity": 1
}Fields
| Name | Description |
|---|---|
code(String) | The code for the offering tag. |
displayName(String) | The display name for the tag. |
Example
{
"displayName": "abc123",
"code": "abc123"
}OfferingType
Represents a product offering in the catalog.
Fields
| Name | Description |
|---|---|
customerDescription(String!) | Customer-facing description of the offering. |
customerName(String!) | Customer-facing name of the offering. |
groups([GroupType]) | Groups of components with cardinality constraints. |
identifier(ID!) | Unique identifier of the offering. |
internalName(String!) | Internal name used to identify the offering. |
isActive(Boolean!) | Whether this offering is currently active. |
isAmendable(Boolean!) | Whether this offering can be amended (only DRAFT offerings). |
isDraft(Boolean!) | Whether this offering is in draft status. |
isExpired(Boolean!) | Whether this offering has expired. |
isFirstDraft(Boolean!) | Whether this is the first draft version (version 1, not yet activated). |
isLatestVersion(Boolean!) | Whether this is the latest version of the offering. |
isSellable(Boolean!) | Whether this offering can be sold stand-alone. |
lifecycle(LifecycleType!) | Lifecycle information for this offering. |
offeringComponents([OfferingComponentType]) | Nested offering components included in this offering. |
productComponents([ProductComponentType]) | Product components included in this offering. |
tags([TagType]) | Tags associated with this offering. |
termTemplateComponents([TermTemplateComponentType]) | Contract term template components included in this offering. |
Example
{
"identifier": "abc123",
"internalName": "abc123",
"customerName": "abc123",
"customerDescription": "abc123",
"isSellable": true,
"isAmendable": true,
"isExpired": true,
"isActive": true,
"isDraft": true,
"isLatestVersion": true,
"isFirstDraft": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([OnSiteJobsAppointmentActionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": OnSiteJobsAppointmentActionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}OnSiteJobsAppointmentActionConnectionTypeEdge
A Relay edge containing a OnSiteJobsAppointmentActionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OnSiteJobsAppointmentActionType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}OnSiteJobsAppointmentActionType
An action linked to an On-Site Jobs Appointment.
Fields
| Name | Description |
|---|---|
actionTriggerStage(OnSiteJobsAppointmentActionTriggerStage) | The appointment stage at which this action is triggered. |
workflowName(String) | The name of the workflow. |
workflowStatus(OnSiteJobsWorkflowStatus) | The current status of the workflow. |
Example
{
"actionTriggerStage": "POST_APPOINTMENT_BOOKING",
"workflowName": "abc123",
"workflowStatus": "SKIPPED"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([OnSiteJobsAppointmentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": OnSiteJobsAppointmentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}OnSiteJobsAppointmentConnectionTypeEdge
A Relay edge containing a OnSiteJobsAppointmentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OnSiteJobsAppointmentType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
isComplete(Boolean!) | 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. |
slots([OnSiteJobsAppointmentSlotType]!) | List of available appointment slots. |
Example
{
"isComplete": true
}Fields
| Name | Description |
|---|---|
endDatetime(DateTime!) | The end datetime of the appointment slot. |
slotId(UUID!) | The unique identifier for this appointment slot. |
startDatetime(DateTime!) | The start datetime of the appointment slot. |
Example
{
"startDatetime": "2020-01-01T00:00:00.000Z",
"endDatetime": "2020-01-01T00:00:00.000Z",
"slotId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}Fields
| Name | Description |
|---|---|
agent(OnSiteJobsAgent) | The agent assigned to the appointment. |
appointmentActions(OnSiteJobsAppointmentActionConnectionTypeConnection) | A list of actions triggered by this appointment, across stages. |
assets(OnSiteJobsAssetConnectionTypeConnection) | A list of assets attached to this request. |
cancellationCategory(OnSiteJobsCancellationCategory) | The cancellation category for this appointment. |
cancellationSubCategory(String!) | |
comments(String!) | |
commsStrategy(OnSiteJobsCommsStrategy) | The communication strategy for this appointment. |
createdAt(DateTime!) | |
deadlineDate(Date) | |
endAt(DateTime) | |
externalJobType(String!) | Appointment job type. Deprecated The 'externalJobType' field is deprecated. |
externalJobTypeMapping(OnSiteJobsExternalJobTypeMappingType) | Mapping of appointment job type value to its human-friendly label. |
externalReference(String!) | |
id(UUID!) | |
jobDetails(JSONString!) | |
jobNotes(JSONString!) | |
krakenWorkCategory(OnSiteJobsWorkCategory) | The work category for this appointment. |
preferredStartDate(Date) | |
request(OnSiteJobsRequestType!) | |
startAt(DateTime) | |
status(OnSiteJobsAppointmentStatus) | The current status of the appointment. |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"externalReference": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z",
"preferredStartDate": "2020-01-01",
"deadlineDate": "2020-01-01",
"jobDetails": {"key": "value"},
"jobNotes": {"key": "value"},
"comments": "abc123",
"cancellationSubCategory": "abc123",
"externalJobType": "abc123",
"krakenWorkCategory": "EXCHANGE",
"agent": "GENERIC_AGENT",
"status": "PENDING",
"commsStrategy": "SEND_ALL",
"cancellationCategory": "CANCELLED_BY_CUSTOMER"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([OnSiteJobsAssetConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": OnSiteJobsAssetConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}OnSiteJobsAssetConnectionTypeEdge
A Relay edge containing a OnSiteJobsAssetConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OnSiteJobsAssetType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}OnSiteJobsAssetType
An On-Site Jobs Asset
Fields
| Name | Description |
|---|---|
additionalDetails(JSONString!) | |
externalIdentifier(String!) | |
fuelType(OnSiteJobsAssetFuelType) | The fuel type of the asset. |
kind(OnSiteJobsAssetKind!) | The kind of the asset. |
status(OnSiteJobsAssetStatus!) | The status of the asset. |
supplyPointIdentifier(String) | The internal identifier of the supply point associated with the asset. Deprecated The 'supplyPointIdentifier' field is deprecated. |
supplyPointInternalIdentifier(Int) |
Example
{
"externalIdentifier": "abc123",
"additionalDetails": {"key": "value"},
"supplyPointInternalIdentifier": 1,
"supplyPointIdentifier": "abc123",
"status": "EXISTING",
"kind": "METER",
"fuelType": "ELECTRICITY"
}OnSiteJobsCheckResultsType
Check results for creating On-Site Jobs requests and appointments.
Fields
| Name | Description |
|---|---|
appointmentCheckResults([CheckResultType]) | Results of appointment checks. |
canCreateAppointment(Boolean) | Whether an appointment can be created (overall appointment check is PASS/WARNING). |
canCreateRequest(Boolean) | Whether a request can be created (overall request check is PASS/WARNING). |
hasAppointmentWarnings(Boolean) | Whether any of the appointment checks have warnings. |
hasRequestWarnings(Boolean) | Whether any of the request checks have warnings. |
requestCheckResults([CheckResultType]) | Results of request checks. |
Example
{
"canCreateRequest": true,
"canCreateAppointment": true,
"hasRequestWarnings": true,
"hasAppointmentWarnings": true
}OnSiteJobsExternalJobTypeMappingType
Mapping of a job type value to its human-friendly label.
Fields
| Name | Description |
|---|---|
label(String) | The human-friendly name of the job type. |
value(String) | The job type value set on the appointment. |
Example
{
"value": "abc123",
"label": "abc123"
}OnSiteJobsJobTypeType
Represents a job type available for on-site jobs requests.
Fields
| Name | Description |
|---|---|
id(String!) | The unique identifier for the job type. |
name(String!) | The human-readable name of the job type. |
Example
{
"id": "abc123",
"name": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([OnSiteJobsRequestActionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": OnSiteJobsRequestActionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}OnSiteJobsRequestActionConnectionTypeEdge
A Relay edge containing a OnSiteJobsRequestActionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OnSiteJobsRequestActionType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}OnSiteJobsRequestActionType
An action linked to an On Site Jobs Request.
Fields
| Name | Description |
|---|---|
actionTriggerStage(OnSiteJobsRequestActionTriggerStage) | The request stage at which this action is triggered. |
workflowName(String) | The name of the workflow. |
workflowStatus(Status) | The current status of the workflow. |
Example
{
"actionTriggerStage": "POST_REQUEST_COMPLETION",
"workflowName": "abc123",
"workflowStatus": "SKIPPED"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([OnSiteJobsRequestConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": OnSiteJobsRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}OnSiteJobsRequestConnectionTypeEdge
A Relay edge containing a OnSiteJobsRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OnSiteJobsRequestType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}OnSiteJobsRequestType
An On Site Jobs Request
Fields
| Name | Description |
|---|---|
account(String) | Request account. |
agent(String!) | |
appointments(OnSiteJobsAppointmentConnectionTypeConnection) | A list of appointments associated to this request. |
assets(OnSiteJobsAssetConnectionTypeConnection) | A list of assets attached to this request. |
comment(String!) | |
createdBy(Int) | The ID of the support user who created the request. |
externalReference(String!) | |
id(UUID!) | |
isEmergency(Boolean!) | |
marketSupplyPoints(SupplyPointConnectionTypeConnection) | List of supply points on request. |
overallActionsStatus(Status) | The overall priority status of all actions linked to the request and its appointments. |
property(PropertyType) | Request property. |
reason(String!) | |
requestActions(OnSiteJobsRequestActionConnectionTypeConnection) | A list of actions attached directly to this request. |
status(OnSiteJobsRequestStatus) | Request status. |
subReason(String!) |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"reason": "abc123",
"subReason": "abc123",
"isEmergency": true,
"externalReference": "abc123",
"agent": "abc123",
"comment": "abc123",
"account": "abc123",
"marketSupplyPoints": SupplyPointConnectionTypeConnection,
"property": PropertyType,
"status": "APPROVAL_PENDING",
"overallActionsStatus": "SKIPPED",
"requestActions": OnSiteJobsRequestActionConnectionTypeConnection,
"createdBy": 1
}Example
{
"id": "abc123",
"name": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([OpportunitiesEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": OpportunitiesEdge,
"totalCount": 1,
"edgeCount": 1
}OpportunitiesEdge
A Relay edge containing a Opportunities and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OpportunityOutput) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
category(OpportunityAttachmentCategory) | Attachment category. |
filename(String) | Attachment filename. |
id(ID) | Attachment ID. |
Example
{
"id": "abc123",
"category": "LEAD_FILE",
"filename": "abc123"
}Fields
| Name | Description |
|---|---|
expiresAt(DateTime) | The date and time the file attachment will expire. |
presignedUrl(String) | Presigned URL for the file attachment. |
Example
{
"presignedUrl": "abc123",
"expiresAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
assignedToAffiliateNumber(String) | The affiliate's name this opportunity is assigned to. |
assignedToTeam(String) | Team assigned to this opportunity. |
assignedToUser(String) | User assigned to this opportunity. |
attachments([OpportunityAttachment]) | Attachments for the opportunity. |
consents([ConsentOutput]) | List of consents for the opportunity. |
email(String) | Lead legal contact email. |
extraDetailItems([ExtraDetail]) | Extra details about the opportunity as key/value pairs. |
extraDetails(JSONString) | Extra details about the opportunity. Deprecated The 'extraDetails' field is deprecated. |
funnel(SalesFunnel) | The sales funnel this opportunity is in. |
leadNumber(String) | Lead number. |
leadType(String) | Lead type. |
name(String) | Lead legal name. |
notes(String) | Notes for the opportunity. |
number(String) | Opportunity number. |
offerGroupId(String) | Offer group ID. |
opportunityAddress(AddressOutput) | Opportunity address. |
opportunityId(ID) | Opportunity ID. Deprecated The 'opportunityId' field is deprecated. |
opportunityRichAddress(RichAddressType) | Opportunity rich address. |
phoneNumber(String) | Lead legal contact phone number. |
productOffering(OfferingType) | The product offering of the opportunity. |
productOfferingId(String) | Product offering ID. |
salesChannel(String) | Sales channel. |
stage(String) | Current stage in a funnel. |
supplyPoints([LeadSupplyPointType]) | List of supply points associated with the opportunity. Arguments
Input fields for retrieving supply points by market. |
Example
{
"opportunityId": "abc123",
"leadNumber": "abc123",
"leadType": "abc123",
"name": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"number": "abc123",
"stage": "abc123",
"extraDetails": {"key": "value"},
"opportunityRichAddress": RichAddressType,
"salesChannel": "abc123",
"assignedToTeam": "abc123",
"assignedToUser": "abc123",
"productOfferingId": "abc123",
"offerGroupId": "abc123",
"consents": [ConsentOutput],
"notes": "abc123",
"assignedToAffiliateNumber": "abc123"
}Fields
| Name | Description |
|---|---|
market(String) | The market for the Product. |
productCharacteristics(GenericScalar) | The characteristics of the product. |
productCode(String) | The code of the Product. |
productIdentifier(String) | The UUID for the Product. |
productOfferingIdentifier(String) | The UUID for the Product Offering. |
Example
{
"productOfferingIdentifier": "abc123",
"productIdentifier": "abc123",
"productCode": "abc123",
"productCharacteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"market": "abc123"
}Fields
| Name | Description |
|---|---|
monthlyPrice(FinancialAmount) | The monthly price when out of contract. |
monthlyPriceWithTaxes(FinancialAmount) | The monthly price with taxes when out of contract. |
Example
{
"monthlyPrice": FinancialAmount,
"monthlyPriceWithTaxes": FinancialAmount
}Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | 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. |
id(ID!) | The ID of the call. |
metadata([CallMetadataItemType]!) | Metadata related to the call, for example metrics or data passed via an interactive voice response (IVR). |
Example
{
"id": "abc123",
"account": TelcoAccountType
}Fields
| Name | Description |
|---|---|
category(AppSessionOutcomeCategory) | |
reason(String) | |
type(AppSessionOutcomeType!) |
Example
{
"type": "SALE",
"category": "SUCCESS",
"reason": "abc123"
}PageInfo
The Relay compliant PageInfo type, containing data necessary to paginate this connection.
Fields
| Name | Description |
|---|---|
endCursor(String) | When paginating forwards, the cursor to continue. |
hasNextPage(Boolean!) | When paginating forwards, are there more items? |
hasPreviousPage(Boolean!) | When paginating backwards, are there more items? |
startCursor(String) | When paginating backwards, the cursor to continue. |
Example
{
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123",
"endCursor": "abc123"
}Fields
| Name | Description |
|---|---|
actualDeliveryDate(Date) | The CPE actual delivery date. |
deliveryAddress(DeliveryAddressType) | The CPE delivery address. |
deliveryId(String) | The CPE delivery id. |
deliveryStatus(String) | The CPE delivery status. |
description(String) | The CPE description. |
expectedDeliveryDate(Date) | The CPE expected delivery date. |
orderId(String) | The CPE broadband order id. |
Example
{
"deliveryId": "abc123",
"orderId": "abc123",
"description": "abc123",
"deliveryAddress": DeliveryAddressType,
"expectedDeliveryDate": "2020-01-01",
"deliveryStatus": "abc123",
"actualDeliveryDate": "2020-01-01"
}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 |
|---|---|
collectionProcessPaused(PauseCollectionProcessOutput) | Collection process pause output. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
pauseRecords([CollectionProcessPauseStatusRecord]) | Pause records on the collection process. |
Example
{
}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 |
|---|---|
pauseCreated(Boolean) | Whether the pause has been successfully created. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
accountNumber(String) | Unique identifier of the account the transaction belongs to. |
amount(Int) | Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
balanceCarriedForward(Int) | The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
billingDocumentIdentifier(ID) | 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. |
createdAt(DateTime) | The date time when the transaction is created. |
hasStatement(Boolean) | Returns True if the transaction is linked with a statement. |
id(ID) | Unique identifier for the transaction. |
isAccountCharge(Boolean) | Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
isAccountPayment(Boolean) | Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
isCredit(Boolean) | Deprecated. Deprecated The 'isCredit' field is deprecated. |
isHeld(Boolean) | 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. |
isIssued(Boolean) | 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. |
isLateFailedPayment(Boolean!) | 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. |
isReversed(Boolean!) | |
note(String) | Returns the note field value for the transaction, which contains additional info. |
paymentTransactionType(AccountPaymentTransactionTypeChoices) | The transaction type of the payment. |
postedDate(Date) | Date when the transaction was posted to the account. |
reasonCode(String) | Returns the reason. |
statementId(ID) | Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
title(String) | Human-readable title describing the transaction. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123",
"isLateFailedPayment": true,
"paymentTransactionType": "DD_FIRST_COLLECTION"
}PaymentAdequacyChangeType
An applied Payment Adequacy review that updated the recurring payment schedule.
Fields
| Name | Description |
|---|---|
appliedDate(DateTime) | When the Payment Adequacy review was applied. |
newPaymentAmount(Int) | New payment amount in minor currency after Payment Adequacy was applied. |
previousPaymentAmount(Int) | Previous payment amount in minor currency before Payment Adequacy was applied. |
Example
{
"appliedDate": "2020-01-01T00:00:00.000Z",
"previousPaymentAmount": 1,
"newPaymentAmount": 1
}PaymentAdequacyDetailsType
Payment adequacy adjusts fixed payment schedules to maintain a healthy ledger balance over a year.
Fields
| Name | Description |
|---|---|
isCurrentlyExempt(Boolean) | This ledger will be exempt from default Payment Adequacy. This may mean that it is completely exempt, or handled with special rules. |
latestAppliedPaymentAdequacyChange(PaymentAdequacyChangeType) | The most recent Payment Adequacy review that has been applied to this ledger, or null if no review has been applied. |
Example
{
"isCurrentlyExempt": true,
"latestAppliedPaymentAdequacyChange": PaymentAdequacyChangeType
}Fields
| Name | Description |
|---|---|
fingerprint(String) | Fingerprint. |
isFound(Boolean) | Returns True if the fingerprint exists, False otherwise. |
isRiskListed(Boolean) | Returns True if the fingerprint is risk-listed, False otherwise. |
Example
{
"fingerprint": "abc123",
"isFound": true,
"isRiskListed": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentForecastConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentForecastConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentForecastConnectionTypeEdge
A Relay edge containing a PaymentForecastConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentForecastType) | The item at the end of the edge |
Example
{
"node": PaymentForecastType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amount(Int) | |
date(Date) | |
method(ScheduleType) | The payment method used for the forecasted payment. |
paymentNumber(Int) |
Example
{
"paymentNumber": 1,
"date": "2020-01-01",
"amount": 1,
"method": "BACS_TRANSFER"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentInstructionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentInstructionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentInstructionConnectionTypeEdge
A Relay edge containing a PaymentInstructionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentInstructionType) | The item at the end of the edge |
Example
{
"node": PaymentInstructionType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
accountUser(AccountUserType) | The account user who is an owner of this payment instruction. |
business(BusinessType) | The business who is an owner of this payment instruction. |
Example
{
"accountUser": AccountUserType,
"business": BusinessType
}PaymentInstructionType
Payment Instructions
Fields
| Name | Description |
|---|---|
accountHolder(String!) | |
accountType(String) | |
bankCode(String) | |
cardExpiryMonth(Int) | |
cardExpiryYear(Int) | |
cardNumber(String!) | |
cardPaymentNetwork(String) | |
cardType(String) | |
iban(String!) | |
id(ID!) | |
instructionType(String!) | |
maskedAccountIdentifier(String) | A masked reference to a recurring payment method. |
owners([PaymentInstructionOwnerType]) | The owners of the financial account this instruction represents. |
sortCode(String!) | |
status(String!) | |
supplementaryLedger(SupplementaryLedgerType) | The supplementary ledger for this payment instruction. |
validFrom(DateTime!) | |
vendor(String!) |
Example
{
"id": "abc123",
"status": "abc123",
"sortCode": "abc123",
"iban": "abc123",
"accountHolder": "abc123",
"instructionType": "abc123",
"cardPaymentNetwork": "abc123",
"cardExpiryMonth": 1,
"cardExpiryYear": 1,
"supplementaryLedger": SupplementaryLedgerType,
"bankCode": "abc123",
"accountType": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"vendor": "abc123",
"cardNumber": "abc123",
"cardType": "abc123",
"maskedAccountIdentifier": "abc123",
"owners": [PaymentInstructionOwnerType]
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentPlanConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentPlanConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentPlanConnectionTypeEdge
A Relay edge containing a PaymentPlanConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentPlanType) | The item at the end of the edge |
Example
{
"node": PaymentPlanType,
"cursor": "abc123"
}PaymentPlanPaymentType
An object that represents a planned payment for a payment plan.
Example
{
"payableDate": "2020-01-01",
"amount": 1,
"paymentType": "abc123"
}PaymentPlanType
An object that represents a payment plan.
Fields
| Name | Description |
|---|---|
acceptedAt(DateTime) | |
account(TelcoAccountType!) | |
id(ID!) | |
initialScheduleType(String!) | |
ledgerNumber(String) | The ledger number for this payment plan or None if one does not exist. |
nextPayment(PaymentPlanPaymentType) | The next planned payment for this payment plan. |
offerExpiresAt(DateTime) | |
offeredAt(DateTime) | |
payments([PaymentPlanPaymentType!]!) | |
status(String!) | |
strategyDisplayName(String) | The display name of the strategy used for this payment plan or None if one does not exist. |
strategyName(String!) | |
updatedAt(DateTime!) |
Example
{
"id": "abc123",
"account": TelcoAccountType,
"initialScheduleType": "abc123",
"strategyName": "abc123",
"status": "abc123",
"offeredAt": "2020-01-01T00:00:00.000Z",
"offerExpiresAt": "2020-01-01T00:00:00.000Z",
"acceptedAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"payments": PaymentPlanPaymentType,
"nextPayment": PaymentPlanPaymentType,
"strategyDisplayName": "abc123",
"ledgerNumber": "abc123"
}PaymentPreferenceConnectionTypeConnection
Pagination object for PaymentPreferenceUnion
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentPreferenceConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentPreferenceConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentPreferenceConnectionTypeEdge
A Relay edge containing a PaymentPreferenceConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentPreferenceUnion) | The item at the end of the edge |
Example
{
"node": PreferredInstruction,
"cursor": "abc123"
}PaymentRequestConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentRequestConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentRequestConnectionTypeEdge
A Relay edge containing a PaymentRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentRequestType) | The item at the end of the edge |
Example
{
"node": PaymentRequestType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
customerAmount(Int) | The amount the customer is expected to pay in minor currency. |
expectedPaymentDate(Date) | The date the payment is expected to be made. |
fundingSourceAmounts(FundingSourceAmountConnectionTypeConnection) | The amount that was funded by each funding source. |
paymentStatus(String) | The status of the payment. |
totalAmount(Int) | The total amount of the payment in minor currency. |
Example
{
"expectedPaymentDate": "2020-01-01",
"paymentStatus": "abc123",
"totalAmount": 1,
"customerAmount": 1,
"fundingSourceAmounts": FundingSourceAmountConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
paymentRequest(PaymentRequestConnectionTypeConnection) | A list of payment requests for a given ledger. |
Example
{
"paymentRequest": PaymentRequestConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentScheduleConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentScheduleConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentScheduleConnectionTypeEdge
A Relay edge containing a PaymentScheduleConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentScheduleType) | The item at the end of the edge |
Example
{
"node": PaymentScheduleType,
"cursor": "abc123"
}PaymentScheduleDataType
Payment schedule details for a join supplier process.
This type represents the chosen payment schedule configuration. Only one of the schedule type fields will be populated, depending on which type of schedule was chosen.
Fields
| Name | Description |
|---|---|
balanceTriggered(BalanceTriggeredScheduleType) | Balance-triggered payment schedule details, if this schedule type was chosen. |
billTriggered(BillTriggeredScheduleType) | Bill-triggered payment schedule details, if this schedule type was chosen. |
billTriggeredBalanceTarget(BillTriggeredBalanceTargetScheduleType) | Bill-triggered with balance target schedule details, if this schedule type was chosen. |
regular(RegularScheduleType) | Regular payment schedule details, if this schedule type was chosen. |
Example
{
"regular": RegularScheduleType,
"billTriggered": BillTriggeredScheduleType,
"balanceTriggered": BalanceTriggeredScheduleType,
"billTriggeredBalanceTarget": BillTriggeredBalanceTargetScheduleType
}Fields
| Name | Description |
|---|---|
args(JSONString) | The arguments of the delay configuration. |
code(String) | The code of the delay configuration. |
Example
{
"code": "abc123",
"args": {"key": "value"}
}Fields
| Name | Description |
|---|---|
description(String) | A human-readable description of the value. |
direction(PaymentDayDirectionType) | Direction of payment day. |
Example
{
"direction": "OF_MONTH",
"description": "abc123"
}PaymentScheduleType
An object that represents when we have agreed to take payments from a payment instruction.
Fields
| Name | Description |
|---|---|
delayConfiguration(PaymentScheduleDelayConfigurationType) | The delay configuration for this payment schedule. |
id(ID!) | |
isExemptFromPaymentAdequacy(Boolean) | If the payment schedule is exempt from payment adequacy. |
isPaymentHoliday(Boolean) | |
isVariablePaymentAmount(Boolean!) | |
ledgerNumber(String) | The ledger number of the payment schedule. |
paymentAdequacyAdjustment(Int) | |
paymentAdequacyAdjustmentExpiryDate(Date) | |
paymentAmount(Int!) | |
paymentDay(Int) | |
paymentDayDetails(PaymentSchedulePaymentDayDetailsType) | Details of the payment_day value. |
paymentFrequency(PaymentFrequencyOptions) | The frequency of the payment schedule. |
paymentFrequencyMultiplier(Int!) | |
paymentHolidayReason(String!) | |
reason(PaymentScheduleReasonOptions) | The reason the payment schedule was created. |
scheduleType(ScheduleType) | The method of payment for the schedule. Deprecated The 'scheduleType' field is deprecated. |
supplementaryLedger(SupplementaryLedgerType) | The supplementary ledger for this payment schedule, if it is on one. |
totalDebtAmount(Int) | The sum of the payment adequacy contributions on the payment schedule that are expected to be taken before the debt repayment is complete. |
trigger(ScheduleTrigger) | The cause for requesting payment on a schedule. |
validFrom(Date!) | |
validTo(Date) |
Example
{
"id": "abc123",
"supplementaryLedger": SupplementaryLedgerType,
"validFrom": "2020-01-01",
"validTo": "2020-01-01",
"reason": "GENERAL_ACCOUNT_PAYMENT",
"paymentHolidayReason": "abc123",
"paymentDay": 1,
"paymentFrequency": "Weekly",
"paymentFrequencyMultiplier": 1,
"paymentAmount": 1,
"paymentAdequacyAdjustment": 1,
"paymentAdequacyAdjustmentExpiryDate": "2020-01-01",
"isVariablePaymentAmount": true,
"totalDebtAmount": 1,
"isPaymentHoliday": true,
"scheduleType": "BACS_TRANSFER",
"paymentDayDetails": PaymentSchedulePaymentDayDetailsType,
"delayConfiguration": PaymentScheduleDelayConfigurationType,
"isExemptFromPaymentAdequacy": true,
"ledgerNumber": "abc123",
"trigger": "PLAN"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentWithNonConcludedRePresentationConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentWithNonConcludedRePresentationConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentWithNonConcludedRePresentationConnectionTypeEdge
A Relay edge containing a PaymentWithNonConcludedRePresentationConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentWithNonConcludedRePresentationType) | The item at the end of the edge |
Example
{
"node": PaymentWithNonConcludedRePresentationType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amountPayable(Int) | The amount expected for this payment in minor currency units. |
payableDate(Date) | The date this payment is scheduled to be debited. |
Example
{
"amountPayable": 1,
"payableDate": "2020-01-01"
}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 |
|---|---|
payoutResult(PayoutReferralForAccountResultType) | The result of the payout. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}PayoutReferralForAccountResultType
The result of the payout of a referral for an account.
Fields
| Name | Description |
|---|---|
accountCreditAmount(Int) | The amount of the account credit paid out to the referring account. |
Example
{
"accountCreditAmount": 1
}Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
attachments(BillingAttachmentConnectionTypeConnection) | |
billType(BillTypeEnum) | The type of the bill. |
closingBalance(Int!) | The closing balance of an issued billing document. Arguments
When provided, the closing balance for this ledger on this statement. Required if multiple ledgers are affected by this statement. |
documentDebtPosition(BillingDocumentPositionType) | Position of the billing document in the delinquent debt tracking system. |
fromDate(Date) | The date of the constituent bill covered from. |
id(ID) | The ID of the constituent bill. |
identifier(ID) | 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. |
isAnnulled(Boolean!) | Whether the billing document has been annulled. |
issuedDate(Date) | The date the bill was sent to the customer. |
openingBalance(Int) | This field returns the opening balance of a statement. Arguments
When provided, the opening balance for this ledger on this statement. Required if multiple ledgers are affected by this statement. |
printedCopyRequests([Date]) | List of dates when a printed copy of this bill was requested. |
representations(BillRepresentationConnectionTypeConnection) | |
reversalsAfterClose(StatementReversalsAfterClose!) | How many charges have been reversed after the close date. |
temporaryUrl(String) | 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. |
toDate(Date) | The date of the constituent bill covered to. |
totalCharges(StatementTotalType) | The total amounts for all charges on the billing document. |
totalCredits(StatementTotalType) | The total amounts for all credits on the statement. |
transactions(BillTransactionConnectionTypeConnection) | Transactions on the given billing document. Arguments
When provided, only entries that are linked to that ledger are returned.
The order in which to return the transactions.
Include only these specific transaction types in the result. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"identifier": "abc123",
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"isAnnulled": true,
"transactions": BillTransactionConnectionTypeConnection,
"openingBalance": 1,
"closingBalance": 1,
"documentDebtPosition": BillingDocumentPositionType,
"representations": BillRepresentationConnectionTypeConnection,
"printedCopyRequests": ["2020-01-01"]
}Fields
| Name | Description |
|---|---|
accountAllMatches(AccountConnectionTypeConnection!) | All accounts that are linked to this phone number. A maximum of 26 results are returned. Results are ordered by most likely first. |
accountBestMatch(TelcoAccountType) | Our best guess for which account a call with this phone number would be about. |
accountUserAllMatches(AccountUserConnectionTypeConnection!) | All account users that are linked to this phone number. A maximum of 26 results are returned. Results are ordered by most likely first. |
accountUserBestMatch(AccountUserType) | Our best guess for which account user would be calling from this phone number. |
Example
{
"accountBestMatch": TelcoAccountType,
"accountAllMatches": AccountConnectionTypeConnection,
"accountUserBestMatch": AccountUserType,
"accountUserAllMatches": AccountUserConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
buttonAction(ActionType!) | The action to perform when the button is pressed. |
buttonStyle(ButtonStyle) | The button style. |
id(ID) | Unique identifier of the object. |
title(String!) | Title text of the button. |
typename(String) | The name of the object's type. |
Example
{
"buttonStyle": "PRIMARY",
"title": "abc123",
"buttonAction": DeeplinkActionType,
"id": "abc123",
"typename": "abc123"
}Fields
| Name | Description |
|---|---|
isBlocked(Boolean) | Whether the viewer has been blocked due to spending all its allowed points. |
limit(Int) | The maximum number of points the viewer gets for requests per hour. |
remainingPoints(Int) | The remaining points for the viewer in one hour time limit. |
ttl(Int) | Time To Live: UNIX timestamp when the viewer will get a new allowance of points. |
usedPoints(Int) | The points used so far in one hour time limit. |
Example
{
"limit": 1,
"remainingPoints": 1,
"usedPoints": 1,
"ttl": 1,
"isBlocked": true
}PointsSizeType
A measurement in points.
Fields
| Name | Description |
|---|---|
id(ID) | Unique identifier of the object. |
points(Int!) | The points value. |
typename(String) | The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"points": 1
}PortfolioConnectionTypeConnection
Paginator of Operations Team
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PortfolioConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PortfolioConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PortfolioConnectionTypeEdge
A Relay edge containing a PortfolioConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PortfolioType) | The item at the end of the edge |
Example
{
"node": PortfolioType,
"cursor": "abc123"
}PortfolioType
An object that represents a portfolio.
Fields
| Name | Description |
|---|---|
accounts(AccountConnectionTypeConnection) | The accounts associated with this portfolio. |
ancestors(PortfolioConnectionTypeConnection) | The ancestors of the given portfolio. |
billingName(String) | |
brand(String) | The brand code associated with the portfolio. |
collectiveBilling(Boolean!) | |
createdAt(DateTime!) | |
depth(Int) | The depth of the portfolio in the hierarchy. |
descendants(PortfolioConnectionTypeConnection) | The descendants of the given portfolio. |
id(ID!) | |
leadAccountNumber(String) | The lead account for this portfolio. |
name(String) | The name of the portfolio. |
number(String!) | |
operationsTeam(OperationsTeamType) | Operations team for this portfolio. |
parent(PortfolioType) | The parent portfolio of the given portfolio, if any. |
updatedAt(DateTime!) |
Example
{
"id": "abc123",
"number": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"billingName": "abc123",
"collectiveBilling": true,
"leadAccountNumber": "abc123",
"brand": "abc123",
"name": "abc123",
"depth": 1,
"parent": PortfolioType,
"ancestors": PortfolioConnectionTypeConnection,
"descendants": PortfolioConnectionTypeConnection,
"accounts": AccountConnectionTypeConnection
}PortfolioUserRoleType
The role a user has in association with one portfolio.
Fields
| Name | Description |
|---|---|
id(ID!) | |
portfolio(PortfolioType!) | Portfolio object. |
role(RoleString) | The portfolio role. |
user(AccountUserType!) |
Example
{
"id": "abc123",
"user": AccountUserType,
"role": RoleString,
"portfolio": PortfolioType
}PossibleErrorType
The GraphQL error type for displaying information about GraphQL errors that might be raised from the API.
Fields
| Name | Description |
|---|---|
code(String) | The error code that might be returned from the query/mutation. |
description(String) | The error description that might be returned from the query/mutation. |
message(String) | The error message that might be returned from the query/mutation. |
type(String) | The error type that might be returned from the query/mutation. |
Example
{
"message": "abc123",
"code": "abc123",
"type": "abc123",
"description": "abc123"
}PossibleErrorsOutputType
Information and possible errors of the requested query/mutation.
Fields
| Name | Description |
|---|---|
authErrors(Boolean) | Whether the possible authentication errors are included. |
name(String) | Name of the query/mutation whose possible errors are returned. |
possibleErrors([PossibleErrorType]) | List of the errors the query/mutation is susceptible of raising. |
type(query_type) | Type of the query (query or mutation). |
Example
{
"name": "abc123",
"type": "query",
"authErrors": true,
"possibleErrors": [PossibleErrorType]
}PostCredit
The possible errors that can be raised are:
- KT-CT-5316: Invalid data.
- KT-CT-5311: The credit reason with the requested code is deprecated.
- KT-CT-5312: The credit reason with the requested code does not exist.
- KT-CT-5313: An error occurred whilst posting the credit.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
credit(Credit) | Posted account credit. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"credit": Credit
}Fields
| Name | Description |
|---|---|
attachments(BillingAttachmentConnectionTypeConnection) | |
billType(BillTypeEnum) | The type of the bill. |
fromDate(Date) | The date of the bill is covered from. |
grossAmount(BigInt) | The gross amount of the historical bill. |
id(ID) | The ID of the bill. |
identifier(String) | The unique identifier of a historical bill. It will usually be present on the billing document itself. |
issuedDate(Date) | The date the bill was sent to the customer. |
params(JSONString) | The params associated with the historical bill. |
reversalsAfterClose(StatementReversalsAfterClose!) | How many charges have been reversed after the close date. |
temporaryUrl(String) | 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. |
toDate(Date) | The date of the bill is covered to. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"identifier": "abc123",
"params": {"key": "value"},
"grossAmount": 1
}PreSignedToken
A pre-signed, expiring and opaque tokens that can be swapped for a limited scope JWT (Kraken Token).
Fields
| Name | Description |
|---|---|
isValid(Boolean) | |
key(String!) | |
scope(ExpiringTokenScope!) | The scope that the token will grant to the account user. |
Example
{
"key": "abc123",
"scope": "SUBMIT_METER_READINGS",
"isValid": true
}PreferredInstruction
Represents the preference of the user to be charged using a specific payment instruction.
Fields
| Name | Description |
|---|---|
forPaymentsAfter(String) | The start time of the payment preference. |
paymentMethod(PaymentInstructionType) | The payment instruction preferred by the user. |
status(String) | The status of the payment preference. |
Example
{
"forPaymentsAfter": "abc123",
"status": "abc123",
"paymentMethod": PaymentInstructionType
}Fields
| Name | Description |
|---|---|
accountNumber(String) | The account number of the newly created account or the existing account to be re-used. |
isNewAccount(Boolean) | Was a new account created. |
isNewUser(Boolean) | Was a new user created. |
userId(ID) | The ID of the newly created or existing account user. |
userNumber(String) | The user number of the newly created or existing account user. |
Example
{
"isNewAccount": true,
"accountNumber": "abc123",
"isNewUser": true,
"userId": "abc123",
"userNumber": "abc123"
}PriceForStream
Rate group prices for a product.
Fields
| Name | Description |
|---|---|
characteristicMapping(JSONString!) | The characteristic mapping for the price. |
price(Decimal!) | The price per unit. |
schemeLabels(JSONString) | The scheme labels for the price. |
Example
{
"characteristicMapping": {"key": "value"},
"schemeLabels": {"key": "value"},
"price": "1.0"
}Fields
| Name | Description |
|---|---|
amount(Decimal!) | |
unit(Unit) | 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 |
|---|---|
filename(String!) | |
id(ID!) | |
s3Bucket(String!) | |
s3Key(String!) | |
temporaryUrl(String) | Temporary URL at which the attachment is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). |
Example
{
"id": "abc123",
"filename": "abc123",
"s3Bucket": "abc123",
"s3Key": "abc123",
"temporaryUrl": "abc123"
}PrintBatchType
Represents print batch details
Fields
| Name | Description |
|---|---|
id(ID!) | |
messages(PrintMessageTypeConnection) | Messages in a print batch. |
status(PrintBatchStatus) | The status of the print batch. |
Example
{
"id": "abc123",
"status": "OPEN",
"messages": PrintMessageTypeConnection
}Fields
| Name | Description |
|---|---|
eventType(String!) | |
id(ID!) | The ID of the object |
message(PrintMessageType) | Print message of the print event. |
occurredAt(DateTime!) |
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": PrintMessageType
}PrintMessageType
Represents a print communication.
Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | |
attachments([PrintAttachmentType]) | Attachments of the message. |
highPriority(Boolean) | Comms that are marked as high priority. |
id(ID!) | The ID of the object |
templateCode(String!) |
Example
{
"id": "abc123",
"templateCode": "abc123",
"account": TelcoAccountType,
"attachments": [PrintAttachmentType],
"highPriority": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PrintMessageTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PrintMessageTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PrintMessageTypeEdge
A Relay edge containing a PrintMessageType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PrintMessageType) | The item at the end of the edge |
Example
{
"node": PrintMessageType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
description(NonEmptyString) | The description of the term. |
displayName(NonEmptyString) | The display name of the term. |
identifier(NonEmptyString) | The identifier of the term. |
isVariable(Boolean) | Whether the term is variable. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}ProductComponentType
Represents a product component within an offering.
Fields
| Name | Description |
|---|---|
component(CatalogProductType!) | The product associated with this component. |
identifier(ID!) | Unique identifier of the component. |
initialQuantity(Int!) | Initial/default quantity for this component. |
maximumQuantity(Int!) | Maximum quantity of this component that can be selected. |
minimumQuantity(Int!) | Minimum quantity of this component that can be selected. |
Example
{
"identifier": "abc123",
"minimumQuantity": 1,
"maximumQuantity": 1,
"initialQuantity": 1
}ProductMinimumCommitmentLengthInstanceType
Represents a single product's minimum commitment length within a contract term.
Fields
| Name | Description |
|---|---|
length(Int) | The minimum commitment length. |
productCode(NonEmptyString) | The product code. |
unitOfTime(String) | The unit of time for the commitment length. |
Example
{
"productCode": NonEmptyString,
"length": 1,
"unitOfTime": "abc123"
}ProductMinimumCommitmentLengthType
Represents a product minimum commitment length term in a contract.
Fields
| Name | Description |
|---|---|
description(NonEmptyString) | The description of the term. |
displayName(NonEmptyString) | The display name of the term. |
identifier(NonEmptyString) | The identifier of the term. |
isVariable(Boolean) | Whether the term is variable. |
productInstances([ProductMinimumCommitmentLengthInstanceType!]) | The product commitment length instances for this term. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true,
"productInstances": [ProductMinimumCommitmentLengthInstanceType]
}ProductOfferingPrice
Singular price/discount (one or many) applicable to a product offering.
To find the price for a product offering see pseudo code:
INITIAL PRICE:
total = sum(
pop.price.value
for pop in product_offering_prices
if pop.priceType in [RECURRING, DISCOUNT, SETUP] and now() in pop.validFor
)
MONTHLY RECURRING PRICE:
total = sum(
pop.price.value
for pop in product_offering_prices
if pop.priceType in [RECURRING, DISCOUNT]
and pop.recurringChargePeriodType == MONTH
and now() in pop.validFor
)
EARLY TERMINATION:
pop = next(
pop
for pop in product_offering_prices
if pop.priceType == EARLY_TERMINATION_PENALTY and now() in pop.validFor
)
match pop.recurringChargePeriodType:
case ONE_TIME:
total = pop.price.value
case MONTH:
total = months_remaining() * pop.price.value
case YEAR:
total = years_remaining() * pop.price.value
Inspired by TMF schema see: https://github.com/tmforum-rand/schemas/blob/candidates/Product/ProductOfferingPrice.schema.json
Fields
| Name | Description |
|---|---|
description(String!) | Description of the productOfferingPrice. |
name(String!) | Name of the productOfferingPrice. |
percentage(Decimal) | Percentage to apply for ProductOfferPriceAlteration if price represents a percentage discount, eg: '-0.20' for 20% off. |
price(Money) | The amount of money that characterizes the price. |
priceType(PriceType!) | A category that describes the price. |
recurringChargePeriodType(RecurringChargePeriodType!) | The period to repeat the application of the price, eg: once per period (month/year/...). |
tax([TaxItem!]!) | An amount of money levied on the price of a Product by a legislative body. |
validFor(TimePeriod!) | The period for which the productOfferingPrice is valid. |
variant([CharacteristicVariant]) | Variation of characteristics that this price relates to. |
Example
{
"name": "abc123",
"description": "abc123",
"validFor": TimePeriod,
"priceType": "RECURRING",
"recurringChargePeriodType": "ONE_TIME",
"price": Money,
"percentage": "1.0",
"tax": TaxItem,
"variant": [CharacteristicVariant]
}Fields
| Name | Description |
|---|---|
code(String) | The code for the tag. |
displayName(String) | The display name for the tag. |
Example
{
"displayName": "abc123",
"code": "abc123"
}ProgressTelcoFaultTroubleshootingStep
Progress a telco fault troubleshooting session by executing a specific step.
The possible errors that can be raised are:
- KT-CT-10943: Invalid input for progressing troubleshooting step.
- KT-CT-10944: Playbook configuration error.
- KT-CT-10945: Invalid step request.
- KT-CT-10946: Invalid session state.
- KT-CT-10953: Appointment slot not available.
- KT-CT-10951: External service error.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
nextRecommendedStep(TroubleshootingStepDefinitionType) | The next recommended step. |
otherNextSteps([TroubleshootingStepDefinitionType]) | Other possible next steps. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
sessionId(ID) | ID of the troubleshooting session. |
status(TroubleshootingSessionStatus) | Current status of the session. |
steps([TroubleshootingStepInstanceType]) | List of steps in the session. |
Example
{
"possibleErrors": [PossibleErrorType],
"sessionId": "abc123",
"status": "OPEN",
"steps": [TroubleshootingStepInstanceType],
"nextRecommendedStep": TroubleshootingStepDefinitionType,
"otherNextSteps": [TroubleshootingStepDefinitionType]
}Fields
| Name | Description |
|---|---|
additiveDiscounts([AdditiveDiscount]) | List of discounts with monetary amount. |
code(String) | Unique promotion code. |
description(String) | Marketing description for promotion. |
id(UUID) | The id of the promotion. |
multiplicativeDiscounts([MultiplicativeDiscount]) | List of discounts with percentage multiplier. |
priceWithVat(FinancialAmount) | The monthly price incl. VAT of the product if promotion applied. |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"code": "abc123",
"description": "abc123",
"additiveDiscounts": [AdditiveDiscount],
"multiplicativeDiscounts": [MultiplicativeDiscount],
"priceWithVat": FinancialAmount
}PropertyConnection
Paginated list of properties.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PropertyEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PropertyEdge,
"totalCount": 1,
"edgeCount": 1
}PropertyEdge
A Relay edge containing a Property and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PropertyInterface) | The item at the end of the edge |
Example
{
"node": PropertyInterface,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
administrativeArea(String) | Top-level administrative subdivision, e.g. US state, AU state/territory, NZ, region, IT region, JP prefecture.
|
asString(String) | 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. Arguments
Whether to include the country. The country will be spelled out in all-caps on the last line, as per Universal Postal Union standards.
Whether to include the name attached to this address.
Whether to include the postal code attached to this address. |
country(String) | ISO 3166-1 alpha-2 code of the country this address belongs
to, e.g. |
deliveryPointIdentifier(String) | 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. |
dependentLocality(String) | UK dependent localities, or neighbourhoods or boroughs in some other locations. |
locality(String) | City or town portion of an address, e.g. US city, AU suburb/town, NZ suburb and city/town, IT comune, UK post town. |
name(String) | A personal name. |
organization(String) | The name of a business or organisation. |
postalCode(String) | Postal code (ZIP code in the US). |
sortingCode(String) | Sorting code, e.g. FR CEDEX code. This field is not used in many countries. |
streetAddress(String) | 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 |
structuredStreetAddress(GenericScalar) | The 'street address' component, in a structured format. This field stores the same value as The exact structure of this value depends on the country of the address, which is not necessarily the same as the country this Kraken is configured to serve. For addresses outside of the countries listed below, this field will be left blank.
|
Example
{
"name": "abc123",
"organization": "abc123",
"streetAddress": "abc123",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "abc123",
"locality": "abc123",
"administrativeArea": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"country": "abc123",
"deliveryPointIdentifier": "abc123",
"asString": "abc123"
}Fields
| Name | Description |
|---|---|
property(PropertyType!) | The matched property. |
score(Decimal!) | A score representing the degree of confidence for a match. |
Example
{
"score": "1.0",
"property": PropertyType
}PropertyType
Represents a property. Conceptually, it collects supply points under an address.
Fields
| Name | Description |
|---|---|
address(String) | The address of the property, formatted into a single string. |
ancestors(PropertyConnection) | Ancestor properties in the specified hierarchy, ordered from root to immediate parent. Returns empty list if the property is not in the hierarchy. |
coordinates(CoordinatesType) | Coordinates for the property, useful for displaying the property on a map. |
descendants(PropertyConnection) | Descendant properties in the specified hierarchy. Returns empty list if the property is not in the hierarchy. |
embeddedNetwork(EmbeddedNetworkType) | The embedded network this property belongs to, if any. |
id(String) | |
label(String) | An optional label for the property. |
measurements(MeasurementConnection) | Measurements at a property Arguments
Defaults to the far future which will return the most recent readings.
Latest date to return measurements for (inclusive).
Defaults to the far past which will return the oldest readings.
Earliest date to return measurements from.
Timezone to use for grouping. Defaults to Kraken localtime.
Filters for each utility being measured. |
occupancyPeriods([OccupancyPeriodType]) | 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. |
parent(PropertyInterface) | The parent property in the specified hierarchy. Returns null if the property has no parent or is not in the hierarchy. Arguments
The name of the hierarchy to query within. |
postcode(String!) | |
richAddress(PropertyRichAddressType) | Property rich address. |
splitAddress([String]) | List of address lines. |
Example
{
"id": "abc123",
"postcode": "abc123",
"label": "abc123",
"address": "abc123",
"richAddress": PropertyRichAddressType,
"splitAddress": ["abc123"],
"occupancyPeriods": [OccupancyPeriodType],
"coordinates": CoordinatesType,
"embeddedNetwork": EmbeddedNetworkType,
"parent": PropertyInterface,
"descendants": PropertyConnection,
"ancestors": PropertyConnection,
"measurements": MeasurementConnection
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ProvisionalTransactionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ProvisionalTransactionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ProvisionalTransactionConnectionTypeEdge
A Relay edge containing a ProvisionalTransactionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ProvisionalTransactionType) | The item at the end of the edge |
Example
{
"node": ProvisionalTransactionType,
"cursor": "abc123"
}ProvisionalTransactionType
A provisional transaction represents some debit or credit to or from a customer's account which we cannot yet finalise for some reason, but which is still useful to keep a note of, and display to the customer. Provisional transactions are purely to give guidance in the absence of finalised information. We therefore only return provisional transactions that have not been finalised. When a transaction is finalised, it is available through the transactions field.
Fields
| Name | Description |
|---|---|
amount(Int) | The amount in pence for this provisional transaction. It will be negative for charges, positive for credits. |
date(Date) | The date at which the charge should be applied to the account. |
id(ID!) | |
title(String) | A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"title": "abc123",
"amount": 1,
"date": "2020-01-01"
}PublishApprovalApprovedEvent
The possible errors that can be raised are:
- KT-CT-14501: Invalid event parameters.
- KT-CT-14502: Invalid input.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
eventId(ID) | The ID of the created approval approved event. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"eventId": "abc123"
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
trigger(Trigger) | The trigger that has been published. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
trigger(Trigger) | The trigger that has been published. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
voucherPurchase(VoucherPurchaseType) | 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 |
|---|---|
application(NotifiableApplicationType!) | |
expiresAt(DateTime!) | |
id(ID!) | |
messages(PrintMessageTypeConnection!) | |
registeredAt(DateTime!) | |
token(String!) | |
user(AccountUserType!) |
Example
{
"id": "abc123",
"messages": PrintMessageTypeConnection,
"user": AccountUserType,
"token": "abc123",
"application": NotifiableApplicationType,
"registeredAt": "2020-01-01T00:00:00.000Z",
"expiresAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
eventType(String!) | |
id(ID!) | The ID of the object |
message(PushNotificationMessageType) | Push notification message of the push notification event. |
occurredAt(DateTime!) |
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": PushNotificationMessageType
}PushNotificationMessageType
Represents a push notification communication.
Fields
| Name | Description |
|---|---|
createdAt(DateTime!) | The date and time the push notification was created. |
id(ID!) | The ID of the push notification. |
sentAt(DateTime) | The date and time the push notification was sent. |
supportSiteUrl(String) | URL to view the push notification in the support site. |
templateCode(String!) | The trigger type code of the push notification. |
textBody(String) | The body text of the push notification. |
title(String!) | The title of the push notification. |
Example
{
"id": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"sentAt": "2020-01-01T00:00:00.000Z",
"templateCode": "abc123",
"title": "abc123",
"textBody": "abc123",
"supportSiteUrl": "abc123"
}QuantityType
Graphene type object to represent Quantity(magnitude, unit)
Fields
| Name | Description |
|---|---|
magnitude(Float!) | The numeric value of this field. |
unit(String!) | Unit of this field. |
Example
{
"magnitude": 1.0,
"unit": "abc123"
}Fields
| Name | Description |
|---|---|
complexityValue(Int) | The complexity of the query. |
Example
{
"complexityValue": 1
}Fields
| Name | Description |
|---|---|
costs([QuoteCostType]) | The cost for quoting this product. |
createdAt(DateTime) | The date and time when the quote component was created. |
identifier(ID) | Identifier of the Quote. |
productComponentIdentifier(ID) | Identifier of the Product Component. |
quotingParamsInputData([QuotingParamType]) | The input data used for quoting this product component. |
termsAndConditionsS3Urls([TermsAndConditionsS3UrlType]) | S3 URLs for terms and conditions linked to this quote component. Arguments
Expiration time for S3 URLs in seconds. Defaults to 1 hour (3600 seconds). |
Example
{
"identifier": "abc123",
"productComponentIdentifier": "abc123",
"costs": [QuoteCostType],
"quotingParamsInputData": [QuotingParamType],
"createdAt": "2020-01-01T00:00:00.000Z",
"termsAndConditionsS3Urls": [TermsAndConditionsS3UrlType]
}Fields
| Name | Description |
|---|---|
key(String!) | Name of the cost field. |
value(QuoteCostUnionType) | Value of the cost field. |
Example
{
"key": "abc123",
"value": DecimalType
}Fields
| Name | Description |
|---|---|
createdAt(DateTime) | The date and time when the quote was created. |
createdBy(ActorType) | The Actor who created the Quote. |
identifier(ID) | Identifier of the Quote. |
productOfferingIdentifier(ID) | The product offering identifier this Quote is related to. |
quoteComponents([QuoteComponentType]) | Quote components of this quote. |
Example
{
"identifier": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"productOfferingIdentifier": "abc123",
"quoteComponents": [QuoteComponentType],
"createdBy": ActorType
}Fields
| Name | Description |
|---|---|
code(String) | Characteristic code. |
defaultValue(String) | Default value for characteristic. |
description(String) | Customer facing description for characteristic. |
name(String) | Customer facing name for characteristic. |
selectedValue(String) | Selected characteristic value if within selected offering. |
unit(String) | Unit of value eg: 'Mbps'. |
valueOptions([String]) | List of only possible values if provided. |
Example
{
"code": "abc123",
"name": "abc123",
"description": "abc123",
"unit": "abc123",
"valueOptions": ["abc123"],
"defaultValue": "abc123",
"selectedValue": "abc123"
}Fields
| Name | Description |
|---|---|
description(String) | Customer-facing description for the group. |
maximumCardinality(Int) | Maximum number of components that can be selected from this group. |
minimumCardinality(Int) | Minimum number of components that must be selected from this group. |
name(String) | Customer-facing name for the group. |
offeringComponents([QuotedCatalogGroupComponent]) | Offering components within this group. |
productComponents([QuotedCatalogGroupComponent]) | Product components within this group. |
Example
{
"name": "abc123",
"description": "abc123",
"minimumCardinality": 1,
"maximumCardinality": 1,
"productComponents": [QuotedCatalogGroupComponent],
"offeringComponents": [QuotedCatalogGroupComponent]
}Fields
| Name | Description |
|---|---|
identifier(String) | Identifier of the product or offering within this group. |
Example
{
"identifier": "abc123"
}Fields
| Name | Description |
|---|---|
allSubOfferings([QuotedCatalogSubOffering]) | Quoted offerings within offering and sub-offerings. |
code(String) | Unique code for quoted offering. |
description(String) | Customer facing description for offering. |
groups([QuotedCatalogGroup]) | Groups of components with cardinality constraints. |
identifier(String) | Unique identifier for quoted offering version used for offering selection. |
isSelected(Boolean) | Whether the quoted offering is selected on the quote. No more than one quoted offering can be selected on a quote. |
name(String) | Customer facing name for offering. |
offeringTags([OfferingTag]) | The tags associated with this offering. |
quotedCatalogProducts([QuotedCatalogProduct]) | Quoted products within offering and sub-offerings. |
quotedCatalogTerms([QuotedCatalogTerm]) | Quoted terms within offering. |
quotedOfferingCatalogProducts([QuotedCatalogProduct]) | Quoted products directly within offering. |
subOfferings([QuotedCatalogOffering]) | Quoted offerings directly within offering. |
Example
{
"identifier": "abc123",
"code": "abc123",
"name": "abc123",
"description": "abc123",
"quotedCatalogTerms": [QuotedCatalogTerm],
"quotedOfferingCatalogProducts": [QuotedCatalogProduct],
"isSelected": true,
"offeringTags": [OfferingTag],
"groups": [QuotedCatalogGroup],
"subOfferings": [QuotedCatalogOffering],
"allSubOfferings": [QuotedCatalogSubOffering],
"quotedCatalogProducts": [QuotedCatalogProduct]
}Fields
| Name | Description |
|---|---|
availableInstallTypes([InstallationType]) | List of available installation types for this product. |
characteristics([QuotedCatalogCharacteristic]) | List of characteristics for product. |
description(String) | Customer facing description for product. |
identifier(String) | Unique identifier for quoted catalog product used for product selection. |
initialQuantity(Int) | Initial quantity selected for product within range [minimumquantity ... maximumquantity]. |
installType(InstallationType) | Deprecated. The type of installation. |
maximumQuantity(Int) | Maximum quantity that can be selected for product. |
minimumQuantity(Int) | Minimum quantity that can be selected for product. |
name(String) | Customer facing name for product. |
prices([ProductOfferingPrice!]!) | Prices (one or many) applicable to a product offering. |
requiresInstallation(Boolean) | Deprecated. Does the product require installation. |
selectedQuantity(Int) | Selected quantity for product on quote if within selected offering. |
tags([ProductTag]) | Tags associated with the product. |
Example
{
"identifier": "abc123",
"name": "abc123",
"description": "abc123",
"characteristics": [QuotedCatalogCharacteristic],
"minimumQuantity": 1,
"maximumQuantity": 1,
"initialQuantity": 1,
"selectedQuantity": 1,
"prices": ProductOfferingPrice,
"tags": [ProductTag],
"requiresInstallation": true,
"installType": "LINE_INSTALLATION",
"availableInstallTypes": "LINE_INSTALLATION"
}Fields
| Name | Description |
|---|---|
code(String) | Unique code for quoted offering. |
description(String) | Customer facing description for offering. |
groups([QuotedCatalogGroup]) | Groups of components with cardinality constraints. |
identifier(String) | Unique identifier for quoted offering version used for offering selection. |
initialQuantity(Int) | Initial quantity selected for offering within range [minimumquantity ... maximumquantity]. |
isSelected(Boolean) | Whether the quoted offering is selected on the quote. No more than one quoted offering can be selected on a quote. |
maximumQuantity(Int) | Maximum quantity that can be selected for offering. |
minimumQuantity(Int) | Minimum quantity that can be selected for offering. |
name(String) | Customer facing name for offering. |
offeringTags([OfferingTag]) | The tags associated with this offering. |
parentOfferingIdentifier(String) | Parent offering identifier. |
quotedCatalogTerms([QuotedCatalogTerm]) | Quoted terms within offering. |
quotedOfferingCatalogProducts([QuotedCatalogProduct]) | Quoted products directly within offering. |
Example
{
"identifier": "abc123",
"code": "abc123",
"name": "abc123",
"description": "abc123",
"quotedCatalogTerms": [QuotedCatalogTerm],
"quotedOfferingCatalogProducts": [QuotedCatalogProduct],
"isSelected": true,
"offeringTags": [OfferingTag],
"groups": [QuotedCatalogGroup],
"minimumQuantity": 1,
"maximumQuantity": 1,
"initialQuantity": 1,
"parentOfferingIdentifier": "abc123"
}Fields
| Name | Description |
|---|---|
description(String) | Customer facing description for term. |
name(String) | Customer facing name for term. |
termData(JSONString) | Data belonging to term type eg: {'length': 18, 'unitoftime': 'MONTH'}. |
termType(String) | Type of term eg: 'MINIMUMCONTRACTLENGTH'. |
Example
{
"name": "abc123",
"description": "abc123",
"termType": "abc123",
"termData": {"key": "value"}
}Fields
| Name | Description |
|---|---|
offeringComponents([QuotedOfferingParamsType]) | Quoting components of this quote. |
offeringIdentifier(ID) | Product offering identifier. |
productComponents([QuotedProductComponentType]) | Product component data including its quoting parameters. |
Example
{
"offeringIdentifier": "abc123",
"productComponents": [QuotedProductComponentType],
"offeringComponents": [QuotedOfferingParamsType]
}Fields
| Name | Description |
|---|---|
productCode(ID) | Product code. |
quotingParams([QuotingParamType]) | Quoting parameter definitions for this product. |
Example
{
"productCode": "abc123",
"quotingParams": [QuotingParamType]
}QuotedTelcoProductOutputType
Output type for selected product and extras from quoted products.
Fields
| Name | Description |
|---|---|
product(QuotedTelcoProductType) | The selected product from quote. |
productExtras([TelcoProductExtrasType]) | The selected product extras. |
quotingCode(String) | The code of the quote created. |
Example
{
"quotingCode": "abc123",
"product": QuotedTelcoProductType,
"productExtras": [TelcoProductExtrasType]
}QuotedTelcoProductType
Type for selected product from quoted products.
Fields
| Name | Description |
|---|---|
code(String) | The code of the product. |
description(String) | The description of the product. |
discountAmount(FinancialAmount) | The amount discounted from the monthly price of the product with VAT. |
discountLengthInMonths(String) | The validity period of the discount in months. |
discountedPriceWithVat(FinancialAmount) | The amount a customer will pay once the discount has been applied. |
installationRequired(Boolean) | Whether this product requires installation. |
price(FinancialAmount) | The monthly price of the product. |
priceWithVat(FinancialAmount) | The monthly price of the product with VAT. |
promotions([Promotion]) | Promotions available for product. |
rollingPrice(FinancialAmount) | The rolling monthly price of the product. |
rollingPriceWithVat(FinancialAmount) | The rolling monthly price of the product with VAT. |
selected(Boolean) | If the product is selected. |
speeds(Speeds) | The network speeds associated with the product. |
tags([ProductTag]) | The tags associated with this product. |
term(String) | The term the product is available for. |
Example
{
"code": "abc123",
"description": "abc123",
"term": "abc123",
"price": FinancialAmount,
"rollingPrice": FinancialAmount,
"promotions": [Promotion],
"priceWithVat": FinancialAmount,
"rollingPriceWithVat": FinancialAmount,
"discountAmount": FinancialAmount,
"discountedPriceWithVat": FinancialAmount,
"discountLengthInMonths": "abc123",
"speeds": Speeds,
"selected": true,
"tags": [ProductTag],
"installationRequired": true
}Fields
| Name | Description |
|---|---|
choices([String]) | Choices of the quoting parameter if present. |
name(String) | Name of the quoting parameter. |
source(String) | Source of the quoting parameter. |
type(String) | Type of the quoting parameter. |
value(String) | Value of the quoting parameter. |
Example
{
"name": "abc123",
"type": "abc123",
"choices": ["abc123"],
"source": "abc123",
"value": "abc123"
}RateGroupPrices
Rate group prices for a product.
Fields
| Name | Description |
|---|---|
prices([PriceForStream!]!) | The prices for the rate group. |
rateGroup(String!) | The rate group code. |
Example
{
"rateGroup": "abc123"
}ReactivateCollectionProcessRecord
Reactivate a Collection Process Record that was previously activated.
Unlike UpdateCollectionProcessRecordToActive, this mutation does not require or update the externalreference field. Use this when reactivating a collection process that already has an externalreference 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 |
|---|---|
collectionProcessReactivated(ReactivateCollectionProcessRecordOutputType) | The reactivated collection process record. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}ReactivateCollectionProcessRecordOutputType
Output for reactivating a Collection process Record.
Fields
| Name | Description |
|---|---|
number(String) | The number of the collection process record. |
status(CollectionProcessRecordStatusTypes) | The current status of the collection process record. |
Example
{
"number": "abc123",
"status": "PENDING"
}Fields
| Name | Description |
|---|---|
intervalEnd(DateTime) | The exclusive end of this reading's interval. |
intervalStart(DateTime) | The inclusive start of this reading's interval. |
quality(String) | The quality of this reading if applicable. |
source(String) | The source of this reading if applicable. |
units(String) | This reading's units. |
value(Decimal) | The recorded value for this reading. |
Example
{
"value": "1.0",
"units": "abc123",
"intervalStart": "2020-01-01T00:00:00.000Z",
"intervalEnd": "2020-01-01T00:00:00.000Z",
"source": "abc123",
"quality": "abc123"
}Fields
| Name | Description |
|---|---|
exportReadings(ExportReadingsConnection) | Readings representing outgoing utility flow e.g., solar generation. |
importReadings(ImportReadingsConnection) | Readings representing incoming utility flow e.g., usage or consumption.. |
Example
{
"exportReadings": ExportReadingsConnection,
"importReadings": ImportReadingsConnection
}RebookFaultAppointment
Rebook an existing fault appointment to a new time slot.
Reserves a new appointment slot with the network provider (PXC). The trouble ticket is NOT updated by this mutation - that happens when the troubleshooting session progresses through REBOOK_APPOINTMENT.
The possible errors that can be raised are:
- KT-CT-10901: Invalid data.
- KT-CT-10952: Telco fault not found.
- KT-CT-4178: No account found with given account number.
- KT-CT-10953: Appointment slot not available.
- KT-CT-10954: Fault appointment not found.
- KT-CT-10955: Appointment rebook past cutoff.
- KT-CT-10956: Appointment is not rebookable.
- KT-CT-10973: Appointment rebook past start time.
- KT-CT-10957: Invalid appointment slot date.
- KT-CT-10975: Unable to rebook appointment due to network case status conflict.
- KT-CT-10951: External service error.
- KT-CT-10966: Current troubleshooting step cannot be interrupted due to its state.
- KT-CT-10967: Current troubleshooting step cannot be interrupted.
- KT-CT-10968: Troubleshooting session is temporarily locked by another process.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
appointment(FaultAppointment) | The rebooked fault appointment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"appointment": FaultAppointment
}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 |
|---|---|
isRecorded(Boolean) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"isRecorded": true
}RecordFailedPayment
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
- KT-CT-3985: Received both token and options for action intent.
- KT-CT-3986: Received neither token nor options for action intent.
- KT-CT-3987: Invalid payment method type code.
- KT-CT-3988: Number of items in list exceeds maximum value.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
noticeBatchIdentifier(String!) | The unique identifier of the notice batch created from the input. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"noticeBatchIdentifier": "abc123"
}RecordPendingPayment
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
- KT-CT-3985: Received both token and options for action intent.
- KT-CT-3986: Received neither token nor options for action intent.
- KT-CT-3987: Invalid payment method type code.
- KT-CT-3988: Number of items in list exceeds maximum value.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
noticeBatchIdentifier(String!) | The unique identifier of the notice batch created from the input. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"noticeBatchIdentifier": "abc123"
}RecordSuccessfulPayment
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-1609: The provided datetime ISO string is not timezone aware, please provide timezone information.
- KT-CT-3985: Received both token and options for action intent.
- KT-CT-3986: Received neither token nor options for action intent.
- KT-CT-3987: Invalid payment method type code.
- KT-CT-3988: Number of items in list exceeds maximum value.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
noticeBatchIdentifier(String!) | The unique identifier of the notice batch created from the input. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"noticeBatchIdentifier": "abc123"
}Fields
| Name | Description |
|---|---|
buttonAction(ActionType!) | The action to perform when the button is pressed. |
buttonStyle(ButtonStyle) | The button style. |
id(ID) | Unique identifier of the object. |
title(String!) | Title text of the button. |
typename(String) | The name of the object's type. |
variant(ButtonVariance) | Colour style of button eg. filled, outlined, text_only. |
Example
{
"buttonStyle": "PRIMARY",
"title": "abc123",
"buttonAction": DeeplinkActionType,
"id": "abc123",
"typename": "abc123",
"variant": "FILLED"
}RedeemLoyaltyPointsForAccountCredit
Redeem Loyalty Points as account credit.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9201: No Loyalty Point ledger found for the user.
- KT-CT-9202: Loyalty Points adapter not configured.
- KT-CT-9203: No ledger entries for the ledger.
- KT-CT-9205: Insufficient Loyalty Points.
- KT-CT-9206: Indivisible points.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9209: Negative Loyalty Points balance.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
pointsRedeemed(Int) | The number of loyalty points that were redeemed. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsRedeemed": 1
}RedeemReferralClaimCode
The possible errors that can be raised are:
- KT-CT-6723: Unauthorized.
- KT-CT-6724: Referral claim code not found.
- KT-CT-6725: Referral claim code redeeming error.
- KT-CT-6726: Referral claim code has already been redeemed.
- KT-CT-6727: Referral claim code is not available.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean!) | 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 |
|---|---|
accountReferral(ReferralType) | Account referral associated with the claim code. |
createdAt(DateTime) | Datetime when claim code was generated. |
id(Int) | Id of claim code instance. |
isValid(Boolean) | Whether the referral claim code is valid and available for use. |
referralScheme(ReferralSchemeType) | Referral scheme claim code belongs to. |
value(String) | Value of claim code. |
Example
{
"id": 1,
"value": "abc123",
"referralScheme": ReferralSchemeType,
"accountReferral": ReferralType,
"isValid": true,
"createdAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ReferralConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
referringUserTotalPaymentAmount(Int!) | Total payment amount given to the referring account in the smallest unit. of the client's currency. If you filter the referrals by |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ReferralConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1,
"referringUserTotalPaymentAmount": 1
}ReferralConnectionTypeEdge
A Relay edge containing a ReferralConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ReferralType) | The item at the end of the edge |
Example
{
"node": ReferralType,
"cursor": "abc123"
}ReferralSchemeType
A referral scheme is a way for one account to earn a reward for referring another. This is achieved by the referred account using a url (provided by the referring account) to sign up.
Fields
| Name | Description |
|---|---|
canBeReferred(Boolean) | Whether the current account is eligible to be referred under this scheme. |
code(String) | The unique code for the scheme. |
combinedRewardAmount(Int) | The reward amount received by the referrer and the referee combined. |
isUsageAtCapacity(Boolean) | True if the the scheme has limit of uses, and if the usage is at capacity. |
loyaltyPointsBonus(Int) | The number of loyalty points to be awarded to the referrer in addition to the reward amount. |
maxRecurrence(Int) | Max number of times this referral code can be credited to a given account. |
referralDisplayUrl(String) | A referral url for display purposes. |
referralUrl(String) | A fully qualified url give people to create accounts referred by this scheme. |
referredRewardAmount(Int) | The reward amount received by the referred party. |
referrerFamilyName(String) | The family name of the person making the referral. Deprecated The 'referrerFamilyName' field is deprecated. |
referrerGivenName(String) | The given name of the person making the referral. |
referrerRewardAmount(Int) | The reward amount received by the referrer. |
schemeType(String) | Scheme type of the referral scheme. |
Example
{
"referralUrl": "abc123",
"referralDisplayUrl": "abc123",
"referrerRewardAmount": 1,
"referredRewardAmount": 1,
"combinedRewardAmount": 1,
"loyaltyPointsBonus": 1,
"canBeReferred": true,
"code": "abc123",
"referrerGivenName": "abc123",
"referrerFamilyName": "abc123",
"schemeType": "abc123",
"maxRecurrence": 1,
"isUsageAtCapacity": true
}Fields
| Name | Description |
|---|---|
business(ReferralSchemeType) | A business scheme type. |
domestic(ReferralSchemeType) | A domestic scheme type. |
friendsAndFamily(ReferralSchemeType) | 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 |
|---|---|
code(String) | The referral code. |
combinedPaymentAmount(Int) | The payment amount in the smallest unit of the clients currency received by the referrer and the referee combined. |
id(ID!) | |
paymentDate(Date) | The date when the payment was made. |
paymentStatus(String) | The status of the payment. |
referredUserJoinDate(DateTime) | The date the referred user joined. |
referredUserName(String) | The name of the referred user. |
referredUserPaymentAmount(Int) | Payment amount given to the referred account in the smallest unit of the client's currency. |
referringUserPaymentAmount(Int) | Payment amount given to the referring account in the clients fractional currency unit. |
schemeType(ReferralSchemeTypeChoices) | The type of reward scheme. |
Example
{
"id": "abc123",
"paymentDate": "2020-01-01",
"schemeType": "REFERRAL_REWARD",
"code": "abc123",
"referredUserName": "abc123",
"paymentStatus": "abc123",
"referredUserJoinDate": "2020-01-01T00:00:00.000Z",
"referredUserPaymentAmount": 1,
"referringUserPaymentAmount": 1,
"combinedPaymentAmount": 1
}RefreshToken
An opaque token that can be used to renew a Kraken Token.
Fields
| Name | Description |
|---|---|
expiryDt(DateTime!) | The datetime when the token will expire. |
isValid(Boolean) | |
key(String!) |
Example
{
"key": "abc123",
"expiryDt": "2020-01-01T00:00:00.000Z",
"isValid": true
}Refund
A refund to the customer from the energy supplier.
Fields
| Name | Description |
|---|---|
accountNumber(String) | Unique identifier of the account the transaction belongs to. |
amount(Int) | Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
balanceCarriedForward(Int) | The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
billingDocumentIdentifier(ID) | 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. |
createdAt(DateTime) | The date time when the transaction is created. |
hasStatement(Boolean) | Returns True if the transaction is linked with a statement. |
id(ID) | Unique identifier for the transaction. |
isAccountCharge(Boolean) | Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
isAccountPayment(Boolean) | Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
isCredit(Boolean) | Deprecated. Deprecated The 'isCredit' field is deprecated. |
isHeld(Boolean) | 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. |
isIssued(Boolean) | 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. |
isReversed(Boolean!) | |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | Date when the transaction was posted to the account. |
reasonCode(String) | Returns the reason. |
statementId(ID) | Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
title(String) | Human-readable title describing the transaction. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123"
}RefundPayment
The possible errors that can be raised are:
- KT-CT-3924: Unauthorized.
- KT-CT-3928: Idempotency key used for another repayment request.
- KT-CT-3929: The payment is not in a refundable state.
- KT-CT-3933: Refund amount greater than payment amount.
- KT-CT-3937: Payment not eligible for refund.
- KT-CT-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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
repayment(AccountRepaymentType) | The repayment for the requested refund. |
Example
{
"possibleErrors": [PossibleErrorType],
"repayment": AccountRepaymentType
}Fields
| Name | Description |
|---|---|
amount(Int) | The amount of money requested. |
payment(AccountPaymentType) | The payment which is being refunded. |
reasonCode(String) | Internal code for the reason the refund is being requested. |
requestId(ID) | The ID of the refund request. |
status(RepaymentRequestStatus) | The current status of the refund request. |
Example
{
"requestId": "abc123",
"amount": 1,
"payment": AccountPaymentType,
"reasonCode": "abc123",
"status": "REQUESTED"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([RefundRequestConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": RefundRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}RefundRequestConnectionTypeEdge
A Relay edge containing a RefundRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(RefundPaymentRequestType) | The item at the end of the edge |
Example
{
"node": RefundPaymentRequestType,
"cursor": "abc123"
}RegenerateSecretKey
Regenerate the user's API key.
Fields
| Name | Description |
|---|---|
key(String!) | The generated key value, which is only ever available once (here). |
viewer(AccountUserType) | The currently authenticated user. |
Example
{
"key": "abc123",
"viewer": AccountUserType
}RegisterCustomerAsset
Register a new device for an account.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-14602: Customer asset already exists.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
customerAsset(CustomerAssetType) | The registered customer asset. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
pushNotificationBinding(PushNotificationBindingType) |
Example
{
"pushNotificationBinding": PushNotificationBindingType
}RegistersConnection
Pagination for device registers.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([RegistersEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": RegistersEdge,
"totalCount": 1,
"edgeCount": 1
}RegistersEdge
A Relay edge containing a Registers and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(DeviceRegister) | The item at the end of the edge |
Example
{
"node": DeviceRegister,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
frequency(String) | The base unit of frequency at which payments are to be taken. |
frequencyMultiplier(Int) | The multiple of the frequency at which payments are taken. |
paymentDay(Int) | The day of the month/week at which to take payment. |
Example
{
"paymentDay": 1,
"frequency": "abc123",
"frequencyMultiplier": 1
}Fields
| Name | Description |
|---|---|
assigneeId(ID) | The id of the user responsible for completing the reminder. |
assigneeTeamId(ID) | The id of the team responsible for completing the reminder. |
assigneeTeamName(String) | The name of the team responsible for completing the reminder. |
assigneeUsername(String) | The username of the user responsible for completing the reminder. |
content(String) | Reminder content. |
createdAt(DateTime) | The date and time the account reminder was created. |
dueAt(DateTime) | When the reminder is due. |
id(Int) | The unique ID of the reminder. |
isKrakenManaged(Boolean) | If the reminder is managed by Kraken. |
reminderTypeName(String) | The reminder type name. |
reopenInkConversation(Boolean) | Reopen ink conversation. |
Example
{
"id": 1,
"reminderTypeName": "abc123",
"isKrakenManaged": true,
"content": "abc123",
"dueAt": "2020-01-01T00:00:00.000Z",
"assigneeUsername": "abc123",
"assigneeId": "abc123",
"assigneeTeamName": "abc123",
"assigneeTeamId": "abc123",
"reopenInkConversation": true,
"createdAt": "2020-01-01T00:00:00.000Z"
}RemoveCampaignFromAccount
The possible errors that can be raised are:
- KT-CT-7424: Failed to remove campaign from account.
- KT-CT-7426: The account is not part of the given campaign.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
campaignRemoved(Boolean) | Whether the campaign was successfully removed from the account. |
possibleErrors([PossibleErrorType]) | 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-11506: Invalid campaign ID.
- KT-CT-11507: Invalid campaign item ID.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
campaignItems([VoiceCampaignItemType]) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
riskIdentifiers([RiskListItemType]) | List of successfully removed risk identifiers. |
Example
{
"possibleErrors": [PossibleErrorType]
}RemovePropertyFromHierarchy
Remove a property from a hierarchy.
This operation is idempotent - if the property is not in the hierarchy, it will succeed without error. When a property is removed, its descendants are reparented to the removed property's parent. If removing a root node, its children become new root nodes.
The possible errors that can be raised are:
- KT-CT-6622: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
property(PropertyType) | The property that was removed from the hierarchy. |
Example
{
"possibleErrors": [PossibleErrorType],
"property": PropertyType
}Fields
| Name | Description |
|---|---|
acceptedAt(DateTime) | When the quote request was accepted. |
code(String) | Quote request code. |
createdAt(DateTime) | When the quote request was created. |
quoteId(ID) | Quote request ID. |
validFrom(DateTime) | When the agreement is valid from. |
validTo(DateTime) | When the agreement is valid to. |
Example
{
"quoteId": "abc123",
"code": "abc123",
"acceptedAt": "2020-01-01T00:00:00.000Z",
"createdAt": "2020-01-01T00:00:00.000Z",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
outcome(String) | The repayment intervention outcome. |
reason(String) | The repayment intervention reason. |
Example
{
"outcome": "abc123",
"reason": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([RepaymentRequestConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": RepaymentRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}RepaymentRequestConnectionTypeEdge
A Relay edge containing a RepaymentRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(RepaymentRequestType) | The item at the end of the edge |
Example
{
"node": RepaymentRequestType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amount(Int) | The amount of money requested. |
instruction(PaymentInstructionType) | The payment instruction, if any, associated with the repayment request. |
method(RepaymentMethod) | The method by which the money will be transferred to the customer. |
reasonCode(String) | Classifier code for repayment reason. |
requestId(String) | The ID of the repayment request. |
status(RepaymentRequestStatus) | The current status of the repayment request. |
Example
{
"requestId": "abc123",
"amount": 1,
"reasonCode": "abc123",
"method": "BANK_TRANSFER",
"instruction": PaymentInstructionType,
"status": "REQUESTED"
}RequestDoubleOptIn
Request a double opt in for a consent.
This mutation will create a consent with a value of PENDING and publish a double opt-in requested transactional messaging trigger.
The possible errors that can be raised are:
- KT-CT-9019: Invalid input.
- KT-CT-9018: Account not found.
- KT-CT-1111: Unauthorized.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-9023: Consent already accepted.
- KT-CT-1199: Too many requests.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
consent(ConsentType) | The consent that was created or updated. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}Fields
| Name | Description |
|---|---|
email(String) | The email that requested a password reset email. |
userNumber(String) | The number of the user that requested a password reset email. |
Example
{
"email": "abc123",
"userNumber": "abc123"
}RequestPrintedBill
Request an issued bill to be printed and (re)posted to billing address of the account.
The possible errors that can be raised are:
- KT-CT-3824: Unauthorized.
- KT-CT-9705: The billing document has not been issued.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean) | Whether the request was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}Fields
| Name | Description |
|---|---|
canRequestRefund(Boolean!) | Whether the account can request a refund. |
reason(String) | The reason why a refund cannot be requested. |
Example
{
"canRequestRefund": true,
"reason": "abc123"
}RequestRepaymentOutputType
Output for creating a repayment request.
Fields
| Name | Description |
|---|---|
requestId(String) | The ID of the repayment request. |
status(RepaymentRequestStatus) | The current status of the repayment request. |
Example
{
"requestId": "abc123",
"status": "REQUESTED"
}Fields
| Name | Description |
|---|---|
clientMutationId(String) | |
errors([SerializerFieldErrorsType]) |
Example
{
"errors": [SerializerFieldErrorsType],
"clientMutationId": "abc123"
}Fields
| Name | Description |
|---|---|
failureCodes([String]) | A list of codes of which password validation the new password failed against if applicable.
One of:
- Deprecated The 'failureCodes' field is deprecated. |
failureReasons([String]) | A list of messages of which password validations the new password failed against if applicable. Deprecated The 'failureReasons' field is deprecated. |
passwordUpdated(Boolean) | True if the password update was successful, false otherwise. Deprecated The 'passwordUpdated' field is deprecated. |
userId(ID!) | The ID of the user whose password was changed. |
Example
{
"userId": "abc123",
"passwordUpdated": true,
"failureReasons": ["abc123"],
"failureCodes": ["abc123"]
}Fields
| Name | Description |
|---|---|
alternativeSwitchOrders([AlternativeSwitchOrdersType]) | Alternative switch options. |
implicationsSent([ImplicationCommunicationType]) | Specifies how the implications of switching have been sent to the customer. |
matchResult(MatchResultType) | Primary match result as requested by the gaining provider. |
Example
{
"implicationsSent": [ImplicationCommunicationType],
"matchResult": MatchResultType,
"alternativeSwitchOrders": [AlternativeSwitchOrdersType]
}Fields
| Name | Description |
|---|---|
faultCode(String) | A code defining the nature of the fault found processing the match request. |
faultText(String) | A human-readable description of the fault code. |
Example
{
"faultCode": "abc123",
"faultText": "abc123"
}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 |
|---|---|
collectionProcessResumed(ResumeCollectionProcessOutput) | Collection process resume output. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
pauseRecords([CollectionProcessPauseStatusRecord]) | Pause records on the collection process. |
Example
{
}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(TelcoAccountType) | Account responsible for the revoked agreement. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": TelcoAccountType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
code(String) | The referral code. |
id(ID!) | |
paymentDate(Date) | The date when the payment was made. |
paymentStatus(ReferralStatusChoices) | The status of the reward payment. |
rewardAmount(Int) | Reward amount given to the account in the smallest unit of the clients currency. |
schemeType(ReferralSchemeTypeChoices) | The type of reward scheme. |
Example
{
"id": "abc123",
"paymentDate": "2020-01-01",
"schemeType": "REFERRAL_REWARD",
"code": "abc123",
"rewardAmount": 1,
"paymentStatus": "Pending"
}RichAddressType
A postal address.
This data model is based on the structure used by Google's libaddressinput library—so you can use it, or other libraries that use its data model and reference data, to accept input.
All fields can be blank, except for country which must
always be supplied.
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 |
|---|---|
administrativeArea(String) | Top-level administrative subdivision, e.g. US state, AU state/territory, NZ, region, IT region, JP prefecture.
|
asString(String) | 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. Arguments
Whether to include the country. The country will be spelled out in all-caps on the last line, as per Universal Postal Union standards.
Whether to include the name attached to this address.
Whether to include the postal code attached to this address. |
country(String) | ISO 3166-1 alpha-2 code of the country this address belongs
to, e.g. |
deliveryPointIdentifier(String) | 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. |
dependentLocality(String) | UK dependent localities, or neighbourhoods or boroughs in some other locations. |
locality(String) | City or town portion of an address, e.g. US city, AU suburb/town, NZ suburb and city/town, IT comune, UK post town. |
name(String) | A personal name. |
organization(String) | The name of a business or organisation. |
postalCode(String) | Postal code (ZIP code in the US). |
sortingCode(String) | Sorting code, e.g. FR CEDEX code. This field is not used in many countries. |
streetAddress(String) | 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 |
structuredStreetAddress(GenericScalar) | The 'street address' component, in a structured format. This field stores the same value as The exact structure of this value depends on the country of the address, which is not necessarily the same as the country this Kraken is configured to serve. For addresses outside of the countries listed below, this field will be left blank.
|
Example
{
"name": "abc123",
"organization": "abc123",
"streetAddress": "abc123",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "abc123",
"locality": "abc123",
"administrativeArea": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"country": "abc123",
"deliveryPointIdentifier": "abc123",
"asString": "abc123"
}RiskListItemType
Represents the result of importing/removing risk identifiers into the risk list with detailed information.
Fields
| Name | Description |
|---|---|
riskIdentifierId(ID) | The unique identifier of the edited risk identifier. |
Example
{
"riskIdentifierId": "abc123"
}Fields
| Name | Description |
|---|---|
category(String!) | The category of the attribute (LANGUAGE, OPERATIONS_GROUP, SKILL). |
friendlyName(String!) | Human-readable name for the attribute. |
isActive(Boolean!) | Whether this attribute is currently active and can be used for routing. |
ref(String!) | The reference string used to identify this attribute (e.g., SKILL.ENERGY, LANGUAGE.ENGLISH). |
subcategory(String) | Optional subcategory (e.g., TEAM, LOCATION). |
Example
{
"ref": "abc123",
"category": "abc123",
"subcategory": "abc123",
"friendlyName": "abc123",
"isActive": true
}RunAgreementRollover
The possible errors that can be raised are:
- KT-CT-13705: Agreement rollover not found.
- KT-CT-13706: Agreement rollover has an invalid status for this operation.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
agreementRollover(AgreementRolloverType) | The executed agreement rollover. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"agreementRollover": AgreementRolloverType
}Fields
| Name | Description |
|---|---|
eventType(String!) | |
id(ID!) | The ID of the object |
message(SMSMessageType) | SMS message of the SMS event. |
occurredAt(DateTime!) |
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": SMSMessageType
}SMSMessageType
Represents a SMS communication.
Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | The account found. |
attachments([AttachmentType]) | Attachments of the message. |
id(ID!) | The ID of the SMS. |
recipient(String) | SMS recipient. |
sender(String) | SMS sender. |
sentAt(DateTime) | The date and time the SMS was sent. |
textBody(String) | SMS body. |
Example
{
"id": "abc123",
"sentAt": "2020-01-01T00:00:00.000Z",
"account": TelcoAccountType,
"sender": "abc123",
"recipient": "abc123",
"textBody": "abc123",
"attachments": [AttachmentType]
}SalesChannelType
A sales channel.
Fields
| Name | Description |
|---|---|
code(String) | The sales channel code. |
description(String) | The sales channel description. |
hierarchicalName(String) | The hierarchical name of the sales channel. |
name(String) | The name of the sales channel. |
Example
{
"name": "abc123",
"code": "abc123",
"description": "abc123",
"hierarchicalName": "abc123"
}Fields
| Name | Description |
|---|---|
code(String) | The code of this sales funnel. |
collections([Collection]) | The collections of this sales funnel. |
funnelType(FunnelTypeChoices) | The type of this sales funnel. |
name(String) | The name of this sales funnel. |
rules([SalesFunnelRule]) | The rules of this sales funnel. |
stages([SalesFunnelStage]) | The stages of this sales funnel, in order. |
status(FunnelStatusChoices) | The status of this sales funnel. |
uncollectedFields([FunnelField]) | Fields not associated with a collection. |
Example
{
"code": "abc123",
"name": "abc123",
"funnelType": "LEAD",
"status": "DRAFT"
}Fields
| Name | Description |
|---|---|
funnelCode(String!) | The code of the funnel. |
productOffering(OfferingType) | The product offering of the rule. |
productOfferingIdentifier(String!) | The identifier of the product offering of the rule. |
salesChannel(String!) | The code of the sales channel of the rule. |
Example
{
"funnelCode": "abc123",
"productOfferingIdentifier": "abc123",
"salesChannel": "abc123"
}Fields
| Name | Description |
|---|---|
code(String!) | The per-funnel unique code for this stage. |
name(String!) | The human-readable name for this stage. |
order(Int) | The order of the stage. |
Example
{
"code": "abc123",
"name": "abc123",
"order": 1
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean!) | Whether the message was scheduled successfully. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}Fields
| Name | Description |
|---|---|
action(String) | Whether the scheduled transaction is a 'charge' or a 'credit'. |
ancillaryData(JSONString) | Additional data that is consumed and associated with the scheduled transaction. |
displayNote(String) | Optional short note about the scheduled transaction for customer display. |
grossAmount(BigInt) | The gross amount of the scheduled transaction. |
internalNote(String) | Optional short note about the scheduled transaction for internal use. |
ledgerNumber(String) | The ledger the scheduled transaction is for. |
metadata(JSONString) | Any extra data that is associated with scheduled transaction. |
netAmount(BigInt) | The net amount of the scheduled transaction. |
postedAfter(DateTime) | The datetime after which the scheduled transaction can be added to the ledger. |
reason(String) | The reason why the scheduled transaction is added to the account. |
salesTaxAmount(BigInt) | The tax amount of the scheduled transaction. |
salesTaxRate(Decimal) | The tax rate of the scheduled transaction. |
Example
{
"action": "abc123",
"grossAmount": 1,
"netAmount": 1,
"salesTaxAmount": 1,
"salesTaxRate": "1.0",
"reason": "abc123",
"ancillaryData": {"key": "value"},
"metadata": {"key": "value"},
"internalNote": "abc123",
"displayNote": "abc123",
"postedAfter": "2020-01-01T00:00:00.000Z",
"ledgerNumber": "abc123"
}ScreenActionType
An action which calls another backend screen via its screen id.
Fields
| Name | Description |
|---|---|
allowBack(Boolean!) | Whether to allow returning to the original caller screen. |
id(ID) | Unique identifier of the object. |
params([BackendScreenParam]!) | Map of the parameters (key-value pairs) to pass to the next backend screen. |
screenId(String!) | The ID of the screen to navigate to. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"typeName": "abc123",
"screenId": "abc123",
"params": BackendScreenParam,
"allowBack": true
}SectionType
A section containing a list of cards or carousel items
Fields
| Name | Description |
|---|---|
content(SectionContent!) | The content of the section. |
id(ID) | Unique identifier of the object. |
order(Int!) | The order of the section. |
typename(String) | The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"content": CardComponentType,
"order": 1
}Fields
| Name | Description |
|---|---|
availableExtras([TelcoProductExtrasType]!) | Available extras for the chosen product. |
Example
{
"availableExtras": TelcoProductExtrasType
}Fields
| Name | Description |
|---|---|
promiseId(String) | Promise id for polling async results. |
result(SelectProductBaseOutput) | Data returned for sync or completed async results. |
Example
{
"promiseId": "abc123",
"result": SelectProductBaseOutput
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean!) | Whether we successfully marked the chosen quoted products as selected. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}Fields
| Name | Description |
|---|---|
installType(InstallationType) | The selected installation type. |
requiresInstallation(Boolean) | Whether the selected product requires installation. |
selectedOfferingIdentifier(String) | Identifier for selected offering on quote. |
Example
{
"selectedOfferingIdentifier": "abc123",
"requiresInstallation": true,
"installType": "LINE_INSTALLATION"
}Fields
| Name | Description |
|---|---|
promiseId(String) | Promise ID for incomplete async results. |
result(SelectTelcoOfferingBaseOutput) | Sync or completed async results. |
Example
{
"promiseId": "abc123",
"result": SelectTelcoOfferingBaseOutput
}Fields
| Name | Description |
|---|---|
promiseId(String) | The promise ID. |
result(QuotedTelcoProductOutputType) | The output type for selected product and extras from quoted products. |
Example
{
"promiseId": "abc123",
"result": QuotedTelcoProductOutputType
}Fields
| Name | Description |
|---|---|
code(String) | The selected product code. |
displayName(String) | The selected product display name. |
Example
{
"code": "abc123",
"displayName": "abc123"
}SendOfferQuoteSummary
Trigger the sending of an offer quote summary to all active account users.
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-12407: The offer group does not contain an accepted offer.
- KT-CT-5518: Account user not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean!) | Whether the triggering of the offer quote summary was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}SendOneTimeLoginEmail
The possible errors that can be raised are:
- KT-CT-4122: Invalid email.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
status(String) | The result of the operation. |
Example
{
"possibleErrors": [PossibleErrorType],
"status": "abc123"
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean!) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
verificationStatus(Boolean) | If the verification email was sent. |
Example
{
"possibleErrors": [PossibleErrorType],
"verificationStatus": true
}Example
{
"message": "abc123",
"code": "abc123"
}Fields
| Name | Description |
|---|---|
errors([ErrorTypeUnion!]) | |
field(String) |
Example
{
"field": "abc123",
"errors": SerializerErrorType
}Fields
| Name | Description |
|---|---|
identifier(String) | Value of the identifier. |
identifierType(String) | Nature of that identifier. |
Example
{
"identifierType": "abc123",
"identifier": "abc123"
}ServiceLocationType
Service location with an identifier and a location scheme.
Fields
| Name | Description |
|---|---|
identifier(String) | Service location identifier. |
scheme(LocationScheme) | Scheme of the service location. |
Example
{
"identifier": "abc123",
"scheme": "UPRN"
}ServiceType
Service details.
Fields
| Name | Description |
|---|---|
id(ID!) | |
serviceReference(String) | Unique identifier provided by the Service Provider. |
startedAt(DateTime) | When this service was started by a Service Provider |
suspendedAt(DateTime) | When this service was suspended by a Service Provider |
terminatedAt(DateTime) | When this service was terminated by a Service Provider |
type(String!) |
Example
{
"id": "abc123",
"serviceReference": "abc123",
"type": "abc123",
"startedAt": "2020-01-01T00:00:00.000Z",
"suspendedAt": "2020-01-01T00:00:00.000Z",
"terminatedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
serviceIdentifiers([ServiceIdentifierType]) | A list of name and value pairs to identify if an intra-network switch isfeasible. ServiceInformation: Human-readable text value useful to the customer clearly identifying the service instance. This could contain the product/speed, the install date, the install location etc. Example: 1GB, Installed 25th September 2022 (Garage) NetworkOperator: An identifier for the operator of the network on which the serviceis provided. DN: The UK formatted number is expressed in all digits without spaces. For example 01213339999 PartialDN: The UK formatted number is masked so only the final 2 digits are identifiable. CUPID: Where the requested action was |
serviceType(String) | An industry agreed name for the service to be switched.
|
switchAction(String) | Action the losing provider will take when the switch is performed. ServiceFound: The losing provider has found this service for the matched customer. ServiceNotFound: The losing provider has not found this service. ForcedCease: The losing provider has identified a service that was not requested to be ceased but will be automatically ceased if the switch is progressed with the services that have matched. OptionToCease: The losing provider has identified another service, NBICS or IAS, that can also be ceased within the switch but is not mandated to be ceased. ServiceWithAnotherRCP: Broadband and voice are provided over the same line butwith different CPs. (e.g. WLR with PostOffice and FTTC with Zen). ServiceWithAnotherCust: The losing provider has found this service, but it is recorded against a different customer/billing account. |
Example
{
"serviceType": "abc123",
"serviceIdentifiers": [ServiceIdentifierType],
"switchAction": "abc123"
}SetFraudRoleBasedOnCampaign
Mutation to set fraud role based on corresponding account campaign
The possible errors that can be raised are:
- KT-CT-7425: No campaign found with given name.
- KT-CT-10006: Account not found.
- KT-CT-7426: The account is not part of the given campaign.
- KT-CT-5461: Invalid role code.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
accountNumber(String!) | The account number with new role. |
campaignSlug(String!) | The campaign slug. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
roleCode(String) | The code of the new role. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountNumber": "abc123",
"campaignSlug": "abc123",
"roleCode": "abc123"
}SetLoyaltyPointsUser
Set the Loyalty Points user for the account.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-9214: Couldn't assign user loyalty points role.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
newLoyaltyPointsUserId(String) | ID of the new Loyalty Points user. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"newLoyaltyPointsUserId": "abc123"
}SetOpportunityOutcome
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
message(String) | Success message for now. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"message": "abc123"
}SetPaymentPreference
Choose how automatic payments will be collected.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3967: Payment method is not valid.
- KT-CT-3968: Preference cannot be set this soon.
- KT-CT-3969: Preferences must change on a specific day of the week for weekly schedules.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}SetSwitchOrderReferenceForQuote
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4626: No product selected for the given quote code.
- KT-GB-10601: Invalid switch order reference.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | 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-3979: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
paymentInstruction(DirectDebitInstructionType) | |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
paymentInstruction(DirectDebitInstructionType) | The created direct debit instruction. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
paymentInstruction(DirectDebitInstructionType) | The payment instruction that was created from stored details. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
share(GoodsQuoteShare) | Goods quote shared. |
Example
{
"possibleErrors": [PossibleErrorType],
"share": GoodsQuoteShare
}ShipmentType
Shipment details.
Fields
| Name | Description |
|---|---|
carrier(String) | |
createdAt(DateTime!) | |
deliveredAt(Date) | |
estimatedDeliveryDate(Date) | |
shippedAt(DateTime) | |
trackingCode(String) | |
trackingUrl(String) | |
updatedAt(DateTime!) | |
uuid(UUID!) | Public identifier for the shipment. |
Example
{
"uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"trackingUrl": "abc123",
"trackingCode": "abc123",
"carrier": "abc123",
"estimatedDeliveryDate": "2020-01-01",
"deliveredAt": "2020-01-01",
"shippedAt": "2020-01-01T00:00:00.000Z",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}ShowInputFieldErrorsActionType
An action that instructs the app to display validation errors on input fields.
Fields
| Name | Description |
|---|---|
errors([InputFieldErrorType]!) | List of field-level validation errors to display. |
id(ID) | Unique identifier of the object. |
screenId(String) | Optional ID of the form screen these errors apply to. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"screenId": "abc123",
"errors": InputFieldErrorType
}Fields
| Name | Description |
|---|---|
description(String!) | Description of the charge to be applied. |
gross(Int!) | Gross (inc tax) amount of the charge. |
net(Int!) | Net (exc tax) amount of the charge. |
Example
{
"gross": 1,
"net": 1,
"description": "abc123"
}Fields
| Name | Description |
|---|---|
circumstanceCode(String) | Code describing the circumstance. |
description(String!) | Description of the circumstance. |
Example
{
"circumstanceCode": "abc123",
"description": "abc123"
}SpecialCircumstanceRecordType
Any special circumstances that the user has notified us about, which may entitle them to some specialist services.
Fields
| Name | Description |
|---|---|
createdAt(DateTime) | The date and time the special circumstance record was created. |
id(ID) | |
internalCode(String) | |
summary(String) |
Example
{
"id": "abc123",
"summary": "abc123",
"internalCode": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z"
}SpecialCircumstancesType
Information about the special circumstances that relate to a user.
Fields
| Name | Description |
|---|---|
isSharingConsentGiven(Boolean) | 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. |
records([SpecialCircumstanceRecordUnion]) |
Example
{
"isSharingConsentGiven": true,
"records": SpecialCircumstanceRecordType
}Fields
| Name | Description |
|---|---|
advertised(Int) | The advertised speed in Mbps. |
averageDownload(Int) | The average download speed in Mbps. |
averageUpload(Int) | The average upload speed in Mbps. |
estimatedMaxDownload(Int) | The estimated maximum download speed in Mbps. |
estimatedMaxUpload(Int) | The estimated maximum upload speed in Mbps. |
estimatedMinDownload(Int) | The estimated minimum download speed in Mbps. |
estimatedMinUpload(Int) | The estimated minimum upload speed in Mbps. |
guaranteedDownload(Int) | The guaranteed download speed in Mbps. |
guaranteedUpload(Int) | The guaranteed upload speed in Mbps. |
maxDownload(Int) | The max download speed in Mbps. |
maxUpload(Int) | The max upload speed in Mbps. |
minDownload(Int) | The min download speed in Mbps. |
minUpload(Int) | The min upload speed in Mbps. |
quotedDownload(Int) | The quoted download speed in Mbps. |
quotedUpload(Int) | The quoted upload speed in Mbps. |
Example
{
"maxDownload": 1,
"minDownload": 1,
"averageDownload": 1,
"quotedDownload": 1,
"maxUpload": 1,
"minUpload": 1,
"averageUpload": 1,
"quotedUpload": 1,
"advertised": 1,
"guaranteedDownload": 1,
"guaranteedUpload": 1,
"estimatedMinUpload": 1,
"estimatedMaxUpload": 1,
"estimatedMinDownload": 1,
"estimatedMaxDownload": 1
}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 |
|---|---|
collectionProcessStarted(StartCollectionProcessOutput) | Details of collection process that has been started. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
accountNumber(String) | Account number associated to the collection process. |
number(String) | The number of the collection process record. |
Example
{
"number": "abc123",
"accountNumber": "abc123"
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
verificationProcess(VerificationProcess) | The newly created verification process. |
Example
{
"possibleErrors": [PossibleErrorType],
"verificationProcess": VerificationProcess
}StartOnSiteJobsAppointmentBookingSession
The possible errors that can be raised are:
- 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-13032: Request does not exist.
- KT-CT-13054: Appointment not found for rescheduling.
- KT-CT-13055: Appointment does not belong to the specified request.
- KT-CT-13056: Appointment cannot be rescheduled.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
appointmentBookingSessionId(UUID) | The Kraken booking ID for the appointment booking session. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"appointmentBookingSessionId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}StartTelcoFaultTroubleshootingSession
Start a telco fault troubleshooting session for a fault.
The possible errors that can be raised are:
- KT-CT-10901: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
telcoFaultTroubleshootingSession(TelcoFaultTroubleshootingSessionType) | The telco fault troubleshooting session that has been created. |
Example
{
"possibleErrors": [PossibleErrorType],
"telcoFaultTroubleshootingSession": TelcoFaultTroubleshootingSessionType
}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 |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([StatementBillingDocumentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": StatementBillingDocumentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}StatementBillingDocumentConnectionTypeEdge
A Relay edge containing a StatementBillingDocumentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(StatementBillingDocumentType) | The item at the end of the edge |
Example
{
"node": StatementBillingDocumentType,
"cursor": "abc123"
}StatementBillingDocumentType
A statement is a billing document that contains all entries on a ledger during a period of time. A customer can understand how their ledger's balance has changed by looking at each statement in series.
Fields
| Name | Description |
|---|---|
annulledBy(AnnulmentBillingDocumentType) | Billing document that annuls this statement. |
documentDebtPosition(BillingDocumentPositionType) | Position of the billing document in the delinquent debt tracking system. |
earliestChargeAt(DateTime) | The earliest charge date of the statement. |
endAt(DateTime!) | The end of the statement's period. |
firstIssuedAt(DateTime) | The date and time the statement was sent to the customer. |
id(Int) | ID for the statement billing document. |
identifier(String) | The unique reference of the statement that can be used for identifying the statement externally. |
latestChargeAt(DateTime) | The latest charge date of the statement. |
paymentDueDate(Date) | The date due for payment for the statement. |
pdfUrl(String) | URL to the PDF of the statement. |
startAt(DateTime!) | The start of the statement's period. |
totalCharges(StatementTotalType) | The total amounts for all charges on the statement. |
totalCredits(StatementTotalType) | The total amounts for all credits on the statement. |
transactions(BillTransactionConnectionTypeConnection) | Transactions on the statement Arguments
The order in which to return the transactions. |
Example
{
"id": 1,
"identifier": "abc123",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z",
"firstIssuedAt": "2020-01-01T00:00:00.000Z",
"earliestChargeAt": "2020-01-01T00:00:00.000Z",
"latestChargeAt": "2020-01-01T00:00:00.000Z",
"paymentDueDate": "2020-01-01",
"pdfUrl": "abc123",
"annulledBy": AnnulmentBillingDocumentType,
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"transactions": BillTransactionConnectionTypeConnection,
"documentDebtPosition": BillingDocumentPositionType
}Fields
| Name | Description |
|---|---|
grossTotal(Int) | The gross total amount for the statement (in minor currency units). |
netTotal(Int) | The net total amount for the statement (in minor currency units). |
taxTotal(Int) | The total amount of tax on the statement (in minor currency units). |
Example
{
"netTotal": 1,
"taxTotal": 1,
"grossTotal": 1
}Fields
| Name | Description |
|---|---|
attachments(BillingAttachmentConnectionTypeConnection) | |
billType(BillTypeEnum) | The type of the bill. |
closingBalance(Int) | This field returns the closing balance of an issued statement. |
consumptionEndDate(Date) | The last day of consumption that this statement includes. |
consumptionStartDate(Date) | The first day of consumption that this statement includes. |
fromDate(Date) | The date of the constituent bill covered from. |
heldStatus(HeldStatus) | Retrieve the held status of a account statement. |
id(ID) | The ID of the constituent bill. |
isExternalBill(Boolean) | Whether the bill originated in Kraken or externally. |
issuedDate(Date) | The date the bill was sent to the customer. |
openingBalance(Int) | This field returns the opening balance of a statement. |
paymentDueDate(Date) | The date the bill is due to be paid. |
reversalsAfterClose(StatementReversalsAfterClose!) | How many charges have been reversed after the close date. |
status(AccountStatementStatus) | Current status of the associated statement. |
temporaryUrl(String) | 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. |
toAddress(String) | Email recipient address. |
toDate(Date) | The date of the constituent bill covered to. |
totalCharges(StatementTotalType) | The total amounts for all charges on the statement. |
totalCredits(StatementTotalType) | The total amounts for all credits on the statement. |
transactions(TransactionConnectionTypeConnection) | Transactions on the bill. |
userId(Int) | Email recipient user ID. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"closingBalance": 1,
"openingBalance": 1,
"isExternalBill": true,
"transactions": TransactionConnectionTypeConnection,
"userId": 1,
"toAddress": "abc123",
"paymentDueDate": "2020-01-01",
"consumptionStartDate": "2020-01-01",
"consumptionEndDate": "2020-01-01",
"status": "OPEN",
"heldStatus": HeldStatus,
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType
}Fields
| Name | Description |
|---|---|
costExclTax(EstimatedMoneyType) | Monetary cost of the statistic (excluding tax), if applicable. |
costInclTax(EstimatedMoneyType) | Monetary cost of the statistic (including tax), if applicable. |
description(String) | Description of the statistic for the parent node. |
label(String) | Display label of the statistic for the parent node. |
type(ReadingStatisticTypeEnum) | The type of statistic being measured for the parent node. |
value(Decimal) | Consumption / generation value of the statistic, if applicable. |
Example
{
"type": "STANDING_CHARGE_COST",
"label": "abc123",
"description": "abc123",
"costExclTax": EstimatedMoneyType,
"costInclTax": EstimatedMoneyType,
"value": "1.0"
}Fields
| Name | Description |
|---|---|
createdAt(DateTime) | The date when the step was created. |
name(String) | The name of the step. |
nextTriggerAt(DateTime) | The next trigger date for the step. |
status(Status) | The status of the step. |
statusChangedAt(DateTime) | The date when the status changed. |
statusReason(String) | The reason for the step status. |
Example
{
"name": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"status": "SKIPPED",
"statusReason": "abc123",
"statusChangedAt": "2020-01-01T00:00:00.000Z",
"nextTriggerAt": "2020-01-01T00:00:00.000Z"
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
storedPaymentMethodDetailsReference(String) |
Example
{
"possibleErrors": [PossibleErrorType],
"storedPaymentMethodDetailsReference": "abc123"
}StorePaymentInstruction
Store a new payment instruction created through the embedded process.
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3979: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
paymentInstruction(PaymentInstructionType) | The stored payment instruction. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": PaymentInstructionType
}Fields
| Name | Description |
|---|---|
characteristic(CharacteristicType) | The product characteristic. |
stringValue(String!) | The string value of the characteristic. |
value(String) | A string representation of a characteristic value, for convenience. |
Example
{
"value": "abc123",
"characteristic": CharacteristicType,
"stringValue": "abc123"
}StringType
Graphene type object to represent string values
Fields
| Name | Description |
|---|---|
stringValue(String!) | Value of this field. |
Example
{
"stringValue": "abc123"
}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 |
|---|---|
customerFeedback(CustomerFeedbackType) | |
possibleErrors([PossibleErrorType]) | 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-3823: Unauthorized.
- KT-CT-3926: Unauthorized.
- KT-CT-3927: Invalid Amount.
- KT-CT-3928: Idempotency key used for another repayment request.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
repaymentRequest(RequestRepaymentOutputType) | 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 |
|---|---|
currentBalance(Int) | The current final balance of the ledger in pence. |
id(ID) | Deprecated The 'ledgerId' field is deprecated. |
ledgerType(String) | |
name(String) | The display name of the ledger. |
number(String) | The canonical name of the ledger. |
paymentAdequacy(PaymentAdequacyDetailsType) |
Example
{
"id": "abc123",
"name": "abc123",
"ledgerType": "abc123",
"number": "abc123",
"currentBalance": 1,
"paymentAdequacy": PaymentAdequacyDetailsType
}SupplyOrServiceCharge
Supporting information for a customer charge resulting from a supply or service agreement
Fields
| Name | Description |
|---|---|
agreements(AgreementConnection) | Agreements which were charged |
period(Period!) | The period that was charged. |
Example
{
"period": Period,
"agreements": AgreementConnection
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([SupplyPointConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": SupplyPointConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}SupplyPointConnectionTypeEdge
A Relay edge containing a SupplyPointConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(SupplyPointType) | The item at the end of the edge |
Example
{
"node": SupplyPointType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
externalIdentifier(String) | Supply point external identifier. |
marketName(String) | Supply point market name. |
requestedSupplyStartDate(Date) | Requested supply start date. |
selectedProduct(SelectedProductType) | The selected product information for this supply point or None if no product is selected. |
Example
{
"externalIdentifier": "abc123",
"marketName": "abc123",
"requestedSupplyStartDate": "2020-01-01",
"selectedProduct": SelectedProductType
}SupplyPointType
Represents a SupplyPoint.
Fields
| Name | Description |
|---|---|
devices(DevicesConnection) | Get list of devices under a supply point. |
externalIdentifier(String) | The external identifier of the supply point. |
id(ID!) | The ID of the supply point. |
marketName(String!) | The market this supply point belongs to. |
property(PropertyType) | The supply point's property. |
readings(Readings) | Get readings from a readable device e.g., a supply point, device, or register. Arguments
The exclusive end of the time period as an isoformatted string.
Get readings of only this type.
The inclusive start of the time period as an isoformatted string.
Time buckets to group readings into.
The timezone in which to return readings.
Optional filter to return readings only for specific list of units or unit (e.g., KILOWATTHOURS, METERSCUBED, LITER, etc.). |
Example
{
"id": "abc123",
"marketName": "abc123",
"externalIdentifier": "abc123",
"readings": Readings,
"property": PropertyType,
"devices": DevicesConnection
}SupplyProductTagType
A product tag.
Example
{
"code": "abc123",
"displayName": "abc123"
}SupplyProductType
GraphQL type for a supply product.
Fields
| Name | Description |
|---|---|
availabilityStatus(ProductAvailability) | The product availability status. |
availableFrom(DateTime) | The date and time the product is available from. |
availableTo(DateTime) | The date and time the product is available to. |
brandCode(String) | The brand code of the product. |
code(String) | The product code. |
description(String) | The product description. |
displayName(String) | The product description. |
endsAt(DateTime) | The date the product ends. |
fullName(String) | The product title. |
id(ID!) | |
isHidden(Boolean) | Whether the product is hidden. |
marketName(String) | The name of the market the product belongs to. |
notes(String) | The product notes. |
params(JSONString) | The product parameters. |
tags([SupplyProductTagType!]!) | Tags associated with the product. |
term(Int) | The product term in months. |
termsAndConditionsTypes([TermsAndConditionsType!]!) | Active terms and conditions for a market supply product. |
termsContractType(String) | The product contract type. |
Example
{
"id": "abc123",
"code": "abc123",
"fullName": "abc123",
"displayName": "abc123",
"description": "abc123",
"availableFrom": "2020-01-01T00:00:00.000Z",
"availableTo": "2020-01-01T00:00:00.000Z",
"term": 1,
"notes": "abc123",
"isHidden": true,
"endsAt": "2020-01-01T00:00:00.000Z",
"brandCode": "abc123",
"marketName": "abc123",
"availabilityStatus": "EVERYONE",
"termsContractType": "abc123",
"termsAndConditionsTypes": TermsAndConditionsType,
"params": {"key": "value"},
"tags": SupplyProductTagType
}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-3984: Could not delete conflicting future payment schedule.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
schedule(PaymentScheduleType!) | New payment schedule. |
Example
{
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}Fields
| Name | Description |
|---|---|
matchRequestStatus(String) | Status of the switch match request. PENDING: Switch Match request is yet to be sent to the losing provider. SENT: Switch Match request is sent to the losing provider. FAILED: Switch Match request delivery failed. |
messageDeliveryFailure(MessageDeliveryFailureType) | Message delivery failure to the destination. |
residentialSwitchMatchConfirmation(ResidentialSwitchMatchConfirmationType) | Switch match confirmation result. |
residentialSwitchMatchFailure(ResidentialSwitchMatchFailureType) | Switch match failure result. |
Example
{
"residentialSwitchMatchConfirmation": ResidentialSwitchMatchConfirmationType,
"residentialSwitchMatchFailure": ResidentialSwitchMatchFailureType,
"messageDeliveryFailure": MessageDeliveryFailureType,
"matchRequestStatus": "abc123"
}Fields
| Name | Description |
|---|---|
contractId(String) | The contract ID. |
expectedSwitchDate(Date) | The expected date for the product switch to occur. |
switchStatus(String) | The current status of the product switch. |
Example
{
"switchStatus": "abc123",
"contractId": "abc123",
"expectedSwitchDate": "2020-01-01"
}SwitchTelcoProduct
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4620: Badly formed hexadecimal UUID string.
- KT-CT-4623: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
switchProductRequest(SwitchProductType) | Details of the product switch request. |
Example
{
"possibleErrors": [PossibleErrorType],
"switchProductRequest": SwitchProductType
}Fields
| Name | Description |
|---|---|
customerAssistUrl(String) | URL for customer assistance. |
id(String) | Identity ID of the provider. |
isActive(Boolean) | Status of the provider. |
name(String) | Name describing the providers. |
salesAssistUrl(String) | URL for sales assistance. |
Example
{
"name": "abc123",
"id": "abc123",
"customerAssistUrl": "abc123",
"salesAssistUrl": "abc123",
"isActive": true
}TagType
Represents a tag used for classifying offerings and products.
Example
{
"code": "abc123",
"displayName": "abc123"
}Fields
| Name | Description |
|---|---|
error(String) | The error message if the task failed. |
result(JSONString) | The result of the task. |
status(TaskStatusEnum) | The status of the task. |
Example
{
"status": "STARTED",
"result": {"key": "value"},
"error": "abc123"
}TaxItem
Wrapper to describe tax breakdown of price.
Inspired by TMF schema see: https://github.com/tmforum-rand/schemas/blob/candidates/Customer/TaxItem.schema.json
Fields
| Name | Description |
|---|---|
taxAmount(Money!) | Amount of tax expressed in the given currency. |
taxCategory(TaxCategory!) | Tax category. |
taxRate(Decimal!) | Applied rate of the tax, eg: '0.20' for 20% added tax. |
Example
{
"taxAmount": Money,
"taxCategory": "VAT",
"taxRate": "1.0"
}Fields
| Name | Description |
|---|---|
id(ID!) | The ID of the operations team. |
name(String!) | The name of the operations team. |
ref(String!) | The team reference for routing (e.g., 'OPERATIONSGROUP.TEAM.TEAMA'). |
Example
{
"id": "abc123",
"name": "abc123",
"ref": "abc123"
}Fields
| Name | Description |
|---|---|
name(String!) | The name of the team group (e.g., 'GROUP_A'). |
ref(String!) | The team group reference for routing (e.g., 'OPERATIONSGROUP.GROUP.GROUPA'). |
Example
{
"name": "abc123",
"ref": "abc123"
}Fields
| Name | Description |
|---|---|
friendlyName(String!) | The human-readable location name (e.g., 'London'). |
ref(String!) | The location reference for routing (e.g., 'OPERATIONS_GROUP.LOCATION.London'). |
Example
{
"ref": "abc123",
"friendlyName": "abc123"
}Fields
| Name | Description |
|---|---|
accountType(AccountTypeChoices) | The type of account. |
activeContract(ContractType) | The active contract associated with the account. If no contract is active, returns the next pending contract. |
activeHardshipAgreements([HardshipAgreementType]) | List of active hardship agreements for the user when isinhardship is True. |
activeReferralSchemes(ReferralSchemeTypes) | The referral schemes currently active for this account. |
address(RichAddressType) | The billing address of this account, stored in the new libaddressinput-based format. Note that |
annualStatements(AnnualStatementConnectionTypeConnection) | Fetch annual statements for the account. |
applications(AccountApplicationConnectionTypeConnection) | Applications by this account to become our customer. More recent applications will be listed first. Arguments
The account application status. |
assistanceAgreements([AssistanceAgreementType]) | Assistance agreements for account. |
balance(Int!) | The current account balance. Arguments
If this variable is set to true, the balance will be calculated based on the sum of balances on all ledgers configured to contribute to this account's balance. Otherwise, only the main ledger's balance will be fetched (legacy behaviour). If you are unsure, set this value to true. |
bill(BillInterface) | Fetch a specific issued bill (invoice/statement) for the account. Arguments
The unique identifier of the bill.
The unique identifier of the bill. A pending billing document will not have an identifier yet. And not all finalized billing documents will have an identifier. Prefer using the id field unless advised by Kraken.
The number of the ledger for the bill. When provided, only the period- or item-based documentfor this account that is linked to that ledger is returned; pre-kraken, collective bills, and legacy bills are excluded. |
billingAddress(String) | The billing address of the account. |
billingAddressLine1(String) | |
billingAddressLine2(String) | |
billingAddressLine3(String) | |
billingAddressLine4(String) | |
billingAddressLine5(String) | |
billingAddressPostcode(String) | |
billingCountryCode(String) | |
billingDeliveryPointIdentifier(String) | |
billingDocument(TelcoStatementBillingDocumentType) | Fetch a specific issued bill (statement) for the account. |
billingEmail(String) | The billing email of the account. |
billingName(String) | The billing name of the account. |
billingOptions(BillingOptionsType) | Information about the account's billing cycle. |
billingSubName(String) | The billing sub name of the account. |
billingTriggerConfiguration(BillingTriggerConfiguration) | The active billing trigger configuration for the account. |
bills(BillConnectionTypeConnection) | Fetch issued bills (invoices/statements) for the account. Arguments
Optional date representing the beginning of the search results. This date value is inclusive.
Include bills without PDFs.
Include held statements within the results.
Include pre-Kraken / historical statements within the results.
Include open statements. This flag needs to be used along with includeBillsWithoutPDF=false otherwise results will prove unexpected.
Optional date representing the beginning of the search results based on issued date. This date value is inclusive.
Optional date representing the end of the search results based on issued date. This date value is exclusive.
The number of a ledger for the bill. When provided, only period- or item-based documents for this account that are linked to that ledger are returned; collective bills and legacy bills are excluded. Historic/pre-Kraken bills are unaffected by this filter and are included or excluded solely by includeHistoricStatements.
Only include bills emailed to the current user's email.
The order in which to return the bills.
Optional date representing the end of the search results. This date value is exclusive. |
brand(String) | The brand of the account. |
business(BusinessType) | Business info related to a business account. |
businessType(BusinessTypeOptions) | The company type of a business account. Deprecated The 'businessType' field is deprecated. |
campaigns([AccountCampaignType]) | The campaigns associated with an account. |
canModifyPayments(CanModifyPaymentsType) | Data about whether or not an account can modify their payments. |
canRequestRefund(Boolean) | Whether the account can request a credit refund. |
commsDeliveryPreference(CommsDeliveryPreference) | The method the account has specified they prefer we contact them. |
communicationDeliveryPreference(String) | Deprecated The 'communicationDeliveryPreference' field is deprecated. |
complaints(ComplaintConnectionTypeConnection) | The complaints associated with an account. |
consents([ConsentType!]!) | Consents linked to this account. |
contracts([Contract]) | Retrieve details about all current and future contracts for this account. |
contributionAgreements([ContributionAgreementType]) | Contribution agreements for account. |
createdAt(DateTime) | The datetime that the account was originally created. |
customerAssets([CustomerAssetType]) | Get customer assets for an account. |
debtCollectionProceedings([DebtCollectionProceedingType]) | Debt collection proceedings for account. |
directDebitInstructions(DirectDebitInstructionConnectionTypeConnection) | The direct debit instructions of the account Arguments
Filter the direct debit instructions by status |
documentAccessibility(DocumentAccessibilityChoices) | The document accessibility preference of the account. |
events(AccountEventConnectionTypeConnection) | The account events that were recorded for the account. Arguments
Filter the account events by their type.
|
fileAttachments([AccountFileAttachment]) | Files attached to this account. |
id(ID!) | |
isInHardship(Boolean) | True if there is an active Hardship Agreement for this account. False otherwise. |
latestQuote(CreateTelcoQuoteOutput) | Retrieve details of the latest quote for this account. |
ledgers([LedgerType]) | 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. |
marketSupplyAgreements(AgreementConnection) | Retrieve all market supply agreements under this account. Note that when |
maximumRefund(MaximumRefundType) | The maximum amount a customer is allowed to request as a refund and the reason why that's the maximum amount. Arguments
The ledger number to calculate maximum refund for. |
metadata([Metadata]) | Metadata associated with the account. |
notes([AccountNoteType]) | Notes for the account. |
number(String) | A code that uniquely identifies the account. |
overdueBalance(Int) | The current account overdue balance. |
paginatedFileAttachments(AccountFileAttachmentConnectionTypeConnection) | Files attached to this account. |
paginatedPaymentForecast(PaymentForecastConnectionTypeConnection) | Paginated payment forecasts for an account. Starts from today's date (inclusive). The interface supports Arguments
The end date to retrieve forecasts for. This end date is inclusive.
The ledger to return payment forecasts from. Defaults to the main ledger when no ID is passed.
The number of the ledger to return payment forecasts from. Defaults to the main ledger when no number is passed. |
paymentForecast([PaymentForecastType]) | A list displaying the payment forecast for an account. The list starts from today's date (inclusive). Deprecated The 'paymentForecast' field is deprecated. Arguments
The end date to retrieve forecasts for. This end date is inclusive.
The ledger to return payment forecasts from. Defaults to the main ledger when no ID is passed.
The number of the ledger to return payment forecasts from. Defaults to the main ledger when no number is passed. |
paymentMethods(PaymentInstructionConnectionTypeConnection) | The payment instructions of the account. Arguments
Filter the payment instructions by status. |
paymentPlans(PaymentPlanConnectionTypeConnection) | The payment plans that have been created for this account. |
paymentSchedules(PaymentScheduleConnectionTypeConnection) | The schedules that describe how we would expect to take payments for an account on a given month. Arguments
If false, we remove the currently valid schedule if it has already fulfilled its purpose and will have no further impact on customer payments, along with any schedules which are not valid from today.
The ledger id to return the payment schedules from.
The ledger number to return the payment schedules from.
The ledger to return transactions from.
|
payments(AccountPaymentConnectionTypeConnection) | The payments made into an account from a payment instruction. Arguments
Whether to include payment promises (of any kind: made, broken or fulfilled) or not. The default is to include them.
The id of the ledger to return payments from.
WARNING: Will be mandatory in future versions The number of the ledger to return payments from.
Filter for payments that were taken for a particular reason.
|
portfolio(PortfolioType) | The portfolio this account is linked to. |
preferredLanguageForComms(String) | The language that the account preferred for communications. |
properties([PropertyType]) | Properties linked to the account now and in the future. Arguments
Returns properties that have an effective period that ends at or after the given activeFrom datetime. |
provisionalTransactions(ProvisionalTransactionConnectionTypeConnection) | |
references([AccountReferenceType]) | Account references linked to this account. |
referrals(ReferralConnectionTypeConnection) | The referrals created by this account. Arguments
Only return referrals with the specified status. Return all referrals by default. |
referralsCreated(Int) | Number of referrals created by this account. |
reminders(AccountReminderConnectionTypeConnection) | The reminders associated with an account. |
renewalIntention(RenewalIntention) | Renewal intention associated with account. |
repayments(AccountRepaymentConnectionTypeConnection) | The repayments that have been requested for this account. Arguments
Only return repayments whose status matches one of these statuses. |
requestRefundEligibility(RequestRefundEligibilityType) | Details about the eligibility status for requesting a refund. Arguments
The ledger number to check refund eligibility. |
rewards([RewardType]) | The rewards applied to this account. |
services([ServiceType]) | Get service information belonging to some account. |
splitBillingAddress([String]) | List of billing address lines. |
status(AccountStatus) | The current status of the account. |
telcoLedgers([TelcoLedgerType]) | 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. |
transactions(TransactionConnectionTypeConnection) | Fetch transactions that have taken place on the account. Arguments
Optional date representing the beginning of the postedDate range filter. This date value is inclusive.
In a multi-ledger scenario, include all ledgers' transactions if
The ledger to return transactions from.
The number of the ledger to return transactions from.
The order in which to return the transactions.
Optional date representing the end of the postedDate range filter. This date value is exclusive.
Include only these specific transaction types in the result.
Exclude these specific transaction types from the result. |
unbilledCalls(CallDetailRecordConnection) | Paginated history of all unbilled calls associated with this account. Arguments
Criteria to filter the call records.
Sort order by date. |
urn(String) | Unique reference number from a 3rd party enrolment. |
users([AccountUserType!]!) | |
usesProductCatalog(Boolean) | Indicates whether the account uses product catalog. Returns None if the account does not have a contract. |
Example
{
"id": "abc123",
"number": "abc123",
"status": "PENDING",
"users": AccountUserType,
"complaints": ComplaintConnectionTypeConnection,
"brand": "abc123",
"balance": 1,
"overdueBalance": 1,
"urn": "abc123",
"billingName": "abc123",
"billingSubName": "abc123",
"billingEmail": "abc123",
"billingAddress": "abc123",
"billingAddressLine1": "abc123",
"billingAddressLine2": "abc123",
"billingAddressLine3": "abc123",
"billingAddressLine4": "abc123",
"billingAddressLine5": "abc123",
"billingAddressPostcode": "abc123",
"billingCountryCode": "abc123",
"billingDeliveryPointIdentifier": "abc123",
"splitBillingAddress": ["abc123"],
"address": RichAddressType,
"portfolio": PortfolioType,
"ledgers": [LedgerType],
"metadata": [Metadata],
"canRequestRefund": true,
"requestRefundEligibility": RequestRefundEligibilityType,
"payments": AccountPaymentConnectionTypeConnection,
"repayments": AccountRepaymentConnectionTypeConnection,
"paymentPlans": PaymentPlanConnectionTypeConnection,
"paymentSchedules": PaymentScheduleConnectionTypeConnection,
"paymentForecast": [PaymentForecastType],
"paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
"referrals": ReferralConnectionTypeConnection,
"referralsCreated": 1,
"rewards": [RewardType],
"activeReferralSchemes": ReferralSchemeTypes,
"transactions": TransactionConnectionTypeConnection,
"provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
"annualStatements": AnnualStatementConnectionTypeConnection,
"bills": BillConnectionTypeConnection,
"billingOptions": BillingOptionsType,
"billingTriggerConfiguration": BillingTriggerConfiguration,
"bill": BillInterface,
"directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
"paymentMethods": PaymentInstructionConnectionTypeConnection,
"events": AccountEventConnectionTypeConnection,
"applications": AccountApplicationConnectionTypeConnection,
"accountType": "BUSINESS",
"businessType": "SOLE_TRADER",
"business": BusinessType,
"commsDeliveryPreference": "EMAIL",
"communicationDeliveryPreference": "abc123",
"documentAccessibility": "LARGE_PRINT",
"references": [AccountReferenceType],
"fileAttachments": [AccountFileAttachment],
"paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
"maximumRefund": MaximumRefundType,
"campaigns": [AccountCampaignType],
"isInHardship": true,
"activeHardshipAgreements": [HardshipAgreementType],
"notes": [AccountNoteType],
"contributionAgreements": [ContributionAgreementType],
"assistanceAgreements": [AssistanceAgreementType],
"createdAt": "2020-01-01T00:00:00.000Z",
"preferredLanguageForComms": "abc123",
"consents": ConsentType,
"reminders": AccountReminderConnectionTypeConnection,
"properties": [PropertyType],
"marketSupplyAgreements": AgreementConnection,
"canModifyPayments": CanModifyPaymentsType,
"activeContract": ContractType,
"latestQuote": CreateTelcoQuoteOutput,
"telcoLedgers": [TelcoLedgerType],
"contracts": [Contract],
"services": [ServiceType],
"usesProductCatalog": true,
"billingDocument": TelcoStatementBillingDocumentType,
"renewalIntention": RenewalIntention,
"unbilledCalls": CallDetailRecordConnection
}TelcoFaultTroubleshootingSessionType
A telco fault troubleshooting session.
Fields
| Name | Description |
|---|---|
sessionId(String) | ID of the telco fault troubleshooting session. |
Example
{
"sessionId": "abc123"
}TelcoLedgerType
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 |
|---|---|
acceptsPayments(Boolean) | Whether payments can be posted onto this ledger. |
affectsAccountBalance(Boolean) | Whether this ledger's balance contributes to the account's balance. |
agreements(AgreementConnection) | The charged supply agreements of the ledger. |
amountOwedByCustomer(Int) | 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. |
balance(Int) | The current balance on the ledger in minor units of currency. |
billingTriggerConfiguration(BillingTriggerConfiguration) | The active billing trigger configuration for the ledger. The possible errors that can be raised are:
|
creditTransferPermissionsData(CreditTransferPermissionsDataType) | Permissions data for credit transfers involving the given ledger. |
currentDirectDebitInstructionInvalidatedWithVendor(Boolean) | True if the current direct debit instruction has been invalidated by vendor. False otherwise. |
debtLedger(LedgerType) | The debt ledger assigned to this ledger. |
id(ID) | Deprecated The 'ledgerId' field is deprecated. |
invoices(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. Arguments
Exclude invoices that were issued by external systems. Does not apply to legacy bills.
The id of the invoice.
The order the invoices should be returned in. |
ledgerType(String) | The ledger type code. |
name(String) | The display name of the ledger. |
number(String) | The canonical name of the ledger. |
paymentAdequacy(PaymentAdequacyDetailsType) | |
paymentPreferenceAtTime(PaymentPreferenceUnion) | The customer's preferred payment method at a point in time. The possible errors that can be raised are:
Arguments
The time at which to know the payment preference. |
paymentPreferences(PaymentPreferenceConnectionTypeConnection) | The customer's preferred payment methods. |
paymentsWithNonConcludedRePresentation(PaymentWithNonConcludedRePresentationConnectionTypeConnection) | Payments with non-concluded re-presentation. |
refundRequests(RefundRequestConnectionTypeConnection) | Refund requests for a given ledger. |
repaymentRequests(RepaymentRequestConnectionTypeConnection) | Repayment requests for a given ledger. |
statements(TelcoStatementBillingDocumentConnectionTypeConnection) | 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. |
supportsInvoices(Boolean) | Is it possible for this ledger to contain invoices. |
supportsStatements(Boolean) | Is it possible for this ledger to contain statements. |
transactions(TransactionConnectionTypeConnection) | Transactions on the given ledger. Arguments
Optional date representing the beginning of the postedDate range filter. This date value is inclusive.
The order in which to return the transactions.
Optional date representing the end of the postedDate range filter. This date value is exclusive.
Include only these specific transaction types in the result. |
usablePaymentInstructions(PaymentInstructionConnectionTypeConnection) | The usable payment instructions for this ledger. |
Example
{
"id": "abc123",
"name": "abc123",
"number": "abc123",
"ledgerType": "abc123",
"balance": 1,
"amountOwedByCustomer": 1,
"affectsAccountBalance": true,
"statements": TelcoStatementBillingDocumentConnectionTypeConnection,
"invoices": InvoiceBillingDocumentConnectionTypeConnection,
"transactions": TransactionConnectionTypeConnection,
"repaymentRequests": RepaymentRequestConnectionTypeConnection,
"refundRequests": RefundRequestConnectionTypeConnection,
"acceptsPayments": true,
"paymentAdequacy": PaymentAdequacyDetailsType,
"creditTransferPermissionsData": CreditTransferPermissionsDataType,
"paymentPreferences": PaymentPreferenceConnectionTypeConnection,
"paymentPreferenceAtTime": PreferredInstruction,
"debtLedger": LedgerType,
"agreements": AgreementConnection,
"usablePaymentInstructions": PaymentInstructionConnectionTypeConnection,
"billingTriggerConfiguration": BillingTriggerConfiguration,
"supportsStatements": true,
"supportsInvoices": true,
"currentDirectDebitInstructionInvalidatedWithVendor": true,
"paymentsWithNonConcludedRePresentation": PaymentWithNonConcludedRePresentationConnectionTypeConnection
}TelcoPrepareAccount
The possible errors that can be raised are:
- KT-CT-4121: Invalid phone number.
- KT-CT-4618: Unable to accept given quote.
- KT-CT-4619: Quote with given code not found.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-4917: Invalid requested activation date provided.
- KT-CT-5418: Account user not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
accountNumber(String) | The new account's account number. |
accountUserNumber(String) | The new account's user number. |
ledgerNumber(String) | The new account's ledger number. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountNumber": "abc123",
"accountUserNumber": "abc123",
"ledgerNumber": "abc123"
}Fields
| Name | Description |
|---|---|
code(String) | The code of the product. |
description(String) | The description of the product. |
discountAmount(FinancialAmount) | The amount discounted from the monthly price of the product with VAT. |
discountLengthInMonths(String) | The validity period of the discount in months. |
discountedPriceWithVat(FinancialAmount) | The amount a customer will pay once the discount has been applied. |
installationRequired(Boolean) | Whether this product requires installation. |
networkOrderType(String) | The network order type (provisioning type) for this product, if available. |
price(FinancialAmount) | The monthly price of the product. |
priceWithVat(FinancialAmount) | The monthly price of the product with VAT. |
productExtras([TelcoProductExtrasType]) | The product extras available for the product. |
promotions([Promotion]) | Promotions available for product. |
rollingPrice(FinancialAmount) | The rolling monthly price of the product. |
rollingPriceWithVat(FinancialAmount) | The rolling monthly price of the product with VAT. |
selected(Boolean) | If the product is selected. |
speeds(Speeds) | The network speeds associated with the product. |
tags([ProductTag]) | The tags associated with this product. |
term(String) | The term the product is available for. |
Example
{
"code": "abc123",
"description": "abc123",
"term": "abc123",
"price": FinancialAmount,
"rollingPrice": FinancialAmount,
"promotions": [Promotion],
"priceWithVat": FinancialAmount,
"rollingPriceWithVat": FinancialAmount,
"discountAmount": FinancialAmount,
"discountedPriceWithVat": FinancialAmount,
"discountLengthInMonths": "abc123",
"speeds": Speeds,
"selected": true,
"tags": [ProductTag],
"productExtras": [TelcoProductExtrasType],
"installationRequired": true,
"networkOrderType": "abc123"
}Fields
| Name | Description |
|---|---|
code(String) | The code of the Product extra. |
description(String) | The description of the product extra. |
name(String) | The name of the Product extra. |
price(FinancialAmount) | The monthly price of the product extra. |
priceWithVat(FinancialAmount) | The monthly price of the product extra with VAT. |
Example
{
"code": "abc123",
"name": "abc123",
"description": "abc123",
"price": FinancialAmount,
"priceWithVat": FinancialAmount
}Fields
| Name | Description |
|---|---|
family(String) | The family of the product. |
productExtra([TelcoProductExtraType]) | The product extras available for the product. |
Example
{
"family": "abc123",
"productExtra": [TelcoProductExtraType]
}TelcoProductType
A product that user can order
Fields
| Name | Description |
|---|---|
availableFrom(DateTime!) | |
availableTo(DateTime) | |
code(String!) | |
description(String!) | This will be shown to customers during sign-up |
displayName(String!) | This name will be shown to customers during sign-up |
fullName(String!) | |
id(ID!) | |
marketName(String!) | |
tags([ProductTag]) | Tags associated with the product. |
term(Int) | Duration of agreements using this product in months |
termsContractType(String!) |
Example
{
"id": "abc123",
"marketName": "abc123",
"code": "abc123",
"fullName": "abc123",
"displayName": "abc123",
"description": "abc123",
"availableFrom": "2020-01-01T00:00:00.000Z",
"availableTo": "2020-01-01T00:00:00.000Z",
"term": 1,
"termsContractType": "abc123",
"tags": [ProductTag]
}Fields
| Name | Description |
|---|---|
name(String) | The name of the telco product. |
products([TelcoProduct]) | The products available for the quote. |
Example
{
"name": "abc123",
"products": [TelcoProduct]
}TelcoSignUp
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-3943: Invalid ledger.
- KT-CT-3940: Invalid data.
- KT-CT-3979: Invalid ledger.
- KT-CT-4618: Unable to accept given quote.
- KT-CT-10001: Party is already under contract.
- KT-GB-10601: Invalid switch order reference.
- KT-CT-4121: Invalid phone number.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
accountNumber(String) | The new account's account number. |
payment(UpfrontPaymentDetails) | Details of any upfront payment required. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": UpfrontPaymentDetails,
"accountNumber": "abc123"
}TelcoStatementBillingDocumentConnectionTypeConnection
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 |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([TelcoStatementBillingDocumentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": TelcoStatementBillingDocumentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}TelcoStatementBillingDocumentConnectionTypeEdge
A Relay edge containing a TelcoStatementBillingDocumentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(TelcoStatementBillingDocumentType) | The item at the end of the edge |
Example
{
"node": TelcoStatementBillingDocumentType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
annulledBy(AnnulmentBillingDocumentType) | Billing document that annuls this statement. |
calls(CallDetailRecordConnection) | The specific calls that were charged in this statement. Arguments
Criteria to filter the call records.
Sort order by date. |
documentDebtPosition(BillingDocumentPositionType) | Position of the billing document in the delinquent debt tracking system. |
earliestChargeAt(DateTime) | The earliest charge date of the statement. |
endAt(DateTime!) | The end of the statement's period. |
firstIssuedAt(DateTime) | The date and time the statement was sent to the customer. |
id(Int) | ID for the statement billing document. |
identifier(String) | The unique reference of the statement that can be used for identifying the statement externally. |
latestChargeAt(DateTime) | The latest charge date of the statement. |
paymentDueDate(Date) | The date payment is due for the statement. |
pdfUrl(String) | URL to the PDF of the statement. |
startAt(DateTime!) | The start of the statement's period. |
totalCharges(StatementTotalType) | The total amounts for all charges on the statement. |
totalCredits(StatementTotalType) | The total amounts for all credits on the statement. |
transactions(BillTransactionConnectionTypeConnection) | Transactions on the statement Arguments
The order in which to return the transactions. |
Example
{
"id": 1,
"identifier": "abc123",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z",
"firstIssuedAt": "2020-01-01T00:00:00.000Z",
"earliestChargeAt": "2020-01-01T00:00:00.000Z",
"latestChargeAt": "2020-01-01T00:00:00.000Z",
"paymentDueDate": "2020-01-01",
"pdfUrl": "abc123",
"annulledBy": AnnulmentBillingDocumentType,
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"transactions": BillTransactionConnectionTypeConnection,
"documentDebtPosition": BillingDocumentPositionType,
"calls": CallDetailRecordConnection
}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 |
|---|---|
createdAt(DateTime) | The date and time the special circumstance record was created. |
expiryDate(Date) | |
id(ID) | |
internalCode(String) | |
summary(String) |
Example
{
"id": "abc123",
"summary": "abc123",
"internalCode": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"expiryDate": "2020-01-01"
}TermTemplateComponentType
Represents a contract term template component within an offering.
Fields
| Name | Description |
|---|---|
component(TermTemplateType!) | The contract term template associated with this component. |
identifier(ID!) | Unique identifier of the component. |
initialQuantity(Int!) | Initial/default quantity for this component. |
maximumQuantity(Int!) | Maximum quantity of this component that can be selected. |
minimumQuantity(Int!) | Minimum quantity of this component that can be selected. |
Example
{
"identifier": "abc123",
"minimumQuantity": 1,
"maximumQuantity": 1,
"initialQuantity": 1
}TermTemplateType
Represents a contract term template in the catalog.
Fields
| Name | Description |
|---|---|
description(String!) | The description of this contract term template. |
name(String!) | The name of this contract term template. |
templateData(JSONString!) | The data associated with this contract term template. |
termType(String!) | The type of contract term. |
Example
{
"termType": "abc123",
"templateData": {"key": "value"},
"name": "abc123",
"description": "abc123"
}TerminateAgreement
Terminate an agreement.
The possible errors that can be raised are:
- KT-CT-1501: Agreement not found.
- KT-CT-1513: Unable to terminate agreement.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
agreement(CommonAgreementType) | The created agreement. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"agreement": CommonAgreementType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
validTo(DateTime) | Datetime when the credit transfer permission ends. |
Example
{
"possibleErrors": [PossibleErrorType],
"validTo": "2020-01-01T00:00:00.000Z"
}TerminationFeeType
Represents the termination term of a contract.
Fields
| Name | Description |
|---|---|
amount(Decimal) | The amount of the termination fee. |
description(NonEmptyString) | The description of the term. |
displayName(NonEmptyString) | The display name of the term. |
feeType(TerminationFeeType) | The type of termination fee. |
identifier(NonEmptyString) | The identifier of the term. |
isVariable(Boolean) | Whether the term is variable. |
marketName(NonEmptyString) | The market associated with the termination fee. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true,
"amount": "1.0",
"feeType": TerminationFeeType,
"marketName": NonEmptyString
}TermsAndConditionsConnectionTypeConnection
Pagination for terms and conditions.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([TermsAndConditionsConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": TermsAndConditionsConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}TermsAndConditionsConnectionTypeEdge
A Relay edge containing a TermsAndConditionsConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(TermsAndConditionsType) | The item at the end of the edge |
Example
{
"node": TermsAndConditionsType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
name(String) | The display name of the terms and conditions. |
s3Url(String) | The S3 URL to the terms and conditions file. |
Example
{
"name": "abc123",
"s3Url": "abc123"
}Fields
| Name | Description |
|---|---|
brandCode(String) | |
effectiveFrom(DateTime) | |
html(String) | The html of the terms and conditions document rendered as a JSON string. |
markdown(String) | The markdown text of the terms and conditions. |
name(String) | |
pdfUrl(String) | |
version(String) |
Example
{
"name": "abc123",
"pdfUrl": "abc123",
"brandCode": "abc123",
"markdown": "abc123",
"html": "abc123",
"version": "abc123",
"effectiveFrom": "2020-01-01T00:00:00.000Z"
}TextType
A block of text.
Fields
| Name | Description |
|---|---|
id(ID) | Unique identifier of the object. |
textAlignment(Alignment) | The text alignment. |
textStyle(TextStyleV1) | The text style, i.e. header, body. |
typename(String) | The name of the object's type. |
value(String!) | The text content. |
Example
{
"value": "abc123",
"textStyle": "TITLE1",
"textAlignment": "START",
"id": "abc123",
"typename": "abc123"
}ThirdPartyOrganizationType
Type for the third party organization.
Fields
| Name | Description |
|---|---|
name(String!) | The name of the third party. |
permissions([ThirdPartyPermission]) | Holds information about the permissions of the current viewer. |
Example
{
"name": "abc123"
}ThirdPartyPermission
Holds information about a specific permission.
Fields
| Name | Description |
|---|---|
permission(String) | The short name of the permission. |
Example
{
"permission": "abc123"
}TimePeriod
Describe validity period of the price on the product offering. Used for filtering which prices apply to the product offering at any given time.
if startDateTime and endDateTime: The price is valid only between these dates, eg: price applies for contract period only.
if startDateTime and not endDateTime: The price is valid from the start date until forever, eg: price applies for out-of-contract period.
Inspired by TMF schema see: https://github.com/tmforum-rand/schemas/blob/candidates/Common/TimePeriod.schema.json
Fields
| Name | Description |
|---|---|
endDateTime(DateTime) | End of the time period if supplied. |
startDateTime(DateTime!) | Start of the time period. |
Example
{
"startDateTime": "2020-01-01T00:00:00.000Z",
"endDateTime": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
gross(Int) | The gross amount (in minor currency units). |
net(Int) | The net amount (in minor currency units). |
tax(Int) | The amount of tax (in minor currency units). |
Example
{
"net": 1,
"tax": 1,
"gross": 1
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([TransactionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": TransactionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}TransactionConnectionTypeEdge
A Relay edge containing a TransactionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(TransactionType) | The item at the end of the edge |
Example
{
"node": TransactionType,
"cursor": "abc123"
}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 |
|---|---|
opportunitiesTransferred(Int) | Number of opportunities transferred. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"opportunitiesTransferred": 1
}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 |
|---|---|
balanceTransfer(AccountBalanceTransferType) | Balance transfer details. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
pointsTransferred(Int) | The number of loyalty points that were transferred. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsTransferred": 1
}Fields
| Name | Description |
|---|---|
accounts(AccountConnectionTypeConnection!) | The accounts related to this trigger. |
accountsLinkedAt(DateTime) | The datetime that account linking was completed for this trigger. If null, the accounts field will be empty because linking hasn't occurred yet. |
createdAt(DateTime!) | The date/time that the trigger was created. |
id(String!) | The ID of the trigger. |
messages(MessageConnection!) | The messages created in response to this trigger. |
processingStatus(TriggerProcessingStatus!) | The current processing status of this trigger. |
triggerTypeCode(String!) | The trigger type code for this trigger. |
Example
{
"id": "abc123",
"triggerTypeCode": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountsLinkedAt": "2020-01-01T00:00:00.000Z",
"accounts": AccountConnectionTypeConnection,
"processingStatus": "UNPROCESSED"
}TriggerCollectionProcessMessage
Send a communication for 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-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
triggerResult(TriggerCollectionProcessMessageOutput) | Details of the triggered communication. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
fuguTriggerId(String) | The unique identifier of the triggered communication. |
Example
{
"fuguTriggerId": "abc123"
}TriggerPostUploadOperations
The possible errors that can be raised are:
- KT-CT-8710: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
operationsTriggered(Boolean) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"operationsTriggered": true
}TroubleshootingContextEntryType
Represents a single key-value pair of contextual data for a step.
Fields
| Name | Description |
|---|---|
description(String!) | Human-readable description of the key. |
key(String!) | The key name. |
value(String!) | The value as a string. |
Example
{
"key": "abc123",
"description": "abc123",
"value": "abc123"
}TroubleshootingSessionType
The main object representing a single troubleshooting journey.
Fields
| Name | Description |
|---|---|
context([TroubleshootingContextEntryType]!) | Contextual information for this troubleshooting session. |
createdAt(DateTime!) | When the session was created. |
nextRecommendedStep(TroubleshootingStepDefinitionType) | The single next step recommended by the troubleshooting engine. Can be null if no recommendation is available. |
otherNextSteps([TroubleshootingStepDefinitionType]) | A list of other possible steps that can be taken. |
playbookVersion(String!) | The playbook version of the troubleshooting session. |
sessionId(ID!) | The unique identifier for this session. |
status(TroubleshootingSessionStatus!) | The current status of the session. |
steps([TroubleshootingStepInstanceType]!) | A list of steps (running/completed) in this session. |
Example
{
"sessionId": "abc123",
"playbookVersion": "abc123",
"status": "OPEN",
"createdAt": "2020-01-01T00:00:00.000Z",
"context": TroubleshootingContextEntryType,
"steps": TroubleshootingStepInstanceType,
"nextRecommendedStep": TroubleshootingStepDefinitionType,
"otherNextSteps": [TroubleshootingStepDefinitionType]
}TroubleshootingStepDefinitionType
Defines the template for a troubleshooting step.
Fields
| Name | Description |
|---|---|
code(TroubleshootingStepID!) | The step code identifier. |
description(String!) | Human-readable description of the step. |
fields([TroubleshootingStepFieldType]) | Input fields required for this step (if any). |
Example
{
"code": "TRIAGE",
"description": "abc123",
"fields": [TroubleshootingStepFieldType]
}TroubleshootingStepFieldType
Defines a single input field for a troubleshooting step.
Fields
| Name | Description |
|---|---|
acceptableValues([String]) | List of acceptable values for this field (if applicable). |
description(String!) | Human-readable description of the field. |
fieldType(StepFieldType!) | Step field type. |
isRequired(Boolean!) | Whether the field is required. |
key(String!) | The step field key name. |
name(String!) | The field name. |
Example
{
"key": "abc123",
"name": "abc123",
"description": "abc123",
"isRequired": true,
"acceptableValues": ["abc123"],
"fieldType": "TEXT"
}TroubleshootingStepInstanceType
Represents an instance of a troubleshooting step.
Fields
| Name | Description |
|---|---|
code(TroubleshootingStepID!) | The step code identifier. |
context([TroubleshootingContextEntryType]!) | Contextual data associated with this step. |
description(String!) | Human-readable description of the step. |
finishedAt(DateTime) | When the step was finished (if completed). |
startedAt(DateTime) | When the step was started. |
status(TroubleshootingStepStatus!) | The current status of the step. |
stepId(ID!) | The unique identifier for this step instance. |
Example
{
"stepId": "abc123",
"code": "TRIAGE",
"description": "abc123",
"status": "PENDING",
"startedAt": "2020-01-01T00:00:00.000Z",
"finishedAt": "2020-01-01T00:00:00.000Z",
"context": TroubleshootingContextEntryType
}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(UnenrollAccountFromLoyaltyProgramOutcome) | Outcome of the loyalty points campaign enrollment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
hasUnenrolled(Boolean) | Indicates whether the account has been unenrolled from the loyalty points campaign. |
Example
{
"hasUnenrolled": true
}Fields
| Name | Description |
|---|---|
deliveryAddress(DeliveryAddressType) | The CPE delivery address. |
deliveryId(String) | The CPE delivery id. |
deliveryStatus(String) | The CPE delivery status. |
description(String) | The CPE description. |
expectedDeliveryDate(Date) | The CPE expected delivery date. |
orderId(String) | The CPE broadband order id. |
Example
{
"deliveryId": "abc123",
"orderId": "abc123",
"description": "abc123",
"deliveryAddress": DeliveryAddressType,
"expectedDeliveryDate": "2020-01-01",
"deliveryStatus": "abc123"
}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 |
|---|---|
apiException(APIExceptionType) | The updated APIException. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
apiException(APIExceptionType) | The updates APIExceptionNote. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
account(TelcoAccountType) | The updated account. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": TelcoAccountType
}UpdateAccountBillingDay
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4146: Invalid billing day.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
account(AccountInterface) | Account that was changed. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}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(AccountInterface) | Account that was changed. |
possibleErrors([PossibleErrorType]) | 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([ConsentType!]!) | Consents linked to this account. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
accountReference(AccountReferenceType) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}UpdateAccountReferralStatus
Update the status of an AccountReferral.
Status transitions can only move forward: - Pending -> Paid (allowed) - Pending -> Cancelled (allowed) - Paid -> any (not allowed) - Cancelled -> any (not allowed)
The possible errors that can be raised are:
- KT-CT-6712: Invalid reference.
- KT-CT-6732: Invalid referral status transition.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
accountReferral(ReferralType) | The updated account referral instance. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountReferral": ReferralType
}UpdateAccountUserCommsPreferencesMutationPayload
Update the account user comms preferences.
Fields
| Name | Description |
|---|---|
clientMutationId(String) | |
commsPreferences(AccountUserCommsPreferences) | |
emailFormat(String) | |
errors([ErrorType]) | |
fontSizeMultiplier(Float) | |
isOptedInMeterReadingConfirmations(Boolean) | |
isOptedInToClientMessages(Boolean) | |
isOptedInToOfferMessages(Boolean) | |
isOptedInToRecommendedMessages(Boolean) | |
isOptedInToSmsMessages(Boolean) | |
isOptedInToThirdPartyMessages(Boolean) | |
isOptedInToUpdateMessages(Boolean) | |
isUsingInvertedEmailColours(Boolean) | |
preferredHoldMusic(String) |
Example
{
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 1.0,
"emailFormat": "abc123",
"preferredHoldMusic": "abc123",
"errors": [ErrorType],
"commsPreferences": AccountUserCommsPreferences,
"clientMutationId": "abc123"
}UpdateAccountUserConsents
Update the consents from an account user using consent management system
The possible errors that can be raised are:
- KT-CT-9014: Duplicate consent.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-1111: Unauthorized.
- KT-CT-5421: Account user not found.
- KT-CT-5422: Invalid data.
- KT-CT-1605: Invalid input.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
accountUserConsents(AccountUserConsents) | All the consents for an account user. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountUserConsents": AccountUserConsents
}Fields
| Name | Description |
|---|---|
clientMutationId(String) | |
dateOfBirth(Date) | |
email(String) | |
errors([ErrorType]) | |
familyName(String) | |
givenName(String) | |
landline(String) | |
mobile(String) | |
pronouns(String) |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"pronouns": "abc123",
"mobile": "abc123",
"email": "abc123",
"dateOfBirth": "2020-01-01",
"landline": "abc123",
"errors": [ErrorType],
"clientMutationId": "abc123"
}UpdateActivePurchase
The possible errors that can be raised are:
- KT-CT-8225: Received an invalid purchaseId.
- KT-CT-8226: The provided purchase is not active.
- KT-CT-8206: Invalid data.
- KT-CT-8227: Available grants could not be applied.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
goodsPurchase(GoodsPurchase) | Goods purchase updated. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
affiliateLink(AffiliateLinkType) | The updated affiliate link. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
affiliateOrganisation(AffiliateOrganisationType) | The updated affiliate organisation. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}UpdateAgentAuxiliaryStatus
The possible errors that can be raised are:
- KT-CT-7813: Support user not found with that username.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean) | Whether the auxiliary status was successfully updated. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}UpdateAgreementPeriod
Update the period of an agreement.
The possible errors that can be raised are:
- KT-CT-4178: No account found with given account number.
- KT-CT-1501: Agreement not found.
- KT-CT-1503: Agreement validto date must be later than validfrom date.
- KT-CT-1504: Account does not match with the agreement.
- KT-CT-1505: Unable to edit agreement.
- KT-CT-1506: Agreement period is not within the supply and property period.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | Account responsible for the update agreement. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": TelcoAccountType
}UpdateAgreementRescission
Update an agreement rescission.
This mutation allows updating the status and tracking information for an agreement rescission process. Updates are not allowed if the rescission has already been completed.
The possible errors that can be raised are:
- KT-CT-14101: Agreement rescission not found.
- KT-CT-14102: Cannot update completed agreement rescission.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
agreementRescission(AgreementRescissionType) | The updated agreement rescission instance. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}UpdateAgreementRollover
The possible errors that can be raised are:
- KT-CT-4910: No product exists with the given input.
- KT-CT-13705: Agreement rollover not found.
- KT-CT-13706: Agreement rollover has an invalid status for this operation.
- KT-CT-13707: Agreement rollover has an invalid type for this operation.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
agreementRollover(AgreementRolloverType) | The update agreement rollover. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"agreementRollover": AgreementRolloverType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
schedule(PaymentScheduleType) | The new schedule created. |
Example
{
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}UpdateCampaignAccountExpiryDate
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-7428: Failed to update campaign account.
- KT-CT-7429: No active campaign account found for the given account and campaign.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
campaignAccount(AccountCampaignType) | The campaign account with the updated expiry date. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"campaignAccount": AccountCampaignType
}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-11218: External reference cannot be updated once it has been set.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
collectionProcessActivated(UpdateCollectionProcessRecordToActiveOutputType) | Whether the collection process was successfully updated. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}UpdateCollectionProcessRecordToActiveOutputType
Output for updating a Collection process Record to Active.
Fields
| Name | Description |
|---|---|
number(String) | The number of the collection process record. |
status(CollectionProcessRecordStatusTypes) | The current status of the collection process record. |
Example
{
"number": "abc123",
"status": "PENDING"
}UpdateCollectionProcessRecordToComplete
Update the Collection Process Record from raised status to complete
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-11201: No Collection Process Records associated with id.
- KT-CT-11203: No Completion reason provided.
- KT-CT-11204: No Completion details provided.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
collectionProcessComplete(UpdateCollectionProcessRecordToCompleteOutputType) | Whether the collection process was successfully updated. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}UpdateCollectionProcessRecordToCompleteOutputType
Output for updating a Collection process Record to Complete.
Fields
| Name | Description |
|---|---|
number(String) | The number of the collection process record. |
status(CollectionProcessRecordStatusTypes) | The current status of the repayment request. |
Example
{
"number": "abc123",
"status": "PENDING"
}UpdateCommsDeliveryPreference
Update the comms delivery preference for the input account number to the received commsDeliveryPreference value.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4136: Cannot set comms preference to email when account has no email.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
account(AccountInterface) | |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
dcaProceedingUpdateStatus(DCAProceedingUpdateStatus) | Whether the update has been applied. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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(TelcoAccountType) | Account that was changed. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": TelcoAccountType
}UpdateInstallationAppointment
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-4628: Broadband order not found.
- KT-CT-4914: Unable to complete installation request.
- KT-CT-4918: Cannot rebook an installation appointment that has already been completed.
- KT-CT-4919: Cannot rebook an installation appointment that does not exist.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
installationAppointment(InstallationAppointmentType) | The book installation appointment response. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"installationAppointment": InstallationAppointmentType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
updatedLeadData(JSONString) | 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-8912: Funnel not found.
- KT-CT-8931: Extra detail value is invalid.
- KT-CT-8935: National ID bad input.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
updatedLeadData(JSONString) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
updatedLeadData(JSONString) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
tags([InkTag!]!) | Confirmed tags. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
metadata(Metadata) | |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
opportunityNumber(String) | The number of the opportunity. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"opportunityNumber": "abc123"
}UpdateOfferGroupOnOpportunity
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 |
|---|---|
opportunityNumber(String) | The number of the opportunity. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"opportunityNumber": "abc123"
}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 cancellationcategory/cancellationsub_category.
- KT-CT-13039: Cancellation fields require CANCELLED status.
- KT-CT-13045: Failed to update appointment assets.
- KT-CT-13050: Cannot provide both supplypointidentifiertomarketnamemapping and supplypointinternal_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-13062: Datetime field must be timezone-aware.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The Appointment that was updated. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 supplypointidentifiertomarketnamemapping and supplypointinternal_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 |
|---|---|
onSiteJobsRequest(OnSiteJobsRequestType) | The updated request. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
updatedOpportunityData(JSONString) | Arguments passed. |
Example
{
"possibleErrors": [PossibleErrorType],
"updatedOpportunityData": {"key": "value"}
}UpdateOpportunityDetails
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-8930: Unable to parse address.
- KT-CT-8931: Extra detail value is invalid.
- KT-CT-8912: Funnel not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
updatedData(JSONString) | Arguments updated. |
Example
{
"possibleErrors": [PossibleErrorType],
"updatedData": {"key": "value"}
}UpdateOpportunityExtraDetails
The possible errors that can be raised are:
- KT-CT-8906: Opportunity not found.
- KT-CT-8926: Unable to create opportunity.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
extraDetails(JSONString) | The opportunity's extra details to be added or updated. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
message(String) | Placeholder success message for now. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"message": "abc123"
}UpdatePassword
Update user's password.
Note this is different from the ResetPassword mutation, which is used to reset a password when the user has forgotten it. This mutation is used to update the password when the user is already authenticated and wants to change their password.
Ideally, this mutation would simply receive a "new_password" and use the current password update usecase, but, until we're ready for a breaking change, we'll need to use the Django form to also validate the old password and two new passwords.
The possible errors that can be raised are:
- KT-CT-5460: Old password is invalid.
- KT-CT-5450: Password is invalid.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
viewer(AccountUserType) | The currently authenticated user. This field requires the |
Example
{
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}UpdateProductPricesOutput
Rate group prices for a product.
Fields
| Name | Description |
|---|---|
prices([RateGroupPrices!]!) | The rate group prices. |
Example
{
}UpdateRequestedActivationDate
The possible errors that can be raised are:
- KT-CT-4623: Unauthorized.
- KT-CT-4628: Broadband order not found.
- KT-CT-4629: Invalid date format. Expecting YYYY-MM-DD.
- KT-CT-4630: Unable to change activation date.
- KT-CT-10926: OSS currently unavailable.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
broadbandOrder(BroadbandOrderType) | The broadband order that has been updated. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"broadbandOrder": BroadbandOrderType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
siteworksRequest(CoreSiteworksRequestType) | The siteworks request after the update. |
Example
{
"possibleErrors": [PossibleErrorType]
}UpdateUserMobileAppDetails
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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
viewer(UserMobileData) |
Example
{
"possibleErrors": [PossibleErrorType],
"viewer": UserMobileData
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
viewer(AccountUserType) |
Example
{
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}Fields
| Name | Description |
|---|---|
promiseId(String!) | Promise ID for async results. |
result(InstallationAppointmentType) | Data returned for sync or completed async results. |
Example
{
"promiseId": "abc123",
"result": InstallationAppointmentType
}Fields
| Name | Description |
|---|---|
charges([SignupCharge]) | |
retrievalToken(String!) | The retrieval token for this standalone payment. |
secretToken(String!) | The secret used to collect the payment. |
totalCharges(Int!) | The total up-front charges to be collected in pence, inclusive of VAT. |
Example
{
"retrievalToken": "abc123",
"secretToken": "abc123",
"totalCharges": 1,
"charges": [SignupCharge]
}UploadPostRequest
Information that should be used in the POST request to the S3 API.
For more details please see this.
Fields
| Name | Description |
|---|---|
fields(JSONString!) | |
key(String!) | |
url(String!) |
Example
{
"url": "abc123",
"fields": {"key": "value"},
"key": "abc123"
}UserManagedPayment
Represents the preference of the user to pay himself, instead of get charged.
Fields
| Name | Description |
|---|---|
forPaymentsAfter(String) | The start time of the payment preference. |
Example
{
"forPaymentsAfter": "abc123"
}Fields
| Name | Description |
|---|---|
hasMobileApp(Boolean) | Indicates whether the user has the mobile app installed. |
lastMobileAppAccessDate(Date) | Last mobile app access date. |
userId(String) | User id. |
Example
{
"userId": "abc123",
"hasMobileApp": true,
"lastMobileAppAccessDate": "2020-01-01"
}ValidateEmail
Validate whether a user's email is a valid email via the Kickbox API.
Fields
| Name | Description |
|---|---|
isValid(Boolean) | 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 |
|---|---|
deviceIsValid(Boolean) | Flag to indicate if the device has been verified, so it can be used for MFA. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
isValid(Boolean) | 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 |
|---|---|
end(DateTime) | The end date and time of the period. Null indicates an open-ended period. |
start(DateTime) | The start date and time of the period. |
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z"
}VariantProfile
Object representing a variant profile.
Fields
| Name | Description |
|---|---|
characteristicValues(JSONString!) | The characteristic values for the variant. |
schemeLabels(JSONString) | The scheme labels for the variant. |
Example
{
"characteristicValues": {"key": "value"},
"schemeLabels": {"key": "value"}
}VaryContractTermsOutput
Output type for varying contract terms.
Fields
| Name | Description |
|---|---|
contract(Contract) | The contract with the varied terms. |
Example
{
"contract": Contract
}Fields
| Name | Description |
|---|---|
status(String) | Verification process status. |
type(String) | Verification type. |
userNumber(String) | Customer with pending verification. |
Example
{
"userNumber": "abc123",
"status": "abc123",
"type": "abc123"
}VerifyCustomer
Verify a customer using the provided code and verification type.
The possible errors that can be raised are:
- KT-CT-4191: Error while verifying the customer.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
user(AccountUserType) | 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 |
|---|---|
isVerified(Boolean) | Whether the email is verified. |
possibleErrors([PossibleErrorType]) | 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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
token(String!) | An expiring token that can be used to request to update the user's email address. |
Example
{
"possibleErrors": [PossibleErrorType],
"token": "abc123"
}VoiceCampaignConnectionTypeConnection
Paginator of Voice Campaigns
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([VoiceCampaignConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": VoiceCampaignConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}VoiceCampaignConnectionTypeEdge
A Relay edge containing a VoiceCampaignConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(VoiceCampaignType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}VoiceCampaignItemConnectionTypeConnection
Paginator of Campaign Items
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([VoiceCampaignItemConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": VoiceCampaignItemConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}VoiceCampaignItemConnectionTypeEdge
A Relay edge containing a VoiceCampaignItemConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(VoiceCampaignItemType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
accountId(ID) | 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. |
callWindowEnd(DateTime) | Together with |
callWindowStart(DateTime) | Together with |
id(ID) | The ID of the campaign item. |
metadata(JSONString) | 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. |
phoneNumber(String) | 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. |
status(CampaignItemStatus!) | The status of the campaign item that determines what actions can be taken on it. |
Example
{
"id": "abc123",
"phoneNumber": "abc123",
"status": "UNASSIGNED",
"callWindowStart": "2020-01-01T00:00:00.000Z",
"callWindowEnd": "2020-01-01T00:00:00.000Z",
"accountId": "abc123",
"metadata": {"key": "value"}
}Fields
| Name | Description |
|---|---|
campaignItems(VoiceCampaignItemConnectionTypeConnection) | 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. |
campaignType(TypeOfVoiceCampaign) | The type of campaign, e.g. preview or predictive. |
customOutboundPhoneNumber(String) | If appropriate, a custom number to use as the caller id for calls from this campaign. |
description(String) | Additional information to describe the purpose of the campaign. |
id(ID) | The ID of the campaign. |
name(String!) | The name of the campaign. This is used to identify the campaign in the system, and must be unique. |
preventDuplicateRecords(Boolean) | 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 |
status(CampaignStatus) | The status of the campaign. Indicates whether calls can be made for items in the campaign or not. |
tags(CallTagConnectionTypeConnection) | The call tags that can be used within this campaign. |
Example
{
"id": "abc123",
"name": "abc123",
"description": "abc123",
"customOutboundPhoneNumber": "abc123",
"status": "ACTIVE",
"campaignType": "PREVIEW",
"preventDuplicateRecords": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([VoucherPurchaseConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": VoucherPurchaseConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}VoucherPurchaseConnectionTypeEdge
A Relay edge containing a VoucherPurchaseConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(VoucherPurchaseType) | The item at the end of the edge |
Example
{
"node": VoucherPurchaseType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
availableFrom(Date) | When the voucher becomes available to be redeemed. |
balance(Int) | The current balance left in the voucher. |
charge(AccountChargeType) | The amount charged for the voucher. |
chargeBalanceTransfer(AccountBalanceTransferType) | A balance transfer for the voucher charge, if any. |
clientParams(JSONString) | Additional metadata from client sources stored against the voucher. This data is not structural and won't be relied on by Kraken internally. |
displayName(String) | Display name for the voucher purchase. |
id(ID) | The purchase ID. |
payment(AccountPaymentType) | The payment associated with the voucher purchase, if any. |
purchasedAt(DateTime) | When the purchase was performed. |
redemptions([VoucherRedemptionType]) | Fetch the redemptions for this voucher. |
refundedAt(DateTime) | When the voucher was refunded, if it was refunded. |
voucherValue(Int) | The value of the voucher in cents. |
Example
{
"id": "abc123",
"charge": AccountChargeType,
"payment": AccountPaymentType,
"displayName": "abc123",
"clientParams": {"key": "value"},
"purchasedAt": "2020-01-01T00:00:00.000Z",
"voucherValue": 1,
"availableFrom": "2020-01-01",
"balance": 1,
"redemptions": [VoucherRedemptionType],
"refundedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
claimedAt(DateTime) | When the redemption was claimed. |
credit(AccountCreditType) | The amount credited for the voucher redemption. |
id(ID) | The redemption ID. |
isReversed(Boolean) | Whether the redemption has been reversed. |
Example
{
"id": "abc123",
"credit": AccountCreditType,
"claimedAt": "2020-01-01T00:00:00.000Z",
"isReversed": true
}Fields
| Name | Description |
|---|---|
redeemableInFuture(Int) | The balance from vouchers that will be redeemable in future. |
redeemableToday(Int) | The balance from vouchers that can be redeemable today. |
Example
{
"redeemableToday": 1,
"redeemableInFuture": 1
}WaiveExitFeeType
Represents a waive exit fee term in a contract.
Fields
| Name | Description |
|---|---|
description(NonEmptyString) | The description of the term. |
displayName(NonEmptyString) | The display name of the term. |
identifier(NonEmptyString) | The identifier of the term. |
isVariable(Boolean) | Whether the term is variable. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}Fields
| Name | Description |
|---|---|
deviceId(String) | Serial number. |
marketSupplyPointId(String) | Meter point reference. |
readingFrequencyType(ReadingFrequencyType) | The frequency of the reading. |
Example
{
"marketSupplyPointId": "abc123",
"deviceId": "abc123",
"readingFrequencyType": "RAW_INTERVAL"
}Fields
| Name | Description |
|---|---|
body(String!) | Whatsapp text message body. |
Example
{
"body": "abc123"
}WholesaleProductOfferingInfo
Represents wholesale product offering information.
When certain: offering is populated, possible_offerings is null
When uncertain: offering is null, possible_offerings contains all options
Fields
| Name | Description |
|---|---|
offering(ExternalProviderProductInfo) | The certain wholesale product offering ( |
possibleOfferings([ExternalProviderProductInfo]) | List of possible wholesale product offerings ( |
Example
{
"offering": ExternalProviderProductInfo,
"possibleOfferings": [ExternalProviderProductInfo]
}Fields
| Name | Description |
|---|---|
antiMalwareEnabled(Boolean!) | Indicates whether anti malware is enabled. |
homeworkTime(HomeworkTimeType) | The homework time settings. |
kidsSafe(KidsSafeType) | The kids safe setting. |
scamSafeEnabled(Boolean!) | Indicates whether scam safe is enabled. |
Example
{
"antiMalwareEnabled": true,
"scamSafeEnabled": true,
"homeworkTime": HomeworkTimeType,
"kidsSafe": KidsSafeType
}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 |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
withdrawSuccessful(Boolean) | Whether the dunning process was withdrawn successfully. |
Example
{
"possibleErrors": [PossibleErrorType],
"withdrawSuccessful": true
}Fields
| Name | Description |
|---|---|
identifier(String!) | The identifier of the work schedule (also known as the 'slug'). |
isOpen(Boolean!) | Whether the work schedule is currently open. |
isPublicHoliday(Boolean!) | Whether today is a public holiday, according to the work schedule. |
name(String!) | Name of the work schedule. |
openOrClosedReason(WorkScheduleOpenOrClosedReason!) | The reason the Work Schedule is open or closed. |
Example
{
"identifier": "abc123",
"name": "abc123",
"isOpen": true,
"isPublicHoliday": true,
"openOrClosedReason": "CLOSED_DUE_TO_PUBLIC_HOLIDAY"
}Fields
| Name | Description |
|---|---|
cancellationReason(String) | The reason for the cancellation of the workflow. |
cancellationType(String) | The type of cancellation for the workflow. |
createdAt(DateTime) | The date when the workflow was created. |
events([EventOutput]) | List of events in the workflow. |
id(Int) | The ID of the workflow. |
name(String) | The name of the workflow. |
status(Status) | The status of the workflow. |
statusReason(String) | The reason for the workflow status. |
steps([StepOutput]) | List of steps in the workflow. |
Example
{
"id": 1,
"name": "abc123",
"status": "SKIPPED",
"statusReason": "abc123",
"cancellationReason": "abc123",
"cancellationType": "abc123",
"steps": [StepOutput],
"events": [EventOutput],
"createdAt": "2020-01-01T00:00:00.000Z"
}YearlyPriceRiseGroupType
Represents a yearly price rise group term in a contract.
Fields
| Name | Description |
|---|---|
description(NonEmptyString) | The description of the term. |
displayName(NonEmptyString) | The display name of the term. |
identifier(NonEmptyString) | The identifier of the term. |
isVariable(Boolean) | Whether the term is variable. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"displayName": NonEmptyString,
"description": NonEmptyString,
"identifier": NonEmptyString,
"isVariable": true
}