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": "UNKNOWN",
"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
Output type of the acceptGoodsQuote mutation.
Fields
| Name | Description |
|---|---|
goodsPurchase(GoodsPurchase) | Goods purchase created. |
Example
{
"goodsPurchase": GoodsPurchase
}AcceptOfferForQuoting
Output type of the acceptOfferForQuoting mutation.
Fields
| Name | Description |
|---|---|
offer(OfferType) | Accepted quoting offer. |
Example
{
"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([AccountAccessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountAccessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountAccessConnectionTypeEdge
A Relay edge containing a AccountAccessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountAccessType) | The item at the end of the edge |
Example
{
"node": AccountAccessType,
"cursor": "abc123"
}AccountAccessType
Represents the accessible account and access information of an accessor.
Fields
| Name | Description |
|---|---|
entity(TelcoAccountType!) | The account that the accessor has access to. |
roleAssignments([RoleAssignment]!) | The role assignments that the accessor has for the entity. |
Example
{
"roleAssignments": RoleAssignment,
"entity": TelcoAccountType
}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",
"reason": "abc123",
"accountCharge": AccountChargeType,
"accountCredit": AccountCreditType
}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 |
|---|---|
accountNumber(String!) | The account number. |
ledgerDebtPositions([LedgerDebtPositionType]!) | The delinquent debt position for each eligible ledger on the account. |
Example
{
"accountNumber": "abc123",
"ledgerDebtPositions": LedgerDebtPositionType
}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
}AccountManualHoldType
A manual billing document hold on an account.
Fields
| Name | Description |
|---|---|
createdAt(DateTime!) | When the hold was created. |
id(ID!) | The ID of the manual hold. |
reasonCode(String!) | The code of the hold reason. |
validFrom(DateTime!) | The start of the hold validity period. |
validTo(DateTime) | The end of the hold validity period. Null if the hold is open-ended. |
Example
{
"id": "abc123",
"reasonCode": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"createdAt": "2020-01-01T00:00:00.000Z"
}Example
{
"id": "abc123",
"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) | The ID of the payment. Deprecated The 'id' field is deprecated. |
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. |
uuid(UUID!) |
Example
{
"id": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"reference": "abc123",
"transactionType": "DD_FIRST_COLLECTION",
"status": "SCHEDULED",
"uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"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 |
paymentUuid(UUID) | The UUID of the payment being refunded. |
reason(RepaymentReason) | The reason for the repayment. |
status(AccountRepaymentStatusOptions) | The current status of the repayment. |
Example
{
"id": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"status": "REQUESTED",
"reason": "BILLING_ADJUSTMENT",
"paymentUuid": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}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 |
|---|---|
categories([TelcoCategoryInterface]!) | Account-level telco settings, contributed by client-specific category providers. |
Example
{
"categories": TelcoCategoryInterface
}Fields
| Name | Description |
|---|---|
accountNumber(String!) | Account number. |
Example
{
"accountNumber": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountUserAccessorAccessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountUserAccessorAccessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountUserAccessorAccessConnectionTypeEdge
A Relay edge containing a AccountUserAccessorAccessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountUserAccessorAccessType) | The item at the end of the edge |
Example
{
"node": AccountUserAccessorAccessType,
"cursor": "abc123"
}AccountUserAccessorAccessType
Represents an account user and their access information to an entity.
Fields
| Name | Description |
|---|---|
accessor(AccountUserType!) | The account user that has access to the entity. |
roleAssignments([RoleAssignment!]!) | The role assignments that the accessor has for the entity. |
Example
{
"roleAssignments": RoleAssignment,
"accessor": AccountUserType
}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!) | The ID of the account user role. Deprecated The 'id' field is deprecated. |
role(RoleString) | The account role. |
user(AccountUserType!) |
Example
{
"id": "abc123",
"account": TelcoAccountType,
"user": AccountUserType,
"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 |
|---|---|
accessibleAccounts(AccountAccessConnectionTypeConnection) | Accounts this user can access, with the roles granting that access. |
accessibleAccountsSearch(AccountAccessConnectionTypeConnection) | Search for accounts this user can access and match the search terms. |
accessibleBusinesses(BusinessAccessConnectionTypeConnection) | Businesses this user can access, with the roles granting that access. |
accessiblePortfolios(PortfolioAccessConnectionTypeConnection) | Portfolios this user can access, with the roles granting that access. |
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. |
contactEmails([ContactEmailType]) | The account user's contact email addresses. Unlike the |
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!) | |
externalId(String) | The value set in the configured external ID details namespace. |
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!) | The unique identifier of the account user. |
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",
"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],
"accounts": AccountInterface,
"accessibleAccounts": AccountAccessConnectionTypeConnection,
"accessiblePortfolios": PortfolioAccessConnectionTypeConnection,
"accessibleAccountsSearch": AccountAccessConnectionTypeConnection,
"displayName": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"fullName": "abc123",
"preferredName": "abc123",
"isActive": true,
"address": RichAddressType,
"portfolioId": "abc123",
"portfolioIds": ["abc123"],
"portfolios": PortfolioConnectionTypeConnection,
"businesses": BusinessConnectionTypeConnection,
"accessibleBusinesses": BusinessAccessConnectionTypeConnection,
"specialCircumstances": SpecialCircumstancesType,
"preferences": AccountUserCommsPreferences,
"dateOfBirth": "2020-01-01",
"label": "abc123",
"landlinePhoneNumber": "abc123",
"alternativePhoneNumbers": ["abc123"],
"contactEmails": [ContactEmailType],
"hasFamilyIssues": true,
"isInHardship": true,
"accountUserRoles": [AccountUserRoleType],
"portfolioUserRoles": [PortfolioUserRoleType],
"externalId": "abc123",
"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
Output type of the addBusinessToSegment mutation.
Fields
| Name | Description |
|---|---|
businessSegmentPeriod(BusinessSegmentPeriodType) | The business segment period that was created. |
Example
{
"businessSegmentPeriod": BusinessSegmentPeriodType
}AddCampaignToAccount
Output type of the addCampaignToAccount mutation.
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
{
"campaignAdded": true,
"possibleErrors": [PossibleErrorType]
}AddChildToProperty
Output type of the addChildToProperty mutation.
Fields
| Name | Description |
|---|---|
child(PropertyType) | The child property that was added to the parent. |
Example
{
"child": PropertyType
}Fields
| Name | Description |
|---|---|
callId(UUID!) | UUID identifying the call this participant belongs to. |
reason(String) | The reason for the given status. |
status(AddHistoricalCallParticipantResultStatus!) | The processing status: success, skipped, or error. |
vendorCallLegId(String!) | The call system's identifier for this call leg. |
Example
{
"callId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"vendorCallLegId": "abc123",
"status": "SUCCESS",
"reason": "abc123"
}AddHistoricalCallParticipants
Output type of the addHistoricalCallParticipants mutation.
Fields
| Name | Description |
|---|---|
results([AddHistoricalCallParticipantResultType]) | Per-participant processing results. |
summary(AddHistoricalCallParticipantsSummaryType) | Summary counts of the processing results. |
Example
{
}Fields
| Name | Description |
|---|---|
failed(Int!) | Number of participants that failed to process. |
successful(Int!) | Number of participants that were successfully added or skipped. |
total(Int!) | Total number of participants processed. |
Example
{
"total": 1,
"successful": 1,
"failed": 1
}AddItemsToRiskList
Output type of the addItemsToRiskList mutation.
Fields
| Name | Description |
|---|---|
riskIdentifiers([RiskListItemType]) | List of successfully added risk identifiers. |
Example
{
}AddNoteToInkConversation
Output type of the addNoteToInkConversation mutation.
Fields
| Name | Description |
|---|---|
note(InkNote) | The ink conversation note. |
Example
{
}AddOpportunityEvent
Output type of the addOpportunityEvent mutation.
Fields
| Name | Description |
|---|---|
eventType(String) | The event type that was added. |
Example
{
"eventType": "abc123"
}AddParentToProperty
Output type of the addParentToProperty mutation.
Fields
| Name | Description |
|---|---|
parent(PropertyType) | The parent property that was added to the child. |
Example
{
"parent": PropertyType
}AddPartnerUserToTeam
Output type of the addPartnerUserToTeam mutation.
Fields
| Name | Description |
|---|---|
partnerUser(PartnerUserType) | The partner user that was added to the team. |
Example
{
}AddPortfolioReference
Output type of the addPortfolioReference mutation.
Fields
| Name | Description |
|---|---|
portfolioNumber(String) | Number of the portfolio to which the reference was added. |
Example
{
"portfolioNumber": "abc123"
}AddProperty
Output type of the addProperty mutation.
Fields
| Name | Description |
|---|---|
property(PropertyType) | The property that was added to the account. |
Example
{
"property": PropertyType
}AddPropertyToHierarchy
Output type of the addPropertyToHierarchy mutation.
Fields
| Name | Description |
|---|---|
property(PropertyType) | The property that was added to the hierarchy. |
Example
{
"property": PropertyType
}AddSignupReferralOnAccount
Output type of the addSignupReferralOnAccount mutation.
Fields
| Name | Description |
|---|---|
accountReferral(ReferralType) | The created account referral instance. |
Example
{
"accountReferral": ReferralType
}AddStorylineToInkConversation
Output type of the addStorylineToInkConversation mutation.
Fields
| Name | Description |
|---|---|
storyline(InkStoryline) | The storyline that was added to the conversation. |
Example
{
}AddTelcoQuoteToAccount
Output type of the addTelcoQuoteRequestToAccount mutation.
Fields
| Name | Description |
|---|---|
accountNumber(String) | The account number to which the quote has been added. |
quotingCode(String) | The quoting code of the quote that has been added to the account. |
Example
{
"accountNumber": "abc123",
"quotingCode": "abc123"
}AddUserToPortfolio
Output type of the addUserToPortfolio mutation.
Fields
| Name | Description |
|---|---|
roleCode(String) | The code of the role added to the user. |
Example
{
"roleCode": "abc123"
}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
}AddressFieldConfigType
Configuration for a single field in an address form.
Fields
| Name | Description |
|---|---|
default(String) | Pre-filled seed value shown before any user interaction. Null if not set. |
errors([String!]!) | Validation error messages for this field. Empty when the field is valid or no validation has been run. |
fieldType(AddressFieldTypeEnum!) | Input widget type to render for this field. |
hasAutocomplete(Boolean!) | Whether this field's SELECT options are fetched via the autocompleteAddressFieldOptions query rather than inlined in |
label(String!) | Country-specific human-readable label, e.g. 'Suburb' or 'Postcode'. |
name(String!) | Machine identifier for the field, e.g. 'locality' or 'postal_code'. |
options([AddressFieldOptionType!]) | Available options for SELECT fields with a fixed option list. Empty for autocompletable SELECT fields (see |
placeholder(String) | Hint text shown inside the input when it is empty. |
userEditable(Boolean!) | Whether the user can interact with this field. False for hidden fields. |
validation(AddressFieldValidationRuleType!) | Client-side validation constraints for this field. |
value(String) | Submitted or pre-loaded form value. Null if not set. |
Example
{
"name": "abc123",
"label": "abc123",
"fieldType": "TEXT",
"validation": AddressFieldValidationRuleType,
"options": [AddressFieldOptionType],
"hasAutocomplete": true,
"userEditable": true,
"default": "abc123",
"placeholder": "abc123",
"value": "abc123",
"errors": "abc123"
}AddressFieldDescriptorType
Describes the structure of an address form for a given country, including all field groups, field configurations, and validation rules.
Fields
| Name | Description |
|---|---|
fieldGroups([AddressFieldGroupType!]!) | Ordered list of field groups making up the address form. |
Example
{
"fieldGroups": AddressFieldGroupType
}AddressFieldGroupType
A named group of address fields forming a logical section of the form.
Fields
| Name | Description |
|---|---|
fields([AddressFieldConfigType!]!) | Ordered list of fields in this group. |
label(String) | Optional UI section heading. Null for unlabelled groups. |
name(String!) | Machine identifier for the group, e.g. 'addressfields' or 'countryselection'. |
Example
{
"name": "abc123",
"label": "abc123",
"fields": AddressFieldConfigType
}AddressFieldOptionType
A single selectable option for a SELECT address field.
Fields
| Name | Description |
|---|---|
label(String!) | Human-readable text shown in the dropdown, e.g. 'New South Wales'. |
value(String!) | The raw value submitted with the form, e.g. 'NSW'. |
Example
{
"value": "abc123",
"label": "abc123"
}AddressFieldValidationRuleType
Client-side validation constraints for an address field. These rules can be enforced without a server round-trip.
Fields
| Name | Description |
|---|---|
maxLength(Int) | Maximum number of characters allowed. Null if no limit. |
regex(String) | Regular expression the submitted value must match. Null if unrestricted. |
required(Boolean!) | Whether the field must be filled before submitting. |
Example
{
"required": true,
"maxLength": 1,
"regex": "abc123"
}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 |
|---|---|
accessibleAccounts(AccountAccessConnectionTypeConnection) | Accounts this partner can access, with the roles granting that access. |
accessibleBusinesses(BusinessAccessConnectionTypeConnection) | Businesses this partner can access, with the roles granting that access. |
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!) | The ID of the affiliate organisation. |
isFieldSalesOnlyProduct(Boolean) | Restrict to field-sales-only products? This is only allowed for the 'field-sales' and 'events' sales channels. |
name(String!) | The name of the affiliate organisation. |
number(String!) | Unique identifier for the organisation in the format O-XXXXXXXX. |
partnerUserAccessors(PartnerUserAccessorAccessConnectionTypeConnection) | Partner users that have access to this partner, with their access information. |
references([OrganisationReferenceType]) | External references attached to the organisation, keyed by namespace. |
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",
"salesChannel": "DIRECT",
"salesChannelCode": "abc123",
"defaultAccountType": "BUSINESS",
"canRegisterBusinessMeterPoints": true,
"canRegisterPortfolioAccounts": true,
"canRegisterCustomersWithoutEmailAddress": true,
"skipMeterPointAddressValidation": true,
"allowAlternativePaymentMethods": true,
"canRenewTariffs": true,
"canUseIvrSupportApi": true,
"isFieldSalesOnlyProduct": true,
"accessibleAccounts": AccountAccessConnectionTypeConnection,
"accessibleBusinesses": BusinessAccessConnectionTypeConnection,
"partnerUserAccessors": PartnerUserAccessorAccessConnectionTypeConnection
}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 auxiliary status. |
status(String) | The current auxiliary status of the agent. |
updatedAt(DateTime) | The timestamp when the status was last updated. |
Example
{
"id": "abc123",
"status": "abc123",
"updatedAt": "2020-01-01T00:00:00.000Z"
}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. |
updatedAt(DateTime!) |
Example
{
"id": "abc123",
"status": "IN_PROGRESS",
"failureReason": "abc123",
"flowReference": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"agreement": CommonAgreementType
}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",
"rolloverType": "DEFAULT",
"expectedSendDate": "2020-01-01",
"status": "PENDING",
"params": {"key": "value"},
"failureReason": "abc123",
"actualSendDate": "2020-01-01",
"suppressComms": true,
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"tags": ["abc123"],
"agreement": CommonAgreementType,
"rolledOnTo": CommonAgreementType
}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
Output type of the allowRepaymentSubmission mutation.
Fields
| Name | Description |
|---|---|
repaymentId(ID) | The repayment ID. |
repaymentIntervention(RepaymentInterventionType) | Resulting Repayment Intervention details. |
Example
{
"repaymentId": "abc123"
}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
}Fields
| Name | Description |
|---|---|
contract(Contract) | The contract after the subject amendments have been applied. |
Example
{
"contract": Contract
}AmendPayment
Output type of the amendPayment mutation.
Fields
| Name | Description |
|---|---|
payment(AccountPaymentType) |
Example
{
"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. |
uuid(UUID!) | Unique identifier for the annulment billing document. |
Example
{
"id": 1,
"uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"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",
"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",
"account": TelcoAccountType
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ApplicableRateEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ApplicableRateEdge,
"totalCount": 1,
"edgeCount": 1
}ApplicableRateEdge
A Relay edge containing a ApplicableRate and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ApplicableRateType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
category(String) | The category of the rate, e.g. 'CONSUMPTIONCHARGE' or 'STANDINGCHARGE'. |
currency(String) | The currency the rate is priced in. |
isSalesTax(Boolean!) | Whether the rate represents a sales tax. |
name(String!) | The display name of the rate. |
overridePrice(Decimal) | Override price for the applicable rate. |
pricePerUnit(Decimal!) | Price per unit. |
rateId(Int) | Technical identifier of the applicable rate. |
sourceSystem(String!) | The system the rate was sourced from. |
unit(String!) | Unit of the applicable rate. |
unitDisplay(String!) | A human-readable display of the unit, e.g. 'p/kWh'. |
validityPeriod(ApplicableRateValidityPeriodType!) | The period during which the rate is valid. |
variantProfile(VariantProfile!) | The variant profile for the applicable rate. |
Example
{
"sourceSystem": "abc123",
"name": "abc123",
"pricePerUnit": "1.0",
"unit": "abc123",
"unitDisplay": "abc123",
"variantProfile": VariantProfile,
"rateId": 1,
"overridePrice": "1.0",
"currency": "abc123",
"category": "abc123",
"isSalesTax": true
}ApplicableRateValidityPeriodType
Represents the period during which a rate is valid.
Fields
| Name | Description |
|---|---|
end(DateTime) | The date and time until which the rate is valid. Null indicates the rate has no end date. |
start(DateTime) | The date and time from which the rate is valid. |
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z"
}ApproveRepayment
Output type of the approveRepayment mutation.
Fields
| Name | Description |
|---|---|
repayment(AccountRepaymentType) | The approved repayment. |
Example
{
"repayment": AccountRepaymentType
}AssessCollectionProcessRecordForPause
Output type of the assessCollectionProcessRecordForPause mutation.
Fields
| Name | Description |
|---|---|
collectionProcessProcessed(AssessCollectionProcessRecordForPauseOutputType) | Details of collection process after running the pause assessment. |
Example
{
}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
Output type of the assignInkBucket mutation.
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. |
Example
{
"conversation": InkConversation
}AssignSupplyPointToEstimationGroup
Output type of the assignSupplyPointToEstimationGroup mutation.
Fields
| Name | Description |
|---|---|
supplyPointEstimationGroup(AssignedSupplyPointEstimationGroupType) | The created supply point estimation group mapping. |
Example
{
}Fields
| Name | Description |
|---|---|
estimationGroupCode(String!) | The code of the estimation group. |
supplyPointExternalId(String!) | The external identifier of the assigned supply point. |
Example
{
"estimationGroupCode": "abc123",
"supplyPointExternalId": "abc123"
}Fields
| Name | Description |
|---|---|
identifier(String) | Unique identifier for the assigned team. |
name(String) | Display name for the assigned team. |
teamType(AssignedTeamTypeEnum) | Type of assigned team. |
Example
{
"identifier": "abc123",
"name": "abc123",
"teamType": "PARTNER_TEAM"
}Fields
| Name | Description |
|---|---|
email(String) | Email address of the assigned user. |
identifier(String) | Unique identifier for the assigned user. |
name(String) | Display name for the assigned user. |
userType(AssignedUserTypeEnum) | Type of assigned user. |
Example
{
"identifier": "abc123",
"name": "abc123",
"email": "abc123",
"userType": "SUPPORT_USER"
}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"
}AssociateArchivedCallRecordingsWithCalls
Output type of the associateArchivedCallRecordingsWithCalls mutation.
Fields
| Name | Description |
|---|---|
results([AssociateArchivedRecordingResultType]) | Per-recording processing results. |
summary(AssociateArchivedRecordingsSummaryType) | Summary counts of the processing results. |
Example
{
}Fields
| Name | Description |
|---|---|
reason(String) | If skipped or errored, the reason why. |
recordingId(Int) | The ID of the recording, if one exists. |
status(AssociateArchivedRecordingResultStatus!) | The processing status: success, skipped, or error. |
vendorCallLegId(String!) | The vendor call leg ID from the input. |
Example
{
"vendorCallLegId": "abc123",
"recordingId": 1,
"status": "SUCCESS",
"reason": "abc123"
}Fields
| Name | Description |
|---|---|
failed(Int!) | Number of recordings that failed to process. |
successful(Int!) | Number of recordings that were successfully archived or skipped. |
total(Int!) | Total number of recordings processed. |
Example
{
"total": 1,
"successful": 1,
"failed": 1
}AssociateCallWithAccount
Output type of the associateCallWithAccount mutation.
Fields
| Name | Description |
|---|---|
call(InboundCallType) | The call. |
Example
{
}AssociateItemToCollectionProcess
Output type of the associateItemToCollectionProcess mutation.
Fields
| Name | Description |
|---|---|
collectionProcessAssociatedItem(AssociateItemToCollectionProcessOutputType) | Item associated to the collection process. |
Example
{
}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"
}Fields
| Name | Description |
|---|---|
ok(Boolean!) | True if the agreements were successfully attached. |
Example
{
"ok": true
}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
Output type of the attemptToWithdrawCollectionProcess mutation.
Fields
| Name | Description |
|---|---|
withdrawSuccessful(Boolean) | Whether the collection process was withdrawn successfully. |
Example
{
"withdrawSuccessful": true
}AttemptToWithdrawDunning
Output type of the attemptToWithdrawDunning mutation.
Fields
| Name | Description |
|---|---|
withdrawSuccessful(Boolean) | Whether the dunning process was withdrawn successfully. |
Example
{
"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"
}AuxiliaryResultConnection
Pagination for a charge's auxiliary results.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AuxiliaryResultEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AuxiliaryResultEdge,
"totalCount": 1,
"edgeCount": 1
}AuxiliaryResultEdge
A Relay edge containing a AuxiliaryResult and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AuxiliaryResultInterface) | The item at the end of the edge |
Example
{
"node": AuxiliaryResultInterface,
"cursor": "abc123"
}AuxiliaryResultPeriodType
The period an auxiliary result covers.
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z"
}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]
}AvailableServiceTestType
Describes a diagnostic test that can be initiated for this service. Pass testType to the initiateServiceTest mutation to start a run.
Fields
| Name | Description |
|---|---|
description(String!) | Human-readable explanation of what this test checks and what it produces. |
measures([ServiceTestMeasureSpecType]!) | The measures a completed run of this test is expected to produce. |
name(String!) | Short human-readable name for this test. |
resultMode(ServiceTestResultMode!) | How the test delivers its result. Use this to decide whether to poll getServiceTestRuns after initiating. |
testType(ServiceTestType!) | The test type value to pass to the initiateServiceTest mutation. |
Example
{
"testType": "FTTP_LINE_TEST",
"name": "abc123",
"description": "abc123",
"resultMode": "SYNC",
"measures": ServiceTestMeasureSpecType
}AwardLoyaltyPoints
Output type of the awardLoyaltyPoints mutation.
Fields
| Name | Description |
|---|---|
ledgerEntry(LoyaltyPointLedgerEntryType) | The ledger entry for the awarded loyalty points. |
pointsAwarded(Int) | The number of loyalty points that were awarded. |
Example
{
"pointsAwarded": 1,
"ledgerEntry": LoyaltyPointLedgerEntryType
}BackendScreenEvent
Output type of the backendScreenEvent mutation.
Fields
| Name | Description |
|---|---|
action(ActionType) | An action to perform. |
Example
{
"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. |
latestBillingDocumentIdentifier(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. |
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",
"latestBillingDocumentIdentifier": "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. |
latestBillingDocumentIdentifier(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. |
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. |
reversedCharge(BillCharge) | If this credit reverses a charge, the charge it reverses. Null otherwise. |
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",
"latestBillingDocumentIdentifier": "abc123",
"reversedCharge": BillCharge
}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. |
latestBillingDocumentIdentifier(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. |
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",
"latestBillingDocumentIdentifier": "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. |
latestBillingDocumentIdentifier(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. |
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",
"latestBillingDocumentIdentifier": "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"
}BillRepresentationContextType
Provides the rendering context data used to generate a bill representation, along with its associated JSON Schema metadata.
Fields
| Name | Description |
|---|---|
data(GenericScalar) | The raw template context used to render the bill representation. Returns null if the context data is unavailable. |
schema(GenericScalar) | The schema defining the expected structure of the |
schemaType(String) | The level of explicit structural typing applied to the context data. 'STRICT' indicates that the data conforms to a defined, typed schema; 'NONE' indicates that the data is untyped and no schema is enforced. |
templateCode(String) | The unique code of the template associated with this context. |
Example
{
"data": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"schema": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"schemaType": "abc123",
"templateCode": "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. |
context(BillRepresentationContextType) | The rendering context data and schema associated with this bill representation. Returns null if no context record exists. |
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",
"context": BillRepresentationContextType
}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
Output type of the blockRepaymentSubmission mutation.
Fields
| Name | Description |
|---|---|
repaymentId(ID) | The repayment ID. |
repaymentIntervention(RepaymentInterventionType) | Resulting Repayment Intervention details. |
Example
{
"repaymentId": "abc123"
}BookFaultAppointmentOutput
Output for booking a fault appointment.
Fields
| Name | Description |
|---|---|
appointment(FaultAppointment) | The booked fault appointment. |
Example
{
"appointment": FaultAppointment
}BookInstallationAppointment
Output type of the bookInstallationAppointment mutation.
Fields
| Name | Description |
|---|---|
installationAppointment(InstallationAppointmentType) | The book installation appointment response. |
Example
{
"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 |
|---|---|
earliestActivationDate(Date) | The earliest possible activation date for this installation option. |
installType(InstallationType) | The type of installation. |
isSelected(Boolean) | Whether the installation option is selected. |
requiresInstallation(Boolean) | Does the product require installation. |
Example
{
"requiresInstallation": true,
"installType": "LINE_INSTALLATION",
"isSelected": true,
"earliestActivationDate": "2020-01-01"
}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. |
isParentOrder(Boolean) | Whether this order is a root order in the product order hierarchy (it has no parent 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],
"isParentOrder": true
}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
Output type of the bulkAwardLoyaltyPoints mutation.
Fields
| Name | Description |
|---|---|
failed([BulkAwardLoyaltyPointsFailedItemResult]) | Failed loyalty point awards. |
inserted([BulkAwardLoyaltyPointsInsertedItemResult]) | Successfully inserted loyalty point awards. |
Example
{
"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
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BusinessAccessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BusinessAccessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}BusinessAccessConnectionTypeEdge
A Relay edge containing a BusinessAccessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BusinessAccessType) | The item at the end of the edge |
Example
{
"node": BusinessAccessType,
"cursor": "abc123"
}BusinessAccessType
Represents the accessible business and access information of an accessor.
Fields
| Name | Description |
|---|---|
entity(BusinessType!) | The business that the accessor has access to. |
roleAssignments([RoleAssignment]!) | The role assignments that the accessor has for the entity. |
Example
{
"roleAssignments": RoleAssignment,
"entity": BusinessType
}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"
}BusinessCreditCheckDataType
The business data a third party needs to run a credit check.
Fields
| Name | Description |
|---|---|
businessType(String!) | The type of business (e.g. limited company, sole trader). |
checkId(UUID!) | The |
companyCountry(String) | The country of the business billing address, if known. |
companyName(String!) | The registered or trading name of the business. |
companyPostcode(String) | The postcode of the business billing address, if known. |
companyRegistrationNumber(String) | The company registration number, if the business has one. |
Example
{
"checkId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"businessType": "abc123",
"companyName": "abc123",
"companyRegistrationNumber": "abc123",
"companyPostcode": "abc123",
"companyCountry": "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 |
|---|---|
code(String!) | The unique code of the role. |
description(String!) | The description of the role. |
name(String!) | The unique displayable name of the role. |
permissionCodes([String]!) | The permissions associated with the role. |
Example
{
"code": "abc123",
"name": "abc123",
"description": "abc123",
"permissionCodes": "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 |
|---|---|
accountUserAccessors(AccountUserAccessorAccessConnectionTypeConnection) | Account users that have access to this business, with their access information. |
billingAddress(RichAddressType) | The billing address of the business. |
businessType(BusinessTypeOptions) | The company type of a business account. |
details([BusinessDetailType]) | The details of the business. |
displayableNumber(String) | Kraken-generated, human-readable number for display purposes. |
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. |
partnerAccessors(PartnerAccessorAccessConnectionTypeConnection) | Partners that have access to this business, with their access information. |
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",
"displayableNumber": "abc123",
"businessType": "SOLE_TRADER",
"sectors": BusinessSectorString,
"details": [BusinessDetailType],
"billingAddress": RichAddressType,
"legalAddress": RichAddressType,
"linkedAccountNumber": "abc123",
"linkedAccountNumbers": "abc123",
"segmentName": "abc123",
"paymentMethods": PaymentInstructionConnectionTypeConnection,
"accountUserAccessors": AccountUserAccessorAccessConnectionTypeConnection,
"partnerAccessors": PartnerAccessorAccessConnectionTypeConnection
}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]
}CallConnectionTypeConnection
Paginator of Calls
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([CallConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": CallConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}CallConnectionTypeEdge
A Relay edge containing a CallConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CallInterface) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}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. |
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. |
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",
"callStart": "2020-01-01T00:00:00.000Z",
"callDuration": 1,
"billedDuration": 1,
"timeband": "abc123",
"itemisationGroup": "abc123",
"grossCharge": Money,
"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"
}Fields
| Name | Description |
|---|---|
allowanceMinutes(Int) | Included international call allowance in minutes. |
usedMinutes(Int!) | Unbilled international call usage from the current billing period, rounded up to whole minutes. |
Example
{
"usedMinutes": 1,
"allowanceMinutes": 1
}Fields
| Name | Description |
|---|---|
data(JSONString) | Data containing context of the event. |
eventType(String) | The type of event. |
occurredAt(DateTime) | Timestamp for when the event occurred. |
relativeOccurredAt(Int) | Time in milliseconds, relative to the start of the recording. |
Example
{
"data": {"key": "value"},
"eventType": "abc123",
"relativeOccurredAt": 1,
"occurredAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
callDirection(String) | The direction the call was initiated. |
callId(ID) | ID of the associated call. |
download(CallRecordingDownloadType) | A download for the archived recording file. Null when the recording is unavailable. |
endTime(DateTime) | End time of the call recording. |
events([CallRecordingDetailEventType]) | A list of recording events. |
fromPhoneNumber(String) | Phone number of the caller. |
primaryAgentEmail(String) | Email of the call's main agent. |
startTime(DateTime) | Start time of the call recording. |
toPhoneNumber(String) | Phone number of the callee. |
Example
{
"callId": "abc123",
"callDirection": "abc123",
"primaryAgentEmail": "abc123",
"toPhoneNumber": "abc123",
"fromPhoneNumber": "abc123",
"startTime": "2020-01-01T00:00:00.000Z",
"endTime": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
expiresAt(DateTime) | The time at which the presigned |
url(String) | Presigned S3 URL for the recording file. Valid for one hour from the time the response is generated. |
Example
{
"url": "abc123",
"expiresAt": "2020-01-01T00:00:00.000Z"
}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
}CallTranscriptConnectionTypeConnection
Paginator of Call Transcripts
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([CallTranscriptConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": CallTranscriptConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}CallTranscriptConnectionTypeEdge
A Relay edge containing a CallTranscriptConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CallTranscriptType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
expiresAt(DateTime!) | The time at which the presigned |
type(CallTranscriptionType!) | Whether |
url(String!) | Presigned S3 URL for the transcript file. Valid for one hour from the time the response is generated. |
Example
{
"url": "abc123",
"type": "REDACTED",
"expiresAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
call(CallInterface) | The call this transcription is for. May be null when the underlying recording is a participant-level recording whose participant is not associated with a call. |
createdAt(DateTime!) | The time at which this transcription record was created. |
download(CallTranscriptDownloadType) | A presigned download for the transcript file, or null when the transcription is not COMPLETED, no eligible file exists, or the caller lacks permission for the only available file. |
id(ID!) | The ID of the transcription record. |
status(CallTranscriptionStatus!) | The processing status of this transcription. A non-COMPLETED status means no |
transcribedAt(DateTime) | The time the vendor reported the transcription complete. Null until the transcription reaches COMPLETED status. |
vendor(String!) | The transcription vendor that produced this record. |
Example
{
"id": "abc123",
"status": "CREATED",
"vendor": "abc123",
"transcribedAt": "2020-01-01T00:00:00.000Z",
"createdAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
permanentUsageLimit(Money) | Permanent monetary usage limit. |
temporaryUsageLimit(Money) | Temporary monetary usage limit when set. |
Fields
| Name | Description |
|---|---|
isSuspended(Boolean) | True if the service is suspended and false if it is not. |
limits(CallUsageLimitsType!) | Monetary call usage limits. |
suspendedAt(DateTime) | If the service is suspended, when it was suspended. |
unbilled(CallUsageUnbilledType!) | Unbilled call usage from the current billing period. |
Example
{
"unbilled": CallUsageUnbilledType,
"limits": CallUsageLimitsType,
"isSuspended": true,
"suspendedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
international(CallMinutesUsageType) | Unbilled international call usage from the current billing period. |
Example
{
"international": CallMinutesUsageType
}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
Output type of the cancelContract mutation.
Fields
| Name | Description |
|---|---|
cancelContract(CancellationContractType) | Cancel contract for the chosen contract. |
Example
{
"cancelContract": CancellationContractType
}CancelEngineer
Output type of the cancelEngineer mutation.
Fields
| Name | Description |
|---|---|
appointment(FaultAppointment) | The cancelled fault appointment. |
Example
{
"appointment": FaultAppointment
}CancelOnSiteJobsAppointment
Output type of the cancelOnSiteJobsAppointment mutation.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The Appointment that was cancelled. |
Example
{
}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
Output type of the cancelPayment mutation.
Fields
| Name | Description |
|---|---|
payment(AccountPaymentType) | The cancelled payment. |
Example
{
"payment": AccountPaymentType
}CancelRepaymentRequest
Output type of the cancelRepaymentRequest mutation.
Fields
| Name | Description |
|---|---|
repaymentRequest(CancelRepaymentRequestOutputType) | The cancelled repayment/refund request. |
Example
{
"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
Output type of the cancelReturnsBagReorder mutation.
Fields
| Name | Description |
|---|---|
status(String) | The result of the operation. |
Example
{
"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 |
|---|---|
allSubOfferings([CatalogSubOffering]) | All selected sub-offerings within an offering and it's sub-offerings. |
catalogProducts([CatalogProduct]) | All products within an offering tree. |
catalogTerms([CatalogTerm]) | Terms directly within offering. |
description(String) | Customer facing description for offering. |
identifier(String) | Unique identifier for offering. |
name(String) | Customer facing name for offering. |
offeringCatalogProducts([CatalogProduct]) | Products directly within offering. |
Example
{
"identifier": "abc123",
"name": "abc123",
"description": "abc123",
"catalogTerms": [CatalogTerm],
"offeringCatalogProducts": [CatalogProduct],
"catalogProducts": [CatalogProduct],
"allSubOfferings": [CatalogSubOffering]
}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. |
specificationIdentifier(ID) | Identifier of the product specification associated with this 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",
"specificationIdentifier": "abc123"
}Fields
| Name | Description |
|---|---|
catalogTerms([CatalogTerm]) | Terms directly within offering. |
description(String) | Customer facing description for offering. |
identifier(String) | Unique identifier for offering. |
name(String) | Customer facing name for offering. |
offeringCatalogProducts([CatalogProduct]) | Products directly within offering. |
parentOfferingIdentifier(String) | Parent offering identifier. |
Example
{
"identifier": "abc123",
"name": "abc123",
"description": "abc123",
"catalogTerms": [CatalogTerm],
"offeringCatalogProducts": [CatalogProduct],
"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 |
|---|---|
krakenOrderId(String!) | The ID of the order that was created to change the broadband speed. |
Example
{
"krakenOrderId": "abc123"
}ChangeContractGroupComposition
Output type of the changeContractGroupComposition mutation.
Fields
| Name | Description |
|---|---|
contractGroupIdentifier(UUID!) | The identifier of the contract group whose composition was changed. |
Example
{
"contractGroupIdentifier": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}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 |
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
Output type of the chooseTelcoProduct mutation.
Fields
| Name | Description |
|---|---|
availableExtras([TelcoProductExtrasType]) | Available extras for the chosen product. |
availableInstallationAppointments([InstallationAppointmentType]) | Available installation appointments. |
Example
{
"availableExtras": [TelcoProductExtrasType],
"availableInstallationAppointments": [InstallationAppointmentType]
}ChooseTelcoProductExtras
Output type of the chooseTelcoProductExtras mutation.
Fields
| Name | Description |
|---|---|
orderDetails(QuotedTelcoProductOutputType) | The selected product and extras for the quote. |
Example
{
"orderDetails": QuotedTelcoProductOutputType
}ChooseTelcoProductExtrasForAccount
Output type of the chooseTelcoProductExtrasForAccount mutation.
Fields
| Name | Description |
|---|---|
orderDetails(QuotedTelcoProductOutputType) | The selected product and extras for the quote. |
Example
{
"orderDetails": QuotedTelcoProductOutputType
}ChooseTelcoProductForAccount
Output type of the chooseTelcoProductForAccount mutation.
Fields
| Name | Description |
|---|---|
availableExtras([TelcoProductExtrasType]) | Available extras for the chosen product. |
availableInstallationAppointments([InstallationAppointmentType]) | Available installation appointments. |
Example
{
"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
Output type of the closeDcaProceeding mutation.
Fields
| Name | Description |
|---|---|
dcaProceedingClosureStatus(DCAProceedingClosureStatus) | Whether the closure could be applied. |
Example
{
}CloseInkConversation
Output type of the closeInkConversation mutation.
Fields
| Name | Description |
|---|---|
conversation(InkConversation) | The conversation that was closed. |
Example
{
"conversation": InkConversation
}CloseInkLiveChatConversation
Output type of the closeInkLiveChat mutation.
Fields
| Name | Description |
|---|---|
liveChatConversation(InkLiveChatConversation) | The live chat conversation. |
Example
{
"liveChatConversation": InkLiveChatConversation
}CloseOpenPrintBatch
Output type of the closeOpenPrintBatch mutation.
Fields
| Name | Description |
|---|---|
printBatch(PrintBatchType) |
Example
{
}CollectDeposit
Output type of the collectDeposit mutation.
Fields
| Name | Description |
|---|---|
payment(CollectDepositOutput) |
Example
{
}Fields
| Name | Description |
|---|---|
paymentDate(Date) | |
status(CollectDepositStatusChoices) |
Example
{
"status": "APPROVED",
"paymentDate": "2020-01-01"
}CollectPayment
Output type of the collectPayment mutation.
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. |
Example
{
"payment": AccountPaymentType
}CollectUpFrontPayment
Output type of the collectUpFrontPayment mutation.
Fields
| Name | Description |
|---|---|
payment(UpfrontPaymentDetails) | Details of any upfront payment required. |
Example
{
"payment": UpfrontPaymentDetails
}Fields
| Name | Description |
|---|---|
code(String!) | The code of the collection. |
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
{
"code": "abc123",
"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. |
latestStep(CollectionProcessStepType) | The most recent step of the collection process, if it has one. |
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"}
}CollectionProcessStepType
Collection process step type
Fields
| Name | Description |
|---|---|
status(CollectionProcessStepStatus) | The status of the step. |
stepIdentifier(String) | The step identifier. |
Example
{
"stepIdentifier": "abc123",
"status": "COMPLETED"
}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. This may differ from the service/consumption period shown on the bill document. |
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. |
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. This may differ from the service/consumption period shown on the bill document. |
uuid(UUID) | Unique identifier for the billing document. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"constituents": ConstituentConnection,
"identifier": "abc123"
}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
Output type of the commenceDcaProceeding mutation.
Fields
| Name | Description |
|---|---|
dcaProceedingCommencementStatus(DCAProceedingCommencementStatus) | Whether the commencement could be applied. |
Example
{
}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. |
ratesAgreedAt(DateTime!) | |
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",
"ratesAgreedAt": "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!) | |
isOfficial(Boolean) | Whether this is an official complaint. |
officialEntity(String) | The official entity associated with this complaint. |
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",
"isOfficial": true,
"officialEntity": "abc123"
}CompleteApproval
Output type of the completeApproval mutation.
Fields
| Name | Description |
|---|---|
completedApproval(CompletedApproval) | The result of completing the approval. |
Example
{
}CompleteReminder
Output type of the completeReminder mutation.
Fields
| Name | Description |
|---|---|
reminderId(Int) | ID of the completed reminder. |
Example
{
"reminderId": 1
}CompleteReturnsBagReorder
Output type of the completeReturnsBagReorder mutation.
Fields
| Name | Description |
|---|---|
status(String) | The result of the operation. |
Example
{
"status": "abc123"
}CompleteStandalonePayment
Output type of the completeStandalonePayment mutation.
Fields
| Name | Description |
|---|---|
payment(CompleteStandalonePaymentOutput) | The completed standalone payment. |
Example
{
"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
Output type of the completeTelcoSignup mutation.
Fields
| Name | Description |
|---|---|
accountNumber(String) | The new account's account number. |
Example
{
"accountNumber": "abc123"
}Fields
| Name | Description |
|---|---|
approvalUuid(UUID!) | The UUID of the completed approval. |
Example
{
"approvalUuid": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}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
Output type of the confirmDoubleOptIn mutation.
Fields
| Name | Description |
|---|---|
consent(ConsentType) | The consent that was created or updated. |
Example
{
"consent": ConsentType
}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
}Fields
| Name | Description |
|---|---|
splitPercentage(Decimal) | Percentage split for this TOU time slot. |
timeSlot(String) | Specific time slot within the TOU scheme (e.g. PEAK, OFFPEAK, SHOULDER). |
Example
{
"timeSlot": "abc123",
"splitPercentage": "1.0"
}ContactEmailType
A contact email address for the account user.
Fields
| Name | Description |
|---|---|
createdAt(DateTime) | When the contact email was added. |
email(String) | The contact email address. |
Example
{
"email": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z"
}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. |
rescindedAt(DateTime) | Date when the contract was rescinded, null if not rescinded. |
revokedAt(DateTime) | Date when the contract was revoked, null if not revoked. |
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",
"rescindedAt": "2020-01-01T00:00:00.000Z",
"revokedAt": "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. |
rescindedAt(DateTime) | Date when the contract was rescinded, null if not rescinded. |
revokedAt(DateTime) | Date when the contract was revoked, null if not revoked. |
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",
"rescindedAt": "2020-01-01T00:00:00.000Z",
"revokedAt": "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 |
|---|---|
accountContractIdentifier(String) | Identifier of the account contract this join supplier process is subject to. |
businessContractIdentifier(String) | Identifier of the business contract this join supplier process is subject to. |
Example
{
"accountContractIdentifier": "abc123",
"businessContractIdentifier": "abc123"
}Fields
| Name | Description |
|---|---|
href(String) | Contract PDF Summary. |
Example
{
"href": "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",
"fulfilledAt": "2020-01-01T00:00:00.000Z",
"agreement": ContributionAgreementType,
"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_KRAKEN_TIMESLOT_SELECTION",
"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. Deprecated The 'marketSupplyPoints' field is deprecated. |
reason(String!) | |
status(String!) | |
supplyPointsInterface(SupplyPointInterfaceConnection) | List of supply points on request. Node type is the CommonSupplyPointInterface; use inline fragments to access concrete types. |
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",
"marketSupplyPoints": SupplyPointConnectionTypeConnection,
"supplyPointsInterface": SupplyPointInterfaceConnection,
"appointments": [CoreSiteworksAppointmentType]
}CreateAPICall
Output type of the createApiCall mutation.
Fields
| Name | Description |
|---|---|
apiCall(APICallType) | The created APICall. |
Example
{
}CreateAPIException
Output type of the createApiException mutation.
Fields
| Name | Description |
|---|---|
apiException(APIExceptionType) | The created APIException. |
Example
{
}CreateAPIExceptionEvent
Output type of the createApiExceptionEvent mutation.
Fields
| Name | Description |
|---|---|
apiExceptionEvent(APIExceptionEventType) | The created APIExceptionEvent. |
Example
{
}CreateAPIExceptionNote
Output type of the createApiExceptionNote mutation.
Fields
| Name | Description |
|---|---|
apiException(APIExceptionType) | The created APIExceptionNote. |
Example
{
}CreateAccountCharge
Output type of the createAccountCharge mutation.
Fields
| Name | Description |
|---|---|
accountCharge(AccountChargeType) |
Example
{
"accountCharge": AccountChargeType
}CreateAccountFileAttachmentPayload
Output type of the createAccountFileAttachment mutation.
Fields
| Name | Description |
|---|---|
clientMutationId(String) | Deprecated The 'clientMutationId' field is deprecated. |
postRequest(UploadPostRequest) |
Example
{
"postRequest": UploadPostRequest,
"clientMutationId": "abc123"
}CreateAccountManualHold
Output type of the createAccountManualHold mutation.
Fields
| Name | Description |
|---|---|
accountManualHold(AccountManualHoldType!) | The created manual hold. |
Example
{
}CreateAccountNote
Output type of the createAccountNote mutation.
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
{
"account": TelcoAccountType,
"possibleErrors": [PossibleErrorType]
}CreateAccountPaymentSchedule
Output type of the createAccountPaymentSchedule mutation.
Fields
| Name | Description |
|---|---|
schedule(PaymentScheduleType!) | New payment schedule. |
Example
{
"schedule": PaymentScheduleType
}CreateAccountReference
Output type of the createAccountReference mutation.
Fields
| Name | Description |
|---|---|
accountReference(AccountReferenceType) |
Example
{
"accountReference": AccountReferenceType
}CreateAccountReminder
Output type of the createAccountReminder mutation.
Fields
| Name | Description |
|---|---|
accountReminder(AccountReminder) | Account reminder. |
Example
{
}CreateAffiliateLink
Output type of the createAffiliateLink mutation.
Fields
| Name | Description |
|---|---|
affiliateLink(AffiliateLinkType) | The created affiliate link. |
Example
{
}CreateAffiliateOrganisation
Output type of the createAffiliateOrganisation mutation.
Fields
| Name | Description |
|---|---|
affiliateOrganisation(AffiliateOrganisationType) | The created affiliate organisation. |
Example
{
}CreateAffiliateSession
Output type of the createAffiliateSession mutation.
Fields
| Name | Description |
|---|---|
affiliateSession(AffiliateSessionType) | The created affiliate session. |
Example
{
}CreateAgreement
Output type of the createAgreement mutation.
Fields
| Name | Description |
|---|---|
agreement(CommonAgreementType) | The created agreement. |
Example
{
"agreement": CommonAgreementType
}CreateAgreementRollover
Output type of the createAgreementRollover mutation.
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
{
"agreementRollover": AgreementRolloverType,
"possibleErrors": [PossibleErrorType]
}CreateAudioRecording
Output type of the createAudioRecording mutation.
Fields
| Name | Description |
|---|---|
audioRecording(AudioRecordingType) | The created audio recording. |
Example
{
}CreateBusiness
Output type of the createBusiness mutation.
Fields
| Name | Description |
|---|---|
business(BusinessType) | The created business. |
Example
{
"business": BusinessType
}CreateCallMetadata
Output type of the createCallMetadata mutation.
Fields
| Name | Description |
|---|---|
call(CallInterface) | The call metadata was attached to. |
Example
{
}CreateCampaignItems
Output type of the createCampaignItems mutation.
Fields
| Name | Description |
|---|---|
batchIdentifier(String) | The identifier for this batch of items to assist in tracking and logging. |
campaignItems([VoiceCampaignItemType]) |
Example
{
"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
Output type of the createCollectionProcessEvent mutation.
Fields
| Name | Description |
|---|---|
collectionProcessEvent(CollectionProcessEventOutputType) | The created collection process event. |
Example
{
}CreateComplaint
Output type of the createComplaint mutation.
Fields
| Name | Description |
|---|---|
complaint(TelcoComplaintType) | The complaint that has been created. |
Example
{
"complaint": TelcoComplaintType
}CreateContractGroupOutput
Output type for creating a contract group.
Fields
| Name | Description |
|---|---|
contractGroupIdentifier(UUID!) | Unique identifier for the created or matched contract group. |
Example
{
"contractGroupIdentifier": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}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
Output type of the createContractSummary mutation.
Fields
| Name | Description |
|---|---|
contractInformation(ContractInformationOutput) | The contract information created. |
contractSummary(ContractSummaryOutput) | The contract summary created. |
Example
{
"contractSummary": ContractSummaryOutput,
"contractInformation": ContractInformationOutput
}CreateContractSummaryForAccount
Output type of the createContractSummaryForAccount mutation.
Fields
| Name | Description |
|---|---|
contractInformation(ContractInformationOutput) | The contract information created. |
contractSummary(ContractSummaryOutput) | The contract summary created. |
Example
{
"contractSummary": ContractSummaryOutput,
"contractInformation": ContractInformationOutput
}CreateContributionAgreement
Output type of the createContributionAgreement mutation.
Fields
| Name | Description |
|---|---|
contributionAgreement(ContributionAgreementType) | The created contribution agreement. |
Example
{
"contributionAgreement": ContributionAgreementType
}CreateCreditTransferPermission
Output type of the createCreditTransferPermission mutation.
Fields
| Name | Description |
|---|---|
validFrom(DateTime) | Datetime when the credit transfer permission is valid. |
Example
{
"validFrom": "2020-01-01T00:00:00.000Z"
}CreateCustomerFeedback
Output type of the createCustomerFeedback mutation.
Fields
| Name | Description |
|---|---|
customerFeedback(CustomerFeedbackType) | The created customer feedback object. |
Example
{
"customerFeedback": CustomerFeedbackType
}CreateDepositAgreement
Output type of the createDepositAgreement mutation.
Fields
| Name | Description |
|---|---|
depositAgreement(CreateDepositAgreementOutput) |
Example
{
}Example
{
"depositRequired": true,
"depositAmount": 1
}CreateExternalAccountEvent
Output type of the createExternalAccountEvent mutation.
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
Output type of the createExternalAccountUserEvent mutation.
Fields
| Name | Description |
|---|---|
event(ExternalAccountUserEvent) | The new event data. |
Example
{
}CreateExternalMessage
Output type of the createExternalMessage mutation.
Fields
| Name | Description |
|---|---|
externalMessage(ExternalMessageType) | The external message that was created. |
Example
{
}CreateExternalMessageEvent
Output type of the createExternalMessageEvent mutation.
Fields
| Name | Description |
|---|---|
externalMessageEvent(ExternalMessageEventType) | The external message event that was created. |
Example
{
}CreateFault
Output type of the createFault mutation.
Fields
| Name | Description |
|---|---|
fault(FaultType) | The fault that has been created. |
Example
{
"fault": FaultType
}CreateFixedPaymentPlan
Output type of the createFixedPaymentPlan mutation.
Fields
| Name | Description |
|---|---|
account(AccountInterface) | Account with a newly created payment plan. |
Example
{
"account": AccountInterface
}CreateGoodsPurchase
Output type of the createGoodsPurchase mutation.
Fields
| Name | Description |
|---|---|
goodsPurchase(GoodsPurchase) | Goods purchase created. |
Example
{
"goodsPurchase": GoodsPurchase
}CreateGoodsQuote
Output type of the createGoodsQuote mutation.
Fields
| Name | Description |
|---|---|
goodsQuote(GoodsQuote) | Goods quote created for the customer. |
Example
{
"goodsQuote": GoodsQuote
}CreateGoodsQuoteWithoutAccount
Output type of the createGoodsQuoteWithoutAccount mutation.
Fields
| Name | Description |
|---|---|
goodsQuote(GoodsQuote) | Goods quote created for the customer. |
Example
{
"goodsQuote": GoodsQuote
}Fields
| Name | Description |
|---|---|
id(UUID!) | UUID identifying the call, also used as an idempotency key. |
reason(String) | The reason for the given status. |
status(CreateHistoricalCallResultStatus!) | The processing status: success, skipped, or error. |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"status": "SUCCESS",
"reason": "abc123"
}CreateHistoricalCalls
Output type of the createHistoricalCalls mutation.
Fields
| Name | Description |
|---|---|
results([CreateHistoricalCallResultType]) | Per-call processing results. |
summary(CreateHistoricalCallsSummaryType) | Summary counts of the processing results. |
Example
{
}Fields
| Name | Description |
|---|---|
failed(Int!) | Number of calls that failed to process. |
successful(Int!) | Number of calls that were successfully created or skipped. |
total(Int!) | Total number of calls processed. |
Example
{
"total": 1,
"successful": 1,
"failed": 1
}CreateInboundCall
Output type of the createInboundCall mutation.
Fields
| Name | Description |
|---|---|
call(InboundCallType) | The call that was created. |
Example
{
}CreateInkInboundMessage
Output type of the createInkInboundMessage mutation.
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
{
"message": InkEmail,
"possibleErrors": [PossibleErrorType]
}CreateInkLiveChatMessage
Output type of the createInkLiveChatMessage mutation.
Fields
| Name | Description |
|---|---|
liveChatConversation(InkLiveChatConversation) | The live chat conversation. |
messageRelayId(String!) | The ID of the Ink Live Chat message that was created. |
Example
{
"liveChatConversation": InkLiveChatConversation,
"messageRelayId": "abc123"
}CreateInternalCompany
Output type of the createInternalCompany mutation.
Fields
| Name | Description |
|---|---|
internalCompany(CreateInternalCompanyResultType) | The result of the create internal company operation. |
Example
{
}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"
}CreateKnowledgeDatabaseArticleFromText
Output type of the createKnowledgeDatabaseArticleFromText mutation.
Fields
| Name | Description |
|---|---|
articleId(Int) | The ID of the newly created article. |
Example
{
"articleId": 1
}CreateLead
Output type of the createLead mutation.
Fields
| Name | Description |
|---|---|
leadNumber(String) | The unique number of the lead. |
Example
{
"leadNumber": "abc123"
}CreateMetadata
Output type of the createMetadata mutation.
Fields
| Name | Description |
|---|---|
metadata(Metadata) |
Example
{
"metadata": Metadata
}CreateMfaDevice
Output type of the createMfaDevice mutation.
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. |
totpSecret(String) | Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually. |
Example
{
"deviceEmail": "abc123",
"devicePhone": "abc123",
"totpSecret": "abc123"
}CreateOfferGroupForQuoting
Output type of the createOfferGroupForQuoting mutation.
Fields
| Name | Description |
|---|---|
offerGroup(CreateOfferGroupType) | Quoting Offer Group. |
Example
{
"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
Output type of the createOnSiteJobsAppointment mutation.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The created On-Site Jobs appointment. |
Example
{
}CreateOnSiteJobsAppointmentWithDate
Output type of the createOnSiteJobsAppointmentWithDate mutation.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The created On-Site Jobs appointment. |
Example
{
}CreateOnSiteJobsAppointmentWithoutBooking
Output type of the createOnSiteJobsAppointmentWithoutBooking mutation.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The created Appointment. |
Example
{
}CreateOnSiteJobsAppointmentWithoutDateOrTime
Output type of the createOnSiteJobsAppointmentWithoutDateOrTime mutation.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The created On-Site Jobs appointment. |
Example
{
}CreateOnSiteJobsRequest
Output type of the createOnSiteJobsRequest mutation.
Fields
| Name | Description |
|---|---|
onSiteJobsRequest(OnSiteJobsRequestType) | The created request. |
Example
{
}CreateOpportunityAndLead
Output type of the createOpportunityAndLead mutation.
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. |
stage(String) | The stage of the opportunity. |
Example
{
"opportunityNumber": "abc123",
"dateOfCreation": "2020-01-01T00:00:00.000Z",
"stage": "abc123",
"funnelCode": "abc123"
}CreateOpportunityFileAttachment
Output type of the createOpportunityFileAttachment mutation.
Fields
| Name | Description |
|---|---|
result(String) | Whether the operation was successful. |
Example
{
"result": "abc123"
}CreateOpportunityForLead
Output type of the createOpportunityForLead mutation.
Fields
| Name | Description |
|---|---|
dateOfCreation(DateTime) | The date the opportunity was created. |
opportunityNumber(String) | The unique number of the opportunity. |
Example
{
"opportunityNumber": "abc123",
"dateOfCreation": "2020-01-01T00:00:00.000Z"
}CreateOrUpdateLoyaltyCardMutation
Output type of the createOrUpdateLoyaltyCard mutation.
Fields
| Name | Description |
|---|---|
loyaltyCard(LoyaltyCardType) | Created or updated loyalty card. |
Example
{
}CreateOrUpdateProductPricesOutput
The prices created for a product.
Fields
| Name | Description |
|---|---|
prices([ProductPrice!]!) | The prices created. |
Example
{
}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
}CreatePartnerUser
Output type of the createPartnerUser mutation.
Fields
| Name | Description |
|---|---|
partnerUser(PartnerUserType) | The created partner user. |
Example
{
}CreatePaymentActionIntent
Output type of the createPaymentActionIntent mutation.
Fields
| Name | Description |
|---|---|
token(ID!) | The action intent token. |
Example
{
"token": "abc123"
}CreatePaymentMethodActionIntent
Output type of the createPaymentMethodActionIntent mutation.
Fields
| Name | Description |
|---|---|
token(ID!) | The action intent token. |
Example
{
"token": "abc123"
}CreatePortfolio
Output type of the createPortfolio mutation.
Fields
| Name | Description |
|---|---|
portfolio(PortfolioType) | The created portfolio. |
Example
{
"portfolio": PortfolioType
}CreatePortfolioUserRole
Output type of the createPortfolioUserRole mutation.
Fields
| Name | Description |
|---|---|
portfolioUserRole(PortfolioUserRoleType) | The created role for a user in association with a portfolio. |
Example
{
"portfolioUserRole": PortfolioUserRoleType
}CreatePostEvents
Output type of the createPostEvents mutation.
Fields
| Name | Description |
|---|---|
createdEventsCount(Int) | Number of events successfully created. |
Example
{
"createdEventsCount": 1
}CreateProductOutput
Output type for creating a product.
Fields
| Name | Description |
|---|---|
product(SupplyProductType) | The created product. |
Example
{
"product": SupplyProductType
}CreateQuoteForAccount
Output type of the createQuoteForAccount mutation.
Fields
| Name | Description |
|---|---|
quoteRequest(MarketSupplyQuoteRequestType) | Returns a quote request. |
Example
{
}CreateReferral
Output type of the createReferral mutation.
Fields
| Name | Description |
|---|---|
referredAccountRewardAmount(Int) | The reward amount to be issued to the referred account, in smallest currency subunits. |
Example
{
"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
Output type of the createReminder mutation.
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
{
"reminder": Reminder,
"possibleErrors": [PossibleErrorType]
}CreateScheduledTransactions
Output type of the createScheduledTransactions mutation.
Fields
| Name | Description |
|---|---|
scheduledTransactions([ScheduledTransactionType]) |
Example
{
"scheduledTransactions": [ScheduledTransactionType]
}CreateShellAccountPayload
Output type of the createShellAccount mutation.
Fields
| Name | Description |
|---|---|
account(AccountInterface) | |
billingAddressLine1(String) | First line of the billing address. |
billingAddressLine2(String) | Second line of the billing address. |
billingAddressLine3(String) | Third line of the billing address. |
billingAddressLine4(String) | Fourth line of the billing address. |
billingAddressLine5(String) | Fifth line of the billing address. |
billingName(String) | The name to use for billing purposes. |
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) | The billing address postcode. |
billingRichAddress(String) | This must be a string-ified version of the JSON representation of RichAddressInput type. |
brand(String) | The brand associated with the account. |
businessType(String) | The type of business for business accounts. |
clientMutationId(String) | A unique identifier for the client performing the mutation. |
companyName(String) | The name of the company for business accounts. |
companyNumber(String) | The company registration number for business accounts. |
dateOfBirth(Date) | The user's date of birth. |
email(String!) | The email address of the account user. |
errors([ErrorType]) | A list of validation errors. |
familyName(String!) | The family name of the account user. |
givenName(String!) | The given name of the account user. |
isBusinessAccount(Boolean) | Whether this is a business account. |
landline(String) | The user's landline phone number. |
mobile(String) | The mobile number of the account user. |
password(String) | The password for the account user. |
passwordUpdateToken(String) | Token required to set a password during account creation. |
portfolioNumber(String) | The portfolio number associated with the account. |
taxNumber(String) | The tax number for the business account. |
urn(String) | Unique reference number from a 3rd party enrolment. |
Example
{
"account": AccountInterface,
"clientMutationId": "abc123",
"email": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"mobile": "abc123",
"billingAddressLine1": "abc123",
"billingAddressLine2": "abc123",
"billingAddressLine3": "abc123",
"billingAddressLine4": "abc123",
"billingAddressLine5": "abc123",
"billingPostcode": "abc123",
"isBusinessAccount": true,
"urn": "abc123",
"portfolioNumber": "abc123",
"billingName": "abc123",
"brand": "abc123",
"dateOfBirth": "2020-01-01",
"billingRichAddress": "abc123",
"billingPeriodLength": "abc123",
"billingPeriodMultiplier": 1,
"billingPeriodDay": 1,
"billingPeriodMonth": 1,
"companyName": "abc123",
"companyNumber": "abc123",
"businessType": "abc123",
"taxNumber": "abc123",
"password": "abc123",
"passwordUpdateToken": "abc123",
"landline": "abc123",
"errors": [ErrorType]
}CreateSwitchMatchRequest
Output type of the createSwitchMatchRequest mutation.
Fields
| Name | Description |
|---|---|
matchRequestId(String) | Switch match request ID. |
Example
{
"matchRequestId": "abc123"
}CreateTelcoCompensationCredit
Output type of the createTelcoCompensationCredit mutation.
Fields
| Name | Description |
|---|---|
accountCredit(AccountCreditType) | The credit that was created or already existed for this reference. |
outcome(CompensationCreditOutcome) | CREATED if a new credit was posted; ALREADY_EXISTS if a credit for this account with the same idempotency key already existed. |
Example
{
"accountCredit": AccountCreditType,
"outcome": "CREATED"
}CreateTelcoQuote
Output type of the createTelcoQuoteRequest mutation.
Fields
| Name | Description |
|---|---|
telcoQuote(CreateTelcoQuoteOutput) | The telco quote created. |
Example
{
"telcoQuote": CreateTelcoQuoteOutput
}CreateTelcoQuoteForAccount
Output type of the createTelcoQuoteRequestForAccount mutation.
Fields
| Name | Description |
|---|---|
telcoQuote(CreateTelcoQuoteOutput) | The telco quote created. |
Example
{
"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
}CreateTelcoRepaymentRequest
Output type of the createTelcoRepaymentRequest mutation.
Fields
| Name | Description |
|---|---|
outcome(RepaymentRequestOutcome) | CREATED if a new repayment request was posted; ALREADY_EXISTS if a repayment with the same idempotency key already existed. |
repaymentId(ID) | The ID of the repayment that was created or already existed. |
Example
{
"repaymentId": "abc123",
"outcome": "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 |
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
Output type of the deductLoyaltyPoints mutation.
Fields
| Name | Description |
|---|---|
ledgerEntry(LoyaltyPointLedgerEntryType) | The ledger entry for the deducted loyalty points. |
pointsDeducted(Int) | The number of loyalty points that were deducted. |
Example
{
"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
Output type of the deleteAccountReference mutation.
Fields
| Name | Description |
|---|---|
accountReference(DeleteAccountReferenceType) |
Example
{
}Fields
| Name | Description |
|---|---|
namespace(String!) | The namespace associated with the removed AccountReference. |
Example
{
"namespace": "abc123"
}DeleteKnowledgeDatabaseArticle
Output type of the deleteKnowledgeDatabaseArticle mutation.
Fields
| Name | Description |
|---|---|
articleId(Int) | The ID of the deleted article. |
Example
{
"articleId": 1
}DeleteMfaDevice
Output type of the deleteMfaDevice mutation.
Fields
| Name | Description |
|---|---|
deviceDeleted(Boolean) | Flag to indicate if the MFA device has been successfully deleted. |
Example
{
"deviceDeleted": true
}DeletePropertyDescendants
Output type of the deletePropertyDescendants mutation.
Fields
| Name | Description |
|---|---|
property(PropertyType) | The property whose descendants were deleted. |
Example
{
"property": PropertyType
}DeletePushNotificationBinding
Output type of the deletePushNotificationBinding mutation.
Fields
| Name | Description |
|---|---|
status(DeletePushNotificationBindingOutput) |
Example
{
"status": "SUCCESSFUL"
}Fields
| Name | Description |
|---|---|
supplyPointExternalId(String!) | The external identifier of the detached supply point. |
Example
{
"supplyPointExternalId": "abc123"
}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 |
|---|---|
ok(Boolean!) | True if the agreements were successfully detached. |
Example
{
"ok": true
}DetachSupplyPointFromEstimationGroup
Output type of the detachSupplyPointFromEstimationGroup mutation.
Fields
| Name | Description |
|---|---|
supplyPoint(DeletedSupplyPointEstimationGroupType) | The deleted supply point. |
Example
{
}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",
"accountHolder": "abc123",
"instructionType": "abc123",
"cardPaymentNetwork": "abc123",
"cardExpiryMonth": 1,
"cardExpiryYear": 1,
"iban": "abc123",
"sortCode": "abc123",
"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",
"propertyId": "abc123",
"embeddedNetwork": EmbeddedNetworkType
}EndContributionAgreement
Output type of the endContributionAgreement mutation.
Fields
| Name | Description |
|---|---|
contributionAgreement(ContributionAgreementType) | The created contribution agreement. |
Example
{
"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
Output type of the enqueueInboundCall mutation.
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
Output type of the enrollAccountInLoyaltyProgram mutation.
Fields
| Name | Description |
|---|---|
outcome(EnrollAccountInLoyaltyProgramOutcome) | Outcome of the loyalty points campaign enrollment. |
Example
{
"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!) | When this equipment item record was created. |
description(String!) | Public facing description of the equipment item. |
id(ID!) | Identifier of the equipment item. |
ownedAt(DateTime!) | When ownership of the equipment item began. |
ownership(EquipmentItemOwnership) | Ownership of the equipment item. |
serialNumber(String) | Serial number for this equipment item (not necessarily unique). |
sku(String!) | SKU of the equipment item. |
status(String!) | Current status of the equipment item. |
updatedAt(DateTime) | When this equipment item record was last updated. |
Example
{
"id": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"serialNumber": "abc123",
"description": "abc123",
"status": "abc123",
"ownership": "CUSTOMER_OWNED",
"ownedAt": "2020-01-01T00:00:00.000Z",
"sku": "abc123"
}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",
"sku": "abc123",
"description": "abc123",
"quantity": 1,
"serialNumber": "abc123",
"meta": {"key": "value"},
"createdAt": "2020-01-01T00:00:00.000Z",
"shipment": ShipmentType,
"order": EquipmentOrderType
}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",
"deliveryAddress": {"key": "value"},
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"orderLines": [EquipmentOrderLineType],
"supplyPoint": SupplyPointType
}Fields
| Name | Description |
|---|---|
field(String!) | The name of the field that caused the error. |
messages([String!]!) | A list of error messages for the field. |
Example
{
"field": "abc123",
"messages": "abc123"
}EscalateInkConversation
Output type of the escalateInkConversation mutation.
Fields
| Name | Description |
|---|---|
conversationRelayId(ID!) | The ID of the conversation that was escalated. |
Example
{
"conversationRelayId": "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 |
|---|---|
intervalEnd(DateTime!) | The exclusive end of this reading interval. |
intervalStart(DateTime!) | The inclusive start of this reading interval. |
isEstimated(Boolean!) | True if this reading was produced by the estimation engine rather than measured. |
quality(String) | The data quality of this reading (e.g. ACTUAL, ESTIMATE, CALCULATED). |
value(Decimal!) | The consumption value for this interval. |
Example
{
"intervalStart": "2020-01-01T00:00:00.000Z",
"intervalEnd": "2020-01-01T00:00:00.000Z",
"value": "1.0",
"quality": "abc123",
"isEstimated": true
}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"
}ExtendAgreementPeriod
Output type of the extendAgreementPeriod mutation.
Fields
| Name | Description |
|---|---|
agreement(CommonAgreementType) | Agreement that we are going to extend. |
Example
{
"agreement": CommonAgreementType
}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"}
}ExternalMessageEventType
A status update for an external message, such as delivery confirmation, a bounce, or an open.
Fields
| Name | Description |
|---|---|
eventType(MessageEventType!) | The type of message event. |
id(ID!) | The ID of the message event. |
occurredAt(DateTime!) | The date and time this event occurred. |
Example
{
"id": "abc123",
"eventType": "DELIVERED",
"occurredAt": "2020-01-01T00:00:00.000Z"
}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"
}ExternalMessagingUploadPostRequest
Information needed to upload a file to S3 via a presigned POST request. See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-presigned-urls.html#generating-a-presigned-url-to-upload-a-file
Fields
| Name | Description |
|---|---|
fields(JSONString!) | The form fields that must be included in the POST request. |
key(String!) | The S3 key the file will be stored under. |
url(String!) | The S3 endpoint to POST the file to. |
Example
{
"url": "abc123",
"fields": {"key": "value"},
"key": "abc123"
}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"
}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 |
|---|---|
forecastConsumption([ForecastConsumptionEntryType!]) | Forecast consumption entries for this quote configuration. |
Example
{
}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 |
|---|---|
appointmentId(ID) | The appointment ID. |
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. Deprecated The 'id' field is deprecated. |
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",
"appointmentId": "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
Output type of the fetchGeneratePaymentFingerprint mutation.
Fields
| Name | Description |
|---|---|
fingerprint(String) | Fetched or generated fingerprint from vendor. |
vendor(String) | Vendor name. |
Example
{
"fingerprint": "abc123",
"vendor": "abc123"
}FetchPreSignedLinkForOpportunityAttachment
Output type of the fetchPreSignedLinkForOpportunityAttachment mutation.
Fields
| Name | Description |
|---|---|
opportunityFileAttachment(OpportunityFileAttachment) | The opportunity file attachment with pre-signed URL. |
Example
{
}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
}ForceReauthentication
Output type of the forceReauthentication mutation.
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"
}Fields
| Name | Description |
|---|---|
consumptionSplit([ConsumptionSplitType]) | Optional TOU split breakdown for this entry. |
identifier(String) | Unique identifier for this forecast consumption entry. |
touName(String) | Unique identifier of the time-of-use scheme for this entry. |
unit(String) | Unit of the consumption value. |
validFrom(DateTime) | Start of the period this entry covers. |
validTo(DateTime) | End of the period this entry covers. |
value(Decimal) | Forecast consumption value. |
Example
{
"identifier": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"unit": "abc123",
"value": "1.0",
"touName": "abc123"
}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. |
fieldType(FieldTypeChoices!) | The type of the field. |
name(String!) | The name of the field. |
orderInCollection(Int) | The order of the field in the collection. |
required(Boolean) | Whether the field is required. |
textChoices([String]) | The choices for the field if applicable. |
textRegex(String) | A regular expression that a field value must match, if populated. |
Example
{
"code": "abc123",
"name": "abc123",
"fieldType": "STR",
"textChoices": ["abc123"],
"textRegex": "abc123",
"orderInCollection": 1,
"required": true
}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
Output type of the generateAffiliatesAudioRecordingPreSignedUrl mutation.
Fields
| Name | Description |
|---|---|
affiliatesAudioRecordingPreSignedUrl(AffiliateAudioRecordingPresignedPostType) | Input fields required to generate a presigned S3 post for affiliates audio recording. |
Example
{
}GenerateExternalMessagingUploadUrl
Output type of the generateExternalMessagingUploadUrl mutation.
Fields
| Name | Description |
|---|---|
postRequest(ExternalMessagingUploadPostRequest) | The presigned POST request details for uploading the file to S3. |
Example
{
}GenerateInkPresignedUrl
Output type of the generateInkPresignedUrl mutation.
Fields
| Name | Description |
|---|---|
fields(JSONString!) | Presigned post fields required to upload the file. |
key(String!) | The key for the item. |
uploadUrl(String!) | A presigned URL for the user to upload to the quarantine bucket. |
Example
{
"uploadUrl": "abc123",
"key": "abc123",
"fields": {"key": "value"}
}GenerateLeadsFileAttachmentDownloadPreSignedUrl
Output type of the generateLeadsFileAttachmentDownloadPreSignedUrl mutation.
Fields
| Name | Description |
|---|---|
leadsFileAttachmentDownloadPreSignedUrl(LeadsFileAttachmentDownloadPresignedUrlType) | Pre-signed S3 URL for downloading the leads file attachment. |
Example
{
}GenerateLeadsFileAttachmentsPreSignedUrl
Output type of the generateLeadsFileAttachmentPreSignedUrl mutation.
Fields
| Name | Description |
|---|---|
leadsFileAttachmentPreSignedUrl(LeadsFileAttachmentPresignedPostType) | Input fields required to generate a presigned S3 post for leads file attachment. |
Example
{
}GeneratePreSignedToken
Output type of the generatePreSignedToken mutation.
Fields
| Name | Description |
|---|---|
scope(PreSignedTokenScope) | |
token(String) | |
tokenExpiryDatetime(DateTime) |
Example
{
"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
Output type of the getEmbeddedSecretForNewPaymentInstruction mutation.
Fields
| Name | Description |
|---|---|
secretKey(String) |
Example
{
"secretKey": "abc123"
}GetEmbeddedSecretForNewPaymentInstructionWithoutAccount
Output type of the getEmbeddedSecretForNewPaymentInstructionWithoutAccount mutation.
Fields
| Name | Description |
|---|---|
secretKey(String) | The client secret needed to create a new stored payment instruction. |
Example
{
"secretKey": "abc123"
}GetHostedUrlForNewPaymentInstruction
Output type of the getHostedUrlForNewPaymentInstruction mutation.
Fields
| Name | Description |
|---|---|
url(String) | URL at which payment instruction can be set up. |
Example
{
"url": "abc123"
}GetOrCreateAgreement
Output type of the getOrCreateAgreement mutation.
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). |
Example
{
"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
Output type of the grantUserAccessToBusiness mutation.
Fields
| Name | Description |
|---|---|
roleCode(String) | The code of the role granted to the user. |
Example
{
"roleCode": "abc123"
}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"
}ImportTrancheRate
Output type of the importTrancheRate mutation.
Fields
| Name | Description |
|---|---|
rateIdentifier(ID) | Unique identifier that references the new tranche rate. |
Example
{
"rateIdentifier": "abc123"
}Fields
| Name | Description |
|---|---|
recent(Int) | The average number of seconds passed before an inbound call with the given routing attributes is answered. This value represents the calls received in the last 30 minutes. The possible errors that can be raised are:
|
yesterday(Int) | The average number of seconds passed before an inbound call with the given routing attributes is answered. This value represents the calls received on the previous day. The possible errors that can be raised are:
|
Example
{
"yesterday": 1,
"recent": 1
}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). |
tags([CallTagType]!) | Tags that have been applied to the call, for example during call wrap-up. |
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"
}InitiateAgreementRescission
Output type of the initiateAgreementRescission mutation.
Fields
| Name | Description |
|---|---|
agreementRescission(AgreementRescissionType) | The new agreement rescission instance. |
Example
{
}InitiateHostedStandalonePayment
Output type of the initiateHostedStandalonePayment mutation.
Fields
| Name | Description |
|---|---|
payment(InitiateHostedStandalonePaymentOutput) | The details required to refer to and complete a hosted payment. |
Example
{
"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
Output type of the initiateProductSwitch mutation.
Fields
| Name | Description |
|---|---|
productCode(String!) | The selected product for a specific product switch. |
switchDate(Date!) | The date at which the product switch becomes effective. |
Example
{
"productCode": "abc123",
"switchDate": "2020-01-01"
}InitiateServiceTestOutput
The newly started service test run.
Fields
| Name | Description |
|---|---|
runId(ID!) | The public identifier of the service test run. |
testType(ServiceTestType!) | The type of service test that was started. |
Example
{
"runId": "abc123",
"testType": "FTTP_LINE_TEST"
}InitiateStandalonePayment
Output type of the initiateStandalonePayment mutation.
Fields
| Name | Description |
|---|---|
payment(InitiateStandalonePaymentOutput) |
Example
{
"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!) | |
lastMessageAt(DateTime) | The timestamp of the most recent message in the conversation. |
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,
"lastMessageAt": "2020-01-01T00:00:00.000Z"
}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"
}Fields
| Name | Description |
|---|---|
edges([InkConversationsEdge!]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
Example
{
"pageInfo": PageInfo,
"edges": InkConversationsEdge
}InkConversationsEdge
A Relay edge containing a InkConversations and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(InkConversation!) | The item at the end of the edge |
Example
{
"node": InkConversation,
"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 current email (without previous emails from the email thread). |
fromHandle(String!) | From email address. |
fullContentHtml(String!) | The full email, including previous emails from the email thread if available, in HTML. |
fullContentPlainText(String!) | The full email, including previous emails from the email thread if available, in plain text format. |
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",
"fullContentPlainText": "abc123",
"fullContentHtml": "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"
}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!) | |
triggerId(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],
"triggerId": "abc123",
"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"
}Fields
| Name | Description |
|---|---|
endDate(Date) | The date on which the instalment schedule will end. |
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,
"endDate": "2020-01-01"
}InstigateLeaveSupplierForCollectionProcess
Output type of the instigateLeaveSupplierForCollectionProcess mutation.
Fields
| Name | Description |
|---|---|
leaveSupplierInstigated(InstigateLeaveSupplierForCollectionProcessOutputType) | The instigated leave supplier for the collection process. |
Example
{
}Fields
| Name | Description |
|---|---|
leaveSupplierProcessNumber(String) | The number of the leave supplier process that was instigated. |
Example
{
"leaveSupplierProcessNumber": "abc123"
}InstigateSuspendServicesForAccount
Output type of the instigateSuspendServicesForAccount mutation.
Fields
| Name | Description |
|---|---|
accountNumber(String!) | The account number with suspended services. |
Example
{
"accountNumber": "abc123"
}InstigateUnSuspendServicesForAccount
Output type of the instigateUnsuspendServicesForAccount mutation.
Fields
| Name | Description |
|---|---|
accountNumber(String!) | The account number with unsuspended services. |
Example
{
"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
Output type of the invalidatePaymentInstruction mutation.
Fields
| Name | Description |
|---|---|
instruction(InvalidatePaymentInstructionOutput) |
Example
{
"instruction": InvalidatePaymentInstructionOutput
}InvalidatePaymentInstructionOutput
Output for invalidating an arbitrary payment instruction.
Fields
| Name | Description |
|---|---|
id(Int) |
Example
{
"id": 1
}InvalidatePreSignedToken
Output type of the invalidatePreSignedToken mutation.
Fields
| Name | Description |
|---|---|
token(PreSignedToken) |
Example
{
"token": PreSignedToken
}InvalidatePreSignedTokensForUser
Output type of the invalidatePreSignedTokensForUser mutation.
Fields
| Name | Description |
|---|---|
tokens([PreSignedToken]) |
Example
{
"tokens": [PreSignedToken]
}InvalidateRefreshToken
Output type of the invalidateRefreshToken mutation.
Fields
| Name | Description |
|---|---|
token(RefreshToken) |
Example
{
}InvalidateRefreshTokensForUser
Output type of the invalidateRefreshTokensForUser mutation.
Fields
| Name | Description |
|---|---|
tokens([RefreshToken]) |
Example
{
}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. |
dueDate(Date) | The final date before missing payment is considered overdue. |
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. |
isHeld(Boolean) | Whether the billing document is currently held. |
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. Deprecated The 'paymentDueDate' field is deprecated. |
pdfUrl(String) | URL to the PDF of the Invoice. |
scheduledPaymentDate(Date) | The planned date for payment (may be before the due_date). |
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. |
uuid(UUID) | Unique identifier for the invoice billing document. |
Example
{
"id": 1,
"uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"firstIssued": "2020-01-01T00:00:00.000Z",
"pdfUrl": "abc123",
"annulledBy": AnnulmentBillingDocumentType,
"isHeld": true,
"number": "abc123",
"invoicedAmount": 1,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"transactions": BillTransactionConnectionTypeConnection,
"documentDebtPosition": BillingDocumentPositionType,
"dueDate": "2020-01-01",
"scheduledPaymentDate": "2020-01-01",
"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. This may differ from the service/consumption period shown on the bill document. |
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. |
isHeld(Boolean) | Whether the billing document is currently held. |
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. This may differ from the service/consumption period shown on the bill document. |
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. |
uuid(UUID) | Unique identifier for the billing document. |
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",
"uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"grossAmount": 1,
"isAnnulled": true,
"isHeld": true,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"totalPayments": 1,
"transactions": BillTransactionConnectionTypeConnection,
"representations": BillRepresentationConnectionTypeConnection
}JoinSupplierAcceptTermsAndConditions
Output type of the joinSupplierAcceptTermsAndConditions mutation.
Fields
| Name | Description |
|---|---|
success(Boolean) | Indicator that the mutation has completed successfully. |
Example
{
"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 |
|---|---|
contractReferences(ContractReferencesType) | 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. |
stage(String) | Current stage of the join supplier journey. |
status(LifecycleSupplyPointProcessStatus) | The status of the process. |
subtype(String) | The subtype of the process. |
supplyPoints(SupplyPointConnectionTypeConnection!) | The supply points associated with the process. Deprecated The 'supplyPoints' field is deprecated. |
supplyPointsInterface(SupplyPointInterfaceConnection!) | The supply points associated with the process. Node type is the CommonSupplyPointInterface; use inline fragments (e.g. |
Example
{
"id": "abc123",
"status": "PENDING",
"supplyPoints": SupplyPointConnectionTypeConnection,
"supplyPointsInterface": SupplyPointInterfaceConnection,
"number": "abc123",
"subtype": "abc123",
"contractReferences": ContractReferencesType,
"currentProcessData": JoinSupplierProcessDataType,
"ledgerAssignments": JoinSupplierLedgerAssignmentConnectionTypeConnection,
"stage": "abc123"
}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
}KnowledgeDatabaseArticle
An article in the Knowledge Database.
Fields
| Name | Description |
|---|---|
archivedAt(DateTime) | When the Article was archived, if it has been archived. |
articleId(Int!) | The ID of the Article in the Knowledge Database. |
articleType(ArticleType!) | The type of the Article. |
audience(ArticleAudience!) | Whether the Article is for internal or external consumption. |
brands([KnowledgeDatabaseArticleBrand!]!) | The brands associated with the Article. |
createdAt(DateTime!) | When the Article was initially loaded into the Knowledge Database. |
domains([KnowledgeDatabaseArticleDomain!]!) | The domains associated with the Article. |
lastRefreshedAt(DateTime!) | When the Article was last refreshed in the Knowledge Database from its original source. |
status(ArticleStatus!) | Whether the Article is active or archived. |
tags([String!]!) | Any metadata tags attached to the Article. |
text(String) | The body of the Article. |
title(String!) | The title of the Article. |
url(String) | Link to the Article's original source address. |
Example
{
"articleId": 1,
"articleType": "COMPANY_BLOG",
"audience": "INTERNAL",
"title": "abc123",
"tags": "abc123",
"text": "abc123",
"status": "ACTIVE",
"createdAt": "2020-01-01T00:00:00.000Z",
"archivedAt": "2020-01-01T00:00:00.000Z",
"lastRefreshedAt": "2020-01-01T00:00:00.000Z",
"url": "abc123"
}KnowledgeDatabaseArticleBrand
A brand associated with a Knowledge Database article.
Fields
| Name | Description |
|---|---|
code(String!) | The unique code of the brand. |
name(String!) | The display name of the brand. |
Example
{
"code": "abc123",
"name": "abc123"
}KnowledgeDatabaseArticleDomain
A domain associated with a Knowledge Database article.
Fields
| Name | Description |
|---|---|
code(String!) | The unique code of the domain. |
name(String!) | The display name of the domain. |
Example
{
"code": "abc123",
"name": "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. Deprecated The 'assignedToOrganization' field is deprecated. |
assignedToTeamIdentifier(String) | The identifier of the team the lead is assigned to. Deprecated The 'assignedToTeamIdentifier' field is deprecated. |
assignedToUserIdentifier(String) | The identifier of the user the lead is assigned to. Deprecated The 'assignedToUserIdentifier' field is deprecated. |
assignedToUsername(String) | The username of the user the lead is assigned to. Deprecated The 'assignedToUsername' field is deprecated. |
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. Deprecated The 'nationalId' field is deprecated. |
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. Deprecated The 'salesChannel' field is deprecated. |
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",
"assignedToUserIdentifier": "abc123",
"assignedToTeamIdentifier": "abc123"
}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 |
|---|---|
consents([ConsentOutput]) | List of consents for the contact. |
contactAddress(RichAddressType) | The address of the contact. |
email(String) | The email address of the contact. |
familyName(String) | The family name of the contact. |
givenName(String) | The given name of the contact. |
landlineNumber(String) | The landline phone number of the contact. |
nationalId(String) | National Identifier of the lead. |
phoneNumber(String) | The mobile phone number of the contact. |
preferredLanguage(String) | The preferred language of the contact as an ISO code (e.g. 'es-es'). |
roles([LeadContactRoles]) | The roles of the contact. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"nationalId": "abc123",
"landlineNumber": "abc123",
"roles": "ACCOUNT_HOLDER",
"preferredLanguage": "abc123",
"contactAddress": RichAddressType,
"consents": [ConsentOutput]
}Fields
| Name | Description |
|---|---|
accountNumber(String) | Lead's linked account number. |
assignedToTeam(String) | Team assigned to this lead. Deprecated The 'assignedToTeam' field is deprecated. |
assignedToUser(String) | User assigned to this lead. Deprecated The 'assignedToUser' field is deprecated. |
billingAddress(AddressOutput) | Lead billing address. Deprecated The 'billingAddress' field is deprecated. |
billingName(String) | Lead billing name. Deprecated The 'billingName' field is deprecated. |
billingRichAddress(RichAddressType) | Lead billing rich address. Deprecated The 'billingRichAddress' field is deprecated. |
brand(String) | Lead brand. |
contacts([LeadContactDetailsType]) | The contacts for the lead. Arguments
Input fields for filtering contacts. |
email(String) | Lead account holder email. |
extraDetailItems([ExtraDetail]) | Extra details about the lead as key/value pairs. |
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. Deprecated The 'nationalId' field is deprecated. |
number(String) | Lead number. |
phoneNumber(String) | Lead account holder mobile number. |
salesChannel(String) | Lead sales channel. Deprecated The 'salesChannel' field is deprecated. |
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",
"brand": "abc123",
"salesChannel": "abc123",
"assignedToTeam": "abc123",
"assignedToUser": "abc123",
"nationalId": "abc123",
"leadType": "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. Deprecated The 'supplyPoints' field is deprecated. |
supplyPointsInterface(SupplyPointInterfaceConnection!) | The supply points associated with the process. Node type is the CommonSupplyPointInterface; use inline fragments (e.g. |
Example
{
"id": "abc123",
"status": "PENDING",
"supplyPoints": SupplyPointConnectionTypeConnection,
"supplyPointsInterface": SupplyPointInterfaceConnection
}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. |
stage(String) | Current stage of the leave supplier journey. |
status(LifecycleSupplyPointProcessStatus) | The status of the process. |
subtype(String) | The subtype of the process. |
supplyPoints(SupplyPointConnectionTypeConnection!) | The supply points associated with the process. Deprecated The 'supplyPoints' field is deprecated. |
supplyPointsInterface(SupplyPointInterfaceConnection!) | The supply points associated with the process. Node type is the CommonSupplyPointInterface; use inline fragments (e.g. |
Example
{
"id": "abc123",
"status": "PENDING",
"number": "abc123",
"supplyPoints": SupplyPointConnectionTypeConnection,
"supplyPointsInterface": SupplyPointInterfaceConnection,
"subtype": "abc123",
"stage": "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 |
|---|---|
delinquentDebtAmount(Int) | The total amount of delinquent debt for this ledger (in minor currency units, e.g. pence/cents). A value of 0 means the ledger has no delinquent debt. Null if the status is not OK. |
ledgerNumber(String!) | The ledger number. |
status(LedgerDebtPositionStatus!) | The status of the debt position for this ledger. OK means the delinquentdebtamount is available and accurate. UNAVAILABLE means the position could not be determined. |
Example
{
"ledgerNumber": "abc123",
"delinquentDebtAmount": 1,
"status": "OK"
}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) | |
paymentPlans(PaymentPlanConnectionTypeConnection) | The payment plans for this ledger. |
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,
"paymentPlans": PaymentPlanConnectionTypeConnection,
"billingTriggerConfiguration": BillingTriggerConfiguration,
"supportsStatements": true,
"supportsInvoices": true,
"currentDirectDebitInstructionInvalidatedWithVendor": true,
"paymentsWithNonConcludedRePresentation": PaymentWithNonConcludedRePresentationConnectionTypeConnection
}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
Output type of the linkAccountToBusiness mutation.
Fields
| Name | Description |
|---|---|
business(BusinessType) | The business the account was linked to. |
Example
{
"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"
}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
Output type of the manageCpeOptions mutation.
Fields
| Name | Description |
|---|---|
status(String) | The result of the operation. |
Example
{
"status": "abc123"
}MarkPrintBatchAsProcessed
Output type of the markPrintBatchAsProcessed mutation.
Fields
| Name | Description |
|---|---|
printBatch(PrintBatchType) |
Example
{
}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"}
}MasqueradeAuthentication
Output type of the masqueradeAuthentication mutation.
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 |
|---|---|
account(TelcoAccountType) | The account associated with this transactional message. |
accountUser(AccountUserType) | The account user associated with this transactional message. |
channel(Channel!) | The channel that the message was sent through. |
deliveredAt(DateTime) | The date/time that the message was confirmed as having been delivered. Only populated for messages delivered from 2026-08-20 onwards; a null value for earlier messages does not indicate that they were not delivered. |
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. |
id(String!) | The ID of the transactional message. |
Example
{
"channel": "EMAIL",
"dispatchedAt": "2020-01-01T00:00:00.000Z",
"failedAt": "2020-01-01T00:00:00.000Z",
"deliveredAt": "2020-01-01T00:00:00.000Z",
"id": "abc123",
"account": TelcoAccountType,
"accountUser": AccountUserType
}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
Output type of the moveToBucket mutation.
Fields
| Name | Description |
|---|---|
conversation(InkConversation!) | The conversation that was moved to the bucket. |
Example
{
"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
}NextOperationsTeamRoundRobin
Output type of the nextOperationsTeamRoundRobin mutation.
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. |
team(Team!) | The next operations team assigned in round-robin sequence. |
teamGroups([TeamGroup]!) | All operations team groups that the selected team belongs to. |
Example
{
"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!) | The provider that delivers push notifications for the application. |
id(ID!) | |
name(String!) | Human readable name for the app. |
pushNotificationBindings([PushNotificationBindingType!]!) | |
service(NotifiableApplicationService!) | The push notification service the application uses. |
Example
{
"id": "abc123",
"name": "abc123",
"bundleId": "abc123",
"service": "GCM",
"externalProvider": "PINPOINT",
"externalProjectId": "abc123",
"description": "abc123",
"pushNotificationBindings": PushNotificationBindingType
}ObtainKrakenJSONWebToken
Output type of the obtainKrakenToken mutation.
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
{
"token": "abc123",
"payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"refreshToken": "abc123",
"refreshExpiresIn": 1,
"possibleErrors": [PossibleErrorType]
}ObtainLongLivedRefreshToken
Output type of the obtainLongLivedRefreshToken mutation.
Example
{
"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. Deprecated The 'supplyPoints' field is deprecated. |
supplyPointsInterface(SupplyPointInterfaceConnection!) | The supply points associated with the process. Node type is the CommonSupplyPointInterface; use inline fragments (e.g. |
Example
{
"id": "abc123",
"status": "PENDING",
"occupyAt": "2020-01-01T00:00:00.000Z",
"supplyPoints": SupplyPointConnectionTypeConnection,
"supplyPointsInterface": SupplyPointInterfaceConnection
}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!) | |
cancelledAt(DateTime) | The datetime of the latest appointment cancellation event, if the appointment has been cancelled. |
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!) | |
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",
"agent": "GENERIC_AGENT",
"status": "PENDING_KRAKEN_TIMESLOT_SELECTION",
"commsStrategy": "SEND_ALL",
"cancellationCategory": "CANCELLED_BY_CUSTOMER",
"cancelledAt": "2020-01-01T00:00:00.000Z"
}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,
"hasRequestWarnings": true,
"canCreateAppointment": true,
"hasAppointmentWarnings": true
}OnSiteJobsDraftAppointmentType
A draft appointment: the details of an appointment for which a timeslot has not been chosen yet, together with the customer's availability. Booking a timeslot creates an appointment with the same ID.
Fields
| Name | Description |
|---|---|
agent(OnSiteJobsAgent) | The agent the draft appointment will be booked with. |
bookingAm(Boolean) | Whether the customer prefers a morning timeslot. Null if not recorded. |
bookingComments(String!) | Free-text notes about the customer's timeslot preferences. |
bookingFriday(Boolean) | Whether the customer prefers a Friday timeslot. Null if not recorded. |
bookingMonday(Boolean) | Whether the customer prefers a Monday timeslot. Null if not recorded. |
bookingPm(Boolean) | Whether the customer prefers an afternoon timeslot. Null if not recorded. |
bookingThursday(Boolean) | Whether the customer prefers a Thursday timeslot. Null if not recorded. |
bookingTuesday(Boolean) | Whether the customer prefers a Tuesday timeslot. Null if not recorded. |
bookingWednesday(Boolean) | Whether the customer prefers a Wednesday timeslot. Null if not recorded. |
comments(String!) | Comments about the job. |
commsStrategy(OnSiteJobsCommsStrategy) | The communication strategy for this draft appointment. |
createdAt(DateTime!) | When the draft appointment was created. |
externalJobTypeMapping(OnSiteJobsExternalJobTypeMappingType!) | The job type the appointment will be booked with. |
id(UUID!) | The Kraken ID of the draft appointment. |
jobDetails(JSONString!) | Additional details about the job, as required by the agent. |
request(OnSiteJobsRequestType!) | The request this draft appointment was created for. |
updatedAt(DateTime!) | When the draft appointment was last updated. |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"agent": "GENERIC_AGENT",
"commsStrategy": "SEND_ALL",
"jobDetails": {"key": "value"},
"comments": "abc123",
"bookingComments": "abc123",
"bookingAm": true,
"bookingPm": true,
"bookingMonday": true,
"bookingTuesday": true,
"bookingWednesday": true,
"bookingThursday": true,
"bookingFriday": true,
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}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. Deprecated The 'marketSupplyPoints' field is deprecated. |
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!) | |
supplyPointsInterface(SupplyPointInterfaceConnection) | List of supply points on request. Node type is the CommonSupplyPointInterface; use inline fragments to access concrete types. |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"reason": "abc123",
"subReason": "abc123",
"isEmergency": true,
"externalReference": "abc123",
"agent": "abc123",
"comment": "abc123",
"account": "abc123",
"marketSupplyPoints": SupplyPointConnectionTypeConnection,
"supplyPointsInterface": SupplyPointInterfaceConnection,
"property": PropertyType,
"status": "APPOINTMENT_FAILED",
"overallActionsStatus": "SKIPPED",
"requestActions": OnSiteJobsRequestActionConnectionTypeConnection,
"createdBy": 1
}OnSiteJobsVendorComplaintType
A vendor complaint. It may be linked to an on-site jobs request, an appointment, both, or neither.
Fields
| Name | Description |
|---|---|
appointment(OnSiteJobsAppointmentType) | The on-site jobs appointment linked to this vendor complaint. |
clientFormData(JSONString!) | Client-specific form data for the vendor complaint. |
complaint(ComplaintType!) | The formal complaint linked to this vendor complaint. The possible errors that can be raised are:
|
createdAt(DateTime!) | When the vendor complaint was created. |
id(UUID!) | The Kraken ID of the vendor complaint. |
request(OnSiteJobsRequestType) | The on-site jobs request linked to this vendor complaint. |
status(OnSiteJobsVendorComplaintStatus!) | The status of the vendor complaint. |
updatedAt(DateTime!) | When the vendor complaint was last updated. |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"status": "OPEN",
"complaint": ComplaintType,
"clientFormData": {"key": "value"},
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}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 |
|---|---|
assignedTeam(AssignedTeam) | Resolved assigned team details for this opportunity. |
assignedToAffiliateNumber(String) | The affiliate's name this opportunity is assigned to. |
assignedToTeam(String) | Team assigned to this opportunity. Deprecated The 'assignedToTeam' field is deprecated. |
assignedToTeamIdentifier(String) | The identifier of the team assigned to this opportunity. |
assignedToUser(String) | User assigned to this opportunity. Deprecated The 'assignedToUser' field is deprecated. |
assignedToUserIdentifier(String) | The identifier of the user assigned to this opportunity. |
assignedUser(AssignedUser) | Resolved assigned user details for this opportunity. |
attachments([OpportunityAttachment]) | Attachments for the opportunity. |
conversionSalesChannel(String) | Sales channel at conversion time. |
creationSalesChannel(String) | Sales channel recorded when the opportunity was first created. |
email(String) | Lead account holder email. |
extraDetailItems([ExtraDetail]) | Extra details about the opportunity as key/value pairs. |
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 account holder mobile 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. |
updatedAt(DateTime) | When the opportunity was last updated. |
Example
{
"opportunityId": "abc123",
"leadNumber": "abc123",
"leadType": "abc123",
"name": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"number": "abc123",
"stage": "abc123",
"opportunityRichAddress": RichAddressType,
"salesChannel": "abc123",
"creationSalesChannel": "abc123",
"conversionSalesChannel": "abc123",
"assignedToTeam": "abc123",
"assignedToUser": "abc123",
"assignedToUserIdentifier": "abc123",
"assignedToTeamIdentifier": "abc123",
"productOfferingId": "abc123",
"offerGroupId": "abc123",
"notes": "abc123",
"assignedToAffiliateNumber": "abc123",
"updatedAt": "2020-01-01T00:00:00.000Z"
}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"
}OrganisationReferenceType
A namespaced external reference attached to a partner organisation.
Fields
| Name | Description |
|---|---|
namespace(String!) | The code for the namespace this reference belongs to. |
value(String!) | The reference value within the namespace. |
Example
{
"namespace": "abc123",
"value": "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). |
tags([CallTagType]!) | Tags that have been applied to the call, for example during call wrap-up. |
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"
}PartnerAccessType
Represents an accessible partner and the roles granting that access.
Fields
| Name | Description |
|---|---|
partner(AffiliateOrganisationType!) | The partner the accessor has access to. |
roleAssignments([RoleAssignment]!) | The role assignments granting the accessor access to the partner. |
Example
{
"roleAssignments": RoleAssignment
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PartnerAccessorAccessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PartnerAccessorAccessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PartnerAccessorAccessConnectionTypeEdge
A Relay edge containing a PartnerAccessorAccessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PartnerAccessorAccessType) | The item at the end of the edge |
Example
{
"node": PartnerAccessorAccessType,
"cursor": "abc123"
}PartnerAccessorAccessType
Represents a partner and their access information to an entity.
Fields
| Name | Description |
|---|---|
accessor(AffiliateOrganisationType!) | The partner that has access to the entity. |
roleAssignments([RoleAssignment!]!) | The role assignments that the accessor has for the entity. |
Example
{
"roleAssignments": RoleAssignment
}Fields
| Name | Description |
|---|---|
code(String!) | The unique code of the role. |
description(String!) | The description of the role. |
name(String!) | The unique displayable name of the role. |
permissionCodes([String]!) | The permissions associated with the role. |
Example
{
"code": "abc123",
"name": "abc123",
"description": "abc123",
"permissionCodes": "abc123"
}PartnerTeamType
A partner team within an affiliate organisation.
Fields
| Name | Description |
|---|---|
name(String!) | The partner team's name. |
number(String!) | The partner team's number. |
parentTeamNumber(String) | The number of the parent team, if any. |
teamMembers(PartnerTeamUserConnectionTypeConnection!) | Members directly assigned to this team (excluding subteam-only members). |
Example
{
"number": "abc123",
"name": "abc123",
"parentTeamNumber": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PartnerTeamUserConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PartnerTeamUserConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PartnerTeamUserConnectionTypeEdge
A Relay edge containing a PartnerTeamUserConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PartnerUserType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PartnerUserAccessorAccessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PartnerUserAccessorAccessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PartnerUserAccessorAccessConnectionTypeEdge
A Relay edge containing a PartnerUserAccessorAccessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PartnerUserAccessorAccessType) | The item at the end of the edge |
Example
{
"node": PartnerUserAccessorAccessType,
"cursor": "abc123"
}PartnerUserAccessorAccessType
Represents a partner user and their access information to a partner.
Fields
| Name | Description |
|---|---|
accessor(PartnerUserType!) | The partner user that has access to the partner. |
roleAssignments([RoleAssignment!]!) | The role assignments that the accessor has for the entity. |
Example
{
"roleAssignments": RoleAssignment
}PartnerUserPermission
Holds information about a specific permission.
Fields
| Name | Description |
|---|---|
permission(String!) | The short name of the permission. |
Example
{
"permission": "abc123"
}Fields
| Name | Description |
|---|---|
code(String!) | The unique code of the role. |
description(String!) | The description of the role. |
name(String!) | The unique displayable name of the role. |
permissionCodes([String]!) | The permissions associated with the role. |
Example
{
"code": "abc123",
"name": "abc123",
"description": "abc123",
"permissionCodes": "abc123"
}PartnerUserRoleType
A role available for assignment to a partner user.
Fields
| Name | Description |
|---|---|
code(String!) | The role code. |
description(String!) | The role description. |
name(String!) | The role name. |
Example
{
"code": "abc123",
"name": "abc123",
"description": "abc123"
}PartnerUserType
A partner user of an affiliate organisation.
Fields
| Name | Description |
|---|---|
createdAt(DateTime!) | When the partner user was created. |
email(String) | The partner user's email address. |
familyName(String) | The partner user's family name. |
givenName(String) | The partner user's given name. |
id(ID!) | The partner user's ID. |
lastLogin(DateTime) | The last time the partner user logged in. |
name(String!) | The partner user's full name. |
number(String!) | The partner user's number. |
organisation(AffiliateOrganisationType) | The organisation the partner user belongs to. |
permissions([PartnerUserPermission!]!) | The effective permissions of the partner user. |
roles([PartnerUserRoleType!]) | Role codes assigned to the partner user. |
Example
{
"id": "abc123",
"number": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"name": "abc123",
"email": "abc123",
"lastLogin": "2020-01-01T00:00:00.000Z",
"createdAt": "2020-01-01T00:00:00.000Z"
}PartnerViewerPermission
Holds information about a specific permission.
Fields
| Name | Description |
|---|---|
permission(String) | The short name of the permission. |
Example
{
"permission": "abc123"
}PartnerViewerType
Type for the authenticated partner user viewer.
Fields
| Name | Description |
|---|---|
accessiblePartner(PartnerAccessType) | The partner the partner user can access, with the roles granting that access. Null when the partner user holds no active role on a partner. |
email(String!) | The partner user's email address. |
name(String!) | The partner user's full name. |
number(String!) | The partner user's unique number (e.g. PU-XXXXXXXX). |
permissions([PartnerViewerPermission]) | Holds information about the permissions of the current viewer. |
Example
{
"name": "abc123",
"email": "abc123",
"number": "abc123",
"permissions": [PartnerViewerPermission],
"accessiblePartner": PartnerAccessType
}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
Output type of the pauseCollectionProcess mutation.
Fields
| Name | Description |
|---|---|
collectionProcessPaused(PauseCollectionProcessOutput) | Collection process pause output. |
Example
{
}Fields
| Name | Description |
|---|---|
pauseRecords([CollectionProcessPauseStatusRecord]) | Pause records on the collection process. |
Example
{
}PauseDunning
Output type of the pauseDunning mutation.
Fields
| Name | Description |
|---|---|
pauseCreated(Boolean) | Whether the pause has been successfully created. |
Example
{
"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 |
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. |
lead(LeadType) | The lead who is an owner of this payment instruction. |
Example
{
"accountUser": AccountUserType,
"business": BusinessType,
"lead": LeadType
}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",
"validFrom": "2020-01-01T00:00:00.000Z",
"accountHolder": "abc123",
"instructionType": "abc123",
"cardPaymentNetwork": "abc123",
"cardExpiryMonth": 1,
"cardExpiryYear": 1,
"sortCode": "abc123",
"iban": "abc123",
"bankCode": "abc123",
"accountType": "abc123",
"vendor": "abc123",
"cardNumber": "abc123",
"cardType": "abc123",
"maskedAccountIdentifier": "abc123",
"owners": [PaymentInstructionOwnerType],
"supplementaryLedger": SupplementaryLedgerType
}Fields
| Name | Description |
|---|---|
account(TelcoAccountType!) | |
details(JSONString) | |
id(ID!) | |
owners([PaymentInstructionOwnerType]) | The owners of the financial account this instruction represents. |
paymentMethodType(String!) | |
reference(String!) | |
status(String!) | |
supplementaryLedger(SupplementaryLedgerType) | The supplementary ledger for this payment instruction. |
validFrom(DateTime!) | |
validTo(DateTime) |
Example
{
"id": "abc123",
"reference": "abc123",
"status": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"paymentMethodType": "abc123",
"details": {"key": "value"},
"account": TelcoAccountType,
"owners": [PaymentInstructionOwnerType],
"supplementaryLedger": SupplementaryLedgerType
}Fields
| Name | Description |
|---|---|
notificationService(String) | Notification service used to send payment notification. |
reference(String) | Payment notification reference. |
Example
{
"notificationService": "abc123",
"reference": "abc123"
}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",
"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",
"account": TelcoAccountType,
"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
}PaymentScheduleChangeEventType
A recorded change to a payment schedule (creation, update or deletion), sourced from the financial events audit log.
Fields
| Name | Description |
|---|---|
category(PaymentScheduleChangeCategory) | The kind of change made to the schedule. |
createdAt(DateTime) | When the change was recorded. |
description(String) | A human-readable description of the change. |
madeBySupportUser(Boolean) | Whether the change was made by a member of support staff. When false, the change was made by an automated/system process. |
Example
{
"createdAt": "2020-01-01T00:00:00.000Z",
"category": "CREATED",
"description": "abc123",
"madeBySupportUser": true
}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. |
instalment(InstalmentScheduleType) | Instalment 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,
"instalment": InstalmentScheduleType
}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 |
|---|---|
changeHistory([PaymentScheduleChangeEventType]) | The recorded history of changes to this payment schedule (creation, updates and deletion), most recent first. |
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. |
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",
"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,
"supplementaryLedger": SupplementaryLedgerType,
"isPaymentHoliday": true,
"scheduleType": "BACS_TRANSFER",
"paymentDayDetails": PaymentSchedulePaymentDayDetailsType,
"delayConfiguration": PaymentScheduleDelayConfigurationType,
"isExemptFromPaymentAdequacy": true,
"ledgerNumber": "abc123",
"trigger": "PLAN",
"changeHistory": [PaymentScheduleChangeEventType]
}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
Output type of the payoutReferralForAccount mutation.
Fields
| Name | Description |
|---|---|
payoutResult(PayoutReferralForAccountResultType) | The result of the payout. |
Example
{
}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. This may differ from the service/consumption period shown on the bill document. |
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. |
isHeld(Boolean!) | Whether the billing document is currently held. |
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. This may differ from the service/consumption period shown on the bill document. |
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. |
uuid(UUID) | Unique identifier for the billing document. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"identifier": "abc123",
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"isAnnulled": true,
"isHeld": 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
}PickTimeslotForOnSiteJobsAppointment
Output type of the pickTimeslotForOnSiteJobsAppointment mutation.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The appointment the timeslot was picked for. |
Example
{
}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
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PortfolioAccessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PortfolioAccessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PortfolioAccessConnectionTypeEdge
A Relay edge containing a PortfolioAccessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PortfolioAccessType) | The item at the end of the edge |
Example
{
"node": PortfolioAccessType,
"cursor": "abc123"
}PortfolioAccessType
Represents the accessible portfolio and access information of an accessor.
Fields
| Name | Description |
|---|---|
entity(PortfolioType!) | The portfolio that the accessor has access to. |
roleAssignments([RoleAssignment]!) | The role assignments that the accessor has for the entity. |
Example
{
"roleAssignments": RoleAssignment,
"entity": PortfolioType
}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 |
|---|---|
accountUserAccessors(AccountUserAccessorAccessConnectionTypeConnection) | Account users that have access to this portfolio, with their access information. |
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!) | |
collectivePayments(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,
"collectivePayments": true,
"leadAccountNumber": "abc123",
"brand": "abc123",
"name": "abc123",
"depth": 1,
"parent": PortfolioType,
"ancestors": PortfolioConnectionTypeConnection,
"descendants": PortfolioConnectionTypeConnection,
"accounts": AccountConnectionTypeConnection,
"accountUserAccessors": AccountUserAccessorAccessConnectionTypeConnection
}PortfolioUserRoleType
The role a user has in association with one portfolio.
Fields
| Name | Description |
|---|---|
id(ID!) | The ID of the portfolio user role. Deprecated The 'id' field is deprecated. |
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
Output type of the postCredit mutation.
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
{
"credit": Credit,
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
attachments(BillingAttachmentConnectionTypeConnection) | |
billType(BillTypeEnum) | The type of the bill. |
fromDate(Date) | The date of the bill is covered from. This may differ from the service/consumption period shown on the bill document. |
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. This may differ from the service/consumption period shown on the bill document. |
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
{
"scope": "SUBMIT_METER_READINGS",
"key": "abc123",
"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"
}PriceAdjustment
A fixed or externally sourced adjustment to a targeted rate or cost.
Fields
| Name | Description |
|---|---|
adjustmentMethod(PriceAdjustmentAdjustmentMethod) | The method used to calculate the price adjustment. |
adjustmentType(PriceAdjustmentType) | Whether the adjustment reduces or increases the targeted value. |
code(String) | The price adjustment code. |
label(String) | The human-readable label for the price adjustment. |
rateSource(PriceAdjustmentRateSource) | The source used to determine this price adjustment's value. |
Example
{
"code": "abc123",
"label": "abc123",
"adjustmentMethod": "PERCENTAGE",
"adjustmentType": "DISCOUNT"
}PriceAdjustmentAvailabilityPeriod
The period during which a price adjustment bundle is available.
Fields
| Name | Description |
|---|---|
end(DateTime) | The date and time until which the bundle is available, if any. |
start(DateTime) | The date and time from which the bundle is available. |
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z"
}PriceAdjustmentBundle
A collection of price adjustments available in a sales context.
Fields
| Name | Description |
|---|---|
availabilityPeriod(PriceAdjustmentAvailabilityPeriod) | The period during which the bundle is available. |
code(String) | The price adjustment bundle code. |
name(String) | The human-readable name of the price adjustment bundle. |
priceAdjustments([PriceAdjustment]) | The price adjustments in the bundle, ordered by code. |
Example
{
"code": "abc123",
"name": "abc123"
}PriceAdjustmentRateSource
The source used to determine a price adjustment's value.
Fields
| Name | Description |
|---|---|
externalRateSource(String) | The external rate source reference. External sources are not yet exposed. |
fixedRate(Decimal) | The fixed price adjustment value, if configured. |
Example
{
"fixedRate": "1.0",
"externalRateSource": "abc123"
}PriceForStream
Rate group prices for a product.
Fields
| Name | Description |
|---|---|
characteristicMapping(JSONString!) | The characteristic mapping for the price. Deprecated The 'characteristicMapping' field is deprecated. |
characteristics(GenericScalar!) | The characteristic values for the variant. |
price(Decimal!) | The price per unit. |
schemeLabels(JSONString) | The scheme labels for the price. Deprecated The 'schemeLabels' field is deprecated. |
schemes(GenericScalar) | The scheme labels for the variant. |
Example
{
"characteristicMapping": {"key": "value"},
"characteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"schemeLabels": {"key": "value"},
"schemes": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"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",
"attachments": [PrintAttachmentType],
"account": TelcoAccountType,
"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"
}ProductBaseRatesType
Represents product base rates 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 |
|---|---|
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]
}ProductPrice
A price created for a rate group, with the validity period as persisted.
Fields
| Name | Description |
|---|---|
periodEnd(DateTime) | The end of validity for this price. |
periodStart(DateTime!) | The start of validity for this price. |
price(Decimal!) | The price per unit. |
rateGroup(String!) | The rate group code. |
variant(ProductPriceVariant!) | The variant that this price applies to. |
Example
{
"rateGroup": "abc123",
"periodStart": "2020-01-01T00:00:00.000Z",
"periodEnd": "2020-01-01T00:00:00.000Z",
"price": "1.0"
}ProductPriceVariant
The characteristics and schemes that define a variant of a rate group.
Fields
| Name | Description |
|---|---|
characteristics(GenericScalar!) | The characteristic values for the variant. |
schemes(GenericScalar) | The scheme labels for the variant. |
Example
{
"characteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"schemes": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}Fields
| Name | Description |
|---|---|
code(String) | The code for the tag. |
displayName(String) | The display name for the tag. |
Example
{
"displayName": "abc123",
"code": "abc123"
}ProgressTelcoFaultTroubleshootingStep
Output type of the progressTelcoFaultTroubleshootingStep mutation.
Fields
| Name | Description |
|---|---|
nextRecommendedStep(TroubleshootingStepDefinitionType) | The next recommended step. |
otherNextSteps([TroubleshootingStepDefinitionType]) | Other possible next steps. |
sessionId(ID) | ID of the troubleshooting session. |
status(TroubleshootingSessionStatus) | Current status of the session. |
steps([TroubleshootingStepInstanceType]) | List of steps in the session. |
Example
{
"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. |
geographicalId(String) | Identifier for this address in its territory's official address register, e.g. DAR ID in DK, UPRN in GB, G-NAF ID in AU. |
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.
|
subAdministrativeArea(String) | Second-level administrative subdivision, e.g. US county. Only populated for addresses in countries where this concept is relevant. For all other countries this field will be blank. |
Example
{
"name": "abc123",
"organization": "abc123",
"streetAddress": "abc123",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "abc123",
"locality": "abc123",
"administrativeArea": "abc123",
"subAdministrativeArea": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"country": "abc123",
"deliveryPointIdentifier": "abc123",
"geographicalId": "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"
}PublishTransactionalMessagingExternalTrigger
Output type of the publishTransactionalMessagingExternalTrigger mutation.
Fields
| Name | Description |
|---|---|
trigger(Trigger) | The trigger that has been published. |
Example
{
}PublishTransactionalMessagingTrigger
Output type of the publishTransactionalMessagingTrigger mutation.
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]
}PurchaseVoucher
Output type of the purchaseVoucher mutation.
Fields
| Name | Description |
|---|---|
voucherPurchase(VoucherPurchaseType) | The voucher purchase created from the mutation. |
Example
{
"voucherPurchase": VoucherPurchaseType
}PurchaseVouchers
Output type of the purchaseVouchers mutation.
Fields
| Name | Description |
|---|---|
voucherPurchases([VoucherPurchaseType]) | The voucher purchases created from the mutation. |
Example
{
"voucherPurchases": [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",
"registeredAt": "2020-01-01T00:00:00.000Z",
"expiresAt": "2020-01-01T00:00:00.000Z",
"user": AccountUserType,
"messages": PrintMessageTypeConnection,
"application": NotifiableApplicationType,
"token": "abc123"
}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"
}QuantityAuxiliaryResultType
An auxiliary result representing a single numeric value.
Fields
| Name | Description |
|---|---|
agreement(CommonAgreementType) | The agreement the auxiliary result was costed against. |
name(String!) | The name of the auxiliary result. |
period(AuxiliaryResultPeriodType!) | The period the auxiliary result covers. |
unit(AuxiliaryResultUnit) | The unit the value is expressed in. Null if the unit is not a recognised one. |
value(Decimal!) | The value of the auxiliary result. |
Example
{
"name": "abc123",
"period": AuxiliaryResultPeriodType,
"agreement": CommonAgreementType,
"value": "1.0",
"unit": "KILOWATT_HOURS"
}QuantityType
Graphene type object to represent Quantity(magnitude, unit)
Fields
| Name | Description |
|---|---|
description(String) | Human-readable description. |
magnitude(Float!) | The numeric value of this field. |
unit(String!) | Unit of this field. |
Example
{
"magnitude": 1.0,
"unit": "abc123",
"description": "abc123"
}Fields
| Name | Description |
|---|---|
complexityValue(Int) | The complexity of the query. |
Example
{
"complexityValue": 1
}Fields
| Name | Description |
|---|---|
identifier(String) | Unique identifier for the term. |
isVariable(Boolean) | Whether this term uses variable rates. |
schedules([QuoteBespokeRateScheduleType!]) | Rate schedules for this bespoke rate configuration. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"identifier": "abc123",
"isVariable": true
}Fields
| Name | Description |
|---|---|
identifier(String) | Unique identifier for this rate item. |
pricePerUnit(Decimal) | Price per unit for this rate item. |
rateSpecificationCode(String) | Code identifying the rate specification. |
variantProfile(QuoteConfigurationVariantProfileType) | The variant profile for this rate item. |
Example
{
"identifier": "abc123",
"rateSpecificationCode": "abc123",
"pricePerUnit": "1.0"
}Fields
| Name | Description |
|---|---|
identifier(String) | Unique identifier for this schedule. |
items([QuoteBespokeRateItemType!]) | Rate items in this schedule. |
validFrom(DateTime) | Start of validity for this schedule. |
validTo(DateTime) | End of validity for this schedule. |
Example
{
"identifier": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
identifier(String) | Unique identifier for the term. |
isVariable(Boolean) | Whether this term uses variable rates. |
numberOfDays(Int) | Number of days to pay the bill before debt becomes delinquent. |
type(NonEmptyString) | The type of the term. |
typeOfDays(String) | Whether days are WORKING or CALENDAR days. |
Example
{
"type": NonEmptyString,
"identifier": "abc123",
"isVariable": true,
"numberOfDays": 1,
"typeOfDays": "abc123"
}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 |
|---|---|
fieldCode(String) | Field code for this extra detail. |
fieldType(String) | Type of the value (STRING, INTEGER, FLOAT, DATETIME). |
fieldValue(String) | Value for this extra detail. |
Example
{
"fieldCode": "abc123",
"fieldValue": "abc123",
"fieldType": "abc123"
}Fields
| Name | Description |
|---|---|
contractEnd(DateTime) | End of the contract period. |
contractStart(DateTime) | Start of the contract period. |
createdBy(String) | Username of the Support Site user who created this quote configuration. |
expiresAt(DateTime) | When this quote configuration expires. |
extraDetailsItems([QuoteConfigurationExtraDetailItemType!]) | Extra detail items for this quote configuration. |
extraQuotingParams(ExtraQuotingParamsType) | Extra quoting parameters including forecast consumption entries. |
number(String) | Unique number identifying this quote configuration. |
opportunityNumber(String) | Number of the opportunity this quote configuration belongs to. |
status(QuoteConfigurationStatus) | Current status of the quote configuration. |
terms([QuoteTermInterface!]) | Terms included in this quote configuration. |
Example
{
"number": "abc123",
"createdBy": "abc123",
"contractStart": "2020-01-01T00:00:00.000Z",
"contractEnd": "2020-01-01T00:00:00.000Z",
"expiresAt": "2020-01-01T00:00:00.000Z",
"opportunityNumber": "abc123",
"status": "DRAFT",
"terms": QuoteTermInterface
}Fields
| Name | Description |
|---|---|
characteristicValues(JSONString) | Characteristic values for this variant profile. |
schemeLabels(JSONString) | Scheme labels for this variant profile. |
Example
{
"characteristicValues": {"key": "value"},
"schemeLabels": {"key": "value"}
}Fields
| Name | Description |
|---|---|
identifier(String) | Unique identifier for the term. |
isVariable(Boolean) | Whether this term uses variable rates. |
periods([QuoteContractedVolumePeriodType!]) | Contracted volume periods. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"identifier": "abc123",
"isVariable": true
}Fields
| Name | Description |
|---|---|
characteristics(GenericScalar) | The market-supply-characteristic scope, as a code-to-value map. |
marketName(String) | Market name for this contracted volume period. |
maximum(Decimal) | Optional upper bound around the value (e.g. a tolerance cap). |
measurementPeriod(String) | The measurement cadence of the quantity (WHOLE_PERIOD, DAILY or HOURLY). |
minimum(Decimal) | Optional lower bound around the value (e.g. a take-or-pay floor). |
unit(String) | Unit of measurement for the volume. |
validFrom(DateTime) | Start of validity for this period. |
validTo(DateTime) | End of validity for this period. |
value(Decimal) | Volume value for this period. |
Example
{
"value": "1.0",
"unit": "abc123",
"marketName": "abc123",
"measurementPeriod": "abc123",
"minimum": "1.0",
"maximum": "1.0",
"characteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z"
}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 |
|---|---|
identifier(String) | Unique identifier for the term. |
isVariable(Boolean) | Whether this term uses variable rates. |
schedules([QuoteRateGroupEligibilityScheduleType!]) | Rate group eligibility schedules. |
timeSeriesSpecificationSchedules([QuoteTimeSeriesSpecificationEligibilityScheduleType!]) | Time series specification eligibility schedules. |
type(NonEmptyString) | The type of the term. |
Example
{
"type": NonEmptyString,
"identifier": "abc123",
"isVariable": true
}Fields
| Name | Description |
|---|---|
end(DateTime) | End of the effective period (None if open-ended). |
start(DateTime) | Start of the effective period. |
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
effectivePeriod(QuoteRateGroupEligibilityPeriodType) | The period during which this eligibility is effective. |
isEligible(Boolean) | Whether this rate group is eligible. |
productCode(String) | The product code associated with the rate group. |
rateGroupCode(String) | The rate group code. |
supplyPointIdentifier(String) | Optional supply point identifier. |
Example
{
"productCode": "abc123",
"rateGroupCode": "abc123",
"isEligible": true,
"supplyPointIdentifier": "abc123"
}Fields
| Name | Description |
|---|---|
effectivePeriod(QuoteRateGroupEligibilityPeriodType) | The period during which this eligibility is effective. |
isEligible(Boolean) | Whether this time series specification is eligible. |
productCode(String) | The product code associated with the time series specification. |
supplyPointIdentifier(String) | Optional supply point identifier. |
timeSeriesSpecificationCode(String) | The time series specification code. |
Example
{
"productCode": "abc123",
"timeSeriesSpecificationCode": "abc123",
"isEligible": true,
"supplyPointIdentifier": "abc123"
}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 |
|---|---|
availableInstallOptions([BroadbandInstallationOption]) | List of available installation options for this product. |
availableInstallTypes([InstallationType]) | Deprecated. List of available installation types for this product. Deprecated The 'availableInstallTypes' field is deprecated. |
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. Deprecated The 'installType' field is deprecated. |
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. Deprecated The 'requiresInstallation' field is deprecated. |
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",
"availableInstallOptions": [BroadbandInstallationOption]
}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. |
label(String) | Human-readable label when provided (e.g. product catalog characteristic name). |
name(String) | Stable key for the quoting parameter (e.g. characteristic code). |
source(String) | Source of the quoting parameter. |
type(String) | Type of the quoting parameter. |
value(String) | Value of the quoting parameter. |
Example
{
"name": "abc123",
"label": "abc123",
"type": "abc123",
"choices": ["abc123"],
"source": "abc123",
"value": "abc123"
}RangeAuxiliaryResultType
An auxiliary result representing a numeric range.
Fields
| Name | Description |
|---|---|
agreement(CommonAgreementType) | The agreement the auxiliary result was costed against. |
end(Decimal) | The end of the range. Null indicates the range is open-ended. |
name(String!) | The name of the auxiliary result. |
period(AuxiliaryResultPeriodType!) | The period the auxiliary result covers. |
start(Decimal!) | The start of the range. |
unit(AuxiliaryResultUnit) | The unit the range bounds are expressed in. Null if the unit is not a recognised one. |
Example
{
"name": "abc123",
"period": AuxiliaryResultPeriodType,
"agreement": CommonAgreementType,
"start": "1.0",
"end": "1.0",
"unit": "KILOWATT_HOURS"
}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
Output type of the reactivateCollectionProcessRecord mutation.
Fields
| Name | Description |
|---|---|
collectionProcessReactivated(ReactivateCollectionProcessRecordOutputType) | The reactivated collection process record. |
Example
{
}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. |
qualities([ReadingQualityMeta]) | A breakdown of this reading's value and raw reading count by quality group. |
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",
"qualities": [ReadingQualityMeta]
}Fields
| Name | Description |
|---|---|
count(Int) | The number of raw readings contributing to this quality group. |
quality(MeterDataQualities) | The quality of the readings in this group. |
value(Decimal) | The aggregated value for readings of this quality. For interval readings this is the sum of kWh; for peak readings this is the maximum demand recorded. |
Example
{
"quality": "ACTUAL",
"value": "1.0",
"count": 1
}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
Output type of the rebookFaultAppointment mutation.
Fields
| Name | Description |
|---|---|
appointment(FaultAppointment) | The rebooked fault appointment. |
Example
{
"appointment": FaultAppointment
}RecordActivatedPaymentMethod
Output type of the recordActivatedPaymentMethod mutation.
Fields
| Name | Description |
|---|---|
paymentMethod(PaymentMethodType) | The stored payment method. |
Example
{
"paymentMethod": PaymentMethodType
}RecordCancelledPayment
Output type of the recordCancelledPayment mutation.
Fields
| Name | Description |
|---|---|
noticeBatchIdentifier(String!) | The unique identifier of the notice batch created from the input. |
Example
{
"noticeBatchIdentifier": "abc123"
}RecordChargedBackPayment
Output type of the recordChargedBackPayment mutation.
Fields
| Name | Description |
|---|---|
noticeBatchIdentifier(String!) | The unique identifier of the notice batch created from the input. |
Example
{
"noticeBatchIdentifier": "abc123"
}RecordDepositAgreementAccepted
Output type of the recordDepositAgreementAccepted mutation.
Fields
| Name | Description |
|---|---|
isRecorded(Boolean) |
Example
{
"isRecorded": true
}RecordFailedPayment
Output type of the recordFailedPayment mutation.
Fields
| Name | Description |
|---|---|
noticeBatchIdentifier(String!) | The unique identifier of the notice batch created from the input. |
Example
{
"noticeBatchIdentifier": "abc123"
}RecordInitiatedPayment
Output type of the recordInitiatedPayment mutation.
Fields
| Name | Description |
|---|---|
noticeBatchIdentifier(String!) | The unique identifier of the notice batch created from the input. |
Example
{
"noticeBatchIdentifier": "abc123"
}RecordInvalidatedPaymentMethod
Output type of the recordInvalidatedPaymentMethod mutation.
Fields
| Name | Description |
|---|---|
noticeBatchIdentifier(String!) | The unique identifier of the notice batch created from the input. |
Example
{
"noticeBatchIdentifier": "abc123"
}RecordPendingPayment
Output type of the recordPendingPayment mutation.
Fields
| Name | Description |
|---|---|
noticeBatchIdentifier(String!) | The unique identifier of the notice batch created from the input. |
Example
{
"noticeBatchIdentifier": "abc123"
}RecordSuccessfulPayment
Output type of the recordSuccessfulPayment mutation.
Fields
| Name | Description |
|---|---|
noticeBatchIdentifier(String!) | The unique identifier of the notice batch created from the input. |
Example
{
"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
Output type of the redeemLoyaltyPointsForAccountCredit mutation.
Fields
| Name | Description |
|---|---|
pointsRedeemed(Int) | The number of loyalty points that were redeemed. |
Example
{
"pointsRedeemed": 1
}RedeemReferralClaimCode
Output type of the redeemReferralClaimCode mutation.
Fields
| Name | Description |
|---|---|
success(Boolean!) | Whether or not the request was successful. |
Example
{
"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
{
"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,
"id": "abc123"
}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
{
"expiryDt": "2020-01-01T00:00:00.000Z",
"key": "abc123",
"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 |
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
Output type of the refundPayment mutation.
Fields
| Name | Description |
|---|---|
repayment(AccountRepaymentType) | The repayment for the requested refund. |
Example
{
"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"
}RefundVoucher
Output type of the refundVoucher mutation.
Fields
| Name | Description |
|---|---|
voucherPurchase(VoucherPurchaseType) | The voucher purchase that was refunded. |
Example
{
"voucherPurchase": VoucherPurchaseType
}RegenerateSecretKey
Output type of the regenerateSecretKey mutation.
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
Output type of the registerCustomerAsset mutation.
Fields
| Name | Description |
|---|---|
customerAsset(CustomerAssetType) | The registered customer asset. |
Example
{
"customerAsset": CustomerAssetType
}RegisterLeadFlowStatusEvent
Output type of the registerLeadFlowStatusEvent mutation.
Fields
| Name | Description |
|---|---|
flowId(String) | ID of the registered flow status event. |
Example
{
"flowId": "abc123"
}RegisterOpportunityFlowStatusEvent
Output type of the registerOpportunityFlowStatusEvent mutation.
Fields
| Name | Description |
|---|---|
flowId(String) | ID of the registered flow status event. |
Example
{
"flowId": "abc123"
}RegisterPushNotificationBinding
Output type of the registerPushNotificationBinding mutation.
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. |
params(JSONString) | Additional parameters for the reminder type. |
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",
"params": {"key": "value"}
}RemoveBankDetailsForLead
Output type of the removeBankDetailsForLead mutation.
Fields
| Name | Description |
|---|---|
leadNumber(String) | The unique number of the lead. |
Example
{
"leadNumber": "abc123"
}RemoveCampaignFromAccount
Output type of the removeCampaignFromAccount mutation.
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
{
"campaignRemoved": true,
"possibleErrors": [PossibleErrorType]
}RemoveCampaignItems
Output type of the removeCampaignItems mutation.
Fields
| Name | Description |
|---|---|
campaignItems([VoiceCampaignItemType]) |
Example
{
}RemoveItemsFromRiskList
Output type of the removeItemsFromRiskList mutation.
Fields
| Name | Description |
|---|---|
riskIdentifiers([RiskListItemType]) | List of successfully removed risk identifiers. |
Example
{
}RemovePartnerUserFromTeam
Output type of the removePartnerUserFromTeam mutation.
Fields
| Name | Description |
|---|---|
partnerUser(PartnerUserType) | The partner user that was removed from the team. |
Example
{
}RemovePropertyFromHierarchy
Output type of the removePropertyFromHierarchy mutation.
Fields
| Name | Description |
|---|---|
property(PropertyType) | The property that was removed from the hierarchy. |
Example
{
"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"
}ReplacePartnerReferences
Output type of the replacePartnerReferences mutation.
Fields
| Name | Description |
|---|---|
partner(AffiliateOrganisationType) | The updated partner. |
Example
{
}RequestDoubleOptIn
Output type of the requestDoubleOptIn mutation.
Fields
| Name | Description |
|---|---|
consent(ConsentType) | The consent that was created or updated. |
Example
{
"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
Output type of the requestPrintedBill mutation.
Fields
| Name | Description |
|---|---|
success(Boolean) | Whether the request was successful. |
Example
{
"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"
}ResetPasswordMutationPayload
Output type of the resetPassword mutation.
Fields
| Name | Description |
|---|---|
clientMutationId(String) | A unique identifier for the client performing the mutation. Deprecated The 'clientMutationId' field is deprecated. |
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
Output type of the resumeCollectionProcess mutation.
Fields
| Name | Description |
|---|---|
collectionProcessResumed(ResumeCollectionProcessOutput) | Collection process resume output. |
Example
{
}Fields
| Name | Description |
|---|---|
pauseRecords([CollectionProcessPauseStatusRecord]) | Pause records on the collection process. |
Example
{
}RetireCustomerAsset
Output type of the retireCustomerAsset mutation.
Fields
| Name | Description |
|---|---|
customerAsset(CustomerAssetType) | The retired customer asset. |
Example
{
"customerAsset": CustomerAssetType
}RevokeAgreement
Output type of the revokeAgreement mutation.
Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | Account responsible for the revoked agreement. |
Example
{
"account": TelcoAccountType
}RevokePartnerUserAccess
Output type of the revokePartnerUserAccess mutation.
Fields
| Name | Description |
|---|---|
partnerUser(RevokePartnerUserAccessType) | The result of the deletion. |
Example
{
}RevokePartnerUserAccessType
The result of revoking a partner user access.
Fields
| Name | Description |
|---|---|
partnerUserNumber(String!) | The number of the revoking partner user access. |
Example
{
"partnerUserNumber": "abc123"
}RevokeUserAccessFromBusiness
Output type of the revokeUserAccessFromBusiness mutation.
Fields
| Name | Description |
|---|---|
roleCode(String) | The code of the role revoked from the user. |
Example
{
"roleCode": "abc123"
}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
{
"paymentDate": "2020-01-01",
"schemeType": "REFERRAL_REWARD",
"code": "abc123",
"rewardAmount": 1,
"paymentStatus": "Pending",
"id": "abc123"
}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. |
geographicalId(String) | Identifier for this address in its territory's official address register, e.g. DAR ID in DK, UPRN in GB, G-NAF ID in AU. |
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.
|
subAdministrativeArea(String) | Second-level administrative subdivision, e.g. US county. Only populated for addresses in countries where this concept is relevant. For all other countries this field will be blank. |
Example
{
"name": "abc123",
"organization": "abc123",
"streetAddress": "abc123",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "abc123",
"locality": "abc123",
"administrativeArea": "abc123",
"subAdministrativeArea": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"country": "abc123",
"deliveryPointIdentifier": "abc123",
"geographicalId": "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 |
|---|---|
role(RoleInterface!) | The role that has been assigned. |
validFrom(DateTime!) | The timestamp when the role becomes valid. |
validTo(DateTime) | The timestamp when the role is no longer valid. |
Example
{
"role": RoleInterface,
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z"
}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
Output type of the runAgreementRollover mutation.
Fields
| Name | Description |
|---|---|
agreementRollover(AgreementRolloverType) | The executed agreement rollover. |
Example
{
"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]
}SalesChannelMetadataType
Metadata associated with a sales channel.
Fields
| Name | Description |
|---|---|
key(String) | The metadata key. |
value(JSONString) | The metadata value. |
Example
{
"key": "abc123",
"value": {"key": "value"}
}SalesChannelType
A sales channel.
Fields
| Name | Description |
|---|---|
archivedAt(DateTime) | The datetime when the sales channel was archived, if applicable. |
code(String) | The sales channel code. |
createdAt(DateTime) | The datetime when the sales channel was created. |
description(String) | The sales channel description. |
hierarchicalName(String) | The hierarchical name of the sales channel. |
id(ID) | The unique identifier of the sales channel. |
isArchived(Boolean) | Whether the sales channel is archived. |
metadata([SalesChannelMetadataType]) | Metadata associated with the sales channel. |
name(String) | The name of the sales channel. |
Example
{
"id": "abc123",
"name": "abc123",
"code": "abc123",
"description": "abc123",
"hierarchicalName": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"archivedAt": "2020-01-01T00:00:00.000Z",
"isArchived": true
}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. |
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
Output type of the scheduleQuoteFollowUp mutation.
Fields
| Name | Description |
|---|---|
success(Boolean!) | Whether the message was scheduled successfully. |
Example
{
"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
}Fields
| Name | Description |
|---|---|
endDay(Int!) | End day of the season. |
endMonth(Int!) | End month of the season. |
name(String!) | Season name. |
startDay(Int!) | Start day of the season. |
startMonth(Int!) | Start month of the season. |
Example
{
"name": "abc123",
"startDay": 1,
"startMonth": 1,
"endDay": 1,
"endMonth": 1
}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
Output type of the selectProducts mutation.
Fields
| Name | Description |
|---|---|
success(Boolean!) | Whether we successfully marked the chosen quoted products as selected. |
Example
{
"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"
}SendAgreementRescissionConfirmation
Output type of the sendAgreementRescissionConfirmation mutation.
Fields
| Name | Description |
|---|---|
agreementRescission(AgreementRescissionType) | The agreement rescission for which we are sending a message. |
Example
{
}SendInkOutboundMessage
Output type of the sendInkOutboundMessage mutation.
Fields
| Name | Description |
|---|---|
message(InkMessage!) | The Ink message that was enqueued for sending. |
Example
{
"message": InkEmail
}SendOfferQuoteSummary
Output type of the sendOfferQuoteSummary mutation.
Fields
| Name | Description |
|---|---|
success(Boolean!) | Whether the triggering of the offer quote summary was successful. |
Example
{
"success": true
}SendOneTimeLoginEmail
Output type of the sendPreSignedTokenEmail mutation.
Fields
| Name | Description |
|---|---|
status(String) | The result of the operation. |
Example
{
"status": "abc123"
}SendQuoteSummary
Output type of the sendQuoteSummary mutation.
Fields
| Name | Description |
|---|---|
success(Boolean!) | Whether the triggering of the quote summary was successful. |
Example
{
"success": true
}SendTrustpilotReviewInvitation
Output type of the sendTrustpilotReviewInvitation mutation.
Fields
| Name | Description |
|---|---|
referenceNumber(UUID) | The unique reference number of the Trustpilot invite. |
sendAt(DateTime) | The datetime at which Trustpilot will send the review invitation. Deprecated The 'sendAt' field is deprecated. |
Example
{
"sendAt": "2020-01-01T00:00:00.000Z",
"referenceNumber": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}SendVerificationEmail
Output type of the sendVerificationEmail mutation.
Fields
| Name | Description |
|---|---|
verificationStatus(Boolean) | If the verification email was sent. |
Example
{
"verificationStatus": true
}Example
{
"message": "abc123",
"code": "abc123"
}Fields
| Name | Description |
|---|---|
errors([ErrorTypeUnion!]) | |
field(String) |
Example
{
"field": "abc123",
"errors": SerializerErrorType
}ServiceCharacteristicType
A characteristic attached to a service (e.g. line reference, wholesale speed, feature flag).
Fields
| Name | Description |
|---|---|
boolValue(Boolean) | The value when the characteristic stores a boolean (null otherwise). |
intValue(Int) | The value when the characteristic stores an integer (null otherwise). |
name(String) | The characteristic type name. |
stringValue(String) | The value when the characteristic stores a string (null otherwise). |
Example
{
"name": "abc123",
"stringValue": "abc123",
"intValue": 1,
"boolValue": true
}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"
}ServiceTestMeasureSpecType
Describes a single measure that a completed service test run is expected to produce.
Fields
| Name | Description |
|---|---|
description(String!) | Human-readable description of what this measure represents. |
name(String!) | Machine-readable key of this measure, matching the name field in the run's measures list. |
unit(String) | Unit of the measure (e.g. 'mbps', 'ms'), or null if dimensionless. |
Example
{
"name": "abc123",
"description": "abc123",
"unit": "abc123"
}ServiceTestRunMeasureType
A single value produced by a completed service test run.
Fields
| Name | Description |
|---|---|
description(String!) | Human-readable description of what this measure represents, matching the one published for it by availableServiceTests. |
name(String!) | Machine-readable key of this measure, matching the name published for it by availableServiceTests. |
unit(String) | Unit of the measure (e.g. 'mbps', 'ms'), or null if dimensionless. |
value(String!) | The measured value as a string. |
Example
{
"name": "abc123",
"description": "abc123",
"value": "abc123",
"unit": "abc123"
}ServiceTestRunType
A single execution of a service test recorded by Kraken.
Fields
| Name | Description |
|---|---|
endedAt(DateTime) | When the run reached a terminal state, or null while it is still running. Use this to judge whether an earlier run is recent enough to reuse. |
measures([ServiceTestRunMeasureType]!) | The values this run produced. Empty until the run completes, and also empty for a completed run whose results could not be read back. A run missing a measure the caller needs is not a substitute for one that has it. |
runId(ID!) | The public identifier of the run, as returned by initiateServiceTest. |
startedAt(DateTime!) | When the run was initiated. |
status(ServiceTestRunStatus!) | Where the run has got to. Only a COMPLETED run carries measures; PENDING and IN_PROGRESS runs should be polled again. |
statusMessage(String) | Human-readable reason the run ended as it did, or null when there is nothing to explain. Set for runs that did not complete normally, for example when the provider errored or the test was cancelled. |
testType(ServiceTestType!) | The type of test this run executed. |
Example
{
"runId": "abc123",
"testType": "FTTP_LINE_TEST",
"status": "PENDING",
"statusMessage": "abc123",
"startedAt": "2020-01-01T00:00:00.000Z",
"endedAt": "2020-01-01T00:00:00.000Z",
"measures": ServiceTestRunMeasureType
}ServiceType
Service details.
Fields
| Name | Description |
|---|---|
availableServiceTests([AvailableServiceTestType]!) | Diagnostic tests that can be initiated for this service via the initiateServiceTest mutation. Returns an empty list for services that are not currently active or have no registered tests. |
characteristics([ServiceCharacteristicType]) | Characteristics attached to this service (e.g. line reference, wholesale speeds, feature flags). |
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",
"characteristics": [ServiceCharacteristicType],
"availableServiceTests": AvailableServiceTestType
}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
Output type of the setFraudRoleBasedOnCampaign mutation.
Fields
| Name | Description |
|---|---|
accountNumber(String!) | The account number with new role. |
campaignSlug(String!) | The campaign slug. |
roleCode(String) | The code of the new role. |
Example
{
"accountNumber": "abc123",
"campaignSlug": "abc123",
"roleCode": "abc123"
}SetLoyaltyPointsUser
Output type of the setLoyaltyPointsUser mutation.
Fields
| Name | Description |
|---|---|
newLoyaltyPointsUserId(String) | ID of the new Loyalty Points user. |
Example
{
"newLoyaltyPointsUserId": "abc123"
}SetOpportunityOutcome
Output type of the setOpportunityOutcome mutation.
Fields
| Name | Description |
|---|---|
message(String) | Success message for now. |
Example
{
"message": "abc123"
}SetPaymentPreference
Output type of the setPaymentPreference mutation.
Fields
| Name | Description |
|---|---|
accountNumber(String) | Number of the account on which the payment preference was set. |
Example
{
"accountNumber": "abc123"
}SetQuoteConfigurationRatesRequestErrorsOutput
Output for the setQuoteConfigurationRatesRequestErrors mutation.
Fields
| Name | Description |
|---|---|
quoteConfiguration(QuoteConfigurationType!) | The quote configuration associated with the updated rates request. |
Example
{
}SetScheduleCollectionMethod
Output type of the setScheduleCollectionMethod mutation.
Fields
| Name | Description |
|---|---|
schedule(PaymentScheduleType!) | Updated payment schedule. |
Example
{
"schedule": PaymentScheduleType
}SetSwitchOrderReferenceForQuote
Output type of the setSwitchOrderReferenceForQuote mutation.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType]
}SetUpDirectDebitInstruction
Output type of the setUpDirectDebitInstruction mutation.
Fields
| Name | Description |
|---|---|
paymentInstruction(DirectDebitInstructionType) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"paymentInstruction": DirectDebitInstructionType,
"possibleErrors": [PossibleErrorType]
}SetUpDirectDebitInstructionForBusiness
Output type of the setUpDirectDebitInstructionForBusiness mutation.
Fields
| Name | Description |
|---|---|
paymentInstruction(DirectDebitInstructionType) | The created direct debit instruction. |
Example
{
"paymentInstruction": DirectDebitInstructionType
}SetUpDirectDebitInstructionFromStoredDetails
Output type of the setUpDirectDebitInstructionFromStoredDetails mutation.
Fields
| Name | Description |
|---|---|
paymentInstruction(DirectDebitInstructionType) | The payment instruction that was created from stored details. |
Example
{
"paymentInstruction": DirectDebitInstructionType
}ShareGoodsQuote
Output type of the shareGoodsQuote mutation.
Fields
| Name | Description |
|---|---|
share(GoodsQuoteShare) | Goods quote shared. |
Example
{
"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. |
advertisedUpload(Int) | The advertised upload speed in Mbps, from the |
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. |
retailSpeed(String) | The raw |
retailSpeedMbps(Int) | The customer-facing headline retail speed in Mbps, parsed from the |
Example
{
"maxDownload": 1,
"minDownload": 1,
"averageDownload": 1,
"quotedDownload": 1,
"maxUpload": 1,
"minUpload": 1,
"averageUpload": 1,
"quotedUpload": 1,
"advertised": 1,
"advertisedUpload": 1,
"guaranteedDownload": 1,
"guaranteedUpload": 1,
"estimatedMinUpload": 1,
"estimatedMaxUpload": 1,
"estimatedMinDownload": 1,
"estimatedMaxDownload": 1,
"retailSpeedMbps": 1,
"retailSpeed": "abc123"
}StartCollectionProcess
Output type of the startCollectionProcess mutation.
Fields
| Name | Description |
|---|---|
collectionProcessStarted(StartCollectionProcessOutput) | Details of collection process that has been started. |
Example
{
}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
Output type of the startCustomerVerification mutation.
Fields
| Name | Description |
|---|---|
verificationProcess(VerificationProcess) | The newly created verification process. |
Example
{
"verificationProcess": VerificationProcess
}StartGroupedCollectionProcess
Output type of the startGroupedCollectionProcess mutation.
Fields
| Name | Description |
|---|---|
collectionProcessStarted(StartGroupedCollectionProcessOutput) | Details of the collection process that has been started. |
Example
{
}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"
}StartOnSiteJobsAppointmentBookingSession
Output type of the startOnSiteJobsAppointmentBookingSession mutation.
Fields
| Name | Description |
|---|---|
appointmentBookingSessionId(UUID) | The Kraken booking ID for the appointment booking session. |
Example
{
"appointmentBookingSessionId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}StartOnSiteJobsAppointmentBookingSessionForRequest
Output type of the startOnSiteJobsAppointmentBookingSessionForRequest mutation.
Fields
| Name | Description |
|---|---|
appointmentBookingSessionId(UUID) | The Kraken booking ID for the appointment booking session. |
Example
{
"appointmentBookingSessionId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}StartOnSiteJobsAppointmentReschedulingSession
Output type of the startOnSiteJobsAppointmentReschedulingSession mutation.
Fields
| Name | Description |
|---|---|
appointmentReschedulingSessionId(UUID) | The Kraken ID for the appointment rescheduling session. |
Example
{
"appointmentReschedulingSessionId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}StartOnSiteJobsTimeslotPickingSession
Output type of the startOnSiteJobsTimeslotPickingSession mutation.
Fields
| Name | Description |
|---|---|
appointmentBookingSessionId(UUID) | The Kraken booking ID for the appointment booking session. |
Example
{
"appointmentBookingSessionId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}StartTelcoFaultTroubleshootingSession
Output type of the startTelcoFaultTroubleshootingSession mutation.
Fields
| Name | Description |
|---|---|
telcoFaultTroubleshootingSession(TelcoFaultTroubleshootingSessionType) | The telco fault troubleshooting session that has been created. |
Example
{
"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. |
dueDate(Date) | The final date before missing payment is considered overdue. |
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. |
isFinal(Boolean) | Whether this statement is marked as final. |
latestChargeAt(DateTime) | The latest charge date of the statement. |
paymentDueDate(Date) | The date due for payment for the statement. Deprecated The 'paymentDueDate' field is deprecated. |
pdfUrl(String) | URL to the PDF of the statement. |
scheduledPaymentDate(Date) | The scheduled date for payment (may be before the due_date). |
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. |
uuid(UUID) | Unique identifier for the statement billing document. |
Example
{
"id": 1,
"uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"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",
"dueDate": "2020-01-01",
"scheduledPaymentDate": "2020-01-01",
"paymentDueDate": "2020-01-01",
"isFinal": true,
"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. This may differ from the service/consumption period shown on the bill document. |
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. |
isFinal(Boolean) | Whether this statement is marked as final. |
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. This may differ from the service/consumption period shown on the bill document. |
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",
"isFinal": true,
"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
Output type of the stopAutomatedPayments mutation.
Fields
| Name | Description |
|---|---|
accountNumber(String) | Number of the account for which automated payments were stopped. |
Example
{
"accountNumber": "abc123"
}StoreBankDetailsForLead
Output type of the storeBankDetailsForLead mutation.
Fields
| Name | Description |
|---|---|
paymentMethodReference(String) | Reference of the mandate generated for the lead. |
Example
{
"paymentMethodReference": "abc123"
}StoreDirectDebitPaymentMethodDetails
Output type of the storeDirectDebitPaymentMethodDetails mutation.
Fields
| Name | Description |
|---|---|
storedPaymentMethodDetailsReference(String) |
Example
{
"storedPaymentMethodDetailsReference": "abc123"
}StorePaymentInstruction
Output type of the storePaymentInstruction mutation.
Fields
| Name | Description |
|---|---|
paymentInstruction(PaymentInstructionType) | The stored payment instruction. |
Example
{
"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"
}SubmitAllowedRepayment
Output type of the submitAllowedRepayment mutation.
Fields
| Name | Description |
|---|---|
repaymentId(ID) | The repayment ID. |
repaymentStatus(RepaymentRequestStatus) | The current status of the repayment request. |
Example
{
"repaymentId": "abc123",
"repaymentStatus": "REQUESTED"
}SubmitCustomerFeedback
Output type of the submitCustomerFeedback mutation.
Fields
| Name | Description |
|---|---|
customerFeedback(CustomerFeedbackType) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"customerFeedback": CustomerFeedbackType,
"possibleErrors": [PossibleErrorType]
}SubmitRepaymentRequest
Output type of the submitRepaymentRequest mutation.
Fields
| Name | Description |
|---|---|
repaymentRequest(RequestRepaymentOutputType) | The newly created repayment request. |
Example
{
"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 |
id(ID!) | The ID of the charge. |
period(Period!) | The period that was charged. |
Example
{
"id": "abc123",
"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
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([SupplyPointInterfaceEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": SupplyPointInterfaceEdge,
"totalCount": 1,
"edgeCount": 1
}SupplyPointInterfaceEdge
A Relay edge containing a SupplyPointInterface and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CommonSupplyPointInterface) | The item at the end of the edge |
Example
{
"node": CommonSupplyPointInterface,
"cursor": "abc123"
}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!) | The product 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. |
rates([ApplicableRateType!]!) | Rates applicable to the product. |
tags([SupplyProductTagType!]!) | Tags associated with the product. |
term(Int) | The product term in months. |
termsAndConditions([TermsAndConditionsType!]!) | Terms and conditions for this market supply product. |
termsAndConditionsTypes([TermsAndConditionsType!]!) | Deprecated alias of 'termsAndConditions'. Deprecated The 'termsAndConditionsTypes' field is deprecated. |
termsContractType(String) | The product contract type. |
Example
{
"id": "abc123",
"brandCode": "abc123",
"marketName": "abc123",
"code": "abc123",
"notes": "abc123",
"fullName": "abc123",
"displayName": "abc123",
"description": "abc123",
"availableFrom": "2020-01-01T00:00:00.000Z",
"availableTo": "2020-01-01T00:00:00.000Z",
"isHidden": true,
"term": 1,
"endsAt": "2020-01-01T00:00:00.000Z",
"availabilityStatus": "EVERYONE",
"termsContractType": "abc123",
"termsAndConditions": TermsAndConditionsType,
"termsAndConditionsTypes": TermsAndConditionsType,
"params": {"key": "value"},
"tags": SupplyProductTagType
}SwitchAccountToVariablePaymentSchedule
Output type of the switchAccountToVariablePaymentSchedule mutation.
Fields
| Name | Description |
|---|---|
schedule(PaymentScheduleType!) | New payment schedule. |
Example
{
"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
Output type of the switchTelcoProduct mutation.
Fields
| Name | Description |
|---|---|
switchProductRequest(SwitchProductType) | Details of the product switch request. |
Example
{
"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. |
accountUserAccessors(AccountUserAccessorAccessConnectionTypeConnection) | Account users that have access to this account, with their access information. |
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 in the smallest sub-unit of the currency (e.g. pence for GBP, cents for USD). A positive value means the account is in credit (the customer has paid more than they owe). A negative value means the account is in debit (the customer owes money to the supplier). 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 item-based billing documents (invoices) 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. |
callUsage(CallUsageType) | Call usage, limits, and suspension state for the account. |
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. |
partnerAccessors(PartnerAccessorAccessConnectionTypeConnection) | Partners that have access to this account, with their access information. |
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. Deprecated The 'paymentPlans' field is deprecated. |
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. Arguments
Filter services by type (e.g. BROADBAND_SERVICE). |
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. |
telcoSettings(AccountTelcoSettingsType) | Account-level telco settings. |
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
{
"brand": "abc123",
"status": "PENDING",
"balance": 1,
"overdueBalance": 1,
"urn": "abc123",
"billingName": "abc123",
"billingSubName": "abc123",
"billingEmail": "abc123",
"billingAddress": "abc123",
"billingAddressLine1": "abc123",
"billingAddressLine2": "abc123",
"billingAddressLine3": "abc123",
"billingAddressLine4": "abc123",
"billingAddressLine5": "abc123",
"billingAddressPostcode": "abc123",
"billingCountryCode": "abc123",
"billingDeliveryPointIdentifier": "abc123",
"splitBillingAddress": ["abc123"],
"address": RichAddressType,
"number": "abc123",
"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,
"customerAssets": [CustomerAssetType],
"partnerAccessors": PartnerAccessorAccessConnectionTypeConnection,
"accountUserAccessors": AccountUserAccessorAccessConnectionTypeConnection,
"complaints": ComplaintConnectionTypeConnection,
"id": "abc123",
"users": AccountUserType,
"properties": [PropertyType],
"marketSupplyAgreements": AgreementConnection,
"canModifyPayments": CanModifyPaymentsType,
"activeContract": ContractType,
"latestQuote": CreateTelcoQuoteOutput,
"telcoLedgers": [TelcoLedgerType],
"contracts": [Contract],
"services": [ServiceType],
"usesProductCatalog": true,
"billingDocument": TelcoStatementBillingDocumentType,
"renewalIntention": RenewalIntention,
"telcoSettings": AccountTelcoSettingsType,
"unbilledCalls": CallDetailRecordConnection,
"callUsage": CallUsageType
}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) | |
paymentPlans(PaymentPlanConnectionTypeConnection) | The payment plans for this ledger. |
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,
"paymentPlans": PaymentPlanConnectionTypeConnection,
"billingTriggerConfiguration": BillingTriggerConfiguration,
"supportsStatements": true,
"supportsInvoices": true,
"currentDirectDebitInstructionInvalidatedWithVendor": true,
"paymentsWithNonConcludedRePresentation": PaymentWithNonConcludedRePresentationConnectionTypeConnection
}TelcoPrepareAccount
Output type of the telcoPrepareAccount mutation.
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. |
Example
{
"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
Output type of the signUpForTelco mutation.
Fields
| Name | Description |
|---|---|
accountNumber(String) | The new account's account number. |
payment(UpfrontPaymentDetails) | Details of any upfront payment required. |
Example
{
"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. |
dueDate(Date) | The final date before missing payment is considered overdue. |
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. |
isFinal(Boolean) | Whether this statement is marked as final. |
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. |
scheduledPaymentDate(Date) | The scheduled date for payment (may be before the due_date). |
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. |
uuid(UUID) | Unique identifier for the statement billing document. |
Example
{
"id": 1,
"uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"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",
"dueDate": "2020-01-01",
"scheduledPaymentDate": "2020-01-01",
"paymentDueDate": "2020-01-01",
"isFinal": true,
"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
Output type of the terminateAgreement mutation.
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
{
"agreement": CommonAgreementType,
"possibleErrors": [PossibleErrorType]
}TerminateCreditTransferPermission
Output type of the terminateCreditTransferPermission mutation.
Fields
| Name | Description |
|---|---|
validTo(DateTime) | Datetime when the credit transfer permission ends. |
Example
{
"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(TerminationFeeTypeEnum) | 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": "FLAT",
"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"
}Fields
| Name | Description |
|---|---|
name(String!) | Name of the time of use scheme. |
timeslots([TimeSlotWithActivationRuleType!]!) | List of timeslots in the scheme. |
timezone(String) | Timezone of the time of use scheme. |
Example
{
"name": "abc123",
"timezone": "abc123",
"timeslots": TimeSlotWithActivationRuleType
}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 |
|---|---|
activeFrom(Time!) | Active from time. |
activeTo(Time!) | Active to time. |
holidays(Boolean!) | Indicates applies on holidays or not. |
saturdays(Boolean!) | Indicates applies on Saturdays or not. |
season(SeasonType!) | Season the rule applies to. |
sundays(Boolean!) | Indicates applies on Sundays or not. |
timeslot(String!) | Timeslot name. |
weekdays(Boolean!) | Indicates applies on weekdays or not. |
weekends(Boolean!) | Indicates applies on weekends or not. |
workdays(Boolean!) | Indicates applies on workdays or not. |
Example
{
"timeslot": "abc123",
"activeFrom": "00:00:00.000Z",
"activeTo": "00:00:00.000Z",
"weekdays": true,
"weekends": true,
"saturdays": true,
"sundays": true,
"workdays": true,
"holidays": true,
"season": SeasonType
}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
Output type of the transferLeadOpportunities mutation.
Fields
| Name | Description |
|---|---|
opportunitiesTransferred(Int) | Number of opportunities transferred. |
Example
{
"opportunitiesTransferred": 1
}TransferLedgerBalance
Output type of the transferLedgerBalance mutation.
Fields
| Name | Description |
|---|---|
balanceTransfer(AccountBalanceTransferType) | Balance transfer details. |
Example
{
}TransferLoyaltyPointsBetweenUsers
Output type of the transferLoyaltyPointsBetweenUsers mutation.
Fields
| Name | Description |
|---|---|
pointsTransferred(Int) | The number of loyalty points that were transferred. |
Example
{
"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
Output type of the triggerCollectionProcessMessage mutation.
Fields
| Name | Description |
|---|---|
triggerResult(TriggerCollectionProcessMessageOutput) | Details of the triggered communication. |
Example
{
}Fields
| Name | Description |
|---|---|
fuguTriggerId(String) | The unique identifier of the triggered communication. |
Example
{
"fuguTriggerId": "abc123"
}TriggerPostUploadOperations
Output type of the triggerPostUploadOperations mutation.
Fields
| Name | Description |
|---|---|
operationsTriggered(Boolean) |
Example
{
"operationsTriggered": true
}TriggerStandalonePaymentRequest
Output type of the triggerStandalonePaymentRequest mutation.
Fields
| Name | Description |
|---|---|
paymentNotification(PaymentNotification) | Payment notification trigerred for standalone payment request. |
Example
{
"paymentNotification": PaymentNotification
}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"
}TroubleshootingFaultInformationType
Represents the information associated with a fault associated with a troubleshooting session.
Fields
| Name | Description |
|---|---|
number(String) | The number of the fault. |
subtypeOfFault(String) | The subtype of fault. |
summary(String) | The summary of the fault. |
typeOfFault(String) | The type of fault. |
Example
{
"number": "abc123",
"typeOfFault": "abc123",
"subtypeOfFault": "abc123",
"summary": "abc123"
}TroubleshootingSessionContextType
Structured contextual information for a troubleshooting session.
Fields
| Name | Description |
|---|---|
fault(TroubleshootingFaultInformationType) | Fault-related context, present when this session is for a fault. |
Example
{
"fault": TroubleshootingFaultInformationType
}TroubleshootingSessionType
The main object representing a single troubleshooting journey.
Fields
| Name | Description |
|---|---|
context([TroubleshootingContextEntryType]!) | Contextual information for this troubleshooting session. Deprecated The 'context' field is deprecated. |
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. |
originChannel(String) | The channel the session was started in. Null if unknown. |
otherNextSteps([TroubleshootingStepDefinitionType]) | A list of other possible steps that can be taken. |
playbookVersion(String!) | The playbook version of the troubleshooting session. |
sessionContext(TroubleshootingSessionContextType) | Structured contextual information for this 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",
"originChannel": "abc123",
"status": "OPEN",
"createdAt": "2020-01-01T00:00:00.000Z",
"context": TroubleshootingContextEntryType,
"sessionContext": TroubleshootingSessionContextType,
"steps": TroubleshootingStepInstanceType,
"nextRecommendedStep": TroubleshootingStepDefinitionType,
"otherNextSteps": [TroubleshootingStepDefinitionType]
}TroubleshootingStepDefinitionType
Defines the template for a troubleshooting step.
Fields
| Name | Description |
|---|---|
autoProgresses(Boolean!) | True if this step runs automatically without agent input (an AUTOMATIC or WORKFLOW step). The engine executes such steps and advances the session on its own when the session is progressed with autoProgressSession: true; in that case, poll the session for the settled next step rather than treating this as an actionable step. False for steps requiring manual agent input. |
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",
"autoProgresses": true,
"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. |
failureReasonMessage(String) | Human-readable message for the failure reason. Null when no structured reason is set. |
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",
"failureReasonMessage": "abc123",
"context": TroubleshootingContextEntryType
}UnenrollAccountFromLoyaltyProgram
Output type of the unenrollAccountFromLoyaltyProgram mutation.
Fields
| Name | Description |
|---|---|
outcome(UnenrollAccountFromLoyaltyProgramOutcome) | Outcome of the loyalty points campaign enrollment. |
Example
{
}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
Output type of the updateApiException mutation.
Fields
| Name | Description |
|---|---|
apiException(APIExceptionType) | The updated APIException. |
Example
{
}UpdateAPIExceptionNote
Output type of the updateApiExceptionNote mutation.
Fields
| Name | Description |
|---|---|
apiException(APIExceptionType) | The updates APIExceptionNote. |
Example
{
}UpdateAccountBillingAddress
Output type of the updateAccountBillingAddress mutation.
Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | The updated account. |
Example
{
"account": TelcoAccountType
}UpdateAccountBillingDay
Output type of the updateAccountBillingDay mutation.
Fields
| Name | Description |
|---|---|
account(AccountInterface) | Account that was changed. |
Example
{
"account": AccountInterface
}UpdateAccountBillingEmail
Output type of the updateAccountBillingEmail mutation.
Fields
| Name | Description |
|---|---|
account(AccountInterface) | Account that was changed. |
Example
{
"account": AccountInterface
}UpdateAccountBillingName
Output type of the updateAccountBillingName mutation.
Fields
| Name | Description |
|---|---|
account(AccountInterface) | Account that was changed. |
Example
{
"account": AccountInterface
}UpdateAccountConsents
Output type of the updateAccountConsents mutation.
Fields
| Name | Description |
|---|---|
consents([ConsentType!]!) | Consents linked to this account. |
Example
{
"consents": ConsentType
}UpdateAccountReference
Output type of the updateAccountReference mutation.
Fields
| Name | Description |
|---|---|
accountReference(AccountReferenceType) |
Example
{
"accountReference": AccountReferenceType
}UpdateAccountReferralStatus
Output type of the updateAccountReferralStatus mutation.
Fields
| Name | Description |
|---|---|
accountReferral(ReferralType) | The updated account referral instance. |
Example
{
"accountReferral": ReferralType
}UpdateAccountUserCommsPreferencesMutationPayload
Output type of the updateCommsPreferences mutation.
Fields
| Name | Description |
|---|---|
clientMutationId(String) | A unique identifier for the client performing the mutation. |
commsPreferences(AccountUserCommsPreferences) | |
emailFormat(String) | |
errors([ErrorType]) | A list of validation errors. |
fontSizeMultiplier(Float) | |
isOptedInMeterReadingConfirmations(Boolean) | |
isOptedInToClientMessages(Boolean) | |
isOptedInToOfferMessages(Boolean) | |
isOptedInToRecommendedMessages(Boolean) | |
isOptedInToSmsMessages(Boolean) | |
isOptedInToThirdPartyMessages(Boolean) | |
isOptedInToUpdateMessages(Boolean) | |
isUsingInvertedEmailColours(Boolean) | |
preferredHoldMusic(String) |
Example
{
"commsPreferences": AccountUserCommsPreferences,
"clientMutationId": "abc123",
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"isOptedInToSmsMessages": true,
"isOptedInMeterReadingConfirmations": true,
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 1.0,
"emailFormat": "abc123",
"preferredHoldMusic": "abc123",
"errors": [ErrorType]
}UpdateAccountUserConsents
Output type of the updateAccountUserConsents mutation.
Fields
| Name | Description |
|---|---|
accountUserConsents(AccountUserConsents) | All the consents for an account user. |
Example
{
"accountUserConsents": AccountUserConsents
}UpdateAccountUserMutationPayload
Output type of the updateUserDetails mutation.
Fields
| Name | Description |
|---|---|
clientMutationId(String) | A unique identifier for the client performing the mutation. |
dateOfBirth(Date) | The user's date of birth. |
email(String) | The user's email address. |
errors([ErrorType]) | A list of validation errors. |
familyName(String) | The user's family name. |
givenName(String) | The user's given name. |
landline(String) | The user's landline number. |
mobile(String) | The user's mobile number. |
pronouns(String) | The user's pronouns. |
Example
{
"errors": [ErrorType],
"clientMutationId": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"mobile": "abc123",
"dateOfBirth": "2020-01-01",
"landline": "abc123",
"pronouns": "abc123"
}UpdateActivePurchase
Output type of the updateActivePurchase mutation.
Fields
| Name | Description |
|---|---|
goodsPurchase(GoodsPurchase) | Goods purchase updated. |
Example
{
"goodsPurchase": GoodsPurchase
}UpdateAffiliateLink
Output type of the updateAffiliateLink mutation.
Fields
| Name | Description |
|---|---|
affiliateLink(AffiliateLinkType) | The updated affiliate link. |
Example
{
}UpdateAffiliateOrganisation
Output type of the updateAffiliateOrganisation mutation.
Fields
| Name | Description |
|---|---|
affiliateOrganisation(AffiliateOrganisationType) | The updated affiliate organisation. |
Example
{
}UpdateAgentAuxiliaryStatus
Output type of the updateAgentAuxiliaryStatus mutation.
Fields
| Name | Description |
|---|---|
success(Boolean) | Whether the auxiliary status was successfully updated. |
Example
{
"success": true
}UpdateAgreementPeriod
Output type of the updateAgreementPeriod mutation.
Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | Account responsible for the update agreement. |
Example
{
"account": TelcoAccountType
}UpdateAgreementRescission
Output type of the updateAgreementRescission mutation.
Fields
| Name | Description |
|---|---|
agreementRescission(AgreementRescissionType) | The updated agreement rescission instance. |
Example
{
}UpdateAgreementRollover
Output type of the updateAgreementRollover mutation.
Fields
| Name | Description |
|---|---|
agreementRollover(AgreementRolloverType) | The update agreement rollover. |
Example
{
"agreementRollover": AgreementRolloverType
}UpdateAutoTopUpAmount
Output type of the updateAutoTopUpAmount mutation.
Fields
| Name | Description |
|---|---|
schedule(PaymentScheduleType) | The new schedule created. |
Example
{
"schedule": PaymentScheduleType
}UpdateBusiness
Output type of the updateBusiness mutation.
Fields
| Name | Description |
|---|---|
business(BusinessType) | The updated business. |
Example
{
"business": BusinessType
}UpdateCampaignAccountExpiryDate
Output type of the updateCampaignAccountExpiryDate mutation.
Fields
| Name | Description |
|---|---|
campaignAccount(AccountCampaignType) | The campaign account with the updated expiry date. |
Example
{
"campaignAccount": AccountCampaignType
}UpdateCollectionProcessRecordLatestStep
Output type of the updateCollectionProcessRecordLatestStep mutation.
Fields
| Name | Description |
|---|---|
updatedCollectionProcessRecord(UpdateCollectionProcessRecordLatestStepOutputType) | The updated collection process record. |
Example
{
}Fields
| Name | Description |
|---|---|
latestStep(CollectionProcessStepType) | The updated latest step of the collection process record. |
number(String) | The number of the collection process record. |
Example
{
"number": "abc123"
}UpdateCollectionProcessRecordToActive
Output type of the updateCollectionProcessRecordToActive mutation.
Fields
| Name | Description |
|---|---|
collectionProcessActivated(UpdateCollectionProcessRecordToActiveOutputType) | Whether the collection process was successfully updated. |
Example
{
}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
Output type of the updateCollectionProcessRecordToComplete mutation.
Fields
| Name | Description |
|---|---|
collectionProcessComplete(UpdateCollectionProcessRecordToCompleteOutputType) | Whether the collection process was successfully updated. |
Example
{
}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
Output type of the updateCommsDeliveryPreference mutation.
Fields
| Name | Description |
|---|---|
account(AccountInterface) |
Example
{
"account": AccountInterface
}UpdateDCAProceeding
Output type of the updateDcaProceeding mutation.
Fields
| Name | Description |
|---|---|
dcaProceedingUpdateStatus(DCAProceedingUpdateStatus) | Whether the update has been applied. |
Example
{
}UpdateDocumentAccessibilityPreference
Output type of the updateDocumentAccessibilityPreference mutation.
Fields
| Name | Description |
|---|---|
account(TelcoAccountType) | Account that was changed. |
Example
{
"account": TelcoAccountType
}UpdateInstallationAppointment
Output type of the rebookInstallationAppointment mutation.
Fields
| Name | Description |
|---|---|
installationAppointment(InstallationAppointmentType) | The book installation appointment response. |
Example
{
"installationAppointment": InstallationAppointmentType
}UpdateKnowledgeDatabaseArticleFromText
Output type of the updateKnowledgeDatabaseArticleFromText mutation.
Fields
| Name | Description |
|---|---|
articleId(Int) | The ID of the updated article. |
Example
{
"articleId": 1
}UpdateLeadDetails
Output type of the updateLeadDetails mutation.
Fields
| Name | Description |
|---|---|
updatedLeadData(JSONString) | Arguments passed. |
Example
{
"updatedLeadData": {"key": "value"}
}UpdateLeadStage
Output type of the updateLeadStage mutation.
Fields
| Name | Description |
|---|---|
updatedLeadData(JSONString) | Arguments passed. |
Example
{
"updatedLeadData": {"key": "value"}
}UpdateMessageTags
Output type of the updateMessageTags mutation.
Fields
| Name | Description |
|---|---|
tags([InkTag!]!) | Confirmed tags. |
Example
{
}UpdateMetadata
Output type of the updateMetadata mutation.
Fields
| Name | Description |
|---|---|
metadata(Metadata) |
Example
{
"metadata": Metadata
}UpdateNotesOnOpportunity
Output type of the updateNotesOnOpportunity mutation.
Fields
| Name | Description |
|---|---|
opportunityNumber(String) | The number of the opportunity. |
Example
{
"opportunityNumber": "abc123"
}UpdateOfferGroupOnOpportunity
Output type of the updateOfferGroupOnOpportunity mutation.
Fields
| Name | Description |
|---|---|
opportunityNumber(String) | The number of the opportunity. |
Example
{
"opportunityNumber": "abc123"
}UpdateOnSiteJobsAppointment
Output type of the updateOnSiteJobsAppointment mutation.
Fields
| Name | Description |
|---|---|
onSiteJobsAppointment(OnSiteJobsAppointmentType) | The Appointment that was updated. |
Example
{
}UpdateOnSiteJobsRequest
Output type of the updateOnSiteJobsRequest mutation.
Fields
| Name | Description |
|---|---|
onSiteJobsRequest(OnSiteJobsRequestType) | The updated request. |
Example
{
}UpdateOnSiteJobsVendorComplaint
Output type of the updateOnSiteJobsVendorComplaint mutation.
Fields
| Name | Description |
|---|---|
onSiteJobsVendorComplaint(OnSiteJobsVendorComplaintType) | The updated vendor complaint. |
Example
{
}UpdateOpportunityAssignment
Output type of the updateOpportunityAssignment mutation.
Fields
| Name | Description |
|---|---|
updatedOpportunityData(JSONString) | Arguments passed. |
Example
{
"updatedOpportunityData": {"key": "value"}
}UpdateOpportunityDetails
Output type of the updateOpportunityDetails mutation.
Fields
| Name | Description |
|---|---|
updatedData(JSONString) | Arguments updated. |
Example
{
"updatedData": {"key": "value"}
}UpdateOpportunityExtraDetails
Output type of the updateOpportunityExtraDetails mutation.
Fields
| Name | Description |
|---|---|
extraDetails(JSONString) | The opportunity's extra details to be added or updated. |
Example
{
"extraDetails": {"key": "value"}
}UpdateOpportunityStage
Output type of the updateOpportunityStage mutation.
Fields
| Name | Description |
|---|---|
message(String) | Placeholder success message for now. |
Example
{
"message": "abc123"
}UpdateOptionsLanguagePreference
Output type of the updateOptionsLanguagePreference mutation.
Fields
| Name | Description |
|---|---|
optionsLanguagePreference(OptionsLanguagePreferenceChoices) | The selected language preference. |
Example
{
"optionsLanguagePreference": "ENGLISH"
}UpdatePassword
Output type of the updatePassword mutation.
Fields
| Name | Description |
|---|---|
viewer(AccountUserType) | The currently authenticated user. This field requires the |
Example
{
"viewer": AccountUserType
}UpdatePortfolioOperationsTeam
Output type of the updatePortfolioOperationsTeam mutation.
Fields
| Name | Description |
|---|---|
portfolio(PortfolioType) | The updated portfolio. |
Example
{
"portfolio": PortfolioType
}UpdateProductPricesOutput
Rate group prices for a product.
Fields
| Name | Description |
|---|---|
prices([RateGroupPrices!]!) | The rate group prices. |
Example
{
}UpdatePropertyAddress
Output type of the updatePropertyAddress mutation.
Fields
| Name | Description |
|---|---|
property(PropertyType) | The property whose address was updated. |
Example
{
"property": PropertyType
}UpdateQuoteConfigurationOutput
Output for the updateQuoteConfiguration mutation.
Fields
| Name | Description |
|---|---|
quoteConfiguration(QuoteConfigurationType!) | The updated quote configuration. |
Example
{
}UpdateRequestedActivationDate
Output type of the updateRequestedActivationDate mutation.
Fields
| Name | Description |
|---|---|
broadbandOrder(BroadbandOrderType) | The broadband order that has been updated. |
Example
{
"broadbandOrder": BroadbandOrderType
}UpdateSiteworksRequest
Output type of the updateSiteworksRequest mutation.
Fields
| Name | Description |
|---|---|
siteworksRequest(CoreSiteworksRequestType) | The siteworks request after the update. |
Example
{
}UpdateUserMobileAppDetails
Output type of the updateUserMobileAppDetails mutation.
Fields
| Name | Description |
|---|---|
viewer(UserMobileData) |
Example
{
"viewer": UserMobileData
}UpdateUserMutation
Output type of the updateUser mutation.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
viewer(AccountUserType) |
Example
{
"viewer": AccountUserType,
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
serviceId(ID!) | The ID of the VoIP service that was updated. |
Example
{
"serviceId": "abc123"
}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"
}Fields
| Name | Description |
|---|---|
code(String!) | The unique code of the role. |
description(String!) | The description of the role. |
name(String!) | The unique displayable name of the role. |
permissionCodes([String]!) | The permissions associated with the role. |
Example
{
"code": "abc123",
"name": "abc123",
"description": "abc123",
"permissionCodes": "abc123"
}ValidateAddress
Output type of the validateAddress mutation.
Fields
| Name | Description |
|---|---|
cleanedDescriptor(AddressFieldDescriptorType) | The address field descriptor with cleaned/normalised values and per-field validation errors populated. Each field's errors list is empty when valid. Returned on both success and failure. |
isValid(Boolean!) | Whether the address passed all validation checks. |
Example
{
"isValid": true,
"cleanedDescriptor": AddressFieldDescriptorType
}ValidateEmail
Output type of the validateEmail mutation.
Fields
| Name | Description |
|---|---|
isValid(Boolean) | Whether the email is valid or not. |
Example
{
"isValid": true
}ValidateMfaDevice
Output type of the validateMfaDevice mutation.
Fields
| Name | Description |
|---|---|
deviceIsValid(Boolean) | Flag to indicate if the device has been verified, so it can be used for MFA. |
Example
{
"deviceIsValid": true
}ValidatePhone
Output type of the validatePhone mutation.
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. Deprecated The 'characteristicValues' field is deprecated. |
characteristics(GenericScalar!) | The characteristic values for the variant. |
schemeLabels(JSONString) | The scheme labels for the variant. Deprecated The 'schemeLabels' field is deprecated. |
schemes(GenericScalar) | The scheme labels for the variant. |
Example
{
"characteristicValues": {"key": "value"},
"schemeLabels": {"key": "value"},
"characteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"schemes": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}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
Output type of the verifyCustomer mutation.
Fields
| Name | Description |
|---|---|
user(AccountUserType) | The currently authenticated user. |
Example
{
"user": AccountUserType
}VerifyEmail
Output type of the verifyEmail mutation.
Fields
| Name | Description |
|---|---|
isVerified(Boolean) | Whether the email is verified. |
Example
{
"isVerified": true
}VerifyIdentity
Output type of the verifyIdentity mutation.
Fields
| Name | Description |
|---|---|
token(String!) | An expiring token that can be used to request to update the user's email address. |
Example
{
"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
Output type of the withdrawDunning mutation.
Fields
| Name | Description |
|---|---|
withdrawSuccessful(Boolean) | Whether the dunning process was withdrawn successfully. |
Example
{
"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
}