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 .≤fieldName>, for REST APIs this will be an endpoint.
`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.

{
  "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.

{
  "pageInfo": PageInfo,
  "edges": APIBrownoutEdge,
  "totalCount": 1,
  "edgeCount": 1
}

APIBrownoutEdge

A Relay edge containing a APIBrownout and its cursor.

Fields

Name Description

Name	Description
`cursor(String!)`	A cursor for use in pagination
`node(APIBrownout)`	The item at the end of the edge

cursor(String!)

A cursor for use in pagination

node(APIBrownout)

The item at the end of the edge

{
  "cursor": "abc123"
}

APICallType

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.

{
  "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.

{
  "pageInfo": PageInfo,
  "edges": APIExceptionConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

APIExceptionConnectionTypeEdge

A Relay edge containing a APIExceptionConnectionType and its cursor.

Fields

Name Description

Name	Description
`cursor(String!)`	A cursor for use in pagination
`node(APIExceptionType)`	The item at the end of the edge

cursor(String!)

A cursor for use in pagination

node(APIExceptionType)

The item at the end of the edge

{
  "cursor": "abc123"
}

APIExceptionEventType

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!)`

{
  "id": "abc123",
  "eventType": "abc123",
  "category": "abc123",
  "description": "abc123",
  "context": {"key": "value"},
  "createdAt": "2020-01-01T00:00:00.000Z"
}

APIExceptionNoteType

Fields

Name Description

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.

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.

{
  "id": "abc123",
  "body": "abc123",
  "createdAt": "2020-01-01T00:00:00.000Z"
}

APIExceptionType

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.

{
  "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": "FDV",
  "context": {"key": "value"},
  "keyDate": "2020-01-01"
}

AcceptGoodsQuote

Output type of the acceptGoodsQuote mutation.

Fields

Name Description

Name	Description
`goodsPurchase(GoodsPurchase)`	Goods purchase created.

goodsPurchase(GoodsPurchase)

Goods purchase created.

{
  "goodsPurchase": GoodsPurchase
}

AcceptOfferForQuoting

Output type of the acceptOfferForQuoting mutation.

Fields

Name Description

Name	Description
`offer(OfferType)`	Accepted quoting offer.

offer(OfferType)

Accepted quoting offer.

{
  "offer": OfferType
}

AccountAccessConnectionTypeConnection

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.

{
  "pageInfo": PageInfo,
  "edges": AccountAccessConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

AccountAccessConnectionTypeEdge

A Relay edge containing a AccountAccessConnectionType and its cursor.

Fields

Name Description

Name	Description
`cursor(String!)`	A cursor for use in pagination
`node(AccountAccessType)`	The item at the end of the edge

cursor(String!)

A cursor for use in pagination

node(AccountAccessType)

The item at the end of the edge

{
  "node": AccountAccessType,
  "cursor": "abc123"
}

AccountAccessType

Represents the accessible account and access information of an accessor.

Fields

Name Description

Name	Description
`entity(AccountType!)`	The account that the accessor has access to.
`roleAssignments([RoleAssignment]!)`	The role assignments that the accessor has for the entity.

entity(AccountType!)

The account that the accessor has access to.

roleAssignments([RoleAssignment]!)

The role assignments that the accessor has for the entity.

{
  "roleAssignments": RoleAssignment,
  "entity": AccountType
}

AccountApplicationConnectionTypeConnection

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.

{
  "pageInfo": PageInfo,
  "edges": AccountApplicationConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

AccountApplicationConnectionTypeEdge

A Relay edge containing a AccountApplicationConnectionType and its cursor.

Fields

Name Description

Name	Description
`cursor(String!)`	A cursor for use in pagination
`node(AccountApplicationType)`	The item at the end of the edge

cursor(String!)

A cursor for use in pagination

node(AccountApplicationType)

The item at the end of the edge

{
  "node": AccountApplicationType,
  "cursor": "abc123"
}

AccountApplicationType

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!)`

{
  "salesChannel": "abc123",
  "salesSubchannel": "abc123",
  "status": "CURRENT",
  "dateOfSale": "2020-01-01",
  "coolingOffEndDate": "2020-01-01",
  "isMigrated": true,
  "migrationSource": "abc123",
  "preferredSsd": "2020-01-01"
}

AccountBalanceTransferType

Fields

Name	Description
`accountCharge(AccountChargeType)`	Debit details.
`accountCredit(AccountCreditType)`	Credit details.
`id(ID)`	Balance transfer ID.
`reason(String)`	The reason for the balance transfer.

{
  "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.

{
  "pageInfo": PageInfo,
  "edges": AccountCampaignConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

AccountCampaignConnectionTypeEdge

A Relay edge containing a AccountCampaignConnectionType and its cursor.

Fields

Name Description

Name	Description
`cursor(String!)`	A cursor for use in pagination
`node(AccountCampaignType)`	The item at the end of the edge

cursor(String!)

A cursor for use in pagination

node(AccountCampaignType)

The item at the end of the edge

{
  "node": AccountCampaignType,
  "cursor": "abc123"
}

AccountCampaignType

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.

{
  "campaignExpiryDate": "2020-01-01",
  "name": "abc123",
  "slug": "abc123",
  "expiryDate": "2020-01-01",
  "startDate": "2020-01-01"
}

AccountCannotSelectProductErrorType

Fields

Name Description

Name	Description
`message(String!)`

message(String!)

{
  "message": "abc123"
}

AccountChargeMetadataType

Fields

Name Description

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.

data(JSONString)

A JSON object containing unstructured data about the account charge.

updatedAt(DateTime)

The date and time the metadata was last updated.

{
  "data": {"key": "value"},
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

AccountChargeType

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.

{
  "id": "abc123",
  "netAmount": 1,
  "grossAmount": 1,
  "salesTaxAmount": 1,
  "cclAmount": 1,
  "reason": "abc123",
  "note": "abc123",
  "displayNote": "abc123",
  "metadata": AccountChargeMetadataType
}

AccountConnectionTypeConnection

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.

{
  "pageInfo": PageInfo,
  "edges": AccountConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

AccountConnectionTypeEdge

A Relay edge containing a AccountConnectionType and its cursor.

Fields

Name Description

Name	Description
`cursor(String!)`	A cursor for use in pagination
`node(AccountType)`	The item at the end of the edge

cursor(String!)

A cursor for use in pagination

node(AccountType)

The item at the end of the edge

{
  "node": AccountType,
  "cursor": "abc123"
}

AccountCreditMetadataType

Fields

Name Description

Name	Description
`data(JSONString!)`
`updatedAt(DateTime!)`

data(JSONString!)

updatedAt(DateTime!)

{
  "data": {"key": "value"},
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

AccountCreditType

Fields

Name	Description
`grossAmount(BigInt!)`
`id(ID!)`
`metadata(AccountCreditMetadataType)`
`netAmount(BigInt!)`
`note(String!)`
`reason(String!)`
`salesTaxAmount(BigInt!)`

{
  "id": "abc123",
  "grossAmount": 1,
  "netAmount": 1,
  "salesTaxAmount": 1,
  "note": "abc123",
  "reason": "abc123",
  "metadata": AccountCreditMetadataType
}

AccountDebtPositionType

Fields

Name Description

accountNumber(String!)

The account number.

ledgerDebtPositions([LedgerDebtPositionType]!)

The delinquent debt position for each eligible ledger on the account.

{
  "accountNumber": "abc123",
  "ledgerDebtPositions": LedgerDebtPositionType
}

AccountDoesNotHaveEmailErrorType

Fields

Name Description

Name	Description
`message(String!)`

message(String!)

{
  "message": "abc123"
}

AccountEstimatedUsageAndCostType

Fields

Name Description

Name	Description
`electricityEstimation(ElecEstimatedUsageAndCostType)`	Electricity usage (kWh) and cost estimation.
`gasEstimation(GasEstimatedUsageAndCostType)`	Gas usage (MJ) and cost estimation.

electricityEstimation(ElecEstimatedUsageAndCostType)

Electricity usage (kWh) and cost estimation.

gasEstimation(GasEstimatedUsageAndCostType)

Gas usage (MJ) and cost estimation.

{
  "electricityEstimation": ElecEstimatedUsageAndCostType,
  "gasEstimation": GasEstimatedUsageAndCostType
}

AccountEventConnectionTypeConnection

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.

{
  "pageInfo": PageInfo,
  "edges": AccountEventConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

AccountEventConnectionTypeEdge

A Relay edge containing a AccountEventConnectionType and its cursor.

Fields

Name Description

Name	Description
`cursor(String!)`	A cursor for use in pagination
`node(AccountEvent)`	The item at the end of the edge

cursor(String!)

A cursor for use in pagination

node(AccountEvent)

The item at the end of the edge

{
  "node": EmailEventType,
  "cursor": "abc123"
}

AccountFileAttachment

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)`

{
  "id": "abc123",
  "filename": "abc123",
  "category": "abc123",
  "isUploaded": true,
  "isReady": true,
  "fetchUrl": "abc123",
  "sizeInBytes": 1
}

AccountFileAttachmentConnectionTypeConnection

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.

{
  "pageInfo": PageInfo,
  "edges": AccountFileAttachmentConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

AccountFileAttachmentConnectionTypeEdge

A Relay edge containing a AccountFileAttachmentConnectionType and its cursor.

Fields

Name Description

Name	Description
`cursor(String!)`	A cursor for use in pagination
`node(AccountFileAttachment)`	The item at the end of the edge

cursor(String!)

A cursor for use in pagination

node(AccountFileAttachment)

The item at the end of the edge

{
  "node": AccountFileAttachment,
  "cursor": "abc123"
}

AccountIsNotAssociatedWithPropertyErrorType

Fields

Name Description

Name	Description
`message(String!)`

message(String!)

{
  "message": "abc123"
}

AccountLoyaltyPointsType

Fields

Name Description

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.

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.

{
  "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.

{
  "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"
}

AccountNotFound

Fields

Name Description

Name	Description
`message(String!)`

message(String!)

{
  "message": "abc123"
}

AccountNoteType

Fields

Name	Description
`body(String!)`
`createdAt(DateTime!)`
`id(ID!)`
`isPinned(Boolean!)`
`unpinAt(DateTime)`

{
  "id": "abc123",
  "body": "abc123",
  "isPinned": true,
  "createdAt": "2020-01-01T00:00:00.000Z",
  "unpinAt": "2020-01-01T00:00:00.000Z"
}

AccountPaymentConnectionTypeConnection

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.

{
  "pageInfo": PageInfo,
  "edges": AccountPaymentConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

AccountPaymentConnectionTypeEdge

A Relay edge containing a AccountPaymentConnectionType and its cursor.

Fields

Name Description

Name	Description
`cursor(String!)`	A cursor for use in pagination
`node(AccountPaymentType)`	The item at the end of the edge

cursor(String!)

A cursor for use in pagination

node(AccountPaymentType)

The item at the end of the edge

{
  "node": AccountPaymentType,
  "cursor": "abc123"
}

AccountPaymentType

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. Please use uuid instead. - Marked as deprecated on 2026-05-28. - Scheduled for removal on or after 2027-05-28.
`maxRescheduleDays(Int!)`	Maximum number of days the payment can be extended by.
`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!)`
`refundableAmount(Int)`	The amount that can be refunded from this payment.
`schedulabilityStatus(SchedulabilityStatusType)`	Deprecated The 'schedulabilityStatus' field is deprecated. This has been deprecated in favour of the `ReschedulePaymentErrorUnion` resolved by the `ReschedulePayment` mutation. This mutations error types provide a much more granular and richer set of parsable errors then can be supplied here. - Marked as deprecated on 2022-09-02. - Scheduled for removal on or after 2022-11-08. Arguments `numDays` (`Int!`) Days to extend the payment by
`source(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!)`

{
  "id": "abc123",
  "amount": 1,
  "paymentDate": "2020-01-01",
  "reference": "abc123",
  "transactionType": "DD_FIRST_COLLECTION",
  "status": "SCHEDULED",
  "uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
  "source": "abc123",
  "paymentInstruction": PaymentInstructionType,
  "surchargeAmount": 1,
  "schedulabilityStatus": SchedulabilityStatusType,
  "maxRescheduleDays": 1,
  "refundableAmount": 1
}

AccountReferenceType

Fields

Name	Description
`account(AccountType!)`
`createdAt(DateTime!)`
`namespace(String!)`	The namespace for the reference will be one of the following strings: australia-post-reference-numbers bpay-reference-numbers centrepay-reference-numbers payment-reference-numbers
`updatedAt(DateTime!)`
`value(String!)`

{
  "namespace": "abc123",
  "value": "abc123",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T00:00:00.000Z",
  "account": AccountType
}

AccountReminder

Fields

Name Description

Name	Description
`content(String)`	Reminder content.
`dueAt(DateTime)`	When the reminder is due.
`reminderType(AccountReminderTypes)`	The reminder type.

content(String)

Reminder content.

dueAt(DateTime)

When the reminder is due.

reminderType(AccountReminderTypes)

The reminder type.

{
  "reminderType": "AD_HOC",
  "content": "abc123",
  "dueAt": "2020-01-01T00:00:00.000Z"
}

AccountReminderConnectionTypeConnection

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.

{
  "pageInfo": PageInfo,
  "edges": AccountReminderConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

AccountReminderConnectionTypeEdge

A Relay edge containing a AccountReminderConnectionType and its cursor.

Fields

Name Description

Name	Description
`cursor(String!)`	A cursor for use in pagination
`node(Reminder)`	The item at the end of the edge

cursor(String!)

A cursor for use in pagination

node(Reminder)

The item at the end of the edge

{
  "node": Reminder,
  "cursor": "abc123"
}

AccountRepaymentConnectionTypeConnection

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.

{
  "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

{
  "node": AccountRepaymentType,
  "cursor": "abc123"
}

AccountRepaymentType

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.

{
  "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(AccountType)

The account found.

score(Decimal)

How well the account matched the search terms.

{
  "account": AccountType,
  "score": "1.0"
}

AccountType

Fields

Name	Description
`accountType(AccountTypeChoices)`	The type of account.
`accountUserAccessors(AccountUserAccessorAccessConnectionTypeConnection)`	Account users that have access to this account, with their access information. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`) `roleCodes` (`[String!]`) Filter accessors by role codes. `scope` (`AccessScope`) Whether to return only directly assigned accounts (DIRECT) or all accessible accounts including inherited access (ALL, default).
`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 `name` and `organization` are very unlikely to be supplied here; the `billing_name` field on the account itself is generally used for that purpose instead.
`agreements([AusAgreementInterface])`	Retrieve all agreements under this account. Note that when `active` is set to false it actually means 'return both active and inactive agreements'. Arguments `active` (`Boolean`) Whether to return active agreements only. `id` (`ID`) Filter the list to the agreement with this id.
`annualStatements(AnnualStatementConnectionTypeConnection)`	Fetch annual statements for the account. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`applications(AccountApplicationConnectionTypeConnection)`	Applications by this account to become our customer. More recent applications will be listed first. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `status` (`AccountApplicationStatus`) 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 `includeAllLedgers` (`Boolean`) 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 `billType` (`BillTypeEnum`) `id` (`ID`) The unique identifier of the bill. `identifier` (`String`) 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. `ledgerNumber` (`String`) 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)`
`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 `after` (`String`) `before` (`String`) `first` (`Int`) `fromDate` (`Date`) Optional date representing the beginning of the search results. This date value is inclusive. `includeBillsWithoutPDF` (`Boolean`) Include bills without PDFs. `includeHeldStatements` (`Boolean`) Include held statements within the results. `includeHistoricStatements` (`Boolean`) Include pre-Kraken / historical statements within the results. `includeInvoices` (`Boolean`) Include item-based billing documents (invoices) within the results. `includeOpenStatements` (`Boolean`) Include open statements. This flag needs to be used along with includeBillsWithoutPDF=false otherwise results will prove unexpected. `issuedFromDate` (`Date`) Optional date representing the beginning of the search results based on issued date. This date value is inclusive. `issuedToDate` (`Date`) Optional date representing the end of the search results based on issued date. This date value is exclusive. `last` (`Int`) `ledgerNumber` (`String`) 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. `offset` (`Int`) `onlyCurrentEmail` (`Boolean`) Only include bills emailed to the current user's email. `orderBy` (`BillsOrderBy`) The order in which to return the bills. `toDate` (`Date`) 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. Use `business.businessType` instead - Marked as deprecated on 2022-03-09. - Scheduled for removal on or after 2024-01-01.
`campaigns([AccountCampaignType])`	The campaigns associated with an account.
`canRequestRefund(Boolean)`	Whether the account can request a credit refund.
`changeRequests([ChangeRequestType])`
`commsDeliveryPreference(CommsDeliveryPreference)`	The method the account has specified they prefer we contact them.
`communicationDeliveryPreference(String)`	Deprecated The 'communicationDeliveryPreference' field is deprecated. Use `commsDeliveryPreference` instead - Marked as deprecated on 2022-05-27. - Scheduled for removal on or after 2024-01-01.
`consents([ConsentType!]!)`	Consents linked to 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 `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `statuses` (`[DirectDebitInstructionStatus]`) Filter the direct debit instructions by status
`documentAccessibility(DocumentAccessibilityChoices)`	The document accessibility preference of the account.
`dueCharges([DueChargesType])`	Fetch a list of due charges for an account. Due charges are defined for each issued statement as: Charges due = 0 - Closing balance of the statement - Sum of payments and credits received after the statement's `to_date` - Due charges on previous statements (Remember that if the customer owes us money, then their balance will be negative, so subtracting it will result in a positive amount.) Usually, many of a customer's issued statements will have 0 due charges remaining. We omit most of these `0` results from the output. You may use `asOfDate` to request a historical view of due charges. If you set it, then statements issued after the `asOfDate` will be omitted, and payments and credits posted after that date will be ignored by the calculation. Arguments `asOfDate` (`Date`) If supplied, statements issued after this date are omitted. If not supplied, defaults to today's date.
`estimatedUsageAndCost(AccountEstimatedUsageAndCostType)`	Estimated energy usage and cost based on Energy Made Easy.
`events(AccountEventConnectionTypeConnection)`	The account events that were recorded for the account. Arguments `after` (`String`) `before` (`String`) `eventTypes` (`[AccountEventType]`) Filter the account events by their type. `first` (`Int`) `last` (`Int`)
`fileAttachments([AccountFileAttachment])`	Files attached to this account.
`hasWriteOffLedgers(Boolean)`	True if the account has written off ledgers. False otherwise.
`id(ID!)`
`isInHardship(Boolean)`	True if there is an active Hardship Agreement for this account. False otherwise.
`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. Arguments `includeDebtLedgers` (`Boolean`) If this variable is set to false, debt ledgerswill be filtered out of the ledgers list. `ledgerId` (`ID`) The ledger to return. `ledgerNumber` (`String`) The ledger to return by its number.
`lifeSupport(LifeSupportType)`	Account related life support details.
`linkedUserIds([ID])`	A list of user ids linked to this account through either portfolio roles or account roles.
`maximumRefund(MaximumRefundType)`	The maximum amount a customer is allowed to request as a refund and the reason why that's the maximum amount. Arguments `ledgerNumber` (`String`) 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. Arguments `after` (`String`) `before` (`String`) `category` (`String`) File attachment category. `first` (`Int`) `id` (`Int`) File attachment id. `last` (`Int`)
`paginatedPaymentForecast(PaymentForecastConnectionTypeConnection)`	Paginated payment forecasts for an account. Starts from today's date (inclusive). The interface supports `last` but does not guarantee 'lastness'. Deprecated The 'paginatedPaymentForecast' field is deprecated. Please use the 'paymentForecast' field on the ledger instead. - Marked as deprecated on 2026-09-24. - Scheduled for removal on or after 2027-09-24. Arguments `after` (`String`) `before` (`String`) `dateTo` (`Date`) The end date to retrieve forecasts for. This end date is inclusive. `first` (`Int`) `last` (`Int`) `ledgerId` (`Int`) The ledger to return payment forecasts from. Defaults to the main ledger when no ID is passed. `ledgerNumber` (`String`) 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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`) `roleCodes` (`[String!]`) Filter accessors by role codes. `scope` (`AccessScope`) Whether to return only partners assigned directly to this account (DIRECT) or all partners with access including inherited access (ALL, default).
`paymentExtensionInfo(PaymentExtensionInfoType)`	Information related to the viability of a payment extension.
`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. Please use 'paginatedPaymentForecast' instead. - Marked as deprecated on 2024-01-03. - Scheduled for removal on or after 2025-01-01. Arguments `dateTo` (`Date!`) The end date to retrieve forecasts for. This end date is inclusive. `ledgerId` (`Int`) The ledger to return payment forecasts from. Defaults to the main ledger when no ID is passed. `ledgerNumber` (`String`) 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 `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `setupChannel` (`SetupChannel`) Filter the payment instructions by the channel they were set up through. `statuses` (`[PaymentInstructionStatus]`) Filter the payment instructions by status.
`paymentPlans(PaymentPlanConnectionTypeConnection)`	The payment plans that have been created for this account. Deprecated The 'paymentPlans' field is deprecated. Please use 'paymentPlans' on the Ledger type instead. - Marked as deprecated on 2026-09-10. - Scheduled for removal on or after 2027-09-10. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`paymentSchedules(PaymentScheduleConnectionTypeConnection)`	The schedules that describe how we would expect to take payments for an account on a given month. Arguments `active` (`Boolean`) `activeOnDate` (`Date`) `after` (`String`) `before` (`String`) `canCreatePayment` (`Boolean`) `first` (`Int`) `includeDormant` (`Boolean`) 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. `last` (`Int`) `ledgerId` (`ID`) The ledger id to return the payment schedules from. `ledgerNumber` (`String`) The ledger number to return the payment schedules from. `ledgerType` (`Int`) The ledger to return transactions from. `reason` (`PaymentScheduleReasonOptions`)
`payments(AccountPaymentConnectionTypeConnection)`	The payments made into an account from a payment instruction. Deprecated The 'payments' field is deprecated. Please use 'payments' on the Ledger type instead. - Marked as deprecated on 2026-09-30. - Scheduled for removal on or after 2027-09-30. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `includePromises` (`Boolean`) Whether to include payment promises (of any kind: made, broken or fulfilled) or not. The default is to include them. `last` (`Int`) `ledgerId` (`String`) The id of the ledger to return payments from. `ledgerNumber` (`String`) WARNING: Will be mandatory in future versions The number of the ledger to return payments from. `reason` (`PaymentReasonOptions`) Filter for payments that were taken for a particular reason. `status` (`AccountPaymentStatusOptions`)
`portfolio(PortfolioType)`	The portfolio this account is linked to.
`preferredLanguageForComms(String)`	The language that the account preferred for communications.
`previousProperties([PropertyType])`
`properties([PropertyType])`	Arguments `activeFrom` (`DateTime`)
`provisionalTransactions(ProvisionalTransactionConnectionTypeConnection)`	Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`references([AccountReferenceType])`	Account references linked to this account.
`referrals(ReferralConnectionTypeConnection)`	The referrals created by this account. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `status` (`ReferralStatus`) 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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`repayments(AccountRepaymentConnectionTypeConnection)`	The repayments that have been requested for this account. Deprecated The 'repayments' field is deprecated. Please use the 'repayments' field on the ledger instead. - Marked as deprecated on 2026-09-18. - Scheduled for removal on or after 2027-09-18. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `statuses` (`[AccountRepaymentStatusOptions]`) Only return repayments whose status matches one of these statuses.
`requestRefundEligibility(RequestRefundEligibilityType)`	Details about the eligibility status for requesting a refund. Arguments `ledgerNumber` (`String`) The ledger number to check refund eligibility.
`rewards([RewardType])`	The rewards applied to this account.
`serviceOrders([ServiceOrderUnion])`	Account related service orders.
`splitBillingAddress([String])`	List of billing address lines.
`status(AccountStatus)`	The current status of the account.
`totalBalanceOwing(Int)`	The current account total balance owing.
`transactions(TransactionConnectionTypeConnection)`	Fetch transactions that have taken place on the account. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `fromDate` (`Date`) Optional date representing the beginning of the postedDate range filter. This date value is inclusive. `includeAllLedgers` (`Boolean`) In a multi-ledger scenario, include all ledgers' transactions if `true`. Analogously, if `false` and no `ledgerId` or `ledger_number` argument is present, the list of transactions defaults to the main ledger (legacy behaviour). `last` (`Int`) `ledgerId` (`Int`) The ledger to return transactions from. `ledgerNumber` (`String`) The number of the ledger to return transactions from. `offset` (`Int`) `orderBy` (`TransactionsOrderBy`) The order in which to return the transactions. `toDate` (`Date`) Optional date representing the end of the postedDate range filter. This date value is exclusive. `transactionTypes` (`[TransactionTypeFilter]`) Include only these specific transaction types in the result. `transactionTypesExcluded` (`[TransactionTypeFilter]`) Exclude these specific transaction types from the result.
`urn(String)`	Unique reference number from a 3rd party enrolment.

{
  "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],
  "contributionAgreements": [ContributionAgreementType],
  "assistanceAgreements": [AssistanceAgreementType],
  "createdAt": "2020-01-01T00:00:00.000Z",
  "preferredLanguageForComms": "abc123",
  "consents": ConsentType,
  "reminders": AccountReminderConnectionTypeConnection,
  "customerAssets": [CustomerAssetType],
  "partnerAccessors": PartnerAccessorAccessConnectionTypeConnection,
  "accountUserAccessors": AccountUserAccessorAccessConnectionTypeConnection,
  "id": "abc123",
  "agreements": AusAgreementInterface,
  "properties": [PropertyType],
  "previousProperties": [PropertyType],
  "dueCharges": [DueChargesType],
  "paymentExtensionInfo": PaymentExtensionInfoType,
  "lifeSupport": LifeSupportType,
  "serviceOrders": ElectricityServiceOrderType,
  "changeRequests": [ChangeRequestType],
  "estimatedUsageAndCost": AccountEstimatedUsageAndCostType,
  "linkedUserIds": ["abc123"],
  "hasWriteOffLedgers": true,
  "totalBalanceOwing": 1
}

AccountUserAccessorAccessConnectionTypeConnection

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.

{
  "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

{
  "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.

{
  "roleAssignments": RoleAssignment,
  "accessor": AccountUserType
}

AccountUserCanNotFoundErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

AccountUserCommsPreferences

Information about the preferences set up for a user.

Fields

Name	Description
`emailFormat(EmailFormats)`	What format the user would like to receive their emails in.
`fontSizeMultiplier(Float)`	This setting allows the user to adjust the default font size of the communications sent to them.
`isOptedInMeterReadingConfirmations(Boolean)`	Whether the user has opted in to receive meter reading confirmation emails.
`isOptedInToClientMessages(Boolean)`	Whether a user has opted in to receive messages from the client or client group. For example, for Octopus Energy this describes whether a user is opted in to offers from Octopus Investments.
`isOptedInToLifeSupportCall(Boolean)`	Whether the user is opted in to life support call.
`isOptedInToOfferMessages(Boolean)`	Whether a user has opted in to receive messages offering discounts or other services not directly related to the services the client provides.
`isOptedInToRecommendedMessages(Boolean)`	Whether a user has opted in to receive messages we recommend they read, but are not vital to the utilities the client provides. For example, these could be reminders that the client will take a payment.
`isOptedInToSmsMessages(Boolean)`	Whether the user has opted in to receive SMS messages.
`isOptedInToThirdPartyMessages(Boolean)`	Whether a user has opted in to receive messages from the client's preferred third parties.
`isOptedInToUpdateMessages(Boolean)`	Whether a user has opted in to receive messages updating them on client activities.
`isUsingInvertedEmailColours(Boolean)`	Whether a user has opted to have inverted colours in their emails. This is currently only relevant to the Octopus Energy brand, whose emails have a dark background by default.
`preferredHoldMusic(Songs)`	Song which will be used as hold music for the user.
`smsOptInLastChangeDate(DateTime)`	The date the SMS opt-in was last changed.

{
  "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
}

AccountUserConnectionTypeConnection

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.

{
  "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

{
  "node": AccountUserType,
  "cursor": "abc123"
}

AccountUserConsents

Information about the consents for an account user.

Fields

Name Description

consents([ConsentType!]!)

Consents linked to this user.

{
  "consents": ConsentType
}

AccountUserDetailType

Fields

Name Description

isSensitive(Boolean)

Whether the value is sensitive and encrypted.

namespace(String)

The namespace for the property.

value(String)

The property value.

{
  "namespace": "abc123",
  "value": "abc123",
  "isSensitive": true
}

AccountUserIsNotEligibleErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

AccountUserPermission

Holds information about a specific permission.

Fields

Name Description

permission(String)

The short name of the permission.

{
  "permission": "abc123"
}

AccountUserRoleType

The role a user has in association with one account.

Fields

Name	Description
`account(AccountType!)`
`id(ID!)`	The ID of the account user role. Deprecated The 'id' field is deprecated. An access allocation's identifier is internal to the Customer Access domain. Access is identified by who it affects, not by the row that records it: please use 'user', 'account' and 'role' instead. - Marked as deprecated on 2026-09-02. - Scheduled for removal on or after 2026-11-01.
`role(RoleString)`	The account role.
`user(AccountUserType!)`

{
  "id": "abc123",
  "account": AccountType,
  "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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`) `scope` (`AccessScope`) Whether to include access inherited via portfolio/business, or only direct access.
`accessibleAccountsSearch(AccountAccessConnectionTypeConnection)`	Search for accounts this user can access and match the search terms. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`) `searchTerms` (`AccountSearchInputType`) Search operators.
`accessibleBusinesses(BusinessAccessConnectionTypeConnection)`	Businesses this user can access, with the roles granting that access. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`)
`accessiblePortfolios(PortfolioAccessConnectionTypeConnection)`	Portfolios this user can access, with the roles granting that access. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`) `scope` (`AccessScope`) Whether to include access inherited via a business the user belongs to or the portfolio hierarchy.
`accountUserRoles([AccountUserRoleType])`	List of roles a user has for each account they're linked to. Arguments `accountNumber` (`String`) 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 `allowedBrandCodes` (`[BrandChoices]`) Optionally filter the user's accounts to only return those linked to portfolios on the specified brands. `excludeAccountTypes` (`[AccountTypeChoices]`) Optionally exclude accounts with any of the given account types. `excludeAccountsWithoutAgreements` (`Boolean`) Optionally exclude accounts that have never had an agreement. `restrictToAccountNumbers` (`[String]`) Optionally restrict user accounts to only return those with the specified account numbers. `restrictToPublicFacingBrands` (`Boolean`) 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.
`applicableConcessionCardTypes([ConcessionCardApplicableRegionType])`	A list of possible concession card types for the user's jurisdiction.
`bills(BillConnectionTypeConnection)`	Fetch issued bills (invoices/statements) for the account. Arguments `accountNumbers` (`[String]`) If provided, filters the bills down to only the specified accounts. Any account numbers the user doesn't have access to will be ignored. `after` (`String`) `before` (`String`) `first` (`Int`) `fromDate` (`Date`) Optional date representing the beginning of the search results. This date value is inclusive. `includeBillsWithoutPDF` (`Boolean`) Include bills without PDFs. `includeHeldStatements` (`Boolean`) Include held statements within the results. `includeHistoricStatements` (`Boolean`) Include pre-Kraken / historical statements within the results. `includeOpenStatements` (`Boolean`) Include open statements. This flag needs to be used along with includeBillsWithoutPDF=false otherwise results will prove unexpected. `issuedFromDate` (`Date`) Optional date representing the beginning of the search results based on issued date. This date value is inclusive. `issuedToDate` (`Date`) Optional date representing the end of the search results based on issued date. This date value is exclusive. `last` (`Int`) `offset` (`Int`) `onlyCurrentEmail` (`Boolean`) Only include bills emailed to the current user's email. `orderBy` (`BillsOrderBy`) The order in which to return the bills. `toDate` (`Date`) Optional date representing the end of the search results. This date value is exclusive.
`businesses(BusinessConnectionTypeConnection)`	List of businesses that the user has access to through their granted roles. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`concessions([ConcessionType])`	A list of concessions for the user.
`consents([ConsentType!]!)`	Consents linked to this user.
`contactEmails([ContactEmailType])`	The account user's contact email addresses. Unlike the `email` field, a contact email does not have to be unique: the same address can belong to several account users.
`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. Please use fullName instead of this field. - Marked as deprecated on 2019-12-11. - Scheduled for removal on or after 2024-01-01.
`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. Use 'givenName' instead. - Marked as deprecated on 2020-09-23. - Scheduled for removal on or after 2023-06-05.
`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. Use 'landline' instead. - Marked as deprecated on 2021-03-22. - Scheduled for removal on or after 2024-01-01.
`lastName(String)`	We recommend you use preferredName or fullName instead of this field. Deprecated The 'lastName' field is deprecated. Use 'familyName' instead. - Marked as deprecated on 2020-09-23. - Scheduled for removal on or after 2023-06-05.
`lastUpdatedAt(DateTime!)`	The datetime that the AccountUser was last updated.
`liveSecretKey(String)`	The user's secret key to access the Developer API.
`masqueradeToken(String)`	Retrieve Masquerade token used for temporary user login to client sites. The token expires after a pre-configured amount of time. This field requires the `Authorization` header to be set.
`mobile(String!)`
`number(String)`	A code that uniquely identifies the account user.
`paymentMethods(PaymentInstructionConnectionTypeConnection)`	List payment instructions linked to this user. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `statuses` (`[PaymentInstructionStatus]`) Optionally filter the payment instructions by status. `validAt` (`DateTime`) Optionally return only payment instructions valid at the given datetime.
`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. Please use 'portfolioIds' instead. - Marked as deprecated on 2022-08-04. - Scheduled for removal on or after 2024-01-01.
`portfolioIds([ID])`	List of portfolio ids that the user is linked to via their portfolio roles. Arguments `allowedBrandCodes` (`[BrandChoices]`) Optionally filter the user's portfolios to only return those linked to specified brands. `restrictToPublicFacingBrands` (`Boolean`) 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. Arguments `accountNumber` (`String`) Return the user portfolio roles for this account's portfolio. `portfolioNumber` (`String`) Optionally filter the portfolio's user roles to only return those linked to a specific portfolio.
`portfolios(PortfolioConnectionTypeConnection)`	List of portfolios that the user is linked to via their portfolio roles. Arguments `after` (`String`) `allowedBrandCodes` (`[BrandChoices]`) Optionally filter the user's portfolios to only return those linked to specified brands. `before` (`String`) `first` (`Int`) `last` (`Int`) `restrictToPublicFacingBrands` (`Boolean`) Optionally restrict the user portfolios to only return those linked to public facing brands.
`preferences(AccountUserCommsPreferences)`
`preferredName(String)`	The user's preferred name.
`primaryPlacesOfResidence([PrimaryResidenceType])`	A list containing a user's historical and present primary places of residence ordered by "fromDate" (descending).
`pronouns(String)`	The user's pronouns e.g. 'she/her', 'he/him', 'they/them'.
`specialCircumstances(SpecialCircumstancesType)`
`state(StateChoices)`	The state that the user primarily resides in.
`title(String)`
`transactions(TransactionConnectionTypeConnection)`	Fetch all transactions across all of the users accounts. Arguments `accountNumbers` (`[String]`) If provided, filters the transactions down to only the specified accounts. Any account numbers the user doesn't have access to will be ignored. `after` (`String`) `before` (`String`) `excludeImportedTransactions` (`Boolean`) Exclude imported transaction types from the result. `excludeUnissuedTransactions` (`Boolean`) Exclude transactions which have not yet been issued. `first` (`Int`) `fromDate` (`Date`) Optional date representing the beginning of the postedDate range filter. This date value is inclusive. `last` (`Int`) `offset` (`Int`) `orderBy` (`TransactionsOrderBy`) The order in which to return the transactions. `toDate` (`Date`) Optional date representing the end of the postedDate range filter. This date value is exclusive.

{
  "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,
  "bills": BillConnectionTypeConnection,
  "concessions": [ConcessionType],
  "applicableConcessionCardTypes": [ConcessionCardApplicableRegionType],
  "masqueradeToken": "abc123",
  "primaryPlacesOfResidence": [PrimaryResidenceType],
  "lastUpdatedAt": "2020-01-01T00:00:00.000Z",
  "state": "AUSTRALIAN_CAPITAL_TERRITORY",
  "transactions": TransactionConnectionTypeConnection
}

AcquisitionProblemType

Fields

Name Description

code(String!)

The code of the problem.

description(String!)

A human readable description of the problem.

{
  "code": "abc123",
  "description": "abc123"
}

ActorType

Fields

Name Description

username(String)

Username of the Actor.

{
  "username": "abc123"
}

ActualizeContractOutput

Fields

Name Description

contract(Contract)

The contract actualized.

{
  "contract": Contract
}

AddBusinessToSegmentMutation

Output type of the addBusinessToSegment mutation.

Fields

Name Description

businessSegmentPeriod(BusinessSegmentPeriodType)

The business segment period that was created.

{
  "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.

Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead.

- Marked as deprecated on 2025-01-31.
- Scheduled for removal on or after 2025-03-01.

{
  "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.

{
  "child": PropertyType
}

AddComplaintNote

Output type of the addComplaintNote mutation.

Fields

Name Description

note(ComplaintNoteType)

The note that was added to the complaint.

{
  
}

AddCustomEventMutation

Output type of the addCustomEvent mutation.

Fields

Name Description

event(CustomEventType)

Resulting Kraken event

This field requires the Authorization header to be set.

{
  "event": CustomEventType
}

AddHistoricalCallParticipantResultType

Fields

Name	Description
`callId(UUID!)`	UUID identifying the call this participant belongs to.
`reason(String)`	The reason for the given status.
`status(HistoricalCallResultStatus!)`	The processing status: success, skipped, or error.
`vendorCallLegId(String!)`	The call system's identifier for this call leg.

{
  "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.

{
  
}

AddHistoricalCallParticipantsSummaryType

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.

{
  "total": 1,
  "successful": 1,
  "failed": 1
}

AddHistoricalCallRecordingResultType

Fields

Name	Description
`callId(UUID!)`	UUID identifying the call this recording belongs to.
`reason(String)`	The reason for the given status.
`recordingId(UUID)`	UUID identifying the recording that was created. Only set when the status is success.
`sourceS3Url(String!)`	The S3 URL of the recording in the client's own S3 bucket.
`status(HistoricalCallResultStatus!)`	The processing status: success, skipped, or error.

{
  "callId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
  "recordingId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
  "sourceS3Url": "abc123",
  "status": "SUCCESS",
  "reason": "abc123"
}

AddHistoricalCallRecordings

Output type of the addHistoricalCallRecordings mutation.

Fields

Name Description

results([AddHistoricalCallRecordingResultType])

Per-recording processing results.

summary(AddHistoricalCallRecordingsSummaryType)

Summary counts of the processing results.

{
  
}

AddHistoricalCallRecordingsSummaryType

Fields

Name Description

failed(Int!)

Number of recordings that failed to process.

successful(Int!)

Number of recordings that were successfully added or skipped.

total(Int!)

Total number of recordings processed.

{
  "total": 1,
  "successful": 1,
  "failed": 1
}

AddItemsToRiskList

Output type of the addItemsToRiskList mutation.

Fields

Name Description

riskIdentifiers([RiskListItemType])

List of successfully added risk identifiers.

{
  
}

AddNoteToInkConversation

Output type of the addNoteToInkConversation mutation.

Fields

Name Description

note(InkNote)

The ink conversation note.

{
  
}

AddOnInvalidErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

AddOpportunityEvent

Output type of the addOpportunityEvent mutation.

Fields

Name Description

eventType(String)

The event type that was added.

{
  "eventType": "abc123"
}

AddParentToProperty

Output type of the addParentToProperty mutation.

Fields

Name Description

parent(PropertyType)

The parent property that was added to the child.

{
  "parent": PropertyType
}

AddPartnerUserToTeam

Output type of the addPartnerUserToTeam mutation.

Fields

Name Description

partnerUser(PartnerUserType)

The partner user that was added to the team.

{
  
}

AddPortfolioReference

Output type of the addPortfolioReference mutation.

Fields

Name Description

portfolioNumber(String)

Number of the portfolio to which the reference was added.

{
  "portfolioNumber": "abc123"
}

AddProperty

Output type of the addProperty mutation.

Fields

Name Description

property(PropertyType)

The property that was added to the account.

{
  "property": PropertyType
}

AddPropertyToHierarchy

Output type of the addPropertyToHierarchy mutation.

Fields

Name Description

property(PropertyType)

The property that was added to the hierarchy.

{
  "property": PropertyType
}

AddSignupReferralOnAccount

Output type of the addSignupReferralOnAccount mutation.

Fields

Name Description

accountReferral(ReferralType)

The created account referral instance.

{
  "accountReferral": ReferralType
}

AddStorylineToInkConversation

Output type of the addStorylineToInkConversation mutation.

Fields

Name Description

storyline(InkStoryline)

The storyline that was added to the conversation.

{
  
}

AddUserToPortfolio

Output type of the addUserToPortfolio mutation.

Fields

Name Description

roleCode(String)

The code of the role added to the user.

{
  "roleCode": "abc123"
}

AddonFamilyType

Fields

Name Description

addonRates([AddonRateType])

Rates associated with addon.

family(String)

Add on family name associated with rates.

{
  "family": "abc123",
  "addonRates": [AddonRateType]
}

AddonRateType

Fields

Name Description

addon(AddonType)

Add on details for rate.

productRate(RateInterface)

Product rate for addon.

{
  "addon": AddonType,
  "productRate": RateInterface
}

AddonType

Fields

Name	Description
`band(String)`	Product band associated with the addon.
`description(String)`	Full description of addon.
`family(String)`	Shared family name of addon.
`percentGreen(Decimal)`	The percentage of green power, if any, as a decimal number between 0 and 1.
`title(String)`	Simple name of addon.

{
  "band": "abc123",
  "title": "abc123",
  "family": "abc123",
  "description": "abc123",
  "percentGreen": "1.0"
}

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 `options`. When true, `options` is empty and the client should call that query with this field's `name`.
`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 `hasAutocomplete`); fetch those via the autocompleteAddressFieldOptions query instead. Null for all other field types.
`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.

{
  "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.

{
  "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'.

{
  "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'.

{
  "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.

{
  "required": true,
  "maxLength": 1,
  "regex": "abc123"
}

AddressOutput

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.

{
  "line1": "abc123",
  "postcode": "abc123",
  "countryCode": "abc123",
  "line2": "abc123",
  "line3": "abc123",
  "line4": "abc123",
  "line5": "abc123"
}

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.

{
  "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!)`

{
  "id": "abc123",
  "subdomain": "abc123",
  "trainingStatus": "NOT_APPLICABLE",
  "isBusiness": true,
  "contactName": "abc123",
  "contactEmail": "abc123",
  "landingUrl": "abc123"
}

AffiliateOrganisationConnectionTypeConnection

Paginator of partner organisations.

Fields

Name	Description
`edgeCount(Int!)`	Number of nodes in the edge.
`edges([AffiliateOrganisationConnectionTypeEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": AffiliateOrganisationConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

AffiliateOrganisationConnectionTypeEdge

A Relay edge containing a AffiliateOrganisationConnectionType and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(AffiliateOrganisationType)

The item at the end of the edge

{
  "cursor": "abc123"
}

AffiliateOrganisationType

Fields

Name	Description
`accessibleAccounts(AccountAccessConnectionTypeConnection)`	Accounts this partner can access, with the roles granting that access. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`) `scope` (`AccessScope`) Whether to return only directly assigned accounts (DIRECT) or all accessible accounts including inherited access (ALL, default).
`accessibleBusinesses(BusinessAccessConnectionTypeConnection)`	Businesses this partner can access, with the roles granting that access. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`)
`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.
`partnerCommissions(PartnerOrganisationCommissionConnectionTypeConnection)`	Partner commissions configured for this organisation. One-off and trailing commissions are returned together, latest valid-from first. Arguments `activeAt` (`DateTime`) Return only commissions effective at this time. When omitted, every commission for the organisation is returned. `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`partnerUserAccessors(PartnerUserAccessorAccessConnectionTypeConnection)`	Partner users that have access to this partner, with their access information. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`)
`references([OrganisationReferenceType])`	External references attached to the organisation, keyed by namespace.
`salesChannel(SalesChannelChoices)`	Sales Channel. Deprecated The 'salesChannel' field is deprecated. Please use salesChannelCode instead. - Marked as deprecated on 2025-07-17. - Scheduled for removal on or after 2025-10-17.
`salesChannelCode(String)`	Sales Channel Code.
`skipMeterPointAddressValidation(Boolean)`	Allow this partner to skip validation that ensures all meter points belong to the same address.

{
  "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!)`

{
  "id": "abc123",
  "ipAddress": "abc123",
  "userAgent": "abc123",
  "queryParams": {"key": "value"}
}

AgentAuxiliaryStatusType

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.

{
  "id": "abc123",
  "status": "abc123",
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

AgentCallCenterStatusType

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.

{
  "id": "abc123",
  "status": "abc123",
  "updatedAt": "2020-01-01T00:00:00.000Z",
  "mostRecentCallId": 1
}

AgreementConnection

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.

{
  "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

{
  "node": CommonAgreementType,
  "cursor": "abc123"
}

AgreementRescissionType

Details of an agreement rescission

Fields

Name	Description
`agreement(DistributionAgreementType!)`
`createdAt(DateTime!)`
`failureReason(String!)`
`flowReference(String)`
`id(ID!)`
`number(ID!)`	The number of the agreement rescission.
`status(AgreementRescissionStatus)`	The current status of the agreement rescission.
`updatedAt(DateTime!)`

{
  "id": "abc123",
  "number": "abc123",
  "status": "IN_PROGRESS",
  "failureReason": "abc123",
  "flowReference": "abc123",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T00:00:00.000Z",
  "agreement": DistributionAgreementType
}

AgreementRolloverType

Fields

Name	Description
`actualSendDate(Date)`
`agreement(DistributionAgreementType!)`
`createdAt(DateTime!)`
`expectedSendDate(Date!)`
`failureReason(String!)`
`id(ID!)`
`number(String!)`
`params(JSONString!)`
`quoteRequests([QuoteRequestType!]!)`
`rolledOnTo(DistributionAgreementType)`
`rolloverType(AgreementRolloverRolloverType!)`
`status(AgreementRolloverStatus!)`
`suppressComms(Boolean!)`
`tags([String])`	List of tag names associated with this agreement rollover.
`updatedAt(DateTime!)`

{
  "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": DistributionAgreementType,
  "rolledOnTo": DistributionAgreementType
}

AllocationIntentionType

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.

{
  "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.

{
  "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.

{
  "repaymentId": "abc123"
}

AlreadyLinkedError

Fields

Name Description

type(LineLinkErrorType!)

The type of error that occurred.

{
  "type": "NO_MATCHING_LINE_LINK"
}

AlternativeNumberDoesNotExistErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

AlternativeNumberValidationErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

AmendContractSubjectOutput

Fields

Name Description

contract(Contract)

The contract after the subject amendments have been applied.

{
  "contract": Contract
}

AmendPayment

Output type of the amendPayment mutation.

Fields

Name Description

payment(AccountPaymentType)

The amended payment with updated amount and date.

{
  "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.

{
  "width": FractionSizeType,
  "mediaUrl": "abc123",
  "horizontalAlignment": "START",
  "accessibilityHidden": true,
  "accessibilityLabel": "abc123",
  "id": "abc123",
  "typename": "abc123"
}

AnnualStatementConnectionTypeConnection

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.

{
  "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

{
  "node": AnnualStatementType,
  "cursor": "abc123"
}

AnnualStatementType

Annual statements that are sent to the account. They summarize important information about usage and tariffs.

Fields

Name	Description
`id(ID)`
`pdfUrl(String)`
`periodEndsAt(DateTime!)`
`periodStartsAt(DateTime!)`

{
  "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.

{
  "id": 1,
  "uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
  "annulledBillingDocumentId": 1,
  "firstIssued": "2020-01-01T00:00:00.000Z",
  "pdfUrl": "abc123"
}

AppSessionConnectionTypeConnection

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.

{
  "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

{
  "cursor": "abc123"
}

AppSessionType

Fields

Name	Description
`account(AccountType)`
`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(AppSessionTypeChoices)`
`updatedAt(DateTime!)`

{
  "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",
  "type": "SALE",
  "account": AccountType
}

ApplicableRateConnection

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.

{
  "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

{
  "cursor": "abc123"
}

ApplicableRateType

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.
`params(JSONString)`	Raw parameters associated with the rate, e.g. step information for stepped rates.
`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.

{
  "sourceSystem": "abc123",
  "name": "abc123",
  "pricePerUnit": "1.0",
  "unit": "abc123",
  "unitDisplay": "abc123",
  "variantProfile": VariantProfile,
  "rateId": 1,
  "params": {"key": "value"},
  "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.

{
  "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.

{
  "repayment": AccountRepaymentType
}

AsOfDateInvalidErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

AssessCollectionProcessRecordForPause

Output type of the assessCollectionProcessRecordForPause mutation.

Fields

Name Description

collectionProcessProcessed(AssessCollectionProcessRecordForPauseOutputType)

Details of collection process after running the pause assessment.

{
  
}

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.

{
  "number": "abc123",
  "isPaused": true
}

AssessCollectionProcessRecordForWithdrawal

Output type of the assessCollectionProcessRecordForWithdrawal mutation.

Fields

Name Description

collectionProcessProcessed(AssessCollectionProcessRecordForWithdrawalOutputType)

Details of collection process after running the withdrawal assessment.

{
  
}

AssessCollectionProcessRecordForWithdrawalOutputType

Output for assessing a Collection process for withdrawal.

Fields

Name Description

isWithdrawn(Boolean)

Whether the collection process is withdrawn after the assessment. Already withdrawn processes are reported as withdrawn without being reassessed.

number(String)

The number of the collection process record.

{
  "number": "abc123",
  "isWithdrawn": 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.

{
  "conversation": InkConversation
}

AssignSupplyPointToEstimationGroup

Output type of the assignSupplyPointToEstimationGroup mutation.

Fields

Name Description

supplyPointEstimationGroup(AssignedSupplyPointEstimationGroupType)

The created supply point estimation group mapping.

{
  
}

AssignedSupplyPointEstimationGroupType

Fields

Name Description

estimationGroupCode(String!)

The code of the estimation group.

supplyPointExternalId(String!)

The external identifier of the assigned supply point.

{
  "estimationGroupCode": "abc123",
  "supplyPointExternalId": "abc123"
}

AssignedTeam

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.

{
  "identifier": "abc123",
  "name": "abc123",
  "teamType": "PARTNER_TEAM"
}

AssignedUser

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.

{
  "identifier": "abc123",
  "name": "abc123",
  "email": "abc123",
  "userType": "SUPPORT_USER"
}

AssignedUserType

Fields

Name Description

id(ID!)

The ID of the assigned user.

username(String!)

The username of the assigned user.

{
  "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.

{
  "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.

{
  
}

AssociateArchivedRecordingResultType

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.

{
  "vendorCallLegId": "abc123",
  "recordingId": 1,
  "status": "SUCCESS",
  "reason": "abc123"
}

AssociateArchivedRecordingsSummaryType

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.

{
  "total": 1,
  "successful": 1,
  "failed": 1
}

AssociateCallWithAccount

Output type of the associateCallWithAccount mutation.

Fields

Name Description

call(InboundCallType)

The call.

{
  
}

AssociateItemToCollectionProcess

Output type of the associateItemToCollectionProcess mutation.

Fields

Name Description

collectionProcessAssociatedItem(AssociateItemToCollectionProcessOutputType)

Item associated to the collection process.

{
  
}

AssociateItemToCollectionProcessOutputType

Fields

Name Description

itemId(ID)

Associated item identifier.

number(String)

The number of the collection process record.

{
  "number": "abc123",
  "itemId": "abc123"
}

AttachAgreementsToContractsOutput

Fields

Name Description

ok(Boolean!)

True if the agreements were successfully attached.

{
  "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).

{
  "id": "abc123",
  "filename": "abc123",
  "temporaryUrl": "abc123"
}

AudioRecordingType

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!)`

{
  "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"
}

AuthorizedApplication

Fields

Name Description

clientId(String)

The client ID of the application.

name(String)

The name of the application.

{
  "name": "abc123",
  "clientId": "abc123"
}

AutomaticCollectionType

Payments are collected automatically using a payment method.

Fields

Name Description

paymentMethod(PaymentMethodSummaryType!)

The payment method used to collect payments.

{
  "paymentMethod": PaymentMethodSummaryType
}

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.

{
  "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

{
  "node": AuxiliaryResultInterface,
  "cursor": "abc123"
}

AuxiliaryResultPeriodType

The period an auxiliary result covers.

Fields

Name Description

end(DateTime!)

The period end.

start(DateTime!)

The period start.

{
  "start": "2020-01-01T00:00:00.000Z",
  "end": "2020-01-01T00:00:00.000Z"
}

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.

{
  "pointsAwarded": 1,
  "ledgerEntry": LoyaltyPointLedgerEntryType
}

BackendScreenEvent

Output type of the backendScreenEvent mutation.

Fields

Name Description

action(ActionType)

An action to perform.

{
  "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.

{
  "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.

Fields

Name Description

key(String!)

value(String!)

{
  "key": "abc123",
  "value": "abc123"
}

BalanceTriggeredScheduleType

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.

{
  "balanceThreshold": 1,
  "targetBalance": 1
}

BankDetailsValidationResult

Fields

Name Description

areValid(Boolean!)

Indicates whether the provided bank details are valid.

message(String)

Provides additional information about validation result.

{
  "areValid": true,
  "message": "abc123"
}

BaseUsageAndCostType

Fields

Name	Description
`concessionDiscount(Int!)`	Estimated concession (GST excluded).
`exportEarning(Int)`	Estimated export cost in cents (GST excluded).
`exportEnergy(Float)`	Estimated export amount.
`totalCost(Int!)`	Estimated total cost in cents (GST excluded).
`usageCost(Int!)`	Estimated cost in cents (GST excluded).
`usageEnergy(Float!)`	Estimated usage amount.

{
  "usageEnergy": 1.0,
  "usageCost": 1,
  "exportEnergy": 1.0,
  "exportEarning": 1,
  "concessionDiscount": 1,
  "totalCost": 1
}

BespokeRateConfigurationType

The BespokeRateConfiguration term.

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.
`schedules([BespokeRateScheduleType])`	The schedules for the bespoke rate configuration.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "schedules": [BespokeRateScheduleType]
}

BespokeRateItemType

Item for the BespokeRateConfiguration term.

Fields

Name	Description
`pricePerUnit(Decimal)`	The price per unit for the bespoke rate item.
`rateSpecificationCode(String)`	The rate specification code for the bespoke rate item.
`rateSpecificationType(BespokeRateItemTypeEnum)`	The rate specification type for the bespoke rate item.
`variantProfile(VariantProfile)`	The variant profile for the bespoke rate item.

{
  "pricePerUnit": "1.0",
  "rateSpecificationCode": "abc123",
  "rateSpecificationType": "PRODUCT_RATE",
  "variantProfile": VariantProfile
}

BespokeRateScheduleType

Schedule for the BespokeRateConfiguration term.

Fields

Name	Description
`items([BespokeRateItemType])`	The items for the bespoke rate schedule.
`productCode(String)`	The product code for the bespoke rate schedule.
`supplyPointIdentifier(String)`	The external identifier of the supply point this schedule targets.
`validFrom(DateTime)`	The datetime the schedule of bespoke rates is valid from.
`validTo(DateTime)`	The datetime the schedule of bespoke rates is valid to.

{
  "items": [BespokeRateItemType],
  "productCode": "abc123",
  "validFrom": "2020-01-01T00:00:00.000Z",
  "validTo": "2020-01-01T00:00:00.000Z",
  "supplyPointIdentifier": "abc123"
}

BestOfferForAgreement

This represents the Best Offer Details for an Agreement.

Fields

Name	Description
`allProductsChecked([BestOfferProductEstimate])`	All products checked for the agreement.
`bestOfferDifference(Int)`	The cost difference between the current product and best offer.
`bestOfferProduct(Product)`	The best offer product for the agreement.
`estimatedBestOfferProductCost(Int)`	The estimated best offer product cost.
`estimatedCurrentProductCost(Int)`	The estimated cost for the current product.
`id(ID)`	The identifier of the stored calculation, as taken by the Best Offer data query and the verification mutation. Null when the calculation was not stored.
`includesSolarExport(Boolean)`	Whether or not solar export is included.
`usage(BestOfferReportUsage)`	The best offer report usage.

{
  "id": "abc123",
  "estimatedCurrentProductCost": 1,
  "allProductsChecked": [BestOfferProductEstimate],
  "usage": BestOfferReportUsage,
  "bestOfferProduct": Product,
  "estimatedBestOfferProductCost": 1,
  "bestOfferDifference": 1,
  "includesSolarExport": true
}

BestOfferProductEstimate

Fields

Name Description

characteristics(GenericScalar)

The product characteristics this estimate's price was resolved from. This will be NULL for non product catalog products.

estimatedCost(Int)

The estimated cost for the best offer product.

product(Product)

The product for the best offer product estimate.

{
  "product": Product,
  "estimatedCost": 1,
  "characteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}

BestOfferReportUsage

Fields

Name	Description
`controlledLoadUsage(Decimal)`	The controlled load for the best offer report usage.
`endAt(DateTime)`	The end at date time for the best offer report usage.
`offPeakUsage(Decimal)`	The off peak for the best offer report usage.
`peakUsage(Decimal)`	The peak for the best offer report usage.
`shoulderUsage(Decimal)`	The shoulder for the best offer report usage.
`startAt(DateTime)`	The start at date time for the best offer report usage.
`totalUsage(Decimal)`	The total for the best offer report usage.

{
  "startAt": "2020-01-01T00:00:00.000Z",
  "endAt": "2020-01-01T00:00:00.000Z",
  "totalUsage": "1.0",
  "peakUsage": "1.0",
  "offPeakUsage": "1.0",
  "shoulderUsage": "1.0",
  "controlledLoadUsage": "1.0"
}

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.

{
  "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.

{
  "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

{
  "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.

{
  "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
}

BillDueDateType

Represents bill due dates to be applied 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.
`numberOfDays(Int)`	The number of days to pay a bill from issue date, after which the debt becomes delinquent.
`type(NonEmptyString)`	The type of the term.
`typeOfDays(DayType)`	The type of day to consider (WORKING or CALENDAR).

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "numberOfDays": 1,
  "typeOfDays": "WORKING"
}

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.

{
  "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.

{
  "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.

{
  "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

{
  "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 `data` field. This is populated when the schema type is 'STRICT', and empty when the schema type is 'NONE'.
`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.

{
  "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 `TemporaryURL` type represents a temporary URL at which the file is available. It is intended for redirection purposes, NOT persistence in any form. (e.g. inclusion in emails or the body of a web page).
`temporaryUrlExpiresAt(DateTime)`	The expiry datetime field of the temporary URL.
`version(Int)`	The version of the representation.

{
  "code": "abc123",
  "version": 1,
  "temporaryUrl": "abc123",
  "temporaryUrlExpiresAt": "2020-01-01T00:00:00.000Z",
  "filename": "abc123",
  "context": BillRepresentationContextType
}

BillTransactionConnectionTypeConnection

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.

{
  "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

{
  "node": BillTransactionType,
  "cursor": "abc123"
}

BillTriggeredBalanceTargetScheduleType

Fields

Name Description

targetBalance(Int)

The target balance (in minor currency unit) for the ledger.

{
  "targetBalance": 1
}

BillTriggeredScheduleType

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.

{
  "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.

{
  "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

{
  "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 TemporaryURL type represents a temporary URL at which the file is available. It is intended for redirection purposes, NOT persistence in any form. (e.g. inclusion in emails or the body of a web page).

temporaryUrlExpiresAt(DateTime)

The expiry datetime field of the temporary URL.

{
  "temporaryUrl": "abc123",
  "temporaryUrlExpiresAt": "2020-01-01T00:00:00.000Z",
  "filename": "abc123"
}

BillingDocumentIssuanceFrequencyType

Represents billing document issuance frequency to be applied during a contract.

Fields

Name	Description
`description(NonEmptyString)`	The description of the term.
`displayName(NonEmptyString)`	The display name of the term.
`frequency(String)`	Billing frequency.
`identifier(NonEmptyString)`	The identifier of the term.
`isVariable(Boolean)`	Whether the term can be amended after creation.
`multiplier(Int)`	Multiplier applied to the frequency.
`periodStartDay(Int)`	Start day of the billing period.
`periodStartMonth(Int)`	Start month of the billing period.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "frequency": "abc123",
  "periodStartDay": 1,
  "periodStartMonth": 1,
  "multiplier": 1
}

BillingDocumentPositionType

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).

{
  "dueDate": "2020-01-01",
  "expectedAmount": 1,
  "remainingAmount": 1,
  "allocationIntentions": AllocationIntentionType,
  "allocations": AllocationType
}

BillingFrequencyNotValidType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

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).

{
  "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).

{
  "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.

{
  "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.

{
  "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.

{
  "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

{
  "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.

{
  "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).

{
  "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.

{
  "repaymentId": "abc123"
}

BothHouseAndLotNumberErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

BulkAwardLoyaltyPoints

Output type of the bulkAwardLoyaltyPoints mutation.

Fields

Name Description

failed([BulkAwardLoyaltyPointsFailedItemResult])

Failed loyalty point awards.

inserted([BulkAwardLoyaltyPointsInsertedItemResult])

Successfully inserted loyalty point awards.

{
  "inserted": [BulkAwardLoyaltyPointsInsertedItemResult],
  "failed": [BulkAwardLoyaltyPointsFailedItemResult]
}

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.

{
  "accountNumber": "abc123",
  "idempotencyKey": "500c164d-38c7-4f74-9ac6-be210197e9e4",
  "errorCode": "abc123",
  "errorMessage": "abc123"
}

BulkAwardLoyaltyPointsInsertedItemResult

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.

{
  "accountNumber": "abc123",
  "pointsAwarded": 1,
  "ledgerEntry": LoyaltyPointLedgerEntryType
}

BusinessAccessConnectionTypeConnection

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.

{
  "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

{
  "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.

{
  "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.

{
  "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

{
  "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).
`companyCountry(String)`	The country of the business billing address or lead's legal address, if known.
`companyName(String!)`	The registered or trading name of the business.
`companyPostcode(String)`	The postcode of the business billing address or lead's legal address, if known.
`companyRegistrationNumber(String)`	The company registration number, if the business has one.
`industryClassificationCodes([String!]!)`	The industry classification codes of the business (e.g. SIC codes in the UK). Empty if none are known.

{
  "businessType": "abc123",
  "companyName": "abc123",
  "companyRegistrationNumber": "abc123",
  "companyPostcode": "abc123",
  "companyCountry": "abc123",
  "industryClassificationCodes": "abc123"
}

BusinessDetailType

Fields

Name Description

key(String!)

The key of the business detail.

value(String)

The value of the business detail.

{
  "key": "abc123",
  "value": "abc123"
}

BusinessRole

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.

{
  "code": "abc123",
  "name": "abc123",
  "description": "abc123",
  "permissionCodes": "abc123"
}

BusinessSegmentPeriodType

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.

{
  "id": "abc123",
  "segment": SegmentType,
  "startAt": "2020-01-01T00:00:00.000Z",
  "endAt": "2020-01-01T00:00:00.000Z"
}

BusinessType

Fields

Name	Description
`accountUserAccessors(AccountUserAccessorAccessConnectionTypeConnection)`	Account users that have access to this business, with their access information. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`) `roleCodes` (`[String!]`) Filter accessors by role codes.
`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: KT-CT-11102: Business without related account. KT-CT-1113: Disabled GraphQL field requested. Deprecated The 'linkedAccountNumber' field is deprecated. Please use 'linkedAccountNumbers' instead, businesses can be related to multiple Accounts now. - Marked as deprecated on 2025-02-05. - Scheduled for removal on or after 2025-08-01.
`linkedAccountNumbers([ID]!)`	Account numbers linked to this business.
`name(String!)`	The business' name.
`number(String!)`	The business' number.
`numberType(BusinessNumberTypeEnum)`	Which kind of business type the `number` field refers to. Returns MISSING if the `number` field is empty, and UNKNOWN if the value cannot be parsed as either ABN or ACN.
`partnerAccessors(PartnerAccessorAccessConnectionTypeConnection)`	Partners that have access to this business, with their access information. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`) `roleCodes` (`[String!]`) Filter accessors by role codes.
`paymentMethods(PaymentInstructionConnectionTypeConnection)`	List payment instructions owned by this business. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `statuses` (`[PaymentInstructionStatus]`) Optionally filter the payment instructions by status. `validAt` (`DateTime`) Optionally return only payment instructions valid at the given datetime.
`sectors([BusinessSectorString!]!)`	The sectors the business operates in.
`segmentName(String)`	The segment this business is assigned to.

{
  "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,
  "numberType": "ABN"
}

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.

{
  "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

{
  "cursor": "abc123"
}

CallMetadataItemType

Fields

Name Description

key(String!)

The key of the call metadata item.

value(String!)

The value of the call metadata item.

{
  "key": "abc123",
  "value": "abc123"
}

CallRecordingDetailEventType

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.

{
  "data": {"key": "value"},
  "eventType": "abc123",
  "relativeOccurredAt": 1,
  "occurredAt": "2020-01-01T00:00:00.000Z"
}

CallRecordingDetailType

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.

{
  "callId": "abc123",
  "callDirection": "abc123",
  "primaryAgentEmail": "abc123",
  "toPhoneNumber": "abc123",
  "fromPhoneNumber": "abc123",
  "startTime": "2020-01-01T00:00:00.000Z",
  "endTime": "2020-01-01T00:00:00.000Z"
}

CallRecordingDownloadType

Fields

Name Description

expiresAt(DateTime)

The time at which the presigned url stops working.

url(String)

Presigned S3 URL for the recording file. Valid for one hour from the time the response is generated.

{
  "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.

{
  "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

{
  "cursor": "abc123"
}

CallTagType

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.

{
  "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.

{
  "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

{
  "cursor": "abc123"
}

CallTranscriptDownloadType

Fields

Name Description

expiresAt(DateTime!)

The time at which the presigned url stops working.

type(CallTranscriptionType!)

Whether url points to the REDACTED or UNREDACTED transcript file. REDACTED is preferred and returned whenever a redacted file exists. UNREDACTED is only returned to callers that hold an additional permission for unredacted access.

url(String!)

Presigned S3 URL for the transcript file. Valid for one hour from the time the response is generated.

{
  "url": "abc123",
  "type": "REDACTED",
  "expiresAt": "2020-01-01T00:00:00.000Z"
}

CallTranscriptType

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 `download` is available.
`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.

{
  "id": "abc123",
  "status": "CREATED",
  "vendor": "abc123",
  "transcribedAt": "2020-01-01T00:00:00.000Z",
  "createdAt": "2020-01-01T00:00:00.000Z"
}

CanNotCreateAgreementErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

CancelCentrepayDeduction

Output type of the cancelCentrepayDeduction mutation.

Fields

Name Description

centrepayDeduction(CentrepayDeductionType!)

Details of Centrepay Deduction to be cancelled.

{
  "centrepayDeduction": CentrepayDeductionType
}

CancelHouseMoveIn

Output type of the cancelHouseMoveIn mutation.

Fields

Name Description

account(AccountType)

error(CancelHouseMoveInErrorUnion)

{
  "account": AccountType,
  "error": DoesNotExistErrorType
}

CancelHouseMoveOut

Output type of the cancelHouseMoveOut mutation.

Fields

Name Description

account(AccountType)

error(CancelHouseMoveErrorUnion)

{
  "account": AccountType,
  "error": DoesNotExistErrorType
}

CancelOnSiteJobsAppointment

Output type of the cancelOnSiteJobsAppointment mutation.

Fields

Name Description

onSiteJobsAppointment(OnSiteJobsAppointmentType)

The Appointment that was cancelled.

{
  
}

CancelOnSiteJobsRequest

Output type of the cancelOnSiteJobsRequest mutation.

Fields

Name Description

onSiteJobsRequest(OnSiteJobsRequestType)

The cancelled request.

{
  
}

CancelPayment

Output type of the cancelPayment mutation.

Fields

Name Description

payment(AccountPaymentType)

The cancelled payment.

{
  "payment": AccountPaymentType
}

CancelRepaymentRequest

Output type of the cancelRepaymentRequest mutation.

Fields

Name Description

repaymentRequest(CancelRepaymentRequestOutputType)

The cancelled repayment/refund request.

{
  "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.

{
  "requestId": "abc123",
  "status": "REQUESTED"
}

CannotProductSwitchOnUnrelatedAccountError

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

CannotProductSwitchWithoutLoyaltyCardError

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

CannotRescheduleForFixedPaymentCustomerErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

CannotRescheduleForReRepresentedPaymentsErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

CannotRescheduleWithMissingAccountStatementErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

CannotRescheduleWithMoreThenOneRescheduledPaymentErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

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.

{
  "accessibilityHidden": true,
  "accessibilityLabel": "abc123",
  "id": "abc123",
  "typename": "abc123",
  "items": TextType
}

CarouselItemType

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.

{
  "id": "abc123",
  "typename": "abc123",
  "cards": CardComponentType
}

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(CatalogProductTypeEnum)`	The type of product.
`specificationIdentifier(ID)`	Identifier of the product specification associated with this product.
`tags([TagType])`	Tags associated with this product for classification.

{
  "identifier": "abc123",
  "internalName": "abc123",
  "customerName": "abc123",
  "customerDescription": "abc123",
  "code": "abc123",
  "marketName": "abc123",
  "sourceProductType": "SUPPLY",
  "specificationIdentifier": "abc123"
}

CentrepayDeductionType

Fields

Name	Description
`accountNumber(String!)`	Kraken account number that the Deduction is associated with.
`amount(Int!)`	Deduction payment amount (in cents).
`benefitGroup(CentrepayBenefitGroupEnum!)`	3-letter code indicating the type of social security payment.
`changeStatus(CentrepayChangeStatusEnum)`	Status for if this Deduction has a pending create, change or cancel request.
`customerDateOfBirth(String)`	Date of birth of customer that the Deduction is associated with.
`customerFamilyName(String)`	Family name of customer that the Deduction is associated with.
`customerGivenName(String)`	Given name of customer that the Deduction is associated with.
`customerReferenceNumber(String!)`	Customer Centrelink CRN.
`id(ID)`	ID of Centrepay Deduction (empty for pending Create requests).
`serviceReason(CentrepayServiceReasonEnum!)`	3-letter code indicating the product or service the Deduction is for.
`targetAmount(Int)`	An optional target total payment amount after which Centrelink will end the deduction (in cents).
`validFrom(Date!)`	Date this Deduction Instruction is valid from.
`validTo(Date)`	Date this Deduction Instruction is valid to.

{
  "accountNumber": "abc123",
  "benefitGroup": "ABY",
  "serviceReason": "ELE",
  "customerReferenceNumber": "abc123",
  "amount": 1,
  "targetAmount": 1,
  "validTo": "2020-01-01",
  "id": "abc123",
  "validFrom": "2020-01-01",
  "customerGivenName": "abc123",
  "customerFamilyName": "abc123",
  "customerDateOfBirth": "abc123",
  "changeStatus": "CREATING"
}

ChangeCentrepayDeduction

Output type of the changeCentrepayDeduction mutation.

Fields

Name Description

centrepayDeduction(CentrepayDeductionType!)

Details of Centrepay Deduction to be changed.

{
  "centrepayDeduction": CentrepayDeductionType
}

ChangeContractGroupComposition

Output type of the changeContractGroupComposition mutation.

Fields

Name Description

contractGroupIdentifier(UUID!)

The identifier of the contract group whose composition was changed.

{
  "contractGroupIdentifier": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

ChangeRequestType

Fields

Name	Description
`actualChangeDate(Date)`
`actualEndDate(Date)`
`changeReason(String!)`
`direction(DirectionChoices)`
`id(ID!)`
`identifier(String!)`
`meterPoint(MeterPointType)`
`proposedDate(Date)`
`status(ChangeRequestStatus!)`

{
  "id": "abc123",
  "identifier": "abc123",
  "status": "INITIATED",
  "changeReason": "abc123",
  "proposedDate": "2020-01-01",
  "actualChangeDate": "2020-01-01",
  "actualEndDate": "2020-01-01",
  "meterPoint": MeterPointType,
  "direction": "INBOUND"
}

CharacteristicOverrideConfigurationType

Represents a characteristic override configuration term in a contract.

Note: This type is a stub, and will be fleshed out in the future.

Fields

Name	Description
`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.
`overrides([CharacteristicOverrideType!]!)`	List of characteristic overrides.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "overrides": CharacteristicOverrideType
}

CharacteristicOverrideType

An override for a specific characteristic.

Fields

Name Description

characteristic(CharacteristicType)

The characteristic being overridden.

overrideValue(CharacteristicValueInterface)

The value to override the characteristic with.

productCode(String)

Optional product code. If specified, the override applies only to this product.

{
  "characteristic": CharacteristicType,
  "overrideValue": CharacteristicValueInterface,
  "productCode": "abc123"
}

CharacteristicType

A characteristic associated with a product.

Fields

Name	Description
`code(String!)`	The code of the characteristic.
`description(String!)`	The description of the characteristic.
`name(String!)`	The name of the characteristic.
`values([CharacteristicValueUnion]!)`	The possible values for the characteristic (can be strings or integers).

{
  "code": "abc123",
  "name": "abc123",
  "description": "abc123",
  "values": StringCharacteristicValueType
}

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` field for a breakdown of this information.
`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.
`basedOnEstimatedReadings(EstimatedReadingsStatus)`	Represents the basis used for calculating the charge, indicating whether it relies on estimated readings, actual readings, otherwise either Kraken doesn't support it yet, or falls into not applicable category.
`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.
`breakdownItems([ChargeBreakdownItemType])`	Components of the charge, itemised by rate.
`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. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`isAccountPayment(Boolean)`	Deprecated. Deprecated The 'isAccountPayment' field is deprecated. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`isBasedOnEstimatedReadings(Boolean)`	Whether the charge is based on one or more estimated readings. Deprecated The 'isBasedOnEstimatedReadings' field is deprecated. There are non-energy charges e.g. card payment fees, that are irrelevant to estimated readings. Use `basedOnEstimatedReadings` instead. - Marked as deprecated on 2023-06-14. - Scheduled for removal on or after 2024-06-14.
`isCredit(Boolean)`	Deprecated. Deprecated The 'isCredit' field is deprecated. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`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!)`
`lineItems([LineItemType])`	The line items that make up the charge.
`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. Use `billingDocumentIdentifier` instead. - Marked as deprecated on 2023-11-30. - Scheduled for removal on or after 2024-06-01.
`title(String)`	Human-readable title describing the transaction.

{
  "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,
  "isBasedOnEstimatedReadings": true,
  "basedOnEstimatedReadings": "BASED_ON_ESTIMATED_READINGS",
  "breakdownItems": [ChargeBreakdownItemType],
  "lineItems": [LineItemType]
}

ChargeBreakdownItemType

A component of a charge representing consumption for a single rate/tariff.

Fields

Name	Description
`consumptionIsEstimated(Boolean)`	Whether the item is based on estimated readings.
`grossAmount(Decimal)`	The amount charged for this item in cents (incl GST).
`netAmount(Decimal)`	The amount charged for this item in cents (excl GST).
`numberOfUnits(Decimal)`	The number of units consumed.
`periodEndAt(DateTime)`	When the consumption ends.
`periodStartAt(DateTime)`	When the consumption starts.
`rate(RateInterface)`	The associated rate for the item.
`salesTaxAmount(Decimal)`	The GST component of this item.
`supplyPointIdentifier(String)`	Identifier for the supply point, e.g. the NMI for electricity or MIRN for gas.

{
  "rate": RateInterface,
  "periodStartAt": "2020-01-01T00:00:00.000Z",
  "periodEndAt": "2020-01-01T00:00:00.000Z",
  "numberOfUnits": "1.0",
  "grossAmount": "1.0",
  "netAmount": "1.0",
  "salesTaxAmount": "1.0",
  "supplyPointIdentifier": "abc123",
  "consumptionIsEstimated": true
}

ChargeReasonType

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.

{
  "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.

{
  "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

{
  "node": ChargesBreakdownType,
  "cursor": "abc123"
}

ChargesBreakdownType

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).

{
  "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.

{
  "name": "abc123",
  "status": "PASSED",
  "context": "abc123"
}

ChromaTransactionType

Object representing a Chroma transaction.

Fields

Name	Description
`createdAt(DateTime)`	Datetime that the message was created at.
`id(ID!)`	The Kraken ID of the message.
`initiatingTransactionId(ID)`	The industry ID of the transaction that this message was in response to (if applicable).
`messageId(ID)`	The industry ID of the message.
`messageRevision(String)`	The version of the message specification.
`priority(String)`	Priority of the message.
`transactionId(ID)`	The industry ID of the transaction.
`transactionType(String)`	The type of transaction.
`xmlFile(String)`	Path to the raw XML file.

{
  "id": "abc123",
  "messageId": "abc123",
  "transactionId": "abc123",
  "initiatingTransactionId": "abc123",
  "transactionType": "abc123",
  "messageRevision": "abc123",
  "xmlFile": "abc123",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "priority": "abc123"
}

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.

{
  "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.

{
  
}

CloseInkConversation

Output type of the closeInkConversation mutation.

Fields

Name Description

conversation(InkConversation)

The conversation that was closed.

{
  "conversation": InkConversation
}

CloseInkLiveChatConversation

Output type of the closeInkLiveChat mutation.

Fields

Name Description

liveChatConversation(InkLiveChatConversation)

The live chat conversation.

{
  "liveChatConversation": InkLiveChatConversation
}

CloseOpenMeterFaults

Output type of the closeOpenMeterFaults mutation.

Fields

Name Description

closedMeterFaultIds([ID]!)

IDs of the meter faults resolved by this request.

{
  "closedMeterFaultIds": "abc123"
}

CloseOpenPrintBatch

Output type of the closeOpenPrintBatch mutation.

Fields

Name Description

printBatch(PrintBatchType)

{
  
}

CollateralRequiredType

Represents required collaterals to be applied in a contract.

Fields

Name	Description
`amount(Int!)`	Amount set up as collateral as condition for account creation.
`collateralType(SettableCollateralType)`	The kind of collateral that satisfies the requirement. A requirement naming no kind records what is required and has nothing set up for it.
`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.
`reason(CollateralRequiredReason!)`	Reason for setting up required collateral.
`reasonDescription(String)`	The reason spelled out, when the reason is OTHER.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "amount": 1,
  "reason": "INSUFFICIENT_CREDIT_HISTORY",
  "reasonDescription": "abc123",
  "collateralType": "SECURITY_DEPOSIT"
}

CollectDeposit

Output type of the collectDeposit mutation.

Fields

Name Description

payment(CollectDepositOutput)

The result of the deposit collection attempt.

{
  
}

CollectDepositOutput

Fields

Name Description

paymentDate(Date)

The payment date for the deposit collection attempt.

status(CollectDepositStatusChoices)

The status of the deposit collection attempt.

{
  "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.

{
  "payment": AccountPaymentType
}

Collection

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.

{
  "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.

{
  "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.

{
  "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.

{
  "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.

{
  "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.

{
  "stepIdentifier": "abc123",
  "status": "COMPLETED"
}

CollectiveBillType

Fields

Name	Description
`attachments(BillingAttachmentConnectionTypeConnection)`	Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`billType(BillTypeEnum)`	The type of the bill.
`constituents(ConstituentConnection)`	Constituents of the bill. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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. This field is deprecated. Use the 'attachments' field instead. - Marked as deprecated on 2024-09-16. - Scheduled for removal on or after 2025-09-01.
`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.

{
  "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"
}

CombinedRateLimitInformation

Fields

Name Description

fieldSpecificRateLimits(FieldSpecificRateLimitInformationConnectionTypeConnection!)

Information about the current state of the rate limiting for rate limited fields at the time of the request.

Arguments

after (String)

before (String)

fields ([String])

A list of fields to return rate-limiting information for. If not provided, all fields with rate limits will be included.

first (Int)

last (Int)

pointsAllowanceRateLimit(PointsAllowanceRateLimitInformation)

Information about points-allowance rate limit for viewer.

{
  "pointsAllowanceRateLimit": PointsAllowanceRateLimitInformation,
  "fieldSpecificRateLimits": FieldSpecificRateLimitInformationConnectionTypeConnection
}

CommenceDCAProceeding

Output type of the commenceDcaProceeding mutation.

Fields

Name Description

dcaProceedingCommencementStatus(DCAProceedingCommencementStatus)

Whether the commencement could be applied.

{
  
}

CommonAgreementType

Fields

Name	Description
`account(AccountType!)`	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 `at` (`DateTime`) 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)`

{
  "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": AccountType,
  "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"}
}

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.

{
  "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

{
  "node": ComplaintContactType,
  "cursor": "abc123"
}

ComplaintContactType

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.

{
  "name": "abc123",
  "actionTaken": "abc123",
  "status": "abc123",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "mobile": "abc123",
  "email": "abc123",
  "landline": "abc123",
  "preferredCommunicationMethod": "abc123",
  "summary": "abc123"
}

ComplaintNoteType

A note on a complaint.

Fields

Name Description

content(String!)

The content of the note.

id(ID!)

The ID of the note.

{
  "id": "abc123",
  "content": "abc123"
}

ComplaintType

Fields

Name	Description
`assigneeId(ID)`	Complaint Assignee.
`contacts(ComplaintContactConnectionTypeConnection)`	Complaint contacts. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`creationDate(Date)`	Complaint creation date.
`id(ID!)`	The internal ID of the complaint. Prefer using the UUID when possible.
`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.
`uuid(UUID!)`	The UUID of the complaint.

{
  "id": "abc123",
  "uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
  "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.

{
  
}

CompleteReminder

Output type of the completeReminder mutation.

Fields

Name Description

reminderId(Int)

ID of the completed reminder.

{
  "reminderId": 1
}

CompleteStandalonePayment

Output type of the completeStandalonePayment mutation.

Fields

Name Description

payment(CompleteStandalonePaymentOutput)

The completed standalone payment.

{
  "payment": CompleteStandalonePaymentOutput
}

CompleteStandalonePaymentOutput

Result of the complete standalone payment operation.

Fields

Name Description

status(PaymentIntentCompletionStatus!)

The status of the standalone payment.

{
  "status": "CLEARED"
}

CompletedApproval

Fields

Name Description

approvalUuid(UUID!)

The UUID of the completed approval.

{
  "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. Access `items` via `screenData` instead. - Marked as deprecated on 2024-07-02. - Scheduled for removal on or after 2024-08-01.
`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.

{
  "accessibilityHidden": true,
  "accessibilityLabel": "abc123",
  "id": "abc123",
  "typename": "abc123",
  "name": "abc123",
  "refreshFrequency": 1,
  "screenData": "abc123",
  "items": TextType
}

ConcessionAlreadyExistsErrorType

Fields

Name Description

existingCardNumber(String)

The number of the existing concession card.

existingCardType(ConcessionCardType)

The type of the existing concession card.

message(String!)

{
  "message": "abc123",
  "existingCardNumber": "abc123",
  "existingCardType": "CENTRELINK_PENSIONER"
}

ConcessionCardApplicablePeriodType

Fields

Name Description

fromDate(Date!)

id(ID!)

toDate(Date)

{
  "id": "abc123",
  "fromDate": "2020-01-01",
  "toDate": "2020-01-01"
}

ConcessionCardApplicableRegionType

Fields

Name Description

cardLabel(String)

Readable description for the card type.

cardType(ConcessionCardType)

The card type.

{
  "cardType": "CENTRELINK_PENSIONER",
  "cardLabel": "abc123"
}

ConcessionCardValidationType

Fields

Name	Description
`failureCode(String)`
`failureReason(String)`
`id(ID!)`
`isCardValid(Boolean!)`
`method(String)`
`notes(String)`
`validatedAt(Date!)`
`validationDt(DateTime)`

{
  "id": "abc123",
  "validatedAt": "2020-01-01",
  "isCardValid": true,
  "validationDt": "2020-01-01T00:00:00.000Z",
  "failureCode": "abc123",
  "failureReason": "abc123",
  "notes": "abc123",
  "method": "abc123"
}

ConcessionType

Fields

Name	Description
`applicablePeriods([ConcessionCardApplicablePeriodType])`
`cardExpiryDate(Date)`
`cardIssueDate(Date)`
`cardLabel(String)`	Readable description for the card type. NOTE: Do not rely on this field for string matching.
`cardType(ConcessionCardType)`
`concessionValidations([ConcessionCardValidationType])`
`id(ID!)`
`isCardValid(Boolean)`
`isCurrent(Boolean)`
`nextValidationDate(Date)`
`number(String)`
`removalDate(Date)`

{
  "id": "abc123",
  "number": "abc123",
  "cardIssueDate": "2020-01-01",
  "cardExpiryDate": "2020-01-01",
  "isCurrent": true,
  "removalDate": "2020-01-01",
  "nextValidationDate": "2020-01-01",
  "applicablePeriods": [ConcessionCardApplicablePeriodType],
  "cardType": "CENTRELINK_PENSIONER",
  "cardLabel": "abc123",
  "concessionValidations": [ConcessionCardValidationType],
  "isCardValid": true
}

ConfirmDoubleOptIn

Output type of the confirmDoubleOptIn mutation.

Fields

Name Description

consent(ConsentType)

The consent that was created or updated.

{
  "consent": ConsentType
}

ConsentOutput

Fields

Name Description

code(String)

The code of the consent type.

value(String)

The value to update the consent to.

{
  "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.

{
  "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.

{
  "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.

{
  "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

{
  "node": ConstituentInterface,
  "cursor": "abc123"
}

Consumption

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.

{
  "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.

{
  "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

{
  "node": ConsumptionBreakdownType,
  "cursor": "abc123"
}

ConsumptionBreakdownType

Fields

Name Description

charges(ChargesBreakdownConnectionTypeConnection)

Charges grouped per displayed period.

Arguments

after (String)

before (String)

first (Int)

last (Int)

marketName(String)

Name of the market the charges are for.

{
  "marketName": "abc123",
  "charges": ChargesBreakdownConnectionTypeConnection
}

ConsumptionConnection

Pagination for energy consumption readings.

Fields

Name	Description
`edgeCount(Int!)`	Number of nodes in the edge.
`edges([ConsumptionEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": ConsumptionEdge,
  "totalCount": 1,
  "edgeCount": 1
}

ConsumptionEdge

A Relay edge containing a Consumption and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(ConsumptionType)

The item at the end of the edge

{
  "node": ConsumptionType,
  "cursor": "abc123"
}

ConsumptionSplitType

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).

{
  "timeSlot": "abc123",
  "splitPercentage": "1.0"
}

ConsumptionType

Energy consumption between two points in time.

Fields

Name Description

endAt(DateTime)

startAt(DateTime)

value(Decimal)

{
  "value": "1.0",
  "startAt": "2020-01-01T00:00:00.000Z",
  "endAt": "2020-01-01T00:00:00.000Z"
}

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.

{
  "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.
`novatedAt(DateTime)`	Date when the contract was novated, null if not novated.
`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([AccountType])`	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.

{
  "identifier": NonEmptyString,
  "title": "abc123",
  "party": AccountType,
  "subject": [AccountType],
  "status": "PENDING",
  "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",
  "novatedAt": "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.

{
  
}

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.

{
  "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.
`novatedAt(DateTime)`	Date when the contract was novated, null if not novated.
`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([AccountType])`	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.

{
  "identifier": NonEmptyString,
  "title": "abc123",
  "party": AccountType,
  "subject": [AccountType],
  "status": "PENDING",
  "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",
  "novatedAt": "2020-01-01T00:00:00.000Z",
  "lifecycle": ContractVersion
}

ContractGroupType

Fields

Name Description

identifier(UUID!)

The contract group's identifier.

{
  "identifier": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

ContractMetaDataType

Represents additional metadata for a contract term.

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.
`metadata(JSONString)`	The additional metadata of the contract.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "metadata": {"key": "value"}
}

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.

{
  "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.

{
  "note": "abc123",
  "activityType": "ALL_ACTIVITY_TYPES",
  "createdAt": "2020-01-01T00:00:00.000Z"
}

ContractReferencesType

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.

{
  "accountContractIdentifier": "abc123",
  "businessContractIdentifier": "abc123"
}

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.

{
  "versionReference": 1,
  "effectiveFrom": "2020-01-01T00:00:00.000Z"
}

ContractedVolumeConfigurationType

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.
`periods([ContractedVolumePeriodType])`	The periods for the contracted volume configuration.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "periods": [ContractedVolumePeriodType]
}

ContractedVolumePeriodType

Fields

Name	Description
`characteristics(GenericScalar)`	The market-supply-characteristic scope, as a code-to-value map.
`marketName(String)`	The market name the contracted volume applies to.
`maximum(Decimal)`	Optional upper bound around the value (e.g. a tolerance cap).
`measurementPeriod(ContractedVolumeMeasurementPeriod!)`	The measurement cadence of the quantity.
`minimum(Decimal)`	Optional lower bound around the value (e.g. a take-or-pay floor).
`purpose(ContractedVolumePurpose!)`	The role of the quantity.
`unit(String)`	The unit for the commodity provided by the contracted volume.
`validFrom(DateTime)`	When the contracted volume is valid from.
`validTo(DateTime)`	When the contracted volume is valid to.
`value(Decimal)`	The decimal value of the quantity provided by the contracted volume.

{
  "value": "1.0",
  "unit": "abc123",
  "marketName": "abc123",
  "measurementPeriod": "WHOLE_PERIOD",
  "purpose": "TRANCHE",
  "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"
}

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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)

{
  "id": "abc123",
  "contributionScheme": ContributionSchemeType,
  "interval": "MONTHLY",
  "activeFrom": "2020-01-01T00:00:00.000Z",
  "activeTo": "2020-01-01T00:00:00.000Z",
  "amount": 1,
  "periods": ContributionPeriodConnection
}

ContributionItemType

A component representing contribution items.

Fields

Name	Description
`grossAmount(BigInt!)`	The amount charged for this item in cents (incl. tax).
`netAmount(BigInt!)`	The amount charged for this item in cents (excl. tax).
`salesTaxAmount(BigInt)`	The amount charged for the tax component of this item.
`scheme(String!)`	The scheme name of the contribution.

{
  "scheme": "abc123",
  "grossAmount": 1,
  "netAmount": 1,
  "salesTaxAmount": 1
}

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.

{
  "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

{
  "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.

{
  "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?

{
  "id": "abc123",
  "code": "abc123",
  "displayName": "abc123",
  "taxable": true,
  "acceptingContributions": true
}

CoordinatesType

Fields

Name Description

latitude(Float)

longitude(Float)

{
  "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.

{
  "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"
}

CoreSiteworksRequestConnectionTypeConnection

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.

{
  "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

{
  "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. Please use 'supplyPointsInterface' instead. It returns SupplyPointInterfaceConnection, whose node is CommonSupplyPointInterface, and supports inline fragments (e.g. `... on WaterSupplyPointType`, `... on ElectricitySupplyPointType`). - Marked as deprecated on 2026-07-23. - Scheduled for removal on or after 2027-01-23. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`reason(String!)`
`status(String!)`
`supplyPointsInterface(SupplyPointInterfaceConnection)`	List of supply points on request. Node type is the CommonSupplyPointInterface; use inline fragments to access concrete types. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)

{
  "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]
}

CorrectivePeriodMarketConfigType

Fields

Name	Description
`length(Int)`	The length of the corrective period window.
`lengthUnit(String)`	The unit of time for the corrective period length.
`marketName(String)`	The market this corrective period configuration applies to.
`supplyPointIds([BigInt])`	Supply point IDs this config applies to. NULL means all supply points in this market.

{
  "marketName": "abc123",
  "supplyPointIds": [1],
  "length": 1,
  "lengthUnit": "abc123"
}

CorrectivePeriodType

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.
`marketConfigs([CorrectivePeriodMarketConfigType])`	Per-market corrective period configurations.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "marketConfigs": [CorrectivePeriodMarketConfigType]
}

CostEstimation

Fields

Name	Description
`estimatedControlledLoad1Cost(Int)`	Estimated Controlled Load 1 cost. Null when the CL1/CL2 split is unavailable - e.g. when the request supplies a combined usage summary rather than deriving usage from the meter's registers.
`estimatedControlledLoad1StandingCharge(Int)`	Estimated Controlled Load 1 standing charge. Null when the CL1/CL2 split is unavailable - e.g. when the request supplies a combined usage summary rather than deriving usage from the meter's registers.
`estimatedControlledLoad2Cost(Int)`	Estimated Controlled Load 2 cost. Null when the CL1/CL2 split is unavailable - e.g. when the request supplies a combined usage summary rather than deriving usage from the meter's registers.
`estimatedControlledLoad2StandingCharge(Int)`	Estimated Controlled Load 2 standing charge. Null when the CL1/CL2 split is unavailable - e.g. when the request supplies a combined usage summary rather than deriving usage from the meter's registers.
`estimatedControlledLoadCost(Int)`	Estimated controlled load cost (CL1 + CL2 combined). When the CL1/CL2 split is available this equals the sum of the split cost fields, each of which is GST-rounded independently.
`estimatedControlledLoadStandingCharge(Int)`	Estimated controlled load standing charge (CL1 + CL2 combined). When the CL1/CL2 split is available this equals the sum of the split standing charge fields, each of which is GST-rounded independently.
`estimatedExportCost(Int)`	Export cost estimate for a new plan.
`estimatedExportStandingCharge(Int)`	Export standing charge for a new plan.
`estimatedNewPlanCost(Int)`	Total cost estimate for a new plan.
`estimatedNewPlanWithExportCost(Int)`	Estimated new plan with export costs.
`estimatedStandardCost(Int)`	Standard usage cost estimate for a new plan.
`estimatedStandingCharge(Int)`	Standard standing charge for a new plan.
`standingCharge(Decimal)`	Total standing charge cost.

{
  "standingCharge": "1.0",
  "estimatedControlledLoadCost": 1,
  "estimatedControlledLoadStandingCharge": 1,
  "estimatedControlledLoad1Cost": 1,
  "estimatedControlledLoad1StandingCharge": 1,
  "estimatedControlledLoad2Cost": 1,
  "estimatedControlledLoad2StandingCharge": 1,
  "estimatedNewPlanWithExportCost": 1,
  "estimatedNewPlanCost": 1,
  "estimatedStandardCost": 1,
  "estimatedStandingCharge": 1,
  "estimatedExportCost": 1,
  "estimatedExportStandingCharge": 1
}

CouldNotStartWorkflowErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

CreateAPICall

Output type of the createApiCall mutation.

Fields

Name Description

apiCall(APICallType)

The created APICall.

{
  
}

CreateAPIException

Output type of the createApiException mutation.

Fields

Name Description

apiException(APIExceptionType)

The created APIException.

{
  
}

CreateAPIExceptionEvent

Output type of the createApiExceptionEvent mutation.

Fields

Name Description

apiExceptionEvent(APIExceptionEventType)

The created APIExceptionEvent.

{
  
}

CreateAPIExceptionNote

Output type of the createApiExceptionNote mutation.

Fields

Name Description

apiException(APIExceptionType)

The created APIExceptionNote.

{
  
}

CreateAccountCharge

Output type of the createAccountCharge mutation.

Fields

Name Description

accountCharge(AccountChargeType)

{
  "accountCharge": AccountChargeType
}

CreateAccountManualHold

Output type of the createAccountManualHold mutation.

Fields

Name Description

accountManualHold(AccountManualHoldType!)

The created manual hold.

{
  
}

CreateAccountNote

Output type of the createAccountNote mutation.

Fields

Name Description

account(AccountType)

Account, which has the added note.

note(AccountNoteType)

The created account note.

possibleErrors([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

{
  "account": AccountType,
  "possibleErrors": [PossibleErrorType]
}

CreateAccountPaymentSchedule

Output type of the createAccountPaymentSchedule mutation.

Fields

Name Description

schedule(PaymentScheduleType!)

New payment schedule.

{
  "schedule": PaymentScheduleType
}

CreateAccountReference

Output type of the createAccountReference mutation.

Fields

Name Description

accountReference(AccountReferenceType)

{
  "accountReference": AccountReferenceType
}

CreateAccountReminder

Output type of the createAccountReminder mutation.

Fields

Name Description

accountReminder(AccountReminder)

Account reminder.

{
  
}

CreateAccountUser

Output type of the createAccountUser mutation.

Fields

Name Description

accountUser(AccountUserType)

The account user.

{
  "accountUser": AccountUserType
}

CreateAffiliateLink

Output type of the createAffiliateLink mutation.

Fields

Name Description

affiliateLink(AffiliateLinkType)

The created affiliate link.

{
  
}

CreateAffiliateOrganisation

Output type of the createAffiliateOrganisation mutation.

Fields

Name Description

affiliateOrganisation(AffiliateOrganisationType)

The created affiliate organisation.

{
  
}

CreateAffiliateSession

Output type of the createAffiliateSession mutation.

Fields

Name Description

affiliateSession(AffiliateSessionType)

The created affiliate session.

{
  
}

CreateAgreement

Output type of the createAgreement mutation.

Fields

Name Description

agreement(CommonAgreementType)

The created agreement.

{
  "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

{
  "agreementRollover": AgreementRolloverType,
  "possibleErrors": [PossibleErrorType]
}

CreateAudioRecording

Output type of the createAudioRecording mutation.

Fields

Name Description

audioRecording(AudioRecordingType)

The created audio recording.

{
  
}

CreateBusiness

Output type of the createBusiness mutation.

Fields

Name Description

business(BusinessType)

The created business.

{
  "business": BusinessType
}

CreateCallMetadata

Output type of the createCallMetadata mutation.

Fields

Name Description

call(CallInterface)

The call metadata was attached to.

{
  
}

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])

{
  "batchIdentifier": "abc123"
}

CreateCentrepayDeduction

Output type of the createCentrepayDeduction mutation.

Fields

Name Description

centrepayDeduction(CentrepayDeductionType!)

Details of resulting request to add a Centrepay Deduction.

{
  "centrepayDeduction": CentrepayDeductionType
}

CreateCollectionProcessEvent

Output type of the createCollectionProcessEvent mutation.

Fields

Name Description

collectionProcessEvent(CollectionProcessEventOutputType)

The created collection process event.

{
  
}

CreateConcession

Output type of the createConcession mutation.

Fields

Name Description

concession(ConcessionType)

error(ConcessionCreationErrorUnion)

{
  "concession": ConcessionType,
  "error": ConcessionAlreadyExistsErrorType
}

CreateContractGroupOutput

Output type for creating a contract group.

Fields

Name Description

contractGroupIdentifier(UUID!)

Unique identifier for the created or matched contract group.

{
  "contractGroupIdentifier": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

CreateContractGroupVersion

Output type of the createContractGroupVersion mutation.

Fields

Name Description

contractGroup(ContractGroupType!)

The contract group whose version was created.

{
  
}

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.

{
  "identifier": NonEmptyString,
  "wasCreated": true
}

CreateContributionAgreement

Output type of the createContributionAgreement mutation.

Fields

Name Description

contributionAgreement(ContributionAgreementType)

The created contribution agreement.

{
  "contributionAgreement": ContributionAgreementType
}

CreateCreditTransferPermission

Output type of the createCreditTransferPermission mutation.

Fields

Name Description

validFrom(DateTime)

Datetime when the credit transfer permission is valid.

{
  "validFrom": "2020-01-01T00:00:00.000Z"
}

CreateCustomerFeedback

Output type of the createCustomerFeedback mutation.

Fields

Name Description

customerFeedback(CustomerFeedbackType)

The created customer feedback object.

{
  "customerFeedback": CustomerFeedbackType
}

CreateCustomerSelfMeterReads

Output type of the createElectricitySelfMeterReads mutation.

Fields

Name Description

error(ReadingValidationSaveErrorUnion)

Error types associated to handled errors during electricity reading generation.

readings([ElectricityAccumulationMeterReadingType])

Electricity readings generated from input.

{
  "readings": [ElectricityAccumulationMeterReadingType],
  "error": MultipleMeterpointsValidationErrorType
}

CreateDepositAgreement

Output type of the createDepositAgreement mutation.

Fields

Name Description

depositAgreement(CreateDepositAgreementOutput)

The newly created deposit agreement.

{
  
}

CreateDepositAgreementOutput

Fields

Name Description

depositAmount(Int)

The amount of the deposit.

depositRequired(Boolean)

Whether a deposit is required.

{
  "depositRequired": true,
  "depositAmount": 1
}

CreateDirectDebitInstruction

Output type of the createDirectDebitInstruction mutation.

Fields

Name Description

directDebitInstruction(DirectDebitInstructionType)

The newly created direct debit instruction.

{
  "directDebitInstruction": DirectDebitInstructionType
}

CreateDraftLegalEntity

Output type of the createDraftLegalEntity mutation.

Fields

Name Description

legalEntity(LegalEntityType)

The created draft legal entity.

{
  
}

CreateElectricityQuote

Output type of the createElectricityQuote mutation.

Fields

Name Description

meterPoint(MeterPointType)

The meter point created (if the nmi is available).

quote(QuoteType)

The quote created.

{
  "meterPoint": MeterPointType
}

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

{
  "possibleErrors": [PossibleErrorType]
}

CreateExternalAccountUserEvent

Output type of the createExternalAccountUserEvent mutation.

Fields

Name Description

event(ExternalAccountUserEvent)

The new event data.

{
  
}

CreateExternalMessage

Output type of the createExternalMessage mutation.

Fields

Name Description

externalMessage(ExternalMessageType)

The external message that was created.

{
  
}

CreateExternalMessageEvent

Output type of the createExternalMessageEvent mutation.

Fields

Name Description

externalMessageEvent(ExternalMessageEventType)

The external message event that was created.

{
  
}

CreateFamilyIssuesSuppressedCommAccountEvent

Output type of the createFamilyIssuesSuppressedCommAccountEvent mutation.

Fields

Name Description

event(CustomEventType)

The account event created if conditions were met, otherwise null.

{
  "event": CustomEventType
}

CreateFixedPaymentSchedule

Output type of the createFixedPaymentSchedule mutation.

Fields

Name Description

error(FixedPaymentScheduleErrorUnion)

paymentSchedule(PaymentScheduleType)

The payment schedule created.

{
  "paymentSchedule": PaymentScheduleType,
  "error": OutOfBoundsPaymentDayErrorType
}

CreateGasQuote

Output type of the createGasQuote mutation.

Fields

Name Description

error(CreateGasQuoteErrorUnion)

quoteRequest(QuoteRequestType)

{
  "error": NoSupplyPointsAssociatedWithMirnErrorType
}

CreateGasSelfMeterReads

Output type of the createGasSelfMeterReads mutation.

Fields

Name Description

error(GasReadingValidationSaveErrorUnion)

Error types associated to handled errors during gas reading generation.

readings([GasMeterReadingType])

Gas readings generated from input.

{
  "readings": [GasMeterReadingType],
  "error": ReadingCreationErrorType
}

CreateGasSupplyPoint

Output type of the createGasSupplyPoint mutation.

Fields

Name Description

error(CreateGasSupplyPointErrorUnion)

gasSupplyPoint(GasSupplyPointType)

{
  "gasSupplyPoint": GasSupplyPointType,
  "error": MirnAlreadyExistsErrorType
}

CreateGoodsPurchase

Output type of the createGoodsPurchase mutation.

Fields

Name Description

goodsPurchase(GoodsPurchase)

Goods purchase created.

{
  "goodsPurchase": GoodsPurchase
}

CreateGoodsQuote

Output type of the createGoodsQuote mutation.

Fields

Name Description

goodsQuote(GoodsQuote)

Goods quote created for the customer.

{
  "goodsQuote": GoodsQuote
}

CreateGoodsQuoteWithoutAccount

Output type of the createGoodsQuoteWithoutAccount mutation.

Fields

Name Description

goodsQuote(GoodsQuote)

Goods quote created for the customer.

{
  "goodsQuote": GoodsQuote
}

CreateGroupOutage

Output type of the createGroupOutage mutation.

Fields

Name Description

groupOutage(GroupOutageCreationType)

The Group Outage after it has been created.

{
  
}

CreateGroupOutageWorkRequest

Output type of the createGroupOutageWorkRequest mutation.

Fields

Name Description

result(CreateGroupOutageWorkRequestResultType!)

The Group Outage for which the work request was created.

{
  
}

CreateGroupOutageWorkRequestResultType

Fields

Name Description

groupOutageId(String!)

The Group Outage number for which the work request was created.

{
  "groupOutageId": "abc123"
}

CreateHardshipAgreement

Output type of the createHardshipAgreement mutation.

Fields

Name Description

newHardshipAgreement(HardshipAgreementType)

The created hardship agreement ID.

{
  "newHardshipAgreement": HardshipAgreementType
}

CreateHistoricalCallResultType

Fields

Name Description

id(UUID!)

UUID identifying the call, also used as an idempotency key.

reason(String)

The reason for the given status.

status(HistoricalCallResultStatus!)

The processing status: success, skipped, or error.

{
  "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.

{
  
}

CreateHistoricalCallsSummaryType

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.

{
  "total": 1,
  "successful": 1,
  "failed": 1
}

CreateInboundCall

Output type of the createInboundCall mutation.

Fields

Name Description

call(InboundCallType)

The call that was created.

hasOutstandingCallback(Boolean!)

Whether this customer already has an outstanding callback.

{
  "hasOutstandingCallback": true
}

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

{
  "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.

{
  "liveChatConversation": InkLiveChatConversation,
  "messageRelayId": "abc123"
}

CreateInternalCompany

Output type of the createInternalCompany mutation.

Fields

Name Description

internalCompany(CreateInternalCompanyResultType)

The result of the create internal company operation.

{
  
}

CreateInternalCompanyResultType

The result of the create internal company mutation.

Fields

Name Description

id(ID!)

The ID of the internal company that was created.

{
  "id": "abc123"
}

CreateJoinSupplierSecurityDeposits

Output type of the createJoinSupplierSecurityDeposits mutation.

Fields

Name Description

joinSupplierProcess(JoinSupplierProcessType!)

The join supplier process that was updated.

{
  "joinSupplierProcess": JoinSupplierProcessType
}

CreateKnowledgeDatabaseArticleFromText

Output type of the createKnowledgeDatabaseArticleFromText mutation.

Fields

Name Description

articleId(Int)

The ID of the newly created article.

{
  "articleId": 1
}

CreateLead

Output type of the createLead mutation.

Fields

Name Description

leadNumber(String)

The unique number of the lead.

{
  "leadNumber": "abc123"
}

CreateLegalEntity

Output type of the createLegalEntity mutation.

Fields

Name Description

legalEntity(LegalEntityType)

The created legal entity.

{
  
}

CreateMetadata

Output type of the createMetadata mutation.

Fields

Name Description

metadata(Metadata)

{
  "metadata": Metadata
}

CreateMeterDataIssueFlow

Output type of the createMeterDataIssueFlow mutation.

Fields

Name Description

meterDataIssueFlowCreated(CreateMeterDataIssueFlowOutputType)

Whether the meter data issue flow was successfully created.

{
  
}

CreateMeterDataIssueFlowOutputType

Output for creating a MeterDataIssueFlow.

Fields

Name Description

issueId(Int)

The ID of the MeterDataIssue.

status(MeterDataIssueFlowStatus)

The current status of the flow.

{
  "issueId": 1,
  "status": "PROCESSING"
}

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.

{
  "deviceEmail": "abc123",
  "devicePhone": "abc123",
  "totpSecret": "abc123"
}

CreateOfferGroupForQuoting

Output type of the createOfferGroupForQuoting mutation.

Fields

Name Description

offerGroup(CreateOfferGroupType)

Quoting Offer Group.

{
  "offerGroup": CreateOfferGroupType
}

CreateOfferGroupType

Fields

Name Description

identifier(ID)

Identifier of the Offer Group.

offers([OfferType])

One or more Offers contained in the Offer Group.

{
  "identifier": "abc123",
  "offers": [OfferType]
}

CreateOnSiteJobsAppointment

Output type of the createOnSiteJobsAppointment mutation.

Fields

Name Description

onSiteJobsAppointment(OnSiteJobsAppointmentType)

The created On-Site Jobs appointment.

{
  
}

CreateOnSiteJobsAppointmentWithDate

Output type of the createOnSiteJobsAppointmentWithDate mutation.

Fields

Name Description

onSiteJobsAppointment(OnSiteJobsAppointmentType)

The created On-Site Jobs appointment.

{
  
}

CreateOnSiteJobsAppointmentWithoutBooking

Output type of the createOnSiteJobsAppointmentWithoutBooking mutation.

Fields

Name Description

onSiteJobsAppointment(OnSiteJobsAppointmentType)

The created Appointment.

{
  
}

CreateOnSiteJobsAppointmentWithoutDateOrTime

Output type of the createOnSiteJobsAppointmentWithoutDateOrTime mutation.

Fields

Name Description

onSiteJobsAppointment(OnSiteJobsAppointmentType)

The created On-Site Jobs appointment.

{
  
}

CreateOnSiteJobsRequest

Output type of the createOnSiteJobsRequest mutation.

Fields

Name Description

onSiteJobsRequest(OnSiteJobsRequestType)

The created request.

{
  
}

CreateOpportunityFileAttachment

Output type of the createOpportunityFileAttachment mutation.

Fields

Name Description

result(String)

Whether the operation was successful.

{
  "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.

{
  "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.

{
  
}

CreateOrUpdateProductPricesOutput

The prices created for a product.

Fields

Name Description

prices([ProductPrice!]!)

The prices created.

{
  
}

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.

{
  "code": "abc123",
  "productCode": "abc123",
  "name": "abc123",
  "description": "abc123",
  "unit": "abc123",
  "periodSize": "abc123",
  "meta": {"key": "value"},
  "variants": VariantProfile
}

CreateOrganisationFileUpload

Output type of the createOrganisationFileUpload mutation.

Fields

Name Description

organisationFileUpload(OrganisationFileUpload)

The organisation file that was recorded.

{
  
}

CreatePartnerUser

Output type of the createPartnerUser mutation.

Fields

Name Description

partnerUser(PartnerUserType)

The created partner user.

{
  
}

CreatePaymentActionIntent

Output type of the createPaymentActionIntent mutation.

Fields

Name Description

token(ID!)

The action intent token.

{
  "token": "abc123"
}

CreatePaymentExtension

Output type of the createPaymentExtension mutation.

Fields

Name Description

paymentExtension(PaymentExtensionUnionType)

{
  "paymentExtension": PaymentPromiseType
}

CreatePaymentMethodActionIntent

Output type of the createPaymentMethodActionIntent mutation.

Fields

Name Description

token(ID!)

The action intent token.

{
  "token": "abc123"
}

CreatePaymentSchedule

Output type of the createPaymentSchedule mutation.

Fields

Name Description

paymentSchedule(PaymentScheduleType)

The payment schedule created.

{
  "paymentSchedule": PaymentScheduleType
}

CreatePortfolio

Output type of the createPortfolio mutation.

Fields

Name Description

portfolio(PortfolioType)

The created portfolio.

{
  "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.

{
  "portfolioUserRole": PortfolioUserRoleType
}

CreatePostEvents

Output type of the createPostEvents mutation.

Fields

Name Description

createdEventsCount(Int)

Number of events successfully created.

{
  "createdEventsCount": 1
}

CreatePrimaryResidence

Output type of the createPrimaryResidence mutation.

Fields

Name Description

error(CreatePrimaryResidenceErrorUnion)

primaryResidence(PrimaryResidenceType)

{
  "primaryResidence": PrimaryResidenceType,
  "error": AccountUserCanNotFoundErrorType
}

CreateProductOutput

Output type for creating a product.

Fields

Name Description

product(SupplyProductType)

The created product.

{
  "product": SupplyProductType
}

CreateProfileEventAndPublish

Output type of the createProfileEventAndPublish mutation.

Fields

Name Description

error(CreateUserProfileEventAndPublishErrorUnion)

syncEvent(SyncEventType)

{
  "syncEvent": SyncEventType,
  "error": CreateUserProfileEventAndPublishAccountNumberNotProvidedError
}

CreateQuoteForAccount

Output type of the createQuoteForAccount mutation.

Fields

Name Description

quoteRequest(MarketSupplyQuoteRequestType)

Returns a quote request.

{
  
}

CreateQuoteForProperty

Output type of the createQuoteForProperty mutation.

Fields

Name Description

error(CreateQuoteForPropertyErrorUnion)

The error preventing a quote from being produced.

quoteRequest(QuoteRequestType)

The QuoteRequest type field.

{
  "error": DoesNotExistErrorType
}

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.

{
  "referredAccountRewardAmount": 1
}

CreateRegisterNTCOverride

Output type of the createRegisterNtcOverride mutation.

Fields

Name Description

meterPoint(MeterPointType)

The target meter point.

{
  "meterPoint": MeterPointType
}

CreateReminder

Output type of the createReminder mutation.

Fields

Name Description

possibleErrors([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

reminder(Reminder)

Account reminder.

{
  "reminder": Reminder,
  "possibleErrors": [PossibleErrorType]
}

CreateScheduledTransactions

Output type of the createScheduledTransactions mutation.

Fields

Name Description

scheduledTransactions([ScheduledTransactionType])

{
  "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.

{
  "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]
}

CreateSupplyPointOutages

Output type of the createSupplyPointOutages mutation.

Fields

Name Description

result(CreateSupplyPointOutagesResultType!)

The identifiers of the Group Outage and created Supply Point Outages.

{
  
}

CreateSupplyPointOutagesResultType

Fields

Name Description

groupOutageNumber(String!)

The Group Outage for which Supply Point Outages were created.

supplyPointOutageNumbers([String]!)

The identifiers of the created Supply Point Outages.

{
  "groupOutageNumber": "abc123",
  "supplyPointOutageNumbers": "abc123"
}

CreateTimeSeriesPrices

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.

{
  "code": "abc123",
  "productCode": "abc123",
  "name": "abc123",
  "description": "abc123",
  "unit": "abc123",
  "periodSize": "abc123",
  "meta": {"key": "value"},
  "variants": VariantProfile
}

CreateUserAlternativeNumber

Output type of the createUserAlternativeNumber mutation.

Fields

Name Description

alternativePhoneNumbers([String])

List of alternative phone numbers for the account user.

error(AlternativeNumberErrorUnion)

Potential error message for the mutation.

{
  "alternativePhoneNumbers": ["abc123"],
  "error": AlternativeNumberValidationErrorType
}

CreateUserProfileEventAndPublishAccountNumberNotProvidedError

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

CreateUserProfileEventAndPublishClientError

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

CreateUserProfileEventAndPublishFinalBillNotFoundError

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

CreateUserProfileEventAndPublishOtherValidationError

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

CreateUserProfileEventAndPublishUserIdNotProvidedError

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

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` field for a breakdown of this information.
`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. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`isAccountPayment(Boolean)`	Deprecated. Deprecated The 'isAccountPayment' field is deprecated. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`isCredit(Boolean)`	Deprecated. Deprecated The 'isCredit' field is deprecated. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`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. Use `billingDocumentIdentifier` instead. - Marked as deprecated on 2023-11-30. - Scheduled for removal on or after 2024-06-01.
`title(String)`	Human-readable title describing the transaction.

{
  "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"
}

CreditReasonType

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.

{
  "code": "abc123",
  "display": "abc123",
  "isDeprecated": true,
  "isTaxExempt": true,
  "isHidden": true,
  "group": "abc123"
}

CreditTransferPermissionFromSourceLedgerType

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.

{
  "ledgerNumber": "abc123",
  "accountNumber": "abc123",
  "validFrom": "2020-01-01T00:00:00.000Z",
  "validTo": "2020-01-01T00:00:00.000Z"
}

CreditTransferPermissionToTargetLedgerType

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.

{
  "ledgerNumber": "abc123",
  "accountNumber": "abc123",
  "validFrom": "2020-01-01T00:00:00.000Z",
  "validTo": "2020-01-01T00:00:00.000Z"
}

CreditTransferPermissionsDataType

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.

{
  "fromSourceLedgers": [CreditTransferPermissionFromSourceLedgerType],
  "toTargetLedgers": [CreditTransferPermissionToTargetLedgerType]
}

CurrentEligibilityStatusOutput

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.

{
  "isEligible": true,
  "reasonsForIneligibility": ["abc123"]
}

CustomEventType

Fields

Name	Description
`account(String)`
`category(String!)`
`content(JSONString)`
`occurredAt(DateTime!)`
`subcategory(String!)`

{
  "occurredAt": "2020-01-01T00:00:00.000Z",
  "category": "abc123",
  "subcategory": "abc123",
  "content": {"key": "value"},
  "account": "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.

{
  "id": "abc123",
  "physicalId": "abc123",
  "name": "abc123",
  "type": "abc123",
  "activeFrom": "2020-01-01T00:00:00.000Z",
  "activeTo": "2020-01-01T00:00:00.000Z",
  "accountNumber": "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.

{
  "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

{
  "node": CustomerFeedbackFormType,
  "cursor": "abc123"
}

CustomerFeedbackFormType

Fields

Name Description

id(ID)

The unique identifier for the customer feedback form.

name(String)

The name of the customer feedback form.

{
  "id": "abc123",
  "name": "abc123"
}

CustomerFeedbackType

Fields

Name Description

id(ID!)

rawScore(Int)

The value attached to the source

submittedAt(DateTime)

The datetime the feedback was submitted

{
  "id": "abc123",
  "rawScore": 1,
  "submittedAt": "2020-01-01T00:00:00.000Z"
}

DCAProceedingClosureStatus

Fields

Name Description

accountNumber(String!)

The account number.

ledgerNumber(String)

The ledger identifier.

{
  "accountNumber": "abc123",
  "ledgerNumber": "abc123"
}

DCAProceedingCommencementStatus

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.

{
  "commencementStatus": true,
  "accountNumber": "abc123",
  "ledgerNumber": "abc123",
  "agency": "abc123",
  "campaign": "abc123"
}

DCAProceedingUpdateStatus

Fields

Name Description

accountNumber(String!)

The account number.

commencementStatus(Boolean!)

Whether the update has been applied.

{
  "commencementStatus": true,
  "accountNumber": "abc123"
}

DailyElectricityMeterReadingType

Meter readings grouped by the date on which they occurred.

Interval readings which occur on the same date are summed.

Accumulation readings do not occur the same date.

Fields

Name Description

date(Date!)

The date of the meter reading.

registerId(String!)

The register_id associated with the reading.

value(Decimal!)

The value of the meter reading.

{
  "date": "2020-01-01",
  "registerId": "abc123",
  "value": "1.0"
}

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.

{
  "id": "abc123",
  "typename": "abc123",
  "dashboardItems": SectionType,
  "serialisedDashboardItems": "abc123"
}

DebtCollectionAgencyType

Fields

Name Description

code(String!)

isActive(Boolean!)

name(String!)

{
  "name": "abc123",
  "code": "abc123",
  "isActive": true
}

DebtCollectionCampaignType

Fields

Name	Description
`code(String!)`
`deprecatedAt(DateTime)`
`displayName(String!)`
`requiresFieldVisit(Boolean!)`

{
  "code": "abc123",
  "displayName": "abc123",
  "deprecatedAt": "2020-01-01T00:00:00.000Z",
  "requiresFieldVisit": true
}

DebtCollectionProceedingType

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. Use `collectionCampaign` instead - Marked as deprecated on 2025-03-20. - Scheduled for removal on or after 2025-04-30.
`collectionCampaign(DebtCollectionCampaignType)`	The campaign type of the collection proceedings.
`startedAt(DateTime!)`
`stopReason(DebtCollectionProceedingStopReason)`
`stoppedAt(DateTime)`

{
  "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.

{
  "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.

{
  "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.

{
  "typeName": "abc123",
  "id": "abc123",
  "typename": "abc123",
  "url": "abc123"
}

DelayerDaysType

Represents delayer days for active payment in a contract.

Note: This type is a stub, and will be fleshed out in the future.

Fields

Name	Description
`days(Int!)`	Number of days to delay based on delay strategy.
`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.
`strategy(DelayerDaysStrategy!)`	Defines the method for calculating the delay period.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "days": 1,
  "strategy": "FIXED"
}

DeleteAccountReference

Output type of the deleteAccountReference mutation.

Fields

Name Description

accountReference(DeleteAccountReferenceType)

{
  
}

DeleteAccountReferenceType

Fields

Name Description

namespace(String!)

The namespace associated with the removed AccountReference.

{
  "namespace": "abc123"
}

DeleteKnowledgeDatabaseArticle

Output type of the deleteKnowledgeDatabaseArticle mutation.

Fields

Name Description

articleId(Int)

The ID of the deleted article.

{
  "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.

{
  "deviceDeleted": true
}

DeletePaymentSchedule

Output type of the deletePaymentSchedule mutation.

Fields

Name Description

account(AccountType)

Account related to payment schedule.

error(DeletePaymentScheduleErrorUnion)

Handled errors related to payment schedule deletion.

{
  "account": AccountType,
  "error": DoesNotExistErrorType
}

DeletePropertyDescendants

Output type of the deletePropertyDescendants mutation.

Fields

Name Description

property(PropertyType)

The property whose descendants were deleted.

{
  "property": PropertyType
}

DeletePushNotificationBinding

Output type of the deletePushNotificationBinding mutation.

Fields

Name Description

status(DeletePushNotificationBindingOutput)

{
  "status": "SUCCESSFUL"
}

DeleteUserAlternativeNumber

Output type of the deleteUserAlternativeNumber mutation.

Fields

Name Description

alternativePhoneNumbers([String])

List of alternative phone numbers for the account user.

error(AlternativeNumberErrorUnion)

Potential error message for the mutation.

{
  "alternativePhoneNumbers": ["abc123"],
  "error": AlternativeNumberValidationErrorType
}

DeletedSupplyPointEstimationGroupType

Fields

Name Description

supplyPointExternalId(String!)

The external identifier of the detached supply point.

{
  "supplyPointExternalId": "abc123"
}

DepositAgreementOutput

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.

{
  "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",
  "currentEligibilityStatus": CurrentEligibilityStatusOutput
}

DepositReturnScheduleOutput

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.

{
  "dueDate": "2020-01-01",
  "amount": 1,
  "status": "abc123"
}

DetachAgreementsFromContractsOutput

Fields

Name Description

ok(Boolean!)

True if the agreements were successfully detached.

{
  "ok": true
}

DetachSupplyPointFromEstimationGroup

Output type of the detachSupplyPointFromEstimationGroup mutation.

Fields

Name Description

supplyPoint(DeletedSupplyPointEstimationGroupType)

The deleted supply point.

{
  
}

Device

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.

The possible errors that can be raised are:

KT-CT-4721: Unsupported reading type.
KT-CT-4729: Unknown reading extra requested.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

endAt (DateTime!)

The exclusive end of the time period as an isoformatted string.

extras ([String!])

Optional list of extra keys to include on each reading if present on the underlying raw meter data. Note, requesting extras may cause aggregation delays with large aggregation queries.

readingType (ReadingTypes!)

Get readings of only this type.

startAt (DateTime!)

The inclusive start of the time period as an isoformatted string.

timeGranularity (TimeGranularities)

Time buckets to group readings into.

timezone (String)

The timezone in which to return readings.

units ([Units])

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.

Arguments

after (String)

before (String)

first (Int)

last (Int)

registerIdentifiers ([String])

The ids of the registers to get. If not provided, all registers for device will be returned.

{
  "readings": Readings,
  "deviceIdentifier": "abc123",
  "registers": RegistersConnection
}

DeviceRegister

Fields

Name Description

nmiSuffix(NmiSuffix)

The NMI suffix for this register data stream. This field is only provided when the operation includes the standard readings variables (startAt, endAt, readingType, timezone).

readings(Readings)

Get readings from a readable device e.g., a supply point, device, or register.

The possible errors that can be raised are:

KT-CT-4721: Unsupported reading type.
KT-CT-4729: Unknown reading extra requested.
KT-CT-1113: Disabled GraphQL field requested.

Arguments

endAt (DateTime!)

The exclusive end of the time period as an isoformatted string.

extras ([String!])

Optional list of extra keys to include on each reading if present on the underlying raw meter data. Note, requesting extras may cause aggregation delays with large aggregation queries.

readingType (ReadingTypes!)

Get readings of only this type.

startAt (DateTime!)

The inclusive start of the time period as an isoformatted string.

timeGranularity (TimeGranularities)

Time buckets to group readings into.

timezone (String)

The timezone in which to return readings.

units ([Units])

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.

{
  "readings": Readings,
  "registerIdentifier": "abc123",
  "nmiSuffix": NmiSuffix
}

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.

{
  "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

{
  "node": Device,
  "cursor": "abc123"
}

DigitalMeterRequestEligibility

Fields

Name Description

isEligible(Boolean)

Whether the NMI is eligible for a digital meter request.

nmi(String)

NMI the request is for.

reason(String)

Additional information about result.

{
  "nmi": "abc123",
  "isEligible": true,
  "reason": "abc123"
}

DirectDebitInstructionConnectionTypeConnection

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.

{
  "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

{
  "node": DirectDebitInstructionType,
  "cursor": "abc123"
}

DirectDebitInstructionType

Direct Debit Instructions

Fields

Name	Description
`accountHolder(String!)`
`cardExpiryMonth(Int)`
`cardExpiryYear(Int)`
`cardPaymentNetwork(String)`
`iban(String!)`	IBAN for this direct debit instruction.
`id(ID!)`
`instructionType(String!)`
`lastFourDigitsOfAccountNumber(String)`	The last four digits of the account number. Deprecated The 'lastFourDigitsOfAccountNumber' field is deprecated. Use 'maskedAccountIdentifier' for a masked reference to the instruction. - Marked as deprecated on 2021-12-23. - Scheduled for removal on or after 2024-01-01.
`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!)`	The bank sort code for this direct debit instruction.
`status(String!)`

{
  "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]
}

DistributionAgreementType

An agreement for an electricity distribution supply point. Returns rates that are active at the time the GraphQL query was made if the agreement is active. If not return rates that are active at the time the agreement ended.

Fields

Name	Description
`account(AccountType)`	The accounts for this agreement.
`agreedAt(DateTime)`
`agreedFrom(DateTime)`	The datetime the agreement was entered.
`agreedTo(DateTime)`	The datetime the agreement was terminated.
`bestOffer(BestOfferForAgreement)`	Get the best offer for an agreement. Arguments `asOf` (`DateTime`) The date time to calculate the best offer. Defaults to now. `eventSource` (`BestOfferEventSource`) What triggered this calculation. Recorded against the stored calculation, and has no effect on the returned costs. `pricesAsOf` (`DateTime`) The date time to calculate cost details.
`eligibleRebates([RebateType])`	Data about concession rebates that users associated with the agreement are eligible for. Arguments `endAt` (`DateTime`) Include eligibility data ending at this datetime. If this isn't provided, an open-ended range will be used. `rebateAmountEffectiveAt` (`DateTime`) The effective time for rebateCents and percentageDiscount data (defaults to now). `startAt` (`DateTime`) Include eligibility data starting at this datetime. If this isn't provided, an open-ended range will be used.
`id(Int)`	The ID of the agreement.
`isActive(String)`
`isRevoked(Boolean)`	Whether the agreement is revoked.
`meterPoint(MeterPointType)`	The meter point for this agreement.
`product(Product)`	The product for this agreement.
`ratesAgreedAt(DateTime)`	The datetime the rates were agreed.
`rescissionDeadlineAt(DateTime)`	The deadline datetime for rescinding the agreement.
`supplyPoint(SupplyPointInterface!)`
`supplyType(String)`
`terminatedAt(DateTime)`
`validFrom(DateTime)`	The start datetime of the agreement.
`validTo(DateTime)`	The end datetime of the agreement.

{
  "id": 1,
  "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",
  "agreedFrom": "2020-01-01T00:00:00.000Z",
  "agreedTo": "2020-01-01T00:00:00.000Z",
  "isRevoked": true,
  "rescissionDeadlineAt": "2020-01-01T00:00:00.000Z",
  "ratesAgreedAt": "2020-01-01T00:00:00.000Z",
  "product": Product,
  "supplyType": "abc123",
  "isActive": "abc123",
  "meterPoint": MeterPointType,
  "supplyPoint": SupplyPointInterface,
  "eligibleRebates": [RebateType],
  "bestOffer": BestOfferForAgreement,
  "account": AccountType
}

DistributorType

Fields

Name	Description
`displayName(String)`	Customer facing display name.
`emergencyPhone(String)`	Emergency Contact number.
`error(String)`	An Error was encountered determining the distributor.
`id(ID)`	A unique code to identify the distributor eg ENERGYAP, AGLGNNWO.
`longName(String)`	Long form distributor name.
`shortName(String)`	Short form distributor name.

{
  "longName": "abc123",
  "shortName": "abc123",
  "displayName": "abc123",
  "emergencyPhone": "abc123",
  "id": "abc123",
  "error": "abc123"
}

DmoReferenceType

Fields

Name	Description
`annualCost(Decimal!)`
`controlledUsage(Int)`
`effectiveFrom(Date!)`	The date on which the DMO first becomes effective
`effectiveTo(Date)`	The final date on which the DMO is effective
`generalUsage(Int!)`
`id(ID!)`
`notRequired(Boolean)`
`ntcCombination([String!]!)`	Network Tariff Codes that applies to the DMO separate by comma
`tariffName(String!)`
`totalUsage(Int)`	Total usage derived from controlled and general usage.

{
  "id": "abc123",
  "effectiveFrom": "2020-01-01",
  "effectiveTo": "2020-01-01",
  "ntcCombination": "abc123",
  "tariffName": "abc123",
  "generalUsage": 1,
  "controlledUsage": 1,
  "annualCost": "1.0",
  "notRequired": true,
  "totalUsage": 1
}

DoesNotExistErrorType

Fields

Name Description

field(String!)

The input field that failed database lookup.

{
  "field": "abc123"
}

DueChargesType

Fields

Name	Description
`amount(Int!)`	Number of cents that the customer still needs to pay.
`billingDocument(PeriodBasedDocumentType)`	The billing document that contained these charges. Note this value may be null.
`dueDate(Date!)`	Date that the customer is expected to pay by.
`statement(StatementType)`	The statement that contained these charges. Note this value may be null.

{
  "amount": 1,
  "statement": StatementType,
  "billingDocument": PeriodBasedDocumentType,
  "dueDate": "2020-01-01"
}

DuplicateConcessionCardNumberErrorType

Fields

Name Description

existingUserId(ID)

The ID of the user who already has this card number.

message(String!)

{
  "message": "abc123",
  "existingUserId": "abc123"
}

DuplicateNTCForStandingChargeErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

ElecEstimatedUsageAndCostType

Fields

Name	Description
`dailyEstimation(BaseUsageAndCostType!)`	Daily usage and cost estimation.
`failureReasons(String)`	Failure reasons.
`fortnightlyEstimation(BaseUsageAndCostType!)`	Fortnightly usage and cost estimation.
`monthlyEstimation(BaseUsageAndCostType!)`	Monthly usage and cost estimation.
`weeklyEstimation(BaseUsageAndCostType!)`	Weekly usage and cost estimation.
`yearlyEstimation(BaseUsageAndCostType!)`	Yearly usage and cost estimation.

{
  "failureReasons": "abc123",
  "dailyEstimation": BaseUsageAndCostType,
  "weeklyEstimation": BaseUsageAndCostType,
  "fortnightlyEstimation": BaseUsageAndCostType,
  "monthlyEstimation": BaseUsageAndCostType,
  "yearlyEstimation": BaseUsageAndCostType
}

ElectricityAccumulationMeterReadingType

An electricity meter reading. Accumulated usage.

Fields

Name	Description
`direction(ElectricityAccumulationMeterReadingDirection!)`	The direction of the reading.
`id(ID!)`
`isQuarantined(Boolean!)`	Indicates whether the reading is quarantined.
`qualityFlag(QualityFlag)`	Possible values: A: ACTUALMETERINGDATA E: FORWARDESTIMATEDDATA F: FINALSUBSTITUTEDDATA N: NULLDATA S: SUBSTITUTEDDATA V: VARIABLE_DATA
`qualityMethod(String)`	Reading quality method.
`readAt(DateTime)`	The datetime when the meter was read.
`registers([RegisterReading])`	List of register readings.
`source(source!)`	The source of the meter reading.
`units(String!)`
`value(Decimal!)`

{
  "id": "abc123",
  "qualityMethod": "abc123",
  "units": "abc123",
  "value": "1.0",
  "readAt": "2020-01-01T00:00:00.000Z",
  "registers": [RegisterReading],
  "source": "OPS_READING_UPDATE",
  "isQuarantined": true,
  "direction": "I",
  "qualityFlag": "A"
}

ElectricityAgreementType

An agreement for an electricity supply point. Returns rates that are active at the time the GraphQL query was made if the agreement is active. If not return rates that are active at the time the agreement ended.

Fields

Name	Description
`account(AccountType)`	The accounts for this agreement.
`agreedAt(DateTime)`
`agreedFrom(DateTime)`	The datetime the agreement was entered.
`agreedTo(DateTime)`	The datetime the agreement was terminated.
`bestOffer(BestOfferForAgreement)`	Get the best offer for an agreement. Arguments `asOf` (`DateTime`) The date time to calculate the best offer. Defaults to now. `eventSource` (`BestOfferEventSource`) What triggered this calculation. Recorded against the stored calculation, and has no effect on the returned costs. `pricesAsOf` (`DateTime`) The date time to calculate cost details.
`eligibleRebates([RebateType])`	Data about concession rebates that users associated with the agreement are eligible for. Arguments `endAt` (`DateTime`) Include eligibility data ending at this datetime. If this isn't provided, an open-ended range will be used. `rebateAmountEffectiveAt` (`DateTime`) The effective time for rebateCents and percentageDiscount data (defaults to now). `startAt` (`DateTime`) Include eligibility data starting at this datetime. If this isn't provided, an open-ended range will be used.
`id(Int)`	The ID of the agreement.
`isActive(String)`
`isRevoked(Boolean)`	Whether the agreement is revoked.
`meterPoint(MeterPointType)`	The meter point for this agreement.
`product(Product)`	The product for this agreement.
`ratesAgreedAt(DateTime)`	The datetime the rates were agreed.
`rescissionDeadlineAt(DateTime)`	The deadline datetime for rescinding the agreement.
`supplyPoint(ElectricitySupplyPointType!)`
`supplyType(String)`
`terminatedAt(DateTime)`
`validFrom(DateTime)`	The start datetime of the agreement.
`validTo(DateTime)`	The end datetime of the agreement.

{
  "id": 1,
  "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",
  "agreedFrom": "2020-01-01T00:00:00.000Z",
  "agreedTo": "2020-01-01T00:00:00.000Z",
  "isRevoked": true,
  "rescissionDeadlineAt": "2020-01-01T00:00:00.000Z",
  "ratesAgreedAt": "2020-01-01T00:00:00.000Z",
  "product": Product,
  "supplyType": "abc123",
  "isActive": "abc123",
  "meterPoint": MeterPointType,
  "supplyPoint": ElectricitySupplyPointType,
  "eligibleRebates": [RebateType],
  "bestOffer": BestOfferForAgreement,
  "account": AccountType
}

ElectricityAmphioIntervalMeterReadingType

An electricity meter reading. Usage within a time window.

Fields

Name	Description
`deviceId(String!)`
`direction(String!)`
`indexRead(Decimal)`
`indexReadAt(DateTime)`
`intervalEndAt(DateTime!)`
`intervalStartAt(DateTime!)`
`isDeleted(Boolean!)`
`isValid(Boolean!)`
`localDate(Date)`
`nmiSuffix(String!)`
`qualityFlag(QualityFlag)`	Possible values: A: ACTUALMETERINGDATA E: FORWARDESTIMATEDDATA F: FINALSUBSTITUTEDDATA N: NULLDATA S: SUBSTITUTEDDATA V: VARIABLE_DATA
`qualityMethod(String)`	Reading quality method.
`reasonCode(AmphioIntervalReadingReasonCode)`
`registerIdentifier(String)`
`units(String!)`
`value(Decimal!)`	Usage value of energy.

{
  "intervalStartAt": "2020-01-01T00:00:00.000Z",
  "intervalEndAt": "2020-01-01T00:00:00.000Z",
  "units": "abc123",
  "direction": "abc123",
  "localDate": "2020-01-01",
  "deviceId": "abc123",
  "registerIdentifier": "abc123",
  "nmiSuffix": "abc123",
  "reasonCode": "A_0",
  "indexRead": "1.0",
  "indexReadAt": "2020-01-01T00:00:00.000Z",
  "isValid": true,
  "isDeleted": true,
  "qualityMethod": "abc123",
  "value": "1.0",
  "qualityFlag": "A"
}

ElectricityCostedConsumptionType

Fields

Name Description

registers([ElectricityRegisterType])

Registers associated with this consumption.

summarizedConsumption([SummarizedConsumptionType])

Summarized costed consumption data.

{
  "summarizedConsumption": [SummarizedConsumptionType],
  "registers": [ElectricityRegisterType]
}

ElectricityDataStreamType

A data stream for one or more meter registers.

Fields

Name Description

averageDailyLoad(Float!)

Estimated energy used by the data stream for this register (kWh/day).

{
  "averageDailyLoad": 1.0
}

ElectricityFiltersOutput

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.

{
  "readingDirection": "CONSUMPTION",
  "registerId": "abc123",
  "readingQuality": "ACTUAL",
  "readingFrequencyType": "RAW_INTERVAL",
  "marketSupplyPointId": "abc123",
  "deviceId": "abc123"
}

ElectricityIntervalMeterReadingType

An electricity meter reading. Usage within a time window.

Fields

Name Description

endAt(DateTime)

The end datetime of the interval reading.

registers([RegisterReading])

List of register readings.

startAt(DateTime)

The start datetime of the interval reading.

{
  "startAt": "2020-01-01T00:00:00.000Z",
  "endAt": "2020-01-01T00:00:00.000Z",
  "registers": [RegisterReading]
}

ElectricityMeterReadingConnectionTypeConnection

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([ElectricityMeterReadingConnectionTypeEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": ElectricityMeterReadingConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

ElectricityMeterReadingConnectionTypeEdge

A Relay edge containing a ElectricityMeterReadingConnectionType and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(ElectricityMeterReadingType)

The item at the end of the edge

{
  "node": ElectricityAccumulationMeterReadingType,
  "cursor": "abc123"
}

ElectricityMeterType

An electricity meter is a collection of registers which store readings. Eco7 meters are an example of a meter with multiple registers (for day and night).

Fields

Name	Description
`activeFrom(DateTime)`
`activeTo(DateTime)`
`consumption(ConsumptionConnection)`	Energy consumption recorded by the meter. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `grouping` (`ConsumptionGroupings!`) Aggregate consumption according to this grouping. `last` (`Int`) `startAt` (`DateTime!`) Earliest consumption reading to return. Must specify a timezone. `timezone` (`String!`) Timezone to use for grouping.
`consumptionUnits(String)`	The units of consumption for a smart meter.
`controlEquipmentType(String)`	Describes the type of control equipment that has been installed on behalf of the LNSP.
`fuelType(String)`	The type of fuel this meter uses.
`id(ID!)`
`installationType(MeterInstallationTypeCodeType)`	The meter installation type code.
`isManuallyRead(Boolean)`	Whether this meter requires manual reading.
`isManuallyReadMrim(Boolean)`	Whether this meter is a manually read Manually Read Interval Meter (MRIM).
`isRemotelyRead(Boolean)`	Whether this meter supports remote reading.
`isRemotelyReadMrim(Boolean)`	Whether this meter is a remotely read Manually Read Interval Meter (MRIM).
`isSmart(Boolean)`	Whether this is a smart (interval) meter.
`isUnmetered(Boolean)`	Whether this is an unmetered supply point (e.g. street lighting).
`location(String)`	Describes the relationship between the location of the metering point and the connection point.
`meterPoint(MeterPointType!)`
`model(String)`	The model of the meter.
`nextScheduledReadDate(Date)`
`readTypeFrequency(MeterReadTypeFrequency)`
`readTypeMethod(MeterReadTypeMethod)`
`readTypeMode(MeterReadTypeMode)`
`readings(ElectricityMeterReadingConnectionTypeConnection)`	Meter readings recorded by this meter. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `includeQuarantined` (`Boolean`) Include readings that have been quarantined. `last` (`Int`)
`registers([ElectricityRegisterType])`	The registers on this meter that record consumption.
`requiresCotFinalReading(Boolean)`	Whether this meter requires a final change of tenancy (COT) reading.
`roundNumber(String)`	The round number of the meter. Deprecated The 'roundNumber' field is deprecated. This field has never been populated from the API - Marked as deprecated on 2026-08-20. - Scheduled for removal on or after 2027-02-20.
`sequenceNumber(String)`	The sequence number of the meter. Deprecated The 'sequenceNumber' field is deprecated. This field has never been populated from the API - Marked as deprecated on 2026-08-20. - Scheduled for removal on or after 2027-02-20.
`serialNumber(String!)`
`status(MeterStatus!)`
`transmissionNodeIdentifier(String)`	The Transmission Node Identifier (TNI) code from the AEMO CATSTNICODES table.

{
  "id": "abc123",
  "serialNumber": "abc123",
  "activeFrom": "2020-01-01T00:00:00.000Z",
  "activeTo": "2020-01-01T00:00:00.000Z",
  "status": "C",
  "installationType": "BASIC",
  "nextScheduledReadDate": "2020-01-01",
  "readTypeMethod": "M",
  "readTypeMode": "T",
  "readTypeFrequency": "A_1",
  "consumptionUnits": "abc123",
  "requiresCotFinalReading": true,
  "fuelType": "abc123",
  "consumption": ConsumptionConnection,
  "meterPoint": MeterPointType,
  "isSmart": true,
  "isRemotelyRead": true,
  "isManuallyRead": true,
  "isRemotelyReadMrim": true,
  "isManuallyReadMrim": true,
  "isUnmetered": true,
  "readings": ElectricityMeterReadingConnectionTypeConnection,
  "registers": [ElectricityRegisterType],
  "roundNumber": "abc123",
  "sequenceNumber": "abc123",
  "controlEquipmentType": "abc123",
  "location": "abc123",
  "model": "abc123",
  "transmissionNodeIdentifier": "abc123"
}

ElectricityMoveInDatesType

Fields

Name Description

error(ElectricityMoveInDatesErrorUnion)

moveInDates([Date])

{
  "moveInDates": ["2020-01-01"],
  "error": DoesNotExistErrorType
}

ElectricityPriceReferenceType

Fields

Name	Description
`annualCost(Decimal!)`	The calculated annual cost, in $.
`effectiveFrom(Date!)`	The date the reference became effective.
`effectiveTo(Date)`	The last date on which the reference is effective.
`hasControlledLoad(Boolean)`	Whether this tariff has a controlled load component. Null when the NTC combination cannot be classified.
`isRegulated(Boolean!)`	Whether this tariff is regulated under the AER Default Market Offer. Non-regulated tariffs include demand tariffs and SME controlled load tariffs.
`planId(String)`	Plan Id.
`savingPercentage(Int!)`	The savings percentage, relative to the Usage Reference annual cost.
`tariffType(String)`	The tariff structure type for this product: flat, tou, sso, or non_regulated. Used to determine the appropriate AER comparison wording per product. Null when the NTC combination cannot be classified (e.g. demand tariffs or malformed NTC data).

{
  "planId": "abc123",
  "effectiveFrom": "2020-01-01",
  "effectiveTo": "2020-01-01",
  "annualCost": "1.0",
  "savingPercentage": 1,
  "isRegulated": true,
  "tariffType": "abc123",
  "hasControlledLoad": true
}

ElectricityRateType

Product rates for electricity may be matched to registers using the network tariff code and time of day.

Fields

Name	Description
`bandCategory(BandCategory)`	Category of band associated with a product rate.
`bandSubcategory(String)`	Subcategory of band associated with a product rate.
`chargeDescription(String)`	Description for the network tariff code.
`currency(String)`
`id(ID)`	ID associated with electricity product rate.
`isControlledLoad(Boolean)`	Whether the rate is for controlled load.
`isForExcessDemand(Boolean)`	Whether the rate is for excess demand.
`isSolar(Boolean)`	Whether the rate is for solar export.
`networkTariffCode(String)`	Matches the Network Tariff Codes published by each LNSP.
`pricePerUnit(Decimal!)`	Price in cents per unit.
`rateDescription(String)`	Description that will show up on the customer's bill.
`rateExcludingTax(Float)`	Unit cost before tax.
`rateIncludingTax(Float)`	Unit cost including tax.
`stepEnd(Float)`	End of the step the rate applies to (Exclusive).
`stepStart(Float)`	Start of the step the rate applies to.
`tariffPeriods([LNSPTariffPeriodType])`	Tariff periods for this rate, grouped by LNSP.
`timeOfDay(String)`	Accumulation meters use the `ALLDAY` product rates.
`unbundledRateType(String)`	Unbundled rate type.
`unitType(UnitType!)`	What the rate is for, e.g. kWh of electricity, MJ or Units of gas, or days on supply.
`validFrom(DateTime)`
`validTo(DateTime)`

{
  "currency": "abc123",
  "pricePerUnit": "1.0",
  "bandCategory": "STANDING_CHARGE",
  "bandSubcategory": "abc123",
  "rateExcludingTax": 1.0,
  "rateIncludingTax": 1.0,
  "rateDescription": "abc123",
  "unitType": "DAYS_ON_SUPPLY",
  "validFrom": "2020-01-01T00:00:00.000Z",
  "validTo": "2020-01-01T00:00:00.000Z",
  "stepStart": 1.0,
  "stepEnd": 1.0,
  "id": "abc123",
  "timeOfDay": "abc123",
  "networkTariffCode": "abc123",
  "chargeDescription": "abc123",
  "unbundledRateType": "abc123",
  "isControlledLoad": true,
  "isForExcessDemand": true,
  "isSolar": true,
  "tariffPeriods": [LNSPTariffPeriodType]
}

ElectricityRegisterType

A register on a meter. See standing data for MSATS for more information.

Fields

Name	Description
`activeFrom(DateTime)`
`billableTariffCode(String)`	Effective network tariff code. May be sourced from a global override if `network_tariff_code_override` is not set.
`consumptionSummary([SummarizedConsumptionType!]!)`	NOTE: This consumptionSummary field is deprecated. Use the consumptionSummary field on the MeterPointType instead. Fetch consumption on this register, bucketed into time slices of a variable granularity. Unlike `readingsSummary`, this endpoint returns consumption; in particular, for accumulation meters, the returned value represents the absolute amount of energy consumed, rather than reading values. When the readings we have are less granular than the requested granularity (e.g. half-hourly or even monthly consumption requested on an interval meter), the consumption is divided evenly. Note that, because the way that humans measure time is weird, so too are the results of this endpoint. For instance, a day may not have exactly 48 half-hour periods (because a DST transition happened), and a three-month interval of meter readings may not appear to be spread evenly between months (because months have different numbers of days). The result will only include periods that are wholly between `start_at` and `end_at`; so, for instance, if you have a `start_at` of midday and a `granularity` of `DAILY`, you'll get results starting at midnight the following day. This field requires the `Authorization` header to be set. Deprecated The 'consumptionSummary' field is deprecated. Use MeterPointType > consumptionSummary instead. - Marked as deprecated on 2023-11-27. - Scheduled for removal on or after 2024-02-27. Arguments `endAt` (`DateTime!`) Include data ending at this datetime. If a datetime-naïve value (without a UTC offset) is passed, this will be assumed to be in the timezone specified in `timezone`; if the UTC offset is absent and it is a time that occurs more than once in the given timezone (e.g. 2am on a transition out of DST) the behaviour is undefined. `granularity` (`ConsumptionGranularity!`) How granular the returned results should be `includeEstimates` (`Boolean`) Include estimated readings `includeQuarantined` (`Boolean`) Include readings that have been quarantined in Kraken `startAt` (`DateTime!`) Include data starting at this datetime. If a datetime-naïve value (without a UTC offset) is passed, this will be assumed to be in the timezone specified in `timezone`; if the UTC offset is absent and it is a time that occurs more than once in the given timezone (e.g. 2am on a transition out of DST) the behaviour is undefined. `timezone` (`String!`) Olson timezone identifier to use (e.g. `Australia/Melbourne`). This is used to determine what time of day to split days and months.
`controlledLoad(String!)`
`dataStream(ElectricityDataStreamType)`
`dialFormatDecimals(Int)`
`dialFormatDigits(Int)`
`id(ID!)`
`identifier(String!)`	MSATS RegisterId.
`isActive(Boolean!)`
`isExportRegister(Boolean!)`	Arguments `asAt` (`DateTime`) Timezone specified date time at which register is considered exported. Defaults to the current date/timezone when not included.
`isReactive(Boolean!)`	Whether the register measures reactive power.
`multiplier(Decimal)`	Multiplier to apply to the meter readings.
`networkTariffCode(String!)`	From the Network Tariff Codes supplied and published by each LNSP.
`networkTariffCodeOverride([RegisterNTCOverrideType])`	Overrides to the current network tariff code for this register.
`nullableUnitOfMeasure(UnitOfMeasure)`	The recorded unit of measure, or null when unavailable. Query this instead of unitOfMeasure when a register may have no unit recorded.
`readingsSummary([DailyElectricityMeterReadingType])`	Fetch summaries of electricity meter readings. You need to pass in the readings granularity desired for the results (e.g. DAILY or MONTHLY). Optionally include readings that have been quarantined (these are excluded by default). Also optionally include/exclude estimated readings (included by default). Days where no meter readings occurred will be omitted. The summarised readings returned have the same semantic meaning as raw readings for this register; interval meters will return a consumption figure for this interval, and accumulation meters will return a raw read (that must be subtracted from the previous read to determine consumption). If this isn't what you want, use `consumptionSummary` instead. This field requires the `Authorization` header to be set. Deprecated The 'readingsSummary' field is deprecated. This will not resolve for Amphio meterpoints. - Marked as deprecated on 2023-03-17. - Scheduled for removal on or after 2024-03-17. Arguments `endDate` (`Date!`) Readings which happened after the end of this day will be excluded. `includeEstimates` (`Boolean`) Include estimated readings `includeQuarantined` (`Boolean`) Include readings that have been quarantined in Kraken `readingsGranularity` (`ReadingsGranularity!`) Data granularity desired for the summary results `startDate` (`Date!`) Readings which happened before the start of this day will be excluded.
`status(RegisterStatus!)`
`suffix(String)`
`timeOfDay(String!)`	Code to identify the time validity of register contents, as published by each LNSP.
`unitOfMeasure(UnitOfMeasure!)`

{
  "id": "abc123",
  "identifier": "abc123",
  "activeFrom": "2020-01-01T00:00:00.000Z",
  "timeOfDay": "abc123",
  "multiplier": "1.0",
  "status": "C",
  "networkTariffCode": "abc123",
  "dialFormatDigits": 1,
  "dialFormatDecimals": 1,
  "suffix": "abc123",
  "controlledLoad": "abc123",
  "unitOfMeasure": "MWH",
  "nullableUnitOfMeasure": "MWH",
  "networkTariffCodeOverride": [RegisterNTCOverrideType],
  "isExportRegister": true,
  "dataStream": ElectricityDataStreamType,
  "isActive": true,
  "isReactive": true,
  "readingsSummary": [DailyElectricityMeterReadingType],
  "consumptionSummary": SummarizedConsumptionType,
  "billableTariffCode": "abc123"
}

ElectricityServiceOrderType

Fields

Name	Description
`chargeRecords(ServiceOrderChargeRecordConnectionTypeConnection)`	Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`deEnergisationReason(ServiceOrderDeEnergisationReasonChoices)`	If applicable, the service order reason for de-energisation.
`meterPoint(MeterPointType)`
`orderNumber(String)`
`responseCode(String)`
`scheduledDate(Date)`
`serviceOrder(Int)`
`status(ServiceOrderStatus)`
`subtype(ServiceOrderSubTypeChoices)`	The service order subtype.
`type(ServiceOrderTypeChoices)`	The service order type.

{
  "orderNumber": "abc123",
  "type": "SUPPLY_SERVICE_WORKS",
  "status": "PENDING",
  "meterPoint": MeterPointType,
  "serviceOrder": 1,
  "responseCode": "abc123",
  "scheduledDate": "2020-01-01",
  "chargeRecords": ServiceOrderChargeRecordConnectionTypeConnection,
  "subtype": "AFTER_DISCONNECTION_FOR_NON_PAYMENT",
  "deEnergisationReason": "CUSTOMER_REQUESTED"
}

ElectricitySupplyPointType

Fields

Name	Description
`externalIdentifier(String)`	The external identifier of the supply point.
`id(ID!)`	The unique identifier of the supply point.
`marketName(String!)`	The market this supply point belongs to.
`meterPoint(MeterPointType)`	The electricity meter point for this supply point.
`property(PropertyType)`	The property associated with this supply point.

{
  "id": "abc123",
  "marketName": "abc123",
  "property": PropertyType,
  "meterPoint": MeterPointType,
  "externalIdentifier": "abc123"
}

ElectricityUsageReferenceType

Fields

Name	Description
`annualCost(Decimal!)`	The reference annual cost, in $.
`controlledUsage(Int)`	Amount of controlled usage included in the total.
`effectiveFrom(Date!)`	The date the reference became effective.
`effectiveTo(Date)`	The last date on which the reference is effective.
`generalUsage(Int!)`	Amount of general usage included in the total.
`notRequired(Boolean!)`	Whether the reference is required or not.
`ntcCombination([String]!)`	Relevant NTCs used for this reference.
`tariffName(String)`	The name of the tariff.
`totalUsage(Int!)`	Total amount of usage used for the reference.

{
  "effectiveFrom": "2020-01-01",
  "effectiveTo": "2020-01-01",
  "totalUsage": 1,
  "ntcCombination": "abc123",
  "annualCost": "1.0",
  "tariffName": "abc123",
  "generalUsage": 1,
  "controlledUsage": 1,
  "notRequired": true
}

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)

{
  "id": "abc123",
  "filename": "abc123",
  "temporaryUrl": "abc123"
}

EmailEventType

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!)`

{
  "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!)`

{
  "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"
}

EmailVerificationStatus

Fields

Name Description

email(String!)

The email address to be checked.

status(VerificationRequestStatus)

The status of verification for associated email.

{
  "email": "abc123",
  "status": "NOT_SENT"
}

EmbeddedElectricityFiltersOutput

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.

{
  "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

{
  "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.

{
  "id": "abc123",
  "propertyId": "abc123",
  "embeddedNetwork": EmbeddedNetworkType
}

EndContributionAgreement

Output type of the endContributionAgreement mutation.

Fields

Name Description

contributionAgreement(ContributionAgreementType)

The created contribution agreement.

{
  "contributionAgreement": ContributionAgreementType
}

EndMeterDataIssueFlow

Output type of the endMeterDataIssueFlow mutation.

Fields

Name Description

meterDataIssueFlowEnded(EndMeterDataIssueFlowOutputType)

Whether the meter data issue flow was successfully ended.

{
  
}

EndMeterDataIssueFlowOutputType

Output for ending a MeterDataIssueFlow.

Fields

Name Description

flowRunIdentifier(String)

The flow run identifier.

status(MeterDataIssueFlowStatus)

The current status of the meter data issue flow.

{
  "flowRunIdentifier": "abc123",
  "status": "PROCESSING"
}

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

{
  "possibleErrors": [PossibleErrorType]
}

EnrollAccountInLoyaltyProgram

Output type of the enrollAccountInLoyaltyProgram mutation.

Fields

Name Description

outcome(EnrollAccountInLoyaltyProgramOutcome)

Outcome of the loyalty points campaign enrollment.

{
  "outcome": EnrollAccountInLoyaltyProgramOutcome
}

EnrollAccountInLoyaltyProgramOutcome

Fields

Name Description

hasEnrolled(Boolean)

Whether or not this account has been enrolled in the loyalty points campaign.

{
  "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.

{
  "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.

{
  "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.

{
  "message": "abc123",
  "enrollmentProcess": JoinSupplierProcessType
}

EnrolmentType

Details of an ongoing enrolment process.

Fields

Name Description

status(ChangeOfSupplierStatusOptions)

PRE_REGISTRATION can transition to the following statuses:️ INITIATED.

INITIATED can transition to the following statuses:️ REJECTED, PENDING_VALIDATION, CANCELLED, REQUESTED.

PENDINGVALIDATION can transition to the following statuses:️ REQUESTED, REJECTED, CANCELLED, PENDINGCANCELLATION, OBJECTED, PENDING.

REQUESTED can transition to the following statuses:️ PENDING, COMPLETED, OBJECTED, REJECTED, CANCELLED, PENDINGCANCELLATION, PENDINGVALIDATION.

OBJECTED can transition to the following statuses:️ REQUESTED, CANCELLED, PENDINGCANCELLATION, OBJECTIONWITHDRAWN.

REJECTED can transition to the following statuses:️ REJECTED.

WITHDRAWN is a terminal status.

PENDING can transition to the following statuses:️ COMPLETED, CANCELLED, PENDING_CANCELLATION, OBJECTED, REJECTED.

COMPLETED is a terminal status.

CANCELLED is a terminal status.

PENDING_CANCELLATION can transition to the following statuses:️ CANCELLED.

OBJECTION_WITHDRAWN can transition to the following statuses:️ REQUESTED, OBJECTED.

supplyStartDate(Date)

Target date for supply to start.

switchStartDate(Date)

Date the switch started.

{
  "switchStartDate": "2020-01-01",
  "supplyStartDate": "2020-01-01",
  "status": "INITIATED"
}

EnumMappingType

Fields

Name Description

abbreviation(String!)

The abbreviation of the enum.

fullString(String!)

The full string of the enum.

{
  "abbreviation": "abc123",
  "fullString": "abc123"
}

ErrorType

Fields

Name Description

field(String!)

The name of the field that caused the error.

messages([String!]!)

A list of error messages for the field.

{
  "field": "abc123",
  "messages": "abc123"
}

EscalateInkConversation

Output type of the escalateInkConversation mutation.

Fields

Name Description

conversationRelayId(ID!)

The ID of the conversation that was escalated.

{
  "conversationRelayId": "abc123"
}

Estimate

Fields

Name Description

costEstimation(CostEstimation)

The estimated costs calculated.

error(ElectricityCostEstimateErrorUnion)

Error that occurred during estimation.

usageSummary(UsageSummaryType)

Usage summary used to generate this estimate.

{
  "error": ProductDoesNotExist
}

EstimatedMoneyType

Fields

Name Description

costCurrency(String!)

Monetary currency of the statistic in ISO-4217 format.

estimatedAmount(Decimal!)

        Monetary cost of the statistic. This is the smallest unit of currency,
        e.g. cents for USD or yen for JPY. Because electricity is priced as a commodity, we must
        account for fractional cents and this field must be a Decimal. Values from this field should
        likely not be used for accounting purposes.

pricePerUnit(PricePerUnit)

Net price per unit of the statistic if applicable.

{
  "estimatedAmount": "1.0",
  "costCurrency": "abc123",
  "pricePerUnit": PricePerUnit
}

EstimatedSupplyPointReadingType

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.

{
  "intervalStart": "2020-01-01T00:00:00.000Z",
  "intervalEnd": "2020-01-01T00:00:00.000Z",
  "value": "1.0",
  "quality": "abc123",
  "isEstimated": true
}

ExceededMaxSchedulableWorkingDaysErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

ExistingBillingOverMoveInAdjustmentErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

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.

{
  "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

{
  "node": Reading,
  "cursor": "abc123"
}

ExportRepaymentDetailsType

Solar export payment details for a customer account. Solar customers who export electricity to the grid can receive payments for their accumulated export credits. This shows when the next payment will be processed.

Fields

Name	Description
`accountNumber(String!)`	Account number.
`isConfigured(Boolean!)`	Whether export repayment details have been configured for this account. If false, the customer needs to set up their payment method first.
`lastRepaymentDate(Date)`	Date when the last solar export payment was processed. Returns null if no payment has been made yet.
`nextRepaymentDate(Date)`	Date when the next solar export payment will be processed. Returns null if not yet scheduled or no payment is due.
`paymentMethod(String)`	Method of payment for solar export repayments. Can be 'CHEQUE' or 'DIRECT_DEBIT'. Returns null if not configured.

{
  "accountNumber": "abc123",
  "isConfigured": true,
  "nextRepaymentDate": "2020-01-01",
  "lastRepaymentDate": "2020-01-01",
  "paymentMethod": "abc123"
}

ExtendAgreementPeriod

Output type of the extendAgreementPeriod mutation.

Fields

Name Description

agreement(CommonAgreementType)

Agreement that we are going to extend.

{
  "agreement": CommonAgreementType
}

ExternalAccountEvent

Fields

Name	Description
`category(String!)`
`content(JSONString)`
`description(String)`
`eventType(String!)`
`id(ID!)`
`occurredAt(DateTime!)`
`subcategory(String!)`

{
  "id": "abc123",
  "eventType": "abc123",
  "occurredAt": "2020-01-01T00:00:00.000Z",
  "category": "abc123",
  "subcategory": "abc123",
  "description": "abc123",
  "content": {"key": "value"}
}

ExternalAccountEventConnectionTypeConnection

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.

{
  "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

{
  "cursor": "abc123"
}

ExternalAccountUserEvent

Fields

Name	Description
`category(String!)`
`content(JSONString)`
`description(String)`
`eventType(String!)`
`id(ID!)`
`occurredAt(DateTime!)`
`subcategory(String!)`

{
  "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.

{
  "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.

{
  "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.

{
  "url": "abc123",
  "fields": {"key": "value"},
  "key": "abc123"
}

ExtraDetail

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.

{
  "key": "abc123",
  "value": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}

ExtraQuotingParamsType

Fields

Name Description

forecastConsumption([ForecastConsumptionEntryType!])

Forecast consumption entries for this quote configuration.

{
  
}

ExtrasOutput

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.

{
  "label": "abc123",
  "description": "abc123",
  "value": "abc123"
}

FailedDateRangeType

Fields

Name Description

endDate(Date)

The end date of the date range.

reason(String)

The reason the PMD request failed for this date range.

startDate(Date)

The start date of the date range.

{
  "startDate": "2020-01-01",
  "endDate": "2020-01-01",
  "reason": "abc123"
}

FailedPrimaryResidenceValidationErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

FailedToRetrieveQuoteErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

FailedToSwitchProductForAccountErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

FailureStatusCodeInAEMOResponseErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

FetchGeneratePaymentFingerprint

Output type of the fetchGeneratePaymentFingerprint mutation.

Fields

Name Description

fingerprint(String)

Fetched or generated fingerprint from vendor.

vendor(String)

Vendor name.

{
  "fingerprint": "abc123",
  "vendor": "abc123"
}

FetchPreSignedLinkForOpportunityAttachment

Output type of the fetchPreSignedLinkForOpportunityAttachment mutation.

Fields

Name Description

opportunityFileAttachment(OpportunityFileAttachment)

The opportunity file attachment with pre-signed URL.

{
  
}

FieldSpecificRateLimitInformation

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.

{
  "field": "abc123",
  "rate": "abc123",
  "ttl": 1,
  "isBlocked": true
}

FieldSpecificRateLimitInformationConnectionTypeConnection

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.

{
  "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

{
  "node": FieldSpecificRateLimitInformation,
  "cursor": "abc123"
}

FinancialRiskLevelType

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 `0.0` and `1.0`. Higher is worse.

{
  "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.

{
  "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'.

{
  "tokensInvalidated": true,
  "effectiveAt": "2020-01-01T00:00:00.000Z"
}

ForecastConsumptionEntryType

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.

{
  "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.

{
  "accessibilityHidden": true,
  "accessibilityLabel": "abc123",
  "id": "abc123",
  "typename": "abc123",
  "name": "abc123",
  "refreshFrequency": 1,
  "screenData": "abc123"
}

FormSubmissionOuput

Fields

Name Description

content(JSONString)

errors([SerializerFieldErrorsType])

id(Int)

{
  "id": 1,
  "content": {"key": "value"},
  "errors": [SerializerFieldErrorsType]
}

ForwardGroupOutageMfin

Output type of the forwardGroupOutageMfin mutation.

Fields

Name Description

transaction(ChromaTransactionType)

The forwarded MFIN transaction.

{
  
}

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.

{
  "id": "abc123",
  "typename": "abc123",
  "fraction": "1.0"
}

FraudMeterPointCheckType

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.

{
  "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.

{
  "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.

{
  "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

{
  "node": FundingSourceAmountType,
  "cursor": "abc123"
}

FundingSourceAmountType

Fields

Name Description

amount(Int)

Amount used from a funding source in minor currency.

reason(String)

Reason why the funding source was used.

{
  "reason": "abc123",
  "amount": 1
}

FunnelField

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.

{
  "code": "abc123",
  "name": "abc123",
  "fieldType": "STR",
  "textChoices": ["abc123"],
  "textRegex": "abc123",
  "orderInCollection": 1,
  "required": true
}

GasAgreementType

An agreement for gas supply point. Returns rates that are active at the time the GraphQL query was made if the agreement is active. If not return rates that are active at the time the agreement ended.

Fields

Name	Description
`account(AccountType)`	The accounts for this agreement.
`agreedAt(DateTime)`
`agreedFrom(DateTime)`	The datetime the agreement was entered.
`agreedTo(DateTime)`	The datetime the agreement was terminated.
`bestOffer(BestOfferForAgreement)`	Get the best offer for an agreement. Arguments `asOf` (`DateTime`) The date time to calculate the best offer. Defaults to now. `eventSource` (`BestOfferEventSource`) What triggered this calculation. Recorded against the stored calculation, and has no effect on the returned costs. `pricesAsOf` (`DateTime`) The date time to calculate cost details.
`eligibleRebates([RebateType])`	Data about concession rebates that users associated with the agreement are eligible for. Arguments `endAt` (`DateTime`) Include eligibility data ending at this datetime. If this isn't provided, an open-ended range will be used. `rebateAmountEffectiveAt` (`DateTime`) The effective time for rebateCents and percentageDiscount data (defaults to now). `startAt` (`DateTime`) Include eligibility data starting at this datetime. If this isn't provided, an open-ended range will be used.
`id(Int)`	The ID of the agreement.
`isActive(String)`
`isRevoked(Boolean)`	Whether the agreement is revoked.
`meterPoint(GasMeterPointType)`	The meter point for this agreement.
`product(Product)`	The product for this agreement.
`ratesAgreedAt(DateTime)`	The datetime the rates were agreed.
`rescissionDeadlineAt(DateTime)`	The deadline datetime for rescinding the agreement.
`supplyPoint(GasSupplyPointType!)`
`supplyType(String)`
`terminatedAt(DateTime)`
`validFrom(DateTime)`	The start datetime of the agreement.
`validTo(DateTime)`	The end datetime of the agreement.

{
  "id": 1,
  "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",
  "agreedFrom": "2020-01-01T00:00:00.000Z",
  "agreedTo": "2020-01-01T00:00:00.000Z",
  "isRevoked": true,
  "rescissionDeadlineAt": "2020-01-01T00:00:00.000Z",
  "ratesAgreedAt": "2020-01-01T00:00:00.000Z",
  "product": Product,
  "supplyType": "abc123",
  "isActive": "abc123",
  "meterPoint": GasMeterPointType,
  "supplyPoint": GasSupplyPointType,
  "eligibleRebates": [RebateType],
  "bestOffer": BestOfferForAgreement,
  "account": AccountType
}

GasEstimatedUsageAndCostType

Fields

Name	Description
`dailyEstimation(BaseUsageAndCostType!)`	Daily usage and cost estimation.
`failureReasons(String)`	Failure reasons.
`fortnightlyEstimation(BaseUsageAndCostType!)`	Fortnightly usage and cost estimation.
`monthlyEstimation(BaseUsageAndCostType!)`	Monthly usage and cost estimation.
`weeklyEstimation(BaseUsageAndCostType!)`	Weekly usage and cost estimation.
`yearlyEstimation(BaseUsageAndCostType!)`	Yearly usage and cost estimation.

{
  "failureReasons": "abc123",
  "dailyEstimation": BaseUsageAndCostType,
  "weeklyEstimation": BaseUsageAndCostType,
  "fortnightlyEstimation": BaseUsageAndCostType,
  "monthlyEstimation": BaseUsageAndCostType,
  "yearlyEstimation": BaseUsageAndCostType
}

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.

{
  "registerId": "abc123",
  "readingFrequencyType": "RAW_INTERVAL",
  "marketSupplyPointId": "abc123",
  "deviceId": "abc123"
}

GasHouseMoveInFailedErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

GasMeterPointType

Fields

Name	Description
`address(MeterPointAddressType)`
`agreements([AusAgreementInterface])`	A list of agreements belonging to an account that is linked to the logged in user. Arguments `includeInactive` (`Boolean`) Include inactive agreements.
`distributor(ProviderType)`
`energizationStatus(GasEnergizationStatus)`	The physical state of the meter point.
`enrolment(EnrolmentType)`	Details about an enrolment of this meter point. Will be null if no enrolment is taking place.
`id(Int)`	The database identifier of the meter point.
`identifier(String)`	The external identifier for the meter point (NMI for electricity, MIRN for gas).
`isOnSupply(Boolean)`	Whether the meter point is on supply.
`meters([GasMeterType])`	Arguments `id` (`Int`) `includeInactive` (`Boolean`)
`status(String)`
`supplyDetails(SupplyDetailsType)`	Supply details including agreed capacity and connection units.
`supplyEndDate(DateTime)`
`supplyStartDate(DateTime)`
`supplyStatus(KrakenStatus)`	The Financially Responsible Organisation status.
`supplyType(String)`	The fuel/service type for this meter point.

{
  "id": 1,
  "status": "abc123",
  "agreements": AusAgreementInterface,
  "identifier": "abc123",
  "meters": [GasMeterType],
  "supplyType": "abc123",
  "supplyDetails": SupplyDetailsType,
  "enrolment": EnrolmentType,
  "supplyStatus": "OFF_SUPPLY",
  "supplyStartDate": "2020-01-01T00:00:00.000Z",
  "supplyEndDate": "2020-01-01T00:00:00.000Z",
  "isOnSupply": true,
  "energizationStatus": "Registered",
  "distributor": ProviderType,
  "address": MeterPointAddressType
}

GasMeterReadingConnectionTypeConnection

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([GasMeterReadingConnectionTypeEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": GasMeterReadingConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

GasMeterReadingConnectionTypeEdge

A Relay edge containing a GasMeterReadingConnectionType and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(GasMeterReadingType)

The item at the end of the edge

{
  "node": GasMeterReadingType,
  "cursor": "abc123"
}

GasMeterReadingType

A reading from an Australian gas meter, as Kraken receives it from industry.

Fields

Name	Description
`averageHeatingValue(Decimal)`
`consumedEnergy(Decimal)`
`gasMeterUnits(ReadingGasMeterUnits)`
`id(ID!)`
`meter(GasMeterType!)`
`pressureCorrectionFactor(Decimal)`
`readAt(DateTime!)`
`reasonForRead(ReadingReasonForRead)`
`typeOfRead(ReadingTypeOfRead)`
`value(Decimal!)`
`volumeFlow(Decimal)`

{
  "id": "abc123",
  "value": "1.0",
  "readAt": "2020-01-01T00:00:00.000Z",
  "typeOfRead": "A",
  "reasonForRead": "SRF",
  "volumeFlow": "1.0",
  "gasMeterUnits": "M",
  "averageHeatingValue": "1.0",
  "pressureCorrectionFactor": "1.0",
  "consumedEnergy": "1.0",
  "meter": GasMeterType
}

GasMeterType

Fields

Name	Description
`activeFrom(DateTime)`
`activeTo(DateTime)`
`consumption(ConsumptionConnection)`	Energy consumption recorded by the meter. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `grouping` (`ConsumptionGroupings!`) Aggregate consumption according to this grouping. `last` (`Int`) `startAt` (`DateTime!`) Earliest consumption reading to return. Must specify a timezone. `timezone` (`String!`) Timezone to use for grouping.
`consumptionUnits(String)`	The units of consumption for a smart meter.
`currentReadDate(Date)`
`currentReadPressureCorrectionFactor(Decimal)`
`fuelType(String)`	The type of fuel this meter uses.
`id(ID!)`
`installationType(GasMeterInstallationType)`
`kpaValue(Decimal)`
`meterMeasurementUnit(GasMeterMeasurementUnit)`
`meterMultiplier(Decimal)`
`meterReadFrequency(GasMeterReadFrequency)`
`meterType(AusGasMeterType)`
`meterTypeSizeCode(String)`
`nextScheduledReadDate(Date)`
`nextScheduledSpecialRead(Date)`
`numberOfDials(Int)`
`readings(GasMeterReadingConnectionTypeConnection)`	Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `includeQuarantined` (`Boolean`) `last` (`Int`)
`requiresCotFinalReading(Boolean)`	Whether this meter requires a final change of tenancy (COT) reading.
`serialNumber(String!)`
`status(GasMeterStatus)`
`supplyPointIdentifier(String)`

{
  "id": "abc123",
  "serialNumber": "abc123",
  "meterTypeSizeCode": "abc123",
  "kpaValue": "1.0",
  "supplyPointIdentifier": "abc123",
  "numberOfDials": 1,
  "currentReadDate": "2020-01-01",
  "currentReadPressureCorrectionFactor": "1.0",
  "nextScheduledReadDate": "2020-01-01",
  "nextScheduledSpecialRead": "2020-01-01",
  "meterMultiplier": "1.0",
  "activeFrom": "2020-01-01T00:00:00.000Z",
  "activeTo": "2020-01-01T00:00:00.000Z",
  "consumptionUnits": "abc123",
  "requiresCotFinalReading": true,
  "fuelType": "abc123",
  "consumption": ConsumptionConnection,
  "status": "TURNED_ON",
  "meterType": "GAS",
  "installationType": "MASTER_METER",
  "meterMeasurementUnit": "METRIC",
  "meterReadFrequency": "BI_MONTHLY",
  "readings": GasMeterReadingConnectionTypeConnection
}

GasMoveInDatesType

Fields

Name Description

error(GasMoveInDatesErrorUnion)

moveInDates([Date])

{
  "moveInDates": ["2020-01-01"],
  "error": DoesNotExistErrorType
}

GasRateType

Product rates for gas.

Fields

Name	Description
`bandCategory(BandCategory)`	Category of band associated with a product rate.
`bandSubcategory(String)`	Subcategory of band associated with a product rate.
`currency(String)`
`id(ID)`	ID associated with gas product rate.
`pricePerUnit(Decimal!)`	Price in cents per unit.
`pricingZone(PricingZoneType)`	Gas pricing zone.
`rateDescription(String)`	Description that will show up on the customer's bill.
`rateExcludingTax(Float)`	Unit cost before tax.
`rateIncludingTax(Float)`	Unit cost including tax.
`stepEnd(Float)`	End of the step the rate applies to (Exclusive).
`stepStart(Float)`	Start of the step the rate applies to.
`unitType(UnitType!)`	What the rate is for, e.g. kWh of electricity, MJ or Units of gas, or days on supply.
`validFrom(DateTime)`
`validTo(DateTime)`

{
  "currency": "abc123",
  "pricePerUnit": "1.0",
  "bandCategory": "STANDING_CHARGE",
  "bandSubcategory": "abc123",
  "rateExcludingTax": 1.0,
  "rateIncludingTax": 1.0,
  "rateDescription": "abc123",
  "unitType": "DAYS_ON_SUPPLY",
  "validFrom": "2020-01-01T00:00:00.000Z",
  "validTo": "2020-01-01T00:00:00.000Z",
  "stepStart": 1.0,
  "stepEnd": 1.0,
  "id": "abc123",
  "pricingZone": PricingZoneType
}

GasServiceOrderType

Fields

Name	Description
`chargeRecords(ServiceOrderChargeRecordConnectionTypeConnection)`	Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`meterPoint(MeterPointType)`
`orderNumber(String)`
`responseCode(String)`
`scheduledDate(Date)`
`serviceOrder(Int)`
`status(ServiceOrderStatus)`
`type(JobEnquiryCodeChoices)`

{
  "orderNumber": "abc123",
  "status": "PENDING",
  "meterPoint": MeterPointType,
  "serviceOrder": 1,
  "responseCode": "abc123",
  "scheduledDate": "2020-01-01",
  "chargeRecords": ServiceOrderChargeRecordConnectionTypeConnection,
  "type": "ATTACH_LOCKS_OR_PLUGS_TO_METER_FOR_DEBT"
}

GasSpecialReadType

Fields

Name	Description
`chargeRecords(ServiceOrderChargeRecordConnectionTypeConnection)`	Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`meterPoint(MeterPointType)`
`orderNumber(String)`
`responseCode(String)`
`scheduledDate(Date)`
`serviceOrder(Int)`
`status(ServiceOrderStatus)`
`type(SpecialReadReasonCodeChoices)`

{
  "orderNumber": "abc123",
  "status": "PENDING",
  "meterPoint": MeterPointType,
  "serviceOrder": 1,
  "responseCode": "abc123",
  "scheduledDate": "2020-01-01",
  "chargeRecords": ServiceOrderChargeRecordConnectionTypeConnection,
  "type": "FINAL_READ"
}

GasSupplyPointType

Fields

Name	Description
`externalIdentifier(String)`	The external identifier of the supply point.
`id(ID!)`	The unique identifier of the supply point.
`marketName(String!)`	The market this supply point belongs to.
`meterPoint(MeterPointInterface)`	The meter point associated with this supply point.
`property(PropertyType)`	The property associated with this supply point.

{
  "id": "abc123",
  "marketName": "abc123",
  "property": PropertyType,
  "meterPoint": MeterPointInterface,
  "externalIdentifier": "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.

{
  
}

GenerateExternalMessagingUploadUrl

Output type of the generateExternalMessagingUploadUrl mutation.

Fields

Name Description

postRequest(ExternalMessagingUploadPostRequest)

The presigned POST request details for uploading the file to S3.

{
  
}

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.

{
  "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.

{
  
}

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.

{
  
}

GenerateOrganisationFileUploadPreSignedUrl

Output type of the generateOrganisationFileUploadPreSignedUrl mutation.

Fields

Name Description

organisationFileUploadPreSignedUrl(OrganisationFileUploadPresignedPostType)

Fields required to POST the file directly to S3.

{
  
}

GeneratePreSignedToken

Output type of the generatePreSignedToken mutation.

Fields

Name Description

scope(PreSignedTokenScope)

token(String)

tokenExpiryDatetime(DateTime)

{
  "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.

{
  "name": "abc123",
  "refreshFrequency": 1,
  "screenData": "abc123"
}

GetEmbeddedSecretForNewPaymentInstruction

Output type of the getEmbeddedSecretForNewPaymentInstruction mutation.

Fields

Name Description

secretKey(String)

A secret token used to initialize an embedded payment form.

{
  "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.

{
  "secretKey": "abc123"
}

GetGroupOutageDetails

Fields

Name	Description
`duration(String)`	Start duration of the Group Outage.
`endDateTime(DateTime)`	End time of the Group Outage.
`groupWorkRequestOsj(String)`	The external reference of the latest on-site job work request for this Group Outage.
`initiatingParticipantId(String)`	Initiating Participant ID of the Service Order that resulted in the Group Outage.
`nmiDetails([NmiDetails])`	Information regarding the NMIs which belong to this Group Outage.
`number(String)`	The Group Outage number to get details for.
`outageType(String)`	The type of the Group Outage.
`startDateTime(DateTime)`	Start time of the Group Outage.
`status(String)`	The status of the Group Outage.
`triggerNmi(String)`	NMI that resulted in the Group Outage.
`triggerParticipant(String)`	MC Participant linked to the Group Outage.
`triggerServiceOrder(String)`	Service Order number of the Service Order that resulted in the Group Outage.
`triggerServiceOrderOsj(String)`	The external reference of the latest on-site job work request for the trigger service order of this Group Outage.

{
  "number": "abc123",
  "outageType": "abc123",
  "status": "abc123",
  "startDateTime": "2020-01-01T00:00:00.000Z",
  "endDateTime": "2020-01-01T00:00:00.000Z",
  "duration": "abc123",
  "triggerServiceOrder": "abc123",
  "initiatingParticipantId": "abc123",
  "triggerNmi": "abc123",
  "triggerParticipant": "abc123",
  "groupWorkRequestOsj": "abc123",
  "triggerServiceOrderOsj": "abc123"
}

GetHostedUrlForNewPaymentInstruction

Output type of the getHostedUrlForNewPaymentInstruction mutation.

Fields

Name Description

url(String)

URL at which payment instruction can be set up.

{
  "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).

{
  "created": true,
  "agreement": CommonAgreementType
}

GoodsGrant

Fields

Name	Description
`currency(String)`	Currency.
`grossAmount(Float)`	Gross amount.
`netAmount(Float)`	Net amount.
`type(String)`	Grant type.

{
  "type": "abc123",
  "netAmount": 1.0,
  "grossAmount": 1.0,
  "currency": "abc123"
}

GoodsProduct

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.

{
  "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"
}

GoodsProductConnectionTypeConnection

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.

{
  "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

{
  "node": GoodsProduct,
  "cursor": "abc123"
}

GoodsProductType

Fields

Name Description

code(String)

Product type code.

internalName(String)

Product type name.

{
  "code": "abc123",
  "internalName": "abc123"
}

GoodsPurchase

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. Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A' - Marked as deprecated on 2024-10-22. - Scheduled for removal on or after 2025-06-25.
`ledgerNumber(String)`	The ledger number associated to the purchase.
`marketName(String!)`	Market name of the purchase.
`marketParams(JSONString)`	Market parameters of the purchase.

{
  "code": "abc123",
  "ledgerId": "abc123",
  "ledgerNumber": "abc123",
  "goodsSaleItems": [GoodsSaleItem],
  "goodsGrants": [GoodsGrant],
  "marketName": "abc123",
  "marketParams": {"key": "value"},
  "clientParams": {"key": "value"}
}

GoodsQuote

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.

{
  "id": "abc123",
  "code": "abc123",
  "totalNetAmount": 1,
  "quotedAt": "2020-01-01T00:00:00.000Z",
  "goodsQuotedProducts": [GoodsQuotedProduct],
  "hasQuoteExpired": true
}

GoodsQuoteShare

Fields

Name Description

id(ID)

The ID of the quote share.

{
  "id": "abc123"
}

GoodsQuotedProduct

Fields

Name	Description
`currency(String)`	Currency.
`netAmount(Int)`	Net amount.
`numberOfUnits(Int)`	Number of units.
`pricePerUnit(Int)`	Price per unit.
`product(String)`	Product code.

{
  "product": "abc123",
  "numberOfUnits": 1,
  "pricePerUnit": 1,
  "netAmount": 1,
  "currency": "abc123"
}

GoodsSaleItem

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.

{
  "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.

{
  "roleCode": "abc123"
}

GroupOutageCreationType

Fields

Name	Description
`number(String!)`	The Group Outage number.
`outageType(String)`	The Group Outage's outage type.
`status(String)`	The Group Outage's current status.
`triggerNmi(String)`	The NMI which triggered the Group Outage.
`triggerParticipant(String)`	The Participant which triggered the Group Outage.
`triggerServiceOrder(String)`	The Service Order which triggered the Group Outage.

{
  "number": "abc123",
  "outageType": "abc123",
  "status": "abc123",
  "triggerServiceOrder": "abc123",
  "triggerNmi": "abc123",
  "triggerParticipant": "abc123"
}

GroupOutageStatusType

Fields

Name Description

number(String)

The Group Outage number.

status(String)

The Group Outage's current status.

{
  "number": "abc123",
  "status": "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.

{
  "identifier": "abc123",
  "internalName": "abc123",
  "customerName": "abc123",
  "customerDescription": "abc123",
  "minCardinality": 1,
  "maxCardinality": 1
}

GuaranteeOfOriginConfigurationType

Configuration for Guarantee of Origin term, defining percentage of energy from renewable sources.

Fields

Name	Description
`description(NonEmptyString)`	The description of the term.
`displayName(NonEmptyString)`	The display name of the term.
`guaranteeOfOriginPercentage(GuaranteeOfOriginPercentage)`	The percentage of the guarantee of origin.
`identifier(NonEmptyString)`	The identifier of the term.
`isVariable(Boolean)`	Whether the term is variable.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "guaranteeOfOriginPercentage": "ZERO"
}

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!)`

{
  "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"
}

HasFamilyIssues

Output type of the hasFamilyIssues mutation.

Fields

Name Description

accountUser(AccountUserType)

The updated account user.

{
  "accountUser": AccountUserType
}

HeldStatus

Fields

Name Description

isHeld(Boolean)

Whether a statement is currently held.

reason(String)

Reason for statement being held.

{
  "isHeld": true,
  "reason": "abc123"
}

HouseMoveInCancelExceptionErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

HouseMoveLeaveSupplierProcess

Fields

Name Description

joinSupplierProcessNumber(String!)

The join supplier process number, e.g. JS-12345678.

leaveSupplierProcessNumber(String!)

The number of the leave supplier process linked to the join supplier process by a house move, e.g. LS-12345678.

{
  "joinSupplierProcessNumber": "abc123",
  "leaveSupplierProcessNumber": "abc123"
}

HouseMoveOutHasBeenPerformedErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

HouseMoveProblemsErrorType

Fields

Name Description

message(String!)

problems([AcquisitionProblemType]!)

A list of problems that blocked the move in.

{
  "message": "abc123",
  "problems": AcquisitionProblemType
}

IdentificationType

Fields

Name Description

discoveryStatus(Status)

Current status of discovery.

marketIdentifier(String)

The market identifier discovered.

reference(String)

The discovery process reference.

{
  "reference": "abc123",
  "marketIdentifier": "abc123",
  "discoveryStatus": "SKIPPED"
}

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.

{
  "width": FractionSizeType,
  "mediaUrl": "abc123",
  "horizontalAlignment": "START",
  "accessibilityHidden": true,
  "accessibilityLabel": "abc123",
  "id": "abc123",
  "typename": "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.

{
  "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

{
  "node": Reading,
  "cursor": "abc123"
}

ImportTrancheRate

Output type of the importTrancheRate mutation.

Fields

Name Description

rateIdentifier(ID)

Unique identifier that references the new tranche rate.

{
  "rateIdentifier": "abc123"
}

InboundCallAverageWaitTimeForAttributesType

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:

KT-CT-11821: No calls found matching the given routing attributes.
KT-CT-1113: Disabled GraphQL field requested.

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:

KT-CT-11821: No calls found matching the given routing attributes.
KT-CT-1113: Disabled GraphQL field requested.

{
  "yesterday": 1,
  "recent": 1
}

InboundCallAverageWaitTimeType

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.

{
  "yesterday": 1,
  "recent": 1
}

InboundCallType

Fields

Name	Description
`account(AccountType)`	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.

{
  "id": "abc123",
  "account": AccountType
}

IndexationOptionsType

Fields

Name Description

escalationStartAt(DateTime)

The escalation start date for the product rate override configuration.

indexCode(String)

The index code for the product rate override configuration.

{
  "indexCode": "abc123",
  "escalationStartAt": "2020-01-01T00:00:00.000Z"
}

InitializeAccountResult

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.

{
  "isNewAccount": true,
  "accountNumber": "abc123"
}

InitializeUserResult

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.

{
  "isNewUser": true,
  "userNumber": "abc123"
}

InitiateAgreementRescission

Output type of the initiateAgreementRescission mutation.

Fields

Name Description

agreementRescission(AgreementRescissionType)

The new agreement rescission instance.

{
  
}

InitiateHostedStandalonePayment

Output type of the initiateHostedStandalonePayment mutation.

Fields

Name Description

payment(InitiateHostedStandalonePaymentOutput)

The details required to refer to and complete a hosted payment.

{
  "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.

{
  "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.

{
  "productCode": "abc123",
  "switchDate": "2020-01-01"
}

InitiateStandalonePayment

Output type of the initiateStandalonePayment mutation.

Fields

Name Description

payment(InitiateStandalonePaymentOutput)

The initiated standalone payment details.

{
  "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.

{
  "retrievalToken": "abc123",
  "secretToken": "abc123"
}

InkBucket

Fields

Name Description

icon(String)

The icon code point.

id(ID!)

The ID of the object

name(String!)

The ink bucket name.

{
  "id": "abc123",
  "name": "abc123",
  "icon": "abc123"
}

InkContactChannelIdentities

Fields

Name Description

all([InkContactChannelIdentity!]!)

All contacts for this conversation.

default(InkContactChannelIdentity)

The default contact for this conversation.

{
  "default": InkContactChannelIdentity,
  "all": InkContactChannelIdentity
}

InkContactChannelIdentity

Fields

Name Description

channel(InkCommunicationChannel!)

The channel of the contact.

displayName(String!)

The name to display to the user.

handle(String!)

The handle.

{
  "channel": "EMAIL",
  "handle": "abc123",
  "displayName": "abc123"
}

InkConversation

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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`id(ID!)`
`lastMessageAt(DateTime)`	The timestamp of the most recent message in the conversation.
`relayId(ID!)`	The relay ID of the conversation.
`status(InkConversationStatus!)`	The status of the conversation.
`tags([InkTag!])`	The tags on the conversation.

{
  "id": "abc123",
  "relayId": "abc123",
  "status": "OPEN",
  "contactChannelIdentities": InkContactChannelIdentities,
  "accountUsers": [AccountUserType],
  "accountNumber": "abc123",
  "events": InkConversationEventsConnection,
  "lastMessageAt": "2020-01-01T00:00:00.000Z"
}

InkConversationEventsConnection

Fields

Name Description

edges([InkConversationEventsEdge!]!)

Contains the nodes in this connection.

pageInfo(PageInfo!)

Pagination data for this connection.

{
  "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

{
  "node": InkNewMessage,
  "cursor": "abc123"
}

InkConversationsConnection

Fields

Name Description

edges([InkConversationsEdge!]!)

Contains the nodes in this connection.

pageInfo(PageInfo!)

Pagination data for this connection.

{
  "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

{
  "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.

{
  "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.

{
  "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.

{
  "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.

{
  "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.

{
  "id": "abc123",
  "direction": "INBOUND",
  "fromHandle": "abc123",
  "toHandle": "abc123",
  "delivery": InkMessageDelivery,
  "contactChannelIdentity": InkContactChannelIdentity,
  "occurredAt": "2020-01-01T00:00:00.000Z",
  "displayContent": "abc123"
}

InkMessageAttachment

Fields

Name Description

fetchUrl(String)

The url for fetching the attachment.

filename(String!)

The filename.

sizeInBytes(Int)

The size in bytes.

{
  "filename": "abc123",
  "fetchUrl": "abc123",
  "sizeInBytes": 1
}

InkMessageAttributes

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.

{
  "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
}

InkMessageDelivery

Fields

Name Description

status(InkMessageDeliveryStatus!)

Message delivery status.

{
  "status": "PENDING"
}

InkNewMessage

Fields

Name Description

message(InkMessage!)

The message.

occurredAt(DateTime!)

The time the conversation event occurred.

{
  "occurredAt": "2020-01-01T00:00:00.000Z",
  "message": InkEmail
}

InkNote

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.

{
  "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.

{
  "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.

{
  "direction": "INBOUND",
  "fromHandle": "abc123",
  "toHandle": "abc123",
  "delivery": InkMessageDelivery,
  "contactChannelIdentity": InkContactChannelIdentity,
  "occurredAt": "2020-01-01T00:00:00.000Z",
  "displayContent": "abc123",
  "isChannelSms": true
}

InkStoryline

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!)`

{
  "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"
}

InkStorylineAnalyzerResult

Fields

Name	Description
`analyzerType(String!)`
`createdAt(DateTime!)`
`data(JSONString!)`
`id(ID!)`	The ID of the object
`schemaVersion(String!)`
`updatedAt(DateTime!)`

{
  "id": "abc123",
  "analyzerType": "abc123",
  "schemaVersion": "abc123",
  "data": {"key": "value"},
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

InkStorylineEntry

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.

{
  "id": "abc123",
  "entryType": "abc123",
  "occurredAt": "2020-01-01T00:00:00.000Z",
  "content": "abc123",
  "url": "abc123",
  "contentId": 1,
  "isRootCause": true
}

InkTag

Fields

Name Description

id(ID!)

The ID of the object

name(String!)

Tag for a message.

{
  "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.

{
  "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.

{
  "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.

{
  "inputFieldKey": "abc123",
  "inputFieldValue": "abc123",
  "errorMessage": "abc123"
}

InstalmentScheduleType

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.

{
  "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.

{
  
}

InstigateLeaveSupplierForCollectionProcessOutputType

Fields

Name Description

leaveSupplierProcessNumber(String)

The number of the leave supplier process that was instigated.

{
  "leaveSupplierProcessNumber": "abc123"
}

IntegerCharacteristicValueType

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.

{
  "value": "abc123",
  "characteristic": CharacteristicType,
  "integerValue": 1
}

IntegerType

Graphene type object to represent integer values

Fields

Name Description

integerValue(Int!)

Value of this field.

{
  "integerValue": 1
}

InternalCompanyConnectionTypeConnection

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.

{
  "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

{
  "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.

{
  "id": "abc123",
  "displayableNumber": "abc123",
  "name": "abc123",
  "primaryRegistrationNumber": "abc123",
  "secondaryRegistrationNumber": "abc123",
  "primaryTaxIdentifierNumber": "abc123",
  "legalAddress": RichAddressType
}

IntervalMeasurementType

Fields

Name	Description
`accumulation(Decimal)`	Deprecated The 'accumulation' field is deprecated. This field is no longer required. - Marked as deprecated on 2024-10-15. - Scheduled for removal on or after 2024-11-01.
`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.

{
  "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"
}

InvalidAddonErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidContactDetails

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidDiscoveryRequestErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidLoyaltyCardNumberError

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidPrimaryResidenceEndDateErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidPrimaryResidenceFromDateErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidStatusForRescheduleErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidSupplyPointDateErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidTimezoneReadAtDateValidationErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidTransactionErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidUserID

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidVendorForRescheduleErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidWithdrawalRequestErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

InvalidatePaymentInstruction

Output type of the invalidatePaymentInstruction mutation.

Fields

Name Description

instruction(InvalidatePaymentInstructionOutput)

The invalidated payment instruction.

{
  "instruction": InvalidatePaymentInstructionOutput
}

InvalidatePaymentInstructionOutput

Output for invalidating an arbitrary payment instruction.

Fields

Name Description

id(Int)

The ID of the invalidated payment instruction.

{
  "id": 1
}

InvalidatePreSignedToken

Output type of the invalidatePreSignedToken mutation.

Fields

Name Description

token(PreSignedToken)

{
  "token": PreSignedToken
}

InvalidatePreSignedTokensForUser

Output type of the invalidatePreSignedTokensForUser mutation.

Fields

Name Description

tokens([PreSignedToken])

{
  "tokens": [PreSignedToken]
}

InvalidateRefreshToken

Output type of the invalidateRefreshToken mutation.

Fields

Name Description

token(RefreshToken)

{
  
}

InvalidateRefreshTokensForUser

Output type of the invalidateRefreshTokensForUser mutation.

Fields

Name Description

tokens([RefreshToken])

{
  
}

InvoiceBillingDocumentConnectionTypeConnection

An invoice is a bill that contains individual transactions (i.e. charges, credits, payments, and repayments). These may come from any period of time.

Fields

Name	Description
`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.

{
  "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

{
  "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. This field name is ambiguous and inconsistently populated. Use `paymentDate` for the date on which payment will be collected. Use `dueDate` for the last date any payment can be made before the bill is considered overdue. - Marked as deprecated on 2026-06-15. - Scheduled for removal on or after 2027-08-15.
`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 `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `orderBy` (`TransactionsOrderBy`) The order in which to return the transactions.
`uuid(UUID)`	Unique identifier for the invoice billing document.

{
  "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"
}

InvoiceTotalType

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).

{
  "netTotal": 1,
  "taxTotal": 1,
  "grossTotal": 1
}

InvoiceType

Fields

Name	Description
`attachments(BillingAttachmentConnectionTypeConnection)`	Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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)`	Arguments `after` (`String`) `before` (`String`) `code` (`String`) The code of a representation. Used to identify different types of representations. `first` (`Int`) `last` (`Int`)
`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. This field is deprecated. Use the 'attachments' field instead. - Marked as deprecated on 2024-09-16. - Scheduled for removal on or after 2025-09-01.
`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 `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `ledgerNumber` (`String`) When provided, only entries that are linked to that ledger are returned. `orderBy` (`TransactionsOrderBy`) The order in which to return the transactions. `transactionTypes` (`[TransactionTypeFilter]`) Include only these specific transaction types in the result.
`uuid(UUID)`	Unique identifier for the billing document.

{
  "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.

{
  "success": true
}

JoinSupplierLedgerAssignmentConnectionTypeConnection

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.

{
  "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

{
  "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.

{
  "ledgerNumber": "abc123",
  "ledgerType": "abc123",
  "ledgerName": "abc123",
  "ledgerSupplyPoints": [LedgerSupplyPointType]
}

JoinSupplierProcessConnectionTypeConnection

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.

{
  "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

{
  "node": JoinSupplierProcessType,
  "cursor": "abc123"
}

JoinSupplierProcessDataType

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.

{
  "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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`number(String)`	The unique identifier of the process.
`orderNumber(ID)`	The external order number that originated this process, or null if no unique order is linked.
`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. Please use 'supplyPointsInterface' instead. It returns SupplyPointInterfaceConnection, whose node is CommonSupplyPointInterface, and supports inline fragments (e.g. `... on WaterSupplyPointType`, `... on ElectricitySupplyPointType`). - Marked as deprecated on 2026-07-23. - Scheduled for removal on or after 2027-01-23. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`supplyPointsInterface(SupplyPointInterfaceConnection!)`	The supply points associated with the process. Node type is the CommonSupplyPointInterface; use inline fragments (e.g. `... on WaterSupplyPointType`, `... on ElectricitySupplyPointType`) to access concrete types. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`triggeredLeaveProcesses([LeaveSupplierProcessType])`	Leave supplier processes triggered by this join supplier process, e.g. from a house move.

{
  "id": "abc123",
  "status": "PENDING",
  "supplyPoints": SupplyPointConnectionTypeConnection,
  "supplyPointsInterface": SupplyPointInterfaceConnection,
  "number": "abc123",
  "orderNumber": "abc123",
  "subtype": "abc123",
  "contractReferences": ContractReferencesType,
  "currentProcessData": JoinSupplierProcessDataType,
  "ledgerAssignments": JoinSupplierLedgerAssignmentConnectionTypeConnection,
  "stage": "abc123",
  "triggeredLeaveProcesses": [LeaveSupplierProcessType]
}

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.

{
  "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.

{
  "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.

{
  "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.

{
  "number": "abc123",
  "SHA": "abc123",
  "isPinned": true
}

LNSPTariffPeriodType

Fields

Name Description

lnspId(String)

The LNSP id (Local Network Service Provider).

tariffPeriods([TariffPeriodType])

Tariff periods for this rate and LNSP.

{
  "lnspId": "abc123",
  "tariffPeriods": [TariffPeriodType]
}

LNSPType

Fields

Name	Description
`displayName(String!)`	The customer-facing display name of the provider.
`emergencyPhoneNumber(String!)`	The emergency contact phone number for the provider.
`id(String!)`	The AEMO participant identifier code for this provider.
`longName(String!)`	The full registered name of the provider.
`outagePhoneNumber(String)`	The outage reporting phone number for the provider.
`shortName(String!)`	The abbreviated name of the provider.

{
  "id": "abc123",
  "shortName": "abc123",
  "longName": "abc123",
  "displayName": "abc123",
  "emergencyPhoneNumber": "abc123",
  "outagePhoneNumber": "abc123"
}

LatePaymentFeesType

Represents later payment fees to be applied in a contract.

Fields

Name	Description
`description(NonEmptyString)`	The description of the term.
`displayName(NonEmptyString)`	The display name of the term.
`flatFeeAmount(Int)`	The flat fee amount for late payment.
`identifier(NonEmptyString)`	The identifier of the term.
`interestPolicyName(String)`	The interest policy to use for late payment fee calculations.
`isVariable(Boolean)`	Whether the term is variable.
`percentageFee(Decimal)`	The percentage fee for late payment.
`percentageIntervalDays(Int)`	The interval in days for the percentage fee (1=daily, 7=weekly, 30=monthly, 365=yearly).
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "flatFeeAmount": 1,
  "percentageFee": "1.0",
  "percentageIntervalDays": 1,
  "interestPolicyName": "abc123"
}

Lead

Fields

Name	Description
`assignedToOrganization(AffiliateOrganisationType)`	Affiliate organization assigned to this lead. Deprecated The 'assignedToOrganization' field is deprecated. Please use 'assignedToTeamIdentifier' instead. - Marked as deprecated on 2026-05-07. - Scheduled for removal on or after 2026-07-07.
`assignedToTeamIdentifier(String)`	The identifier of the team the lead is assigned to. Deprecated The 'assignedToTeamIdentifier' field is deprecated. Lead-level assignment is being removed. Assignment is managed at Opportunity level. - Marked as deprecated on 2026-05-19. - Scheduled for removal on or after 2026-07-19.
`assignedToUserIdentifier(String)`	The identifier of the user the lead is assigned to. Deprecated The 'assignedToUserIdentifier' field is deprecated. Lead-level assignment is being removed. Assignment is managed at Opportunity level. - Marked as deprecated on 2026-05-19. - Scheduled for removal on or after 2026-07-19.
`assignedToUsername(String)`	The username of the user the lead is assigned to. Deprecated The 'assignedToUsername' field is deprecated. Please use 'assignedToUserIdentifier' instead. - Marked as deprecated on 2026-04-22. - Scheduled for removal on or after 2026-06-22.
`contacts([LeadContactDetailsType])`	The contacts for the lead. Arguments `input` (`LeadContactDetailsFiltersInput`) 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. Please use 'leadContact.nationalId' instead. - Marked as deprecated on 2026-06-10. - Scheduled for removal on or after 2026-09-10.
`number(String!)`	Lead number.
`opportunities([OpportunityOutput])`	List of opportunities for the lead. Arguments `input` (`OpportunitiesQueryInput`) Input fields for retrieving opportunities.
`salesChannel(SalesChannelType)`	The sales channel that this lead was captured by. Deprecated The 'salesChannel' field is deprecated. Sales channel information is being removed from the Lead model. This is information is saved in the Opportunity. - Marked as deprecated on 2025-06-17. - Scheduled for removal on or after 2025-10-17.
`salesFunnel(SalesFunnel)`	The sales funnel this lead is in.
`stage(SalesFunnelStage)`	The current stage of the sales funnel that this lead is in.

{
  "number": "abc123",
  "nationalId": "abc123",
  "leadType": "abc123",
  "assignedToUsername": "abc123",
  "assignedToUserIdentifier": "abc123",
  "assignedToTeamIdentifier": "abc123"
}

LeadBlockListValidationOutput

Fields

Name Description

blockListHits([String])

List of block list hits found.

valid(Boolean)

Indicates if the block list validation passed.

{
  "valid": true,
  "blockListHits": ["abc123"]
}

LeadContactDetailsType

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.

{
  "givenName": "abc123",
  "familyName": "abc123",
  "email": "abc123",
  "phoneNumber": "abc123",
  "nationalId": "abc123",
  "landlineNumber": "abc123",
  "roles": "ACCOUNT_HOLDER",
  "preferredLanguage": "abc123",
  "contactAddress": RichAddressType,
  "consents": [ConsentOutput]
}

LeadIdType

Fields

Name Description

number(String!)

The number of the lead.

{
  "number": "abc123"
}

LeadOutput

Fields

Name	Description
`accountNumber(String)`	Lead's linked account number.
`assignedToTeam(String)`	Team assigned to this lead. Deprecated The 'assignedToTeam' field is deprecated. Please use 'assignedToTeamIdentifier' instead. - Marked as deprecated on 2026-04-22. - Scheduled for removal on or after 2026-06-22.
`assignedToUser(String)`	User assigned to this lead. Deprecated The 'assignedToUser' field is deprecated. Please use 'assignedToUserIdentifier' instead. - Marked as deprecated on 2026-04-22. - Scheduled for removal on or after 2026-06-22.
`billingAddress(AddressOutput)`	Lead billing address. Deprecated The 'billingAddress' field is deprecated. Please use 'contactAddress' on the lead contact with the ACCOUNT_HOLDER role instead. - Marked as deprecated on 2026-06-18. - Scheduled for removal on or after 2026-09-18.
`billingName(String)`	Lead billing name. Deprecated The 'billingName' field is deprecated. Please use 'givenName' and 'familyName' on the lead contact with the ACCOUNT_HOLDER role instead. - Marked as deprecated on 2026-06-18. - Scheduled for removal on or after 2026-09-18.
`billingRichAddress(RichAddressType)`	Lead billing rich address. Deprecated The 'billingRichAddress' field is deprecated. Please use 'contactAddress' on the lead contact with the ACCOUNT_HOLDER role instead. - Marked as deprecated on 2026-06-18. - Scheduled for removal on or after 2026-09-18.
`brand(String)`	Lead brand.
`contacts([LeadContactDetailsType])`	The contacts for the lead. Arguments `input` (`LeadContactDetailsFiltersInput`) 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. Please use 'leadContact.nationalId' instead. - Marked as deprecated on 2026-06-10. - Scheduled for removal on or after 2026-09-10.
`number(String)`	Lead number.
`phoneNumber(String)`	Lead account holder mobile number.
`salesChannel(String)`	Lead sales channel. Deprecated The 'salesChannel' field is deprecated. Sales channel information is being removed from the Lead model. This is information is saved in the Opportunity. - Marked as deprecated on 2025-06-17. - Scheduled for removal on or after 2025-10-17.
`stage(String)`	Current stage in a funnel.

{
  "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"
}

LeadSupplyPointType

Fields

Name Description

externalIdentifier(String)

Supply point identifier.

industryData([SupplyPointIndustryDataItemType])

Industry data for the supply point, derived from the stored payload. Always null on the base type; clients opt in via a type override.

marketName(String)

Market code of the supply point.

{
  "externalIdentifier": "abc123",
  "marketName": "abc123"
}

LeadType

Fields

Name Description

number(String!)

The lead number.

{
  "number": "abc123"
}

LeadsConnection

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.

{
  "pageInfo": PageInfo,
  "edges": LeadsEdge,
  "totalCount": 1,
  "edgeCount": 1
}

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

{
  "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.

{
  "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.

{
  "key": "abc123",
  "bucket": "abc123",
  "preSignedUrl": "abc123",
  "fields": {"key": "value"}
}

LeavePropertyProcessConnectionTypeConnection

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.

{
  "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

{
  "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. Please use 'supplyPointsInterface' instead. It returns SupplyPointInterfaceConnection, whose node is CommonSupplyPointInterface, and supports inline fragments (e.g. `... on WaterSupplyPointType`, `... on ElectricitySupplyPointType`). - Marked as deprecated on 2026-07-23. - Scheduled for removal on or after 2027-01-23. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`supplyPointsInterface(SupplyPointInterfaceConnection!)`	The supply points associated with the process. Node type is the CommonSupplyPointInterface; use inline fragments (e.g. `... on WaterSupplyPointType`, `... on ElectricitySupplyPointType`) to access concrete types. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)

{
  "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.

{
  "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.

Process IDs are deprecated, please use 'number' instead.

- Marked as deprecated on 2025-08-06.
- Scheduled for removal on or after 2025-09-30.

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.

{
  "number": "abc123",
  "leaveSupplierProcessId": "abc123",
  "message": "abc123"
}

LeaveSupplierProcessConnectionTypeConnection

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.

{
  "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

{
  "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
`accountNumber(String)`	The account number of the account associated with this leave supplier process.
`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. Please use 'supplyPointsInterface' instead. It returns SupplyPointInterfaceConnection, whose node is CommonSupplyPointInterface, and supports inline fragments (e.g. `... on WaterSupplyPointType`, `... on ElectricitySupplyPointType`). - Marked as deprecated on 2026-07-23. - Scheduled for removal on or after 2027-01-23. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`supplyPointsInterface(SupplyPointInterfaceConnection!)`	The supply points associated with the process. Node type is the CommonSupplyPointInterface; use inline fragments (e.g. `... on WaterSupplyPointType`, `... on ElectricitySupplyPointType`) to access concrete types. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)

{
  "id": "abc123",
  "status": "PENDING",
  "number": "abc123",
  "supplyPoints": SupplyPointConnectionTypeConnection,
  "supplyPointsInterface": SupplyPointInterfaceConnection,
  "subtype": "abc123",
  "stage": "abc123",
  "accountNumber": "abc123"
}

LeaveSupplierReversed

Output of a LeaveSupplier journey reversal.

Fields

Name Description

message(String!)

The message to display to the user on reversal.

{
  "message": "abc123"
}

LeaveSupplierUpdated

Leave supplier was successfully updated.

Fields

Name Description

message(String!)

The message to display to the user on leave supplier update.

{
  "message": "abc123"
}

LedgerDebtPositionType

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.

{
  "ledgerNumber": "abc123",
  "delinquentDebtAmount": 1,
  "status": "OK"
}

LedgerPaymentScheduleType

An object that represents when we have agreed to take payments from a payment instruction.

Fields

Name	Description
`id(ID!)`
`isVariablePaymentAmount(Boolean!)`
`paymentAdequacyAdjustment(Int)`
`paymentAdequacyAdjustmentExpiryDate(Date)`
`paymentAmount(Int!)`
`paymentDay(Int)`
`paymentFrequency(PaymentSchedulePaymentFrequency!)`
`paymentFrequencyMultiplier(Int!)`
`paymentHolidayReason(String!)`
`reason(PaymentScheduleReason!)`
`validFrom(Date!)`
`validTo(Date)`

{
  "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
}

LedgerSupplyPointType

Fields

Name Description

externalIdentifier(String)

Supply point external identifier. Empty string if not set.

marketName(String)

Market name for the supply point.

{
  "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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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: KT-CT-9709: Billing trigger configuration only supports SupplementaryLedger type. KT-CT-1113: Disabled GraphQL field requested.
`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. Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A' - Marked as deprecated on 2024-10-22. - Scheduled for removal on or after 2025-06-25.
`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 `after` (`String`) `before` (`String`) `excludeExternallyIssued` (`Boolean`) Exclude invoices that were issued by external systems. Does not apply to legacy bills. `first` (`Int`) `invoiceId` (`Int`) The id of the invoice. `last` (`Int`) `orderBy` (`_BillingDocumentsOrderBy`) 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)`
`paymentForecast(PaymentForecastConnectionTypeConnection)`	Paginated payment forecasts for this ledger. Starts from today's date (inclusive). The interface supports `last` but does not guarantee 'lastness'. Arguments `after` (`String`) `before` (`String`) `dateTo` (`Date`) The end date (inclusive) to retrieve forecasts for. `first` (`Int`) `last` (`Int`)
`paymentPlans(PaymentPlanConnectionTypeConnection)`	The payment plans for this ledger. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`paymentPreferenceAtTime(PaymentPreferenceUnion)`	The customer's preferred payment method at a point in time. The possible errors that can be raised are: KT-CT-3976: The ledger has no configured payment preference. KT-CT-3977: Ledger was not accepting payments at this time. KT-CT-1113: Disabled GraphQL field requested. Arguments `atTime` (`DateTime!`) The time at which to know the payment preference.
`paymentPreferences(PaymentPreferenceConnectionTypeConnection)`	The customer's preferred payment methods. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`paymentSchedules(ScheduleConnectionTypeConnection)`	The payment schedules for this ledger. These schedules describe how we would expect to take payments on a given month. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`payments(AccountPaymentConnectionTypeConnection)`	The payments made into this ledger. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `includePromises` (`Boolean`) Whether to include payment promises (of any kind: made, broken or fulfilled) or not. The default is to include them. `last` (`Int`) `reason` (`PaymentReasonOptions`) Filter for payments that were taken for a particular reason. `status` (`AccountPaymentStatusOptions`) Filter for payments by their status.
`paymentsWithNonConcludedRePresentation(PaymentWithNonConcludedRePresentationConnectionTypeConnection)`	Payments with non-concluded re-presentation. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`refundRequests(RefundRequestConnectionTypeConnection)`	Refund requests for a given ledger. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`repaymentRequests(RepaymentRequestConnectionTypeConnection)`	Repayment requests for a given ledger. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`repayments(AccountRepaymentConnectionTypeConnection)`	The repayments that have been requested for this ledger. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `statuses` (`[AccountRepaymentStatusOptions]`) Only return repayments whose status matches one of these statuses.
`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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `orderBy` (`_BillingDocumentsOrderBy`) The order the statements should be returned in. `statementId` (`Int`) The id of billing document.
`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 `after` (`String`) `before` (`String`) `first` (`Int`) `fromDate` (`Date`) Optional date representing the beginning of the postedDate range filter. This date value is inclusive. `last` (`Int`) `orderBy` (`TransactionsOrderBy`) The order in which to return the transactions. `toDate` (`Date`) Optional date representing the end of the postedDate range filter. This date value is exclusive. `transactionTypes` (`[TransactionTypeFilter]`) Include only these specific transaction types in the result.
`usablePaymentInstructions(PaymentInstructionConnectionTypeConnection)`	The usable payment instructions for this ledger. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `usableAt` (`DateTime`) The time at which the payment instructions should be usable.

{
  "id": "abc123",
  "name": "abc123",
  "number": "abc123",
  "ledgerType": "abc123",
  "balance": 1,
  "amountOwedByCustomer": 1,
  "affectsAccountBalance": true,
  "statements": StatementBillingDocumentConnectionTypeConnection,
  "invoices": InvoiceBillingDocumentConnectionTypeConnection,
  "transactions": TransactionConnectionTypeConnection,
  "repaymentRequests": RepaymentRequestConnectionTypeConnection,
  "refundRequests": RefundRequestConnectionTypeConnection,
  "repayments": AccountRepaymentConnectionTypeConnection,
  "paymentForecast": PaymentForecastConnectionTypeConnection,
  "acceptsPayments": true,
  "paymentAdequacy": PaymentAdequacyDetailsType,
  "creditTransferPermissionsData": CreditTransferPermissionsDataType,
  "paymentPreferences": PaymentPreferenceConnectionTypeConnection,
  "paymentPreferenceAtTime": PreferredInstruction,
  "debtLedger": LedgerType,
  "agreements": AgreementConnection,
  "usablePaymentInstructions": PaymentInstructionConnectionTypeConnection,
  "paymentPlans": PaymentPlanConnectionTypeConnection,
  "payments": AccountPaymentConnectionTypeConnection,
  "billingTriggerConfiguration": BillingTriggerConfiguration,
  "paymentSchedules": ScheduleConnectionTypeConnection,
  "supportsStatements": true,
  "supportsInvoices": true,
  "currentDirectDebitInstructionInvalidatedWithVendor": true,
  "paymentsWithNonConcludedRePresentation": PaymentWithNonConcludedRePresentationConnectionTypeConnection
}

LegacyQuoteType

Fields

Name	Description
`code(String)`
`createdAt(DateTime)`
`id(ID)`
`includesElectricity(Boolean)`
`includesExport(Boolean)`
`includesGas(Boolean)`
`postcode(String)`
`products([QuotedProduct])`	Deprecated The 'products' field is deprecated. Use quotedProducts instead. - Marked as deprecated on 2022-09-02. - Scheduled for removal on or after 2022-10-02.
`quotedProducts([QuotedProduct])`	Arguments `filterHeroProducts` (`Boolean`) Return only the top hero products relating to the quote.
`quotedSupplyPoints([QuotedSupplyPointType])`	Quoted Supply Point.
`referenceUsage(DmoReferenceType)`	Return the DMO Reference Data for the quoted NMI. Deprecated The 'dmoReference' field is deprecated. Replace with `QuotedProductType.priceReference` which works across markets. - Marked as deprecated on 2023-11-28. - Scheduled for removal on or after 2024-05-28.

{
  "id": "abc123",
  "code": "abc123",
  "postcode": "abc123",
  "includesElectricity": true,
  "includesGas": true,
  "includesExport": true,
  "createdAt": "2020-01-01T00:00:00.000Z",
  "referenceUsage": DmoReferenceType
}

LegacyQuotedProduct

Fields

Name	Description
`annualAmount(String)`	Deprecated The 'annualAmount' field is deprecated. Replaced with new estimate field. - Marked as deprecated on 2023-07-10. - Scheduled for removal on or after 2023-08-10.
`code(String)`
`description(String)`
`elecAnnualAmount(String)`	Deprecated The 'elecAnnualAmount' field is deprecated. Replaced with new estimate field. - Marked as deprecated on 2023-07-10. - Scheduled for removal on or after 2023-08-10.
`estimate(Estimate)`	Cost and usage estimation.
`gasAnnualAmount(String)`	Deprecated The 'gasAnnualAmount' field is deprecated. Replaced with new estimate field. - Marked as deprecated on 2023-07-10. - Scheduled for removal on or after 2023-08-10.
`id(ID)`
`isRecommended(Boolean)`
`marketSupplyProduct(Product)`	Arguments `filteredRatesByQuoteNmi` (`String`) Return only the marketSupplyProduct rates associated with the associated quote/meter point. Deprecated in favour of `relativeToMeterPointNmi`. Scheduled for removal on `2022-9-22` `relativeToMeterPointNmi` (`String`) Return the product in relation to the associated meter point nmi.
`monthlyAmount(String)`	Deprecated The 'monthlyAmount' field is deprecated. Replaced with new estimate field. - Marked as deprecated on 2023-07-10. - Scheduled for removal on or after 2023-08-10.
`name(String)`
`priceReference(PriceReferenceInterface)`
`usageReference(UsageReferenceInterface)`	Return the Usage Reference for the quoted product.

{
  "id": "abc123",
  "name": "abc123",
  "code": "abc123",
  "description": "abc123",
  "monthlyAmount": "abc123",
  "annualAmount": "abc123",
  "elecAnnualAmount": "abc123",
  "gasAnnualAmount": "abc123",
  "isRecommended": true,
  "marketSupplyProduct": Product
}

LegalEntityAssociatedEntitiesType

The entities linked to a legal entity.

Fields

Name Description

customerBusinessId(ID)

The ID of the customer business linked to this legal entity, if any.

internalCompanyId(ID)

The ID of the internal company linked to this legal entity, if any.

partnerBusinessId(ID)

The ID of the partner linked to this legal entity, if any.

{
  "customerBusinessId": "abc123",
  "internalCompanyId": "abc123",
  "partnerBusinessId": "abc123"
}

LegalEntityType

Represents a legal entity.

Fields

Name	Description
`associatedEntities(LegalEntityAssociatedEntitiesType)`	The entities linked to this legal entity.
`displayableNumber(String!)`	The legal entity's displayable number, which is a human-friendly identifier.
`id(ID!)`	The legal entity's ID.
`industryClassificationCodes([String!]!)`	The industry classification codes for the legal entity.
`legalAddress(RichAddressType)`	The legal address of the legal entity.
`legalEntityType(LegalEntityTypeOptions)`	The type of legal entity.
`name(String!)`	The legal entity's name.
`primaryRegistrationNumber(String)`	The registration number deemed as primary for the legal entity.
`primaryTaxIdentifierNumber(String)`	The tax identifier number deemed as primary for the legal entity.
`secondaryRegistrationNumber(String)`	The registration number deemed as secondary for the legal entity.
`secondaryTaxIdentifierNumber(String)`	The tax identifier number deemed as secondary for the legal entity.
`state(LegalEntityStateOptions!)`	The state of the legal entity.
`tradingName(String)`	The trading name of the legal entity.

{
  "id": "abc123",
  "displayableNumber": "abc123",
  "name": "abc123",
  "state": "DRAFT",
  "tradingName": "abc123",
  "legalEntityType": "SOLE_TRADER",
  "primaryRegistrationNumber": "abc123",
  "secondaryRegistrationNumber": "abc123",
  "primaryTaxIdentifierNumber": "abc123",
  "secondaryTaxIdentifierNumber": "abc123",
  "legalAddress": RichAddressType,
  "industryClassificationCodes": "abc123"
}

LifeSupportRecordType

Fields

Name	Description
`details(String)`
`id(ID!)`
`isOwnedByKraken(Boolean)`
`lifeSupportDate(Date)`
`lifeSupportEquipment(LifeSupportEquipment)`
`lifeSupportStatus(LifeSupportStatus)`
`preferredContactMethod(LifeSupportPreferredContactMethod)`

{
  "id": "abc123",
  "lifeSupportDate": "2020-01-01",
  "details": "abc123",
  "lifeSupportStatus": "REGISTERED_NO_MEDICAL_CONFIRMATION",
  "lifeSupportEquipment": "OXYGEN_CONCENTRATOR",
  "isOwnedByKraken": true,
  "preferredContactMethod": "POSTAL_ADDRESS"
}

LifeSupportType

Fields

Name Description

hasLifeSupportRecord(Boolean)

If the account has a current or past life support record, takes a conservative approach on this unless we have explicit confirmation that they are NOT on life support.

records([LifeSupportRecordType])

{
  "hasLifeSupportRecord": true,
  "records": [LifeSupportRecordType]
}

LifecycleProcessesType

Fields

Name	Description
`joinSupplierProcesses(JoinSupplierProcessConnectionTypeConnection)`	List of JoinSupplierProcess for an account. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`leavePropertyProcesses(LeavePropertyProcessConnectionTypeConnection)`	List of LeavePropertyProcess for an account. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`leaveSupplierProcesses(LeaveSupplierProcessConnectionTypeConnection)`	List of LeaveSupplierProcess for an account. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`occupyPropertyProcesses(OccupyPropertyProcessConnectionTypeConnection)`	List of OccupyPropertyProcess for an account. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)

{
  "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.

{
  "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.

{
  "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.

{
  "index": 1,
  "length": 1,
  "productId": "abc123",
  "emojiId": "abc123"
}

LineImageMessage

Fields

Name Description

id(ID!)

{
  "id": "abc123"
}

LineItemType

The smallest component of a charge on the bill.

Fields

Name	Description
`charge(AccountChargeType)`	The charge.
`chargeTarget(String!)`
`consumptionIsEstimated(Boolean)`	Whether the consumption for this line item was estimated. Note that if the value returned is null, it means that the data is not available.
`currency(LineItemCurrency!)`
`netAmount(Decimal!)`
`numberOfUnits(Decimal!)`
`periodEndAt(DateTime!)`
`periodStartAt(DateTime!)`
`pricePerUnit(Decimal!)`
`rate(RateInterface)`	The associated rate for the item.
`supplyType(String!)`

{
  "supplyType": "abc123",
  "periodStartAt": "2020-01-01T00:00:00.000Z",
  "periodEndAt": "2020-01-01T00:00:00.000Z",
  "numberOfUnits": "1.0",
  "pricePerUnit": "1.0",
  "netAmount": "1.0",
  "chargeTarget": "abc123",
  "rate": RateInterface,
  "charge": AccountChargeType,
  "consumptionIsEstimated": true,
  "currency": "AUD_CENTS"
}

LineLinkRedirectResponse

Link Successful. Complete link process with LINE.

Fields

Name Description

redirectUrl(String!)

{
  "redirectUrl": "abc123"
}

LineStickerMessage

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.

{
  "packageId": "abc123",
  "stickerId": "abc123",
  "resourceType": "abc123",
  "keywords": "abc123",
  "text": "abc123"
}

LineTextMessage

Fields

Name Description

displayContent(String!)

The display content.

emojis([LineEmoji!])

The emojis in the message.

{
  "displayContent": "abc123",
  "emojis": [LineEmoji]
}

LineUnlinkedResponse

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

LinkAccountToBusiness

Output type of the linkAccountToBusiness mutation.

Fields

Name Description

business(BusinessType)

The business the account was linked to.

{
  "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.

{
  "typeName": "abc123",
  "id": "abc123",
  "typename": "abc123",
  "url": "abc123"
}

LinkCustomerBusinessToLegalEntity

Output type of the linkCustomerBusinessToLegalEntity mutation.

Fields

Name Description

legalEntity(LegalEntityType)

The legal entity the customer business was linked to.

{
  
}

LinkInternalCompanyToLegalEntity

Output type of the linkInternalCompanyToLegalEntity mutation.

Fields

Name Description

legalEntity(LegalEntityType)

The legal entity the internal company was linked to.

{
  
}

LinkPartnerToLegalEntity

Output type of the linkPartnerToLegalEntity mutation.

Fields

Name Description

legalEntity(LegalEntityType)

The legal entity the partner was linked to.

{
  
}

LinkTokenNotFound

Fields

Name Description

type(LineLinkErrorType!)

The type of error that occurred.

{
  "type": "NO_MATCHING_LINE_LINK"
}

LivePaymentAdequacyCalculation

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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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.

{
  "suggestedNewMonthlyAmount": 1,
  "consumption": ConsumptionBreakdownConnectionTypeConnection,
  "averageMonthlyCharge": 1,
  "existingMonthlyAmount": 1,
  "balanceAdjustment": 1,
  "currentBalance": 1,
  "targetBalance": 1,
  "reviewedOn": "2020-01-01"
}

LoyaltyCardType

A loyalty card.

Fields

Name	Description
`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.

{
  "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 `balance_carried_forward` from the previous ledger entry or zero if this is the first one.
`balanceCarriedForward(String)`	Equal to the `balance_brought_forward` plus or minus the value depending on the ledger_type.
`id(ID!)`
`idempotencyKey(UUID)`	A unique idempotency key for the operation.
`ledgerType(String)`	The `LedgerEntryType`. Either CHARGE or CREDIT.
`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.

{
  "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"
}

LoyaltyPointsProgramEligibilityType

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.

{
  "isEligible": true,
  "primaryIneligibilityReason": "abc123"
}

LoyaltyType

Fields

Name Description

scheme(String)

The loyalty scheme in use.

{
  "scheme": "abc123"
}

MDHXProcessDiscoveryType

Fields

Name	Description
`correlationId(String!)`
`currentStatus(MDHXStatusReason)`
`id(ID!)`
`processType(MDHXProcessType)`
`statusReason(String)`

{
  "id": "abc123",
  "correlationId": "abc123",
  "processType": "MIRN_DISCOVERY",
  "currentStatus": "REQUEST_RECEIVED",
  "statusReason": "abc123"
}

MIRNCheckType

Fields

Name	Description
`account(AccountType)`	The account associated with the MIRN. This will be null if there is no linked account.
`accountNumber(String)`	The account number associated with the MIRN. This will be null if there is no linked account. Deprecated The 'accountNumber' field is deprecated. Use account to access the account.number instead. - Marked as deprecated on 2024-01-19. - Scheduled for removal on or after 2024-06-01.
`isOccupier(Boolean)`	Whether the account associated with MIRN is an occupier account. This will be null if there is no linked account.
`isOnSupply(Boolean)`	Whether the MIRN searched for is currently on supply.
`krakenStatus(KrakenStatus)`	Meter point Status for the MIRN in Kraken. It will be null if the MIRN is not on supply.
`supplyStartDate(Date)`	Date since when the MIRN is on supply. It will be null if the MIRN is not on supply.

{
  "isOnSupply": true,
  "krakenStatus": "OFF_SUPPLY",
  "supplyStartDate": "2020-01-01",
  "isOccupier": true,
  "accountNumber": "abc123",
  "account": AccountType
}

MIRNDiscoveryRequestAlreadyTriggeredErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

ManualCollectionType

The customer pays manually.

Fields

Name Description

message(String!)

A short description of this collection method.

{
  "message": "abc123"
}

ManualReviewMeterDataIssue

Output type of the manualReviewMeterDataIssue mutation.

Fields

Name Description

meterDataIssueManualReviewed(ManualReviewMeterDataIssueOutputType)

The manually reviewed meter data issue.

{
  
}

ManualReviewMeterDataIssueOutputType

Output for marking a MeterDataIssue as manually reviewed.

Fields

Name Description

issueId(Int)

The ID of the MeterDataIssue.

status(MeterDataIssueStatus)

The new status of the meter data issue.

{
  "issueId": 1,
  "status": "OPEN"
}

MarkPrintBatchAsProcessed

Output type of the markPrintBatchAsProcessed mutation.

Fields

Name Description

printBatch(PrintBatchType)

{
  
}

MarketMismatchErrorType

Fields

Name Description

field(String!)

The input field that failed database lookup.

message(String!)

{
  "message": "abc123",
  "field": "abc123"
}

MarketParticipantType

Fields

Name	Description
`marketType(String)`	The market type.
`participantId(String)`	The participant ID.
`participantName(String)`	The participant name.
`participantType(String)`	The participant type.

{
  "participantId": "abc123",
  "participantName": "abc123",
  "participantType": "abc123",
  "marketType": "abc123"
}

MarketSupplyQuoteRequestAsLegacyQuoteType

Fields

Name	Description
`code(String)`
`createdAt(DateTime)`
`id(ID)`
`includesElectricity(Boolean)`
`includesExport(Boolean)`
`includesGas(Boolean)`
`postcode(String)`
`products([QuotedProduct])`	Deprecated The 'products' field is deprecated. Use quotedProducts instead. - Marked as deprecated on 2022-09-02. - Scheduled for removal on or after 2022-10-02.
`quotedProducts([QuotedProduct])`	Arguments `filterHeroProducts` (`Boolean`) Return only the top hero products relating to the quote.
`quotedSupplyPoints([QuotedSupplyPointType])`	The quoted supply point.
`referenceUsage(DmoReferenceType)`	Return the DMO Reference Data for the quoted NMI. Deprecated The 'dmoReference' field is deprecated. Replace with `QuotedProductType.priceReference` which works across markets. - Marked as deprecated on 2023-11-28. - Scheduled for removal on or after 2024-05-28.

{
  "id": "abc123",
  "code": "abc123",
  "postcode": "abc123",
  "includesElectricity": true,
  "includesGas": true,
  "includesExport": true,
  "createdAt": "2020-01-01T00:00:00.000Z",
  "referenceUsage": DmoReferenceType
}

MarketSupplyQuoteRequestType

A quote request.

Fields

Name	Description
`acceptedAt(DateTime)`
`code(String)`	The code of the created quote.
`quotedSupplyPoints(MarketSupplyQuotedSupplyPointConnectionTypeConnection)`	List of quoted supply points. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`requestedAt(DateTime)`
`termsAndConditions(TermsAndConditionsConnectionTypeConnection)`	List of terms and conditions applicable to the quote. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)

{
  "acceptedAt": "2020-01-01T00:00:00.000Z",
  "requestedAt": "2020-01-01T00:00:00.000Z",
  "code": "abc123",
  "quotedSupplyPoints": MarketSupplyQuotedSupplyPointConnectionTypeConnection,
  "termsAndConditions": TermsAndConditionsConnectionTypeConnection
}

MarketSupplyQuotedProductAsLegacyQuotedProduct

Fields

Name	Description
`annualAmount(String)`	Deprecated The 'annualAmount' field is deprecated. Replaced with new estimate field. - Marked as deprecated on 2023-07-10. - Scheduled for removal on or after 2023-08-10.
`code(String)`
`description(String)`
`elecAnnualAmount(String)`	Deprecated The 'elecAnnualAmount' field is deprecated. Replaced with new estimate field. - Marked as deprecated on 2023-07-10. - Scheduled for removal on or after 2023-08-10.
`estimate(Estimate)`	Cost and usage estimation.
`gasAnnualAmount(String)`	Deprecated The 'gasAnnualAmount' field is deprecated. Replaced with new estimate field. - Marked as deprecated on 2023-07-10. - Scheduled for removal on or after 2023-08-10.
`id(ID)`
`isRecommended(Boolean)`
`marketSupplyProduct(Product)`	Arguments `filteredRatesByQuoteNmi` (`String`) Return only the marketSupplyProduct rates associated with the associated quote/meter point. Deprecated in favour of `relativeToMeterPointNmi`. Scheduled for removal on `2022-9-22` `relativeToMeterPointNmi` (`String`) Return the product in relation to the associated meter point nmi.
`monthlyAmount(String)`	Deprecated The 'monthlyAmount' field is deprecated. Replaced with new estimate field. - Marked as deprecated on 2023-07-10. - Scheduled for removal on or after 2023-08-10.
`name(String)`
`priceReference(PriceReferenceInterface)`
`usageReference(UsageReferenceInterface)`	Return the Usage Reference for the quoted product.

{
  "id": "abc123",
  "name": "abc123",
  "code": "abc123",
  "description": "abc123",
  "monthlyAmount": "abc123",
  "annualAmount": "abc123",
  "elecAnnualAmount": "abc123",
  "gasAnnualAmount": "abc123",
  "isRecommended": true,
  "marketSupplyProduct": Product
}

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.

{
  "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

{
  "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!)`

{
  "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.

{
  "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

{
  "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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`supplyPoint(SupplyPointType)`	The supply point being quoted.

{
  "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.

{
  "token": "abc123",
  "errors": [ErrorType]
}

MaximumRefundType

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.

{
  "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.

{
  "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

{
  "node": MeasurementInterface,
  "cursor": "abc123"
}

MeasurementType

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.

{
  "source": "abc123",
  "metaData": MeasurementsMetadataOutput,
  "value": "1.0",
  "unit": "abc123",
  "readAt": "2020-01-01T00:00:00.000Z"
}

MeasurementsMetadataOutput

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.

{
  "utilityFilters": ElectricityFiltersOutput,
  "statistics": [StatisticOutput],
  "extras": [ExtrasOutput]
}

Message

Fields

Name	Description
`account(AccountType)`	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.

{
  "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": AccountType,
  "accountUser": AccountUserType
}

MessageConnection

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.

{
  "pageInfo": PageInfo,
  "edges": MessageEdge,
  "totalCount": 1,
  "edgeCount": 1
}

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

{
  "cursor": "abc123"
}

MessageType

Represents a communication.

Fields

Name	Description
`attachments([AttachmentType])`	Attachments of the message.
`channel(MessageChannel!)`
`createdAt(DateTime!)`
`fromEmail(String!)`
`fromNumber(String!)`
`id(ID!)`
`sentAt(DateTime)`
`templateCode(String!)`
`toAddress(String!)`
`toNumber(String!)`

{
  "id": "abc123",
  "channel": "EMAIL",
  "toAddress": "abc123",
  "fromEmail": "abc123",
  "toNumber": "abc123",
  "fromNumber": "abc123",
  "templateCode": "abc123",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "sentAt": "2020-01-01T00:00:00.000Z",
  "attachments": [AttachmentType]
}

Metadata

Fields

Name Description

key(String!)

The key for the metadata.

value(JSONString)

The metadata value.

{
  "key": "abc123",
  "value": {"key": "value"}
}

MeterPointAddressType

Fields

Name	Description
`buildingName(String)`
`dpid(Int)`
`flatNumber(String)`
`flatType(String)`
`floorNumber(String)`
`floorType(String)`
`houseNumber(Int)`
`houseNumberSuffix(String)`
`locality(String)`
`locationDescriptor(String)`
`lotNumber(String)`
`postcode(String)`
`state(String)`
`streetName(String)`
`streetSuffix(String)`
`streetType(String)`

{
  "dpid": 1,
  "buildingName": "abc123",
  "flatNumber": "abc123",
  "flatType": "abc123",
  "floorNumber": "abc123",
  "floorType": "abc123",
  "houseNumber": 1,
  "houseNumberSuffix": "abc123",
  "locationDescriptor": "abc123",
  "lotNumber": "abc123",
  "streetName": "abc123",
  "streetSuffix": "abc123",
  "streetType": "abc123",
  "locality": "abc123",
  "state": "abc123",
  "postcode": "abc123"
}

MeterPointIdentifierInvalidErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MeterPointType

Note that this is electricity specific. Use GasMeterPointType for gas meter points.

Fields

Name	Description
`accessDetails(String)`	Instructions for physical access to the meter point site.
`address(MeterPointAddressType)`	We recommend you use siteAddress instead of this field. Deprecated The 'address' field is deprecated. Use siteAddress instead. - Marked as deprecated on 2022-08-22. - Scheduled for removal on or after 2022-09-30.
`agreements([AusAgreementInterface])`	A list of agreements belonging to an account that is linked to the logged in user. Arguments `includeInactive` (`Boolean`)
`branchCode(String)`
`consumptionSummary([ElectricityCostedConsumptionType!]!)`	Fetch consumption for this meterpoint, bucketed into time slices of a variable granularity. When the readings we have are less granular than the requested granularity (e.g. half-hourly or even monthly consumption requested on an interval meter), the consumption is divided evenly. Note that, because the way that humans measure time is weird, so too are the results of this endpoint. For instance, a day may not have exactly 48 half-hour periods (because a DST transition happened), and a three-month interval of meter readings may not appear to be spread evenly between months (because months have different numbers of days). The result will only include periods that are wholly between `start_at` and `end_at`; so, for instance, if you have a `start_at` of midday and a `granularity` of `DAILY`, you'll get results starting at midnight the following day. This field requires the `Authorization` header to be set. Arguments `endAt` (`DateTime!`) Include data ending at this datetime. If a datetime-naïve value (without a UTC offset) is passed, this will be assumed to be in the timezone specified in `timezone`; if the UTC offset is absent and it is a time that occurs more than once in the given timezone (e.g. 2am on a transition out of DST) the behaviour is undefined. `granularity` (`ConsumptionGranularity!`) How granular the returned results should be. `includeBasicMeters` (`Boolean`) Whether to include usage from BASIC meters. Note that because accumulation readings don't happen very often, the basic meter usage will be the average usage between two readings. This might not be the most useful information. The recommendation is to set this as `false`. `includeEstimates` (`Boolean`) Include estimated readings. `startAt` (`DateTime!`) Include data starting at this datetime. If a datetime-naïve value (without a UTC offset) is passed, this will be assumed to be in the timezone specified in `timezone`; if the UTC offset is absent and it is a time that occurs more than once in the given timezone (e.g. 2am on a transition out of DST) the behaviour is undefined. `timezone` (`String!`) Olson timezone identifier to use (e.g. `Australia/Melbourne`). This is used to determine what time of day to split days and months.
`customerClassification(String)`	The classification of the end user at this connection point: BUSINESS or RESIDENTIAL.
`customerClassificationThreshold(String)`	The consumption threshold code as defined in National Energy Retail Regulations: LOW, MEDIUM, or HIGH.
`distributionLossFactorCode(String)`	The Distribution Loss Factor (DLF) code from the AEMO CATSDLFCODES table.
`energizationStatus(EnergizationStatus)`	The physical state of the meter point.
`energizationStatusFrom(Date)`	When the energization status was last changed.
`energizationStatusTo(Date)`	When the energization status record is recorded until.
`enrolment(EnrolmentType)`	Details about an enrolment of this meter point. Will be null if no enrolment is taking place.
`feederClass(String)`	The distribution feeder classification for this meter point.
`hazards([String])`	A list of known hazards at the meter point site.
`id(Int)`	The database identifier of the meter point.
`identifier(String)`	The external identifier for the meter point (NMI for electricity, MIRN for gas).
`isOnSupply(Boolean)`	Whether the meter point is on supply.
`jurisdiction(String)`	The Australian state or territory where the meter point is located, e.g. NSW, QLD, VIC.
`lnsp(LNSPType)`	The Local Network Service Provider responsible for this meter point.
`meters([ElectricityMeterType])`	The electricity meters installed at this meter point. Arguments `id` (`Int`) Filter by meter database ID. `includeInactive` (`Boolean`) Include decommissioned meters.
`nmiChecksum(String)`	The check character that is sometimes suffixed to the NMI. For the NMI itself, refer to the `identifier` field.
`nmiClassification(String)`	The NMI classification describing the flow of electricity at the connection point, e.g. SMALL, LARGE, GENERATR.
`predictedBill(PredictedBillType)`	MVP solution for calculating a predicted bill based on costed consumption and standing charges for a given meter point. The prediction is calculated by the following algorithm: `P(A, B, C, D, E, F) = ( (A + ((B+C)/2)D ) E ) + F` Where: A = Aggregated consumption for each register within this meter point in the billing period to date (kWh). B = 7 day average rolling window consumption per day (kWh). C = Average existing usage per day for the current billing period (kWh). D = Remaining days in the current billing period. E = Rate costs. F = Total standing charges for the billing period assuming the customer stays in the same current product rate. Exceptions: 1. In the first day of the billing cycle, the variable C would tend towards zero. This would result in a poor result for the equation above. Instead, we replace the component ((B+C)/2)D by BD. Notes: 1. The process of getting a meter reading and storing it usually takes about 24-48h in Kraken. This means that the prediction bill is always lagging 1 or 2 days behind. In order to circumvent this, concepts such as "usage to date" are translated as "usage until the date of the last reading" so that the calculation becomes more precise. In future, Kraken will start digesting and storing readings quicker, so that the date of the last reading will be today and the algorithm will catch up. 2. Building a predicted bill can be computationally expensive so we've imposed a cache of 600 seconds on the query. This MVP Excludes: - accounts with flexible billing options. - Anything more or less granular than DAILY consumptions/standing charges. - Concessions. - Credits. - Rebates. - Seasonality. Arguments `includeBasicMeters` (`Boolean`) Include basic meters. `includeEstimates` (`Boolean`) Include estimated readings. `includeQuarantined` (`Boolean`) Include readings that have been quarantined in Kraken. `includeUnbillableRegisters` (`Boolean`) Include registers that cannot be billed. `supportSteppedTariffs` (`Boolean`) Use new code path that supports stepped tariffs (defaults to false).
`roles(RoleType)`	The AEMO market participant roles assigned to this meter point.
`sensitiveLoad(Boolean)`	Whether the meter point has a sensitive load designation. A registered Life Support record takes precedence over this flag.
`siteAddress(RichAddressType)`	The structured address of the meter point site.
`smartStartDate(Date)`
`solarScheme(SolarType)`	The solar feed-in tariff scheme in place at the meterpoint, if any. Arguments `asAt` (`DateTime`) The effective time for network tariff codes (defaults to now).
`standingChargesSummary([SummarizedConsumptionType!]!)`	Fetch standing charges on this meter point, bucketed into time slices of a variable granularity. The result will only include periods that are wholly between `start_at` and `end_at`; so, for instance, if you have a `start_at` of midday and a `granularity` of `DAILY`, you'll get results starting at midnight the following day. This field requires the `Authorization` header to be set. Deprecated The 'standingChargesSummary' field is deprecated. Use standingChargesWindow instead. - Marked as deprecated on 2022-09-02. - Scheduled for removal on or after 2022-11-02. Arguments `endAt` (`DateTime!`) Include data ending at this datetime. If a datetime-naïve value (without a UTC offset) is passed, this will be assumed to be in the timezone specified in `timezone` `granularity` (`ConsumptionGranularity!`) How granular the returned results should be `startAt` (`DateTime!`) Include data starting at this datetime. If a datetime-naïve value (without a UTC offset) is passed, this will be assumed to be in the timezone specified in `timezone` `timezone` (`String!`) Olson timezone identifier to use (e.g. `Australia/Melbourne`). This is used to determine what time of day to split days and months.
`standingChargesWindow(StandingChargesWindowType)`	Fetch standing charges on this meter point, bucketed into time slices of a variable granularity. The result will only include periods that are wholly between `start_at` and `end_at`; so, for instance, if you have a `start_at` of midday and a `granularity` of `DAILY`, you'll get results starting at midnight the following day. This field requires the `Authorization` header to be set. Arguments `input` (`StandingChargesWindowInput!`)
`status(String)`	The Financial Responsible Market Participant status. Deprecated The 'status' field is deprecated. Use supplyStatus instead. - Marked as deprecated on 2022-09-02. - Scheduled for removal on or after 2022-10-10.
`supplyDetails(SupplyDetailsType)`	Supply details including agreed capacity and connection units.
`supplyEndDate(DateTime)`
`supplyStartDate(DateTime)`
`supplyStatus(KrakenStatus)`	The Financial Responsible Market Participant status.
`supplyType(String)`	The fuel/service type for this meter point.
`transmissionNodeIdentifier(String)`	The Transmission Node Identifier (TNI) code from the AEMO CATSTNICODES table.

{
  "id": 1,
  "status": "abc123",
  "agreements": AusAgreementInterface,
  "identifier": "abc123",
  "meters": [ElectricityMeterType],
  "supplyType": "abc123",
  "supplyDetails": SupplyDetailsType,
  "enrolment": EnrolmentType,
  "supplyStatus": "OFF_SUPPLY",
  "supplyStartDate": "2020-01-01T00:00:00.000Z",
  "supplyEndDate": "2020-01-01T00:00:00.000Z",
  "isOnSupply": true,
  "nmiChecksum": "abc123",
  "smartStartDate": "2020-01-01",
  "lnsp": LNSPType,
  "energizationStatus": "A",
  "roles": RoleType,
  "address": MeterPointAddressType,
  "siteAddress": RichAddressType,
  "accessDetails": "abc123",
  "hazards": ["abc123"],
  "customerClassification": "abc123",
  "nmiClassification": "abc123",
  "customerClassificationThreshold": "abc123",
  "jurisdiction": "abc123",
  "feederClass": "abc123",
  "transmissionNodeIdentifier": "abc123",
  "distributionLossFactorCode": "abc123",
  "sensitiveLoad": true,
  "solarScheme": "PFIT",
  "predictedBill": PredictedBillType,
  "standingChargesSummary": SummarizedConsumptionType,
  "standingChargesWindow": StandingChargesWindowType,
  "consumptionSummary": ElectricityCostedConsumptionType,
  "branchCode": "abc123",
  "energizationStatusFrom": "2020-01-01",
  "energizationStatusTo": "2020-01-01"
}

MfaDevice

Fields

Name Description

deviceType(String)

The type of MFA device.

isConfirmed(Boolean)

Whether the MFA device is confirmed or not.

{
  "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.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "length": 1,
  "unitOfTime": "abc123"
}

MirnAlreadyExistsErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MissingAccountForRegisterValidationErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MissingActiveAgreement

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MissingActiveGasSupplyPoint

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MissingHouseAndLotNumberErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MissingPaymentDetailsErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MissingReadingsValidationErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MoveInAdressDetailIsMissingErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MoveInDatesType

Fields

Name Description

error(MoveInDatesErrorUnion)

Potential error message for the query.

moveInDates([Date])

Suitable dates for a move in.

{
  "moveInDates": ["2020-01-01"],
  "error": DoesNotExistErrorType
}

MoveInDetailsHaveTooManyHazardsErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MoveInDetailsInValidErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MoveInFailedToCompleteErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MoveOutDatesType

Fields

Name Description

error(MoveOutDatesErrorUnion)

moveOutDates([Date])

{
  "moveOutDates": ["2020-01-01"],
  "error": DoesNotExistErrorType
}

MoveToBucket

Output type of the moveToBucket mutation.

Fields

Name Description

conversation(InkConversation!)

The conversation that was moved to the bucket.

{
  "conversation": InkConversation
}

MultipleMeterpointsValidationErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

MultipleObjectsReturnedErrorType

Fields

Name Description

field(String!)

The input field that matched more than one object in the database.

{
  "field": "abc123"
}

NMICheckType

Fields

Name	Description
`account(AccountType)`	The account associated with the NMI. This will be null if there is no linked account.
`accountNumber(String)`	The account number associated with the NMI. This will be null if there is no linked account. Deprecated The 'accountNumber' field is deprecated. Use account to access the account.number instead. - Marked as deprecated on 2024-01-19. - Scheduled for removal on or after 2024-06-01.
`isOccupier(Boolean)`	Whether the account associated with NMI is an occupier account. This will be null if there is no linked account.
`isOnSupply(Boolean)`	Whether the NMI searched for is currently on supply.
`krakenStatus(KrakenStatus)`	Meter point Status for the NMI in Kraken. It will be null if the NMI is not on supply.
`supplyStartDate(Date)`	Date since when the NMI is on supply. It will be null if the NMI is not on supply.

{
  "isOnSupply": true,
  "krakenStatus": "OFF_SUPPLY",
  "supplyStartDate": "2020-01-01",
  "isOccupier": true,
  "accountNumber": "abc123",
  "account": AccountType
}

NMIDiscoveryType

Fields

Name Description

error(NMIDiscoveryTypeErrorUnion)

nmi(String)

rawAemoResponse(String)

{
  "nmi": "abc123",
  "rawAemoResponse": "abc123",
  "error": BothHouseAndLotNumberErrorType
}

NMIType2DiscoveryType

Fields

Name	Description
`error(NMIType2DsicoveryErrorUnion)`
`hasAllActiveRemotelyReadMeters(Boolean)`	Returns true if there are active meters and they are all remotely-read, otherwise false.
`hasAtLeastOneActiveSmartMeter(Boolean)`	Returns true if any active meter is smart, otherwise false. Deprecated The 'hasAtLeastOneActiveSmartMeter' field is deprecated. This is due to be replaced by hasAllActiveRemotelyReadMeters in order to make behaviour consistent throughout the system. - Marked as deprecated on 2023-01-11. - Scheduled for removal on or after 2024-01-01.
`hasAtLeastOneActiveSolarNtc(Boolean)`
`hasAtLeastOneRemotelyReadDisconnectedMeter(Boolean)`	Returns true if there are any remotely-read meters with the status of remotely disconnected, otherwise false.
`rawAemoResponse(String)`

{
  "rawAemoResponse": "abc123",
  "hasAtLeastOneActiveSolarNtc": true,
  "hasAtLeastOneActiveSmartMeter": true,
  "hasAllActiveRemotelyReadMeters": true,
  "hasAtLeastOneRemotelyReadDisconnectedMeter": true,
  "error": AEMOAPIUnavailableErrorType
}

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.

{
  "allInferredRoutingAttributes": "abc123"
}

NmiDetails

Fields

Name	Description
`meterReplacement(Boolean)`	True if the Group Outage is a meter replacement.
`meterSerials([String])`	Serials of meters associated with this NMI.
`nmi(String)`	A nmi which is part of the group outage.
`sharedFuseGroup(String)`	The shared Fuse Group number which relates to the nmi.
`siteAddress(String)`	The address of this NMI.

{
  "nmi": "abc123",
  "sharedFuseGroup": "abc123",
  "meterReplacement": true,
  "siteAddress": "abc123",
  "meterSerials": ["abc123"]
}

NoMatchingAccountFoundErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

NoMatchingPropertyFromNMIErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

NoRelatedPaymentSchedulesOnPaymentDateErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

NoSuitableProductsFoundErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

NoSupplyPointsAssociatedWithMirnErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

NoSupplyPointsAssociatedWithPropertyErrorType

Fields

Name Description

message(String!)

{
  "message": "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.

{
  "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 `token` field.
`possibleErrors([PossibleErrorType])`	Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. Please use the 'possibleErrors' query or the 'X-Kraken-Possible-Errors' header instead. - Marked as deprecated on 2025-01-31. - Scheduled for removal on or after 2025-03-01.
`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 `obtainKrakenToken` to get a new Kraken Token with the same access conditions after the previous one has expired.
`token(String!)`	The Kraken Token. Can be used in the `Authorization` header for subsequent calls to the API to access protected resources.

{
  "token": "abc123",
  "payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
  "refreshToken": "abc123",
  "refreshExpiresIn": 1,
  "possibleErrors": [PossibleErrorType]
}

ObtainLongLivedRefreshToken

Output type of the obtainLongLivedRefreshToken mutation.

Fields

Name Description

refreshExpiresIn(Int!)

refreshToken(String)

{
  "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.

{
  "id": "abc123",
  "effectiveFrom": "2020-01-01T00:00:00.000Z",
  "effectiveTo": "2020-01-01T00:00:00.000Z",
  "isOccupier": true,
  "accountNumber": "abc123",
  "numberOfOccupants": 1
}

OccupyPropertyProcessConnectionTypeConnection

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.

{
  "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

{
  "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. Please use 'supplyPointsInterface' instead. It returns SupplyPointInterfaceConnection, whose node is CommonSupplyPointInterface, and supports inline fragments (e.g. `... on WaterSupplyPointType`, `... on ElectricitySupplyPointType`). - Marked as deprecated on 2026-07-23. - Scheduled for removal on or after 2027-01-23. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`supplyPointsInterface(SupplyPointInterfaceConnection!)`	The supply points associated with the process. Node type is the CommonSupplyPointInterface; use inline fragments (e.g. `... on WaterSupplyPointType`, `... on ElectricitySupplyPointType`) to access concrete types. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)

{
  "id": "abc123",
  "status": "PENDING",
  "occupyAt": "2020-01-01T00:00:00.000Z",
  "supplyPoints": SupplyPointConnectionTypeConnection,
  "supplyPointsInterface": SupplyPointInterfaceConnection
}

OfferGroupType

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.

{
  "identifier": "abc123",
  "offers": [OfferType],
  "createdAt": "2020-01-01T00:00:00.000Z",
  "createdBy": ActorType
}

OfferType

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.

{
  "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.

{
  "identifier": "abc123",
  "minimumQuantity": 1,
  "maximumQuantity": 1,
  "initialQuantity": 1
}

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.

{
  "identifier": "abc123",
  "internalName": "abc123",
  "customerName": "abc123",
  "customerDescription": "abc123",
  "isSellable": true,
  "isAmendable": true,
  "isExpired": true,
  "isActive": true,
  "isDraft": true,
  "isLatestVersion": true,
  "isFirstDraft": true
}

OnSiteJobsAppointmentActionConnectionTypeConnection

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.

{
  "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

{
  "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.

{
  "actionTriggerStage": "POST_APPOINTMENT_BOOKING",
  "workflowName": "abc123",
  "workflowStatus": "SKIPPED"
}

OnSiteJobsAppointmentConnectionTypeConnection

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.

{
  "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

{
  "cursor": "abc123"
}

OnSiteJobsAppointmentSlotResultsType

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.

{
  "isComplete": true
}

OnSiteJobsAppointmentSlotType

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.

{
  "startDatetime": "2020-01-01T00:00:00.000Z",
  "endDatetime": "2020-01-01T00:00:00.000Z",
  "slotId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

OnSiteJobsAppointmentType

Fields

Name	Description
`agent(OnSiteJobsAgent)`	The agent assigned to the appointment.
`appointmentActions(OnSiteJobsAppointmentActionConnectionTypeConnection)`	A list of actions triggered by this appointment, across stages. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`assets(OnSiteJobsAssetConnectionTypeConnection)`	A list of assets attached to this request. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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. Please use externalJobTypeMapping instead. - Marked as deprecated on 2026-03-17. - Scheduled for removal on or after 2026-04-17.
`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.

{
  "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"
}

OnSiteJobsAssetConnectionTypeConnection

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.

{
  "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

{
  "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. Use 'supplyPointInternalIdentifier' instead. This field is being removed as the underlying model field is being removed. - Marked as deprecated on 2026-01-16. - Scheduled for removal on or after 2026-03-01.
`supplyPointInternalIdentifier(Int)`

{
  "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.

{
  "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.

{
  "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.

{
  "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.

{
  "id": "abc123",
  "name": "abc123"
}

OnSiteJobsRequestActionConnectionTypeConnection

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.

{
  "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

{
  "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.

{
  "actionTriggerStage": "POST_REQUEST_COMPLETION",
  "workflowName": "abc123",
  "workflowStatus": "SKIPPED"
}

OnSiteJobsRequestConnectionTypeConnection

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.

{
  "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

{
  "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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`assets(OnSiteJobsAssetConnectionTypeConnection)`	A list of assets attached to this request. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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. Please use 'supplyPointsInterface' instead. It returns SupplyPointInterfaceConnection, whose node is CommonSupplyPointInterface, and supports inline fragments (e.g. `... on WaterSupplyPointType`, `... on ElectricitySupplyPointType`). - Marked as deprecated on 2026-07-23. - Scheduled for removal on or after 2027-01-23. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)

{
  "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: KT-CT-13086: Formal complaint does not exist. KT-CT-1113: Disabled GraphQL field requested.
`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.

{
  "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"
}

OnlyMoveInAllowedWithSupply

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

OperationsTeamType

Fields

Name Description

id(ID)

ID for the Operations Team.

name(String)

Name for the Operations Team.

{
  "id": "abc123",
  "name": "abc123"
}

OpportunitiesConnection

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.

{
  "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

{
  "cursor": "abc123"
}

Opportunity

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. Please use 'assignedToTeamIdentifier' instead. - Marked as deprecated on 2026-04-22. - Scheduled for removal on or after 2026-06-22.
`assignedToTeamIdentifier(String)`	The identifier of the team assigned to this opportunity.
`assignedToUser(String)`	User assigned to this opportunity. Deprecated The 'assignedToUser' field is deprecated. Please use 'assignedToUserIdentifier' instead. - Marked as deprecated on 2026-04-22. - Scheduled for removal on or after 2026-06-22.
`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.
`createdAt(DateTime)`	When the opportunity was created.
`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.
`landlineNumber(String)`	Lead account holder landline number.
`leadNumber(String)`	Lead number.
`leadPaymentDetails(StoredPaymentMethodDetailsType)`	Payment details stored on the opportunity's lead. Null when the lead has none, when storing bank details is disabled, or when the viewer is not allowed to see them.
`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. Use `number` instead. - Marked as deprecated on 2025-12-16. - Scheduled for removal on or after 2026-02-16.
`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` (`LeadSupplyPointFiltersInput`) Input fields for retrieving supply points by market.
`updatedAt(DateTime)`	When the opportunity was last updated.

{
  "opportunityId": "abc123",
  "leadNumber": "abc123",
  "leadType": "abc123",
  "name": "abc123",
  "email": "abc123",
  "phoneNumber": "abc123",
  "landlineNumber": "abc123",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "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",
  "leadPaymentDetails": StoredPaymentMethodDetailsType,
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

OpportunityAttachment

Fields

Name Description

category(OpportunityAttachmentCategory)

Attachment category.

filename(String)

Attachment filename.

id(ID)

Attachment ID.

{
  "id": "abc123",
  "category": "LEAD_FILE",
  "filename": "abc123"
}

OpportunityFileAttachment

Fields

Name Description

expiresAt(DateTime)

The date and time the file attachment will expire.

presignedUrl(String)

Presigned URL for the file attachment.

{
  "presignedUrl": "abc123",
  "expiresAt": "2020-01-01T00:00:00.000Z"
}

OpportunityOutput

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. Please use 'assignedToTeamIdentifier' instead. - Marked as deprecated on 2026-04-22. - Scheduled for removal on or after 2026-06-22.
`assignedToTeamIdentifier(String)`	The identifier of the team assigned to this opportunity.
`assignedToUser(String)`	User assigned to this opportunity. Deprecated The 'assignedToUser' field is deprecated. Please use 'assignedToUserIdentifier' instead. - Marked as deprecated on 2026-04-22. - Scheduled for removal on or after 2026-06-22.
`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.
`createdAt(DateTime)`	When the opportunity was created.
`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.
`landlineNumber(String)`	Lead account holder landline number.
`leadNumber(String)`	Lead number.
`leadPaymentDetails(StoredPaymentMethodDetailsType)`	Payment details stored on the opportunity's lead. Null when the lead has none, when storing bank details is disabled, or when the viewer is not allowed to see them.
`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. Use `number` instead. - Marked as deprecated on 2025-12-16. - Scheduled for removal on or after 2026-02-16.
`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` (`LeadSupplyPointFiltersInput`) Input fields for retrieving supply points by market.
`updatedAt(DateTime)`	When the opportunity was last updated.

{
  "opportunityId": "abc123",
  "leadNumber": "abc123",
  "leadType": "abc123",
  "name": "abc123",
  "email": "abc123",
  "phoneNumber": "abc123",
  "landlineNumber": "abc123",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "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",
  "leadPaymentDetails": StoredPaymentMethodDetailsType,
  "updatedAt": "2020-01-01T00:00:00.000Z"
}

OpportunityProductSummary

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.

{
  "productOfferingIdentifier": "abc123",
  "productIdentifier": "abc123",
  "productCode": "abc123",
  "productCharacteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
  "market": "abc123"
}

OpportunitySalesOptionType

Fields

Name Description

label(String!)

The human-readable label for this option.

value(ID!)

The opaque value submitted for this option.

{
  "value": "abc123",
  "label": "abc123"
}

OpportunitySalesOptionsType

Fields

Name Description

affiliateOrganisations([OpportunitySalesOrganisationType!])

The organisations and assignment options available for an opportunity.

{
  
}

OpportunitySalesOrganisationType

Fields

Name Description

option(OpportunitySalesOptionType!)

The affiliate organisation or internal assignment option.

salesChannels([OpportunitySalesOptionType!])

The sales channels available for the organisation.

teams([OpportunitySalesTeamType!])

The assignment teams available for the organisation.

{
  
}

OpportunitySalesTeamType

Fields

Name Description

option(OpportunitySalesOptionType!)

The team option.

users([OpportunitySalesOptionType!])

The users available for assignment through the team.

{
  
}

OrganisationFileUpload

An organisation file recorded after it has been uploaded.

Fields

Name Description

id(UUID!)

The identifier of the recorded organisation file. Use this to reference the file attachment.

{
  "id": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

OrganisationFileUploadPresignedPostType

Metadata returned when generating a pre-signed post for an organisation file.

Fields

Name	Description
`bucket(String!)`	The S3 bucket.
`fields(JSONString!)`	The fields to be included in the pre-signed post.
`key(String!)`	The S3 object key.
`preSignedUrl(String!)`	The pre-signed S3 URL.

{
  "key": "abc123",
  "bucket": "abc123",
  "fields": {"key": "value"},
  "preSignedUrl": "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.

{
  "namespace": "abc123",
  "value": "abc123"
}

OutOfBoundsPaymentDayErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

OutagesForNmiType

Fields

Name Description

groupOutages([GetGroupOutageDetails])

Group outages associated with the NMI.

supplyPointOutages([SupplyPointOutageSummaryType])

Supply point outages for the NMI.

{
  
}

OutboundCallType

Fields

Name	Description
`account(AccountType)`	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.

{
  "id": "abc123",
  "account": AccountType
}

OutcomeType

Fields

Name Description

category(AppSessionOutcomeCategory)

reason(String)

type(AppSessionOutcomeType!)

{
  "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.

{
  "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.

{
  "roleAssignments": RoleAssignment
}

PartnerAccessorAccessConnectionTypeConnection

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.

{
  "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

{
  "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.

{
  "roleAssignments": RoleAssignment
}

PartnerCommissionContractConfigType

Fields

Name	Description
`applyUplift(Boolean)`	Whether to apply uplift to the partner commission.
`displayOnBill(Boolean)`	Whether the partner commission uplift is displayed as a line item on the bill.
`overrideFixedAmount(Decimal)`	Override for the fixed amount of the partner commission.
`overrideTrailingPercentage(Decimal)`	Override for the trailing commission percentage (1-100).
`overrideUnitAmount(Decimal)`	Override for the unit amount of the partner commission.
`partnerCommissionNumber(String)`	The unique number identifying the partner commission.

{
  "partnerCommissionNumber": "abc123",
  "overrideTrailingPercentage": "1.0",
  "overrideUnitAmount": "1.0",
  "overrideFixedAmount": "1.0",
  "applyUplift": true,
  "displayOnBill": true
}

PartnerCommissionMoneyType

A monetary amount in the smallest denomination of the currency.

Fields

Name Description

amount(Decimal!)

The amount in the smallest denomination of the currency.

currency(String!)

The ISO-4217 code for the currency.

{
  "amount": "1.0",
  "currency": "abc123"
}

PartnerCommissionProductUpliftConfigurationType

A product and rate specification whose price a trailing partner commission uplifts.

Fields

Name Description

adjustedRateSpecification(String!)

Identifier of the rate specification the uplift adjusts.

product(String!)

Identifier of the product whose rate is uplifted.

{
  "product": "abc123",
  "adjustedRateSpecification": "abc123"
}

PartnerCommissionType

Represents a partner commission term on a contract.

Fields

Name	Description
`configurations([PartnerCommissionContractConfigType])`	The set of partner commission configurations for this 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.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "configurations": [PartnerCommissionContractConfigType]
}

PartnerOrganisationCommissionConnectionTypeConnection

Paginator of partner commissions for an organisation.

Fields

Name	Description
`edgeCount(Int!)`	Number of nodes in the edge.
`edges([PartnerOrganisationCommissionConnectionTypeEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": PartnerOrganisationCommissionConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

PartnerOrganisationCommissionConnectionTypeEdge

A Relay edge containing a PartnerOrganisationCommissionConnectionType and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(PartnerOrganisationCommissionType)

The item at the end of the edge

{
  "cursor": "abc123"
}

PartnerOrganisationCommissionType

A partner commission configured for a partner organisation. validFrom and validTo are the dates the commission is effective.

Fields

Name	Description
`basis(PartnerCommissionBasis!)`	Whether the commission is paid once or on a trailing basis.
`fixedAmount(PartnerCommissionMoneyType)`	Fixed amount for a one-off commission, in the currency's minor units. Null for trailing commissions.
`name(String!)`	The name of the partner commission.
`number(ID!)`	Unique identifier for the partner commission.
`payoutType(TrailingPartnerCommissionPayoutType)`	How a trailing commission is calculated. Null for one-off commissions.
`percentage(Decimal)`	Trailing commission percentage. Null when the commission is not percentage-based.
`productUpliftConfigurations([PartnerCommissionProductUpliftConfigurationType!])`	Products and rate specifications uplifted by a trailing commission. Empty for one-off commissions.
`targetEntity(PartnerCommissionTargetEntity!)`	The entity the commission applies to.
`unitAmount(Decimal)`	Trailing commission amount per unit. Null when the commission is not unit-based.
`validFrom(DateTime!)`	When the commission becomes valid.
`validTo(DateTime)`	When the commission stops being valid. Null when the commission is open-ended.

{
  "number": "abc123",
  "name": "abc123",
  "basis": "ONE_OFF",
  "targetEntity": "LEAD",
  "validFrom": "2020-01-01T00:00:00.000Z",
  "validTo": "2020-01-01T00:00:00.000Z",
  "payoutType": "UNIT",
  "percentage": "1.0",
  "unitAmount": "1.0"
}

PartnerRole

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.

{
  "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). Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)

{
  "number": "abc123",
  "name": "abc123",
  "parentTeamNumber": "abc123"
}

PartnerTeamUserConnectionTypeConnection

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.

{
  "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

{
  "cursor": "abc123"
}

PartnerUserAccessorAccessConnectionTypeConnection

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.

{
  "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

{
  "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.

{
  "roleAssignments": RoleAssignment
}

PartnerUserPermission

Holds information about a specific permission.

Fields

Name Description

permission(String!)

The short name of the permission.

{
  "permission": "abc123"
}

PartnerUserRole

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.

{
  "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.

{
  "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.

{
  "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.

{
  "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.

{
  "name": "abc123",
  "email": "abc123",
  "number": "abc123",
  "permissions": [PartnerViewerPermission],
  "accessiblePartner": PartnerAccessType
}

PauseCollectionProcess

Output type of the pauseCollectionProcess mutation.

Fields

Name Description

collectionProcessPaused(PauseCollectionProcessOutput)

Collection process pause output.

{
  
}

PauseCollectionProcessOutput

Fields

Name Description

pauseRecords([CollectionProcessPauseStatusRecord])

Pause records on the collection process.

{
  
}

PauseDunning

Output type of the pauseDunning mutation.

Fields

Name Description

pauseCreated(Boolean)

Whether the pause has been successfully created.

{
  "pauseCreated": true
}

Payment

A payment from the customer to 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` field for a breakdown of this information.
`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. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`isAccountPayment(Boolean)`	Deprecated. Deprecated The 'isAccountPayment' field is deprecated. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`isCredit(Boolean)`	Deprecated. Deprecated The 'isCredit' field is deprecated. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`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!)`
`methodCDR(PaymentMethodCDREnum)`	The method of the payment using the CDR-defined method values.
`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. Use `billingDocumentIdentifier` instead. - Marked as deprecated on 2023-11-30. - Scheduled for removal on or after 2024-06-01.
`title(String)`	Human-readable title describing the transaction.

{
  "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",
  "methodCDR": "DIRECT_DEBIT"
}

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.

{
  "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.

{
  "isCurrentlyExempt": true,
  "latestAppliedPaymentAdequacyChange": PaymentAdequacyChangeType
}

PaymentExtensionEligibilityType

Fields

Name Description

isEligibleForPaymentExtension(Boolean)

Is the customer eligible for payment extension.

isInVictoria(Boolean)

Is the customer's billing address in Victoria or not.

requestedAt(RequestedAt)

{
  "isEligibleForPaymentExtension": true,
  "requestedAt": "AFTER_DUE_DATE",
  "isInVictoria": true
}

PaymentExtensionInfoType

Fields

Name Description

paymentExtensionEligibility(PaymentExtensionEligibilityType)

Payment extension eligibility information.

paymentExtensionOptions(PaymentExtensionOptionsType)

Options for setting up a payment extension.

{
  "paymentExtensionOptions": PaymentExtensionOptionsType,
  "paymentExtensionEligibility": PaymentExtensionEligibilityType
}

PaymentExtensionOptionsType

Fields

Name	Description
`fortnightly([Date]!)`	The allowable start dates on which a fortnightly payment can be initiated.
`fullAmount(Int!)`	The full amount that is due on the customer account.
`instalmentAmount(Int!)`	The instalment amount for the regular payments.
`payInFull([Date]!)`	The allowable dates on which a full payment can be made.
`weekly([Date]!)`	The allowable start dates on which a weekly payment can be initiated.

{
  "payInFull": "2020-01-01",
  "weekly": "2020-01-01",
  "fortnightly": "2020-01-01",
  "fullAmount": 1,
  "instalmentAmount": 1
}

PaymentFingerPrintCheckType

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.

{
  "fingerprint": "abc123",
  "isFound": true,
  "isRiskListed": true
}

PaymentForecastConnectionTypeConnection

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.

{
  "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

{
  "node": PaymentForecastType,
  "cursor": "abc123"
}

PaymentForecastType

Fields

Name	Description
`amount(Int)`	The forecasted payment amount.
`date(Date)`	The date this payment is forecasted to be collected.
`method(ScheduleType)`	The payment method used for the forecasted payment.
`paymentNumber(Int)`	The sequential position of this payment within the forecast period.

{
  "paymentNumber": 1,
  "date": "2020-01-01",
  "amount": 1,
  "method": "BACS_TRANSFER"
}

PaymentInstructionConnectionTypeConnection

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.

{
  "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

{
  "node": PaymentInstructionType,
  "cursor": "abc123"
}

PaymentInstructionOwnerType

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.

{
  "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!)`

{
  "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
}

PaymentMethodSummaryType

A summary of a payment method, safe to show to users who do not own it.

Fields

Name	Description
`id(ID!)`	The ID of the payment method.
`maskedDetails(String)`	A masked reference to the payment method.
`status(PaymentInstructionStatus!)`	Whether the payment method can be used to take payments.
`type(PaymentType!)`	The type of the payment method.

{
  "id": "abc123",
  "type": "BPAY",
  "status": "ACTIVE",
  "maskedDetails": "abc123"
}

PaymentMethodType

Fields

Name	Description
`account(AccountType!)`	The account this payment method belongs.
`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)`

{
  "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": AccountType,
  "owners": [PaymentInstructionOwnerType],
  "supplementaryLedger": SupplementaryLedgerType
}

PaymentNotification

Fields

Name Description

notificationService(String)

Notification service used to send payment notification.

reference(String)

Payment notification reference.

{
  "notificationService": "abc123",
  "reference": "abc123"
}

PaymentPlanConnectionTypeConnection

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.

{
  "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

{
  "node": PaymentPlanType,
  "cursor": "abc123"
}

PaymentPlanPaymentType

An object that represents a planned payment for a payment plan.

Fields

Name Description

amount(Int!)

payableDate(Date!)

paymentType(String)

{
  "payableDate": "2020-01-01",
  "amount": 1,
  "paymentType": "abc123"
}

PaymentPlanPreviewPaymentType

Fields

Name Description

amount(Int!)

The payable amount of this payment.

payableDate(Date!)

The payable date of this payment.

{
  "payableDate": "2020-01-01",
  "amount": 1
}

PaymentPlanType

An object that represents a payment plan.

Fields

Name	Description
`acceptedAt(DateTime)`
`account(AccountType!)`	The account associated with this payment plan.
`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!]!)`	The list of payments scheduled as part of this payment plan.
`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!)`

{
  "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": AccountType,
  "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.

{
  "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

{
  "node": PreferredInstruction,
  "cursor": "abc123"
}

PaymentPromiseType

A payment promise applies to an account that does not have automatic payments. It records that a customer has told us they'll pay an amount by an agreed-upon date.

Fields

Name Description

paymentPromises([AccountPaymentType])

{
  "paymentPromises": [AccountPaymentType]
}

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.

{
  "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

{
  "node": PaymentRequestType,
  "cursor": "abc123"
}

PaymentRequestType

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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`paymentStatus(String)`	The status of the payment.
`totalAmount(Int)`	The total amount of the payment in minor currency.

{
  "expectedPaymentDate": "2020-01-01",
  "paymentStatus": "abc123",
  "totalAmount": 1,
  "customerAmount": 1,
  "fundingSourceAmounts": FundingSourceAmountConnectionTypeConnection
}

PaymentRequestsType

Fields

Name Description

paymentRequest(PaymentRequestConnectionTypeConnection)

A list of payment requests for a given ledger.

Arguments

after (String)

before (String)

first (Int)

last (Int)

{
  "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.

{
  "createdAt": "2020-01-01T00:00:00.000Z",
  "category": "CREATED",
  "description": "abc123",
  "madeBySupportUser": true
}

PaymentScheduleConnectionTypeConnection

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.

{
  "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

{
  "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.

{
  "regular": RegularScheduleType,
  "billTriggered": BillTriggeredScheduleType,
  "balanceTriggered": BalanceTriggeredScheduleType,
  "billTriggeredBalanceTarget": BillTriggeredBalanceTargetScheduleType,
  "instalment": InstalmentScheduleType
}

PaymentScheduleDelayConfigurationType

Fields

Name Description

args(JSONString)

The arguments of the delay configuration.

code(String)

The code of the delay configuration.

{
  "code": "abc123",
  "args": {"key": "value"}
}

PaymentSchedulePaymentDayDetailsType

Fields

Name Description

description(String)

A human-readable description of the value.

direction(PaymentDayDirectionType)

Direction of payment day.

{
  "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)`	Whether or not this schedule represents a payment holiday.
`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.
`scheduledPaymentMethods(ScheduledPaymentMethodConnectionTypeConnection)`	Every scheduled payment method this payment schedule has had, past, current and future. Each entry specifies either manual collection or a specific payment method. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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)`

{
  "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],
  "scheduledPaymentMethods": ScheduledPaymentMethodConnectionTypeConnection
}

PaymentTermsInvalidErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PaymentWithNonConcludedRePresentationConnectionTypeConnection

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.

{
  "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

{
  "node": PaymentWithNonConcludedRePresentationType,
  "cursor": "abc123"
}

PaymentWithNonConcludedRePresentationType

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.

{
  "amountPayable": 1,
  "payableDate": "2020-01-01"
}

PayoutReferralForAccount

Output type of the payoutReferralForAccount mutation.

Fields

Name Description

payoutResult(PayoutReferralForAccountResultType)

The result of the payout.

{
  
}

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.

{
  "accountCreditAmount": 1
}

PaysByDirectDebitType

Represents a restriction for if an account should pay only by direct debit in a contract.

Note: This type is a stub, and will be fleshed out in the future.

Fields

Name	Description
`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.
`paysByDirectDebit(Boolean!)`	Whether the account is paying by direct debit or not.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "paysByDirectDebit": true
}

Period

Fields

Name Description

end(DateTime!)

The period end.

start(DateTime!)

The period start.

{
  "start": "2020-01-01T00:00:00.000Z",
  "end": "2020-01-01T00:00:00.000Z"
}

PeriodBasedDocumentType

Fields

Name	Description
`accountNumber(String!)`	The bill account number.
`attachments(BillingAttachmentConnectionTypeConnection)`	Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`averageDailyExport(Float)`	This field returns the average daily solar export during the consumption period of a statement.
`averageDailyUsage(Float)`	This field returns the average daily usage (import only) during the consumption period of a statement.
`billType(BillTypeEnum)`	The type of the bill.
`closingBalance(Int!)`	The closing balance of an issued billing document. Arguments `ledgerNumber` (`String`) When provided, the closing balance for this ledger on this statement. Required if multiple ledgers are affected by this statement.
`consumptionEndDate(Date)`	The last day of consumption that this statement includes.
`consumptionStartDate(Date)`	The first day of consumption that this statement includes.
`documentDebtPosition(BillingDocumentPositionType)`	Position of the billing document in the delinquent debt tracking system.
`dueDate(Date)`	The date by which the billed amount is due from the customer or null for unfinalized bills.
`fromDate(Date)`	The date of the constituent bill covered from. This may differ from the service/consumption period shown on the bill document.
`heldStatus(StatementHeldStatus)`	Retrieve the held status of a account statement.
`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.
`isFinal(Boolean)`	Whether the issued statement is considered 'final' for this account.
`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 `ledgerNumber` (`String`) 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)`	Arguments `after` (`String`) `before` (`String`) `code` (`String`) The code of a representation. Used to identify different types of representations. `first` (`Int`) `last` (`Int`)
`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. This field is deprecated. Use the 'attachments' field instead. - Marked as deprecated on 2024-09-16. - Scheduled for removal on or after 2025-09-01.
`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.
`totalRepayments(BigInt)`	This field returns the total amount of repayments on a statement.
`transactions(BillTransactionConnectionTypeConnection)`	Transactions on the given billing document. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `ledgerNumber` (`String`) When provided, only entries that are linked to that ledger are returned. `orderBy` (`TransactionsOrderBy`) The order in which to return the transactions. `transactionTypes` (`[TransactionTypeFilter]`) Include only these specific transaction types in the result.
`transactionsTmp(TransactionConnectionTypeConnection)`	Transactions on the bill. Note: this field is temporary while we design an an updated version of these APIs for new issuance. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`)
`unfulfilledContributionItems([ContributionItemType])`	Returns a list of unfulfilled contribution items by scheme name.
`unfulfilledDeposits(BigInt)`	This field returns the total amount of unfulfilled deposits on a statement.
`uuid(UUID)`	Unique identifier for the billing document.

{
  "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"],
  "averageDailyUsage": 1.0,
  "averageDailyExport": 1.0,
  "dueDate": "2020-01-01",
  "isFinal": true,
  "transactionsTmp": TransactionConnectionTypeConnection,
  "accountNumber": "abc123",
  "totalRepayments": 1,
  "unfulfilledDeposits": 1,
  "unfulfilledContributionItems": [ContributionItemType],
  "consumptionStartDate": "2020-01-01",
  "consumptionEndDate": "2020-01-01",
  "heldStatus": StatementHeldStatus
}

PhoneNumberIdentificationType

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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`accountBestMatch(AccountType)`	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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`accountUserBestMatch(AccountUserType)`	Our best guess for which account user would be calling from this phone number.

{
  "accountBestMatch": AccountType,
  "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.

{
  
}

PillButtonType

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.

{
  "buttonStyle": "PRIMARY",
  "title": "abc123",
  "buttonAction": DeeplinkActionType,
  "id": "abc123",
  "typename": "abc123"
}

PointsAllowanceRateLimitInformation

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.

{
  "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.

{
  "id": "abc123",
  "typename": "abc123",
  "points": 1
}

PortfolioAccessConnectionTypeConnection

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.

{
  "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

{
  "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.

{
  "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.

{
  "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

{
  "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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`) `roleCodes` (`[String!]`) Filter accessors by role codes. `scope` (`AccessScope`) Whether to return only directly assigned accessors (DIRECT) or all accessors including inherited access (ALL, default).
`accounts(AccountConnectionTypeConnection)`	The accounts associated with this portfolio. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`ancestors(PortfolioConnectionTypeConnection)`	The ancestors of the given portfolio. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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!)`

{
  "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. An access allocation's identifier is internal to the Customer Access domain. Access is identified by who it affects, not by the row that records it: please use 'user', 'portfolio' and 'role' instead. - Marked as deprecated on 2026-09-02. - Scheduled for removal on or after 2026-11-01.
`portfolio(PortfolioType!)`	Portfolio object.
`role(RoleString)`	The portfolio role.
`user(AccountUserType!)`

{
  "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.

{
  "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).

{
  "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

{
  "credit": Credit,
  "possibleErrors": [PossibleErrorType]
}

PreKrakenBillType

Fields

Name	Description
`attachments(BillingAttachmentConnectionTypeConnection)`	Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`averageDailyUsage(Float)`
`billType(BillTypeEnum)`	The type of the bill.
`fromDate(Date)`	The date of the constituent bill 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 constituent bill.
`identifier(String)`	The unique identifier of a historical bill. It will usually be present on the billing document itself.
`isReversed(Boolean)`	Whether the bill has been reversed. Null will be returned if this information wasn't sent in through the data import pipeline.
`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. This field is deprecated. Use the 'attachments' field instead. - Marked as deprecated on 2024-09-16. - Scheduled for removal on or after 2025-09-01.
`toDate(Date)`	The date of the constituent bill covered to. This may differ from the service/consumption period shown on the bill document.
`totalConsumption(Float)`
`totalConsumptionCost(Float)`
`totalFeedInCost(Float)`
`totalFeedInEnergy(Float)`
`totalSupplyCost(Float)`

{
  "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,
  "averageDailyUsage": 1.0,
  "totalConsumption": 1.0,
  "totalConsumptionCost": 1.0,
  "totalSupplyCost": 1.0,
  "totalFeedInEnergy": 1.0,
  "totalFeedInCost": 1.0,
  "isReversed": true
}

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.

{
  "scope": "SUBMIT_METER_READINGS",
  "key": "abc123",
  "isValid": true
}

PreconditionsNotMetErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PredictedBillAgreementNotFoundErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PredictedBillBasicMeterNotSupportedErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PredictedBillBasicMetersRequiredOnQuarantineType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PredictedBillCannotCalculateBillMissingNetworkTariffCodeType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PredictedBillCannotEstimateConcessionsErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PredictedBillChargeType

Fields

Name Description

costInCents(Decimal!)

costInCentsWithGst(Decimal!)

{
  "costInCents": "1.0",
  "costInCentsWithGst": "1.0"
}

PredictedBillComponentsType

Fields

Name	Description
`capacityChargesToDate(PredictedBillChargeType!)`	Capacity charges since the beginning of the current billing period.
`concessionCreditToDate(PredictedBillCreditType!)`	Concession credit since the beginning of the current billing period.
`consumptionChargesToDate(PredictedBillChargeType!)`	Consumption charges since the beginning of the current billing period.
`demandChargesToDate(PredictedBillChargeType!)`	Demand charges since the beginning of the current billing period.
`pastWeekCapacityCharges(PredictedBillChargeType!)`	7-day rolling average capacity charges (for prediction like consumption).
`pastWeekConsumptionCharges(PredictedBillChargeType!)`
`pastWeekDemandCharges(PredictedBillChargeType!)`	7-day rolling average demand charges (for prediction like consumption).
`predictedCapacityCharges(PredictedBillChargeType!)`	Capacity charges predicted from now until the end of the current billing period.
`predictedConcessionCredit(PredictedBillCreditType!)`	Concession credit predicted from now until the end of the current billing period.
`predictedConsumptionCharges(PredictedBillChargeType!)`	Consumption charges predicted from now until the end of the current billing period.
`predictedDemandCharges(PredictedBillChargeType!)`	Demand charges predicted from now until the end of the current billing period.
`predictedStandingCharges(PredictedBillChargeType!)`	Standing charges predicted from now until the end of the current billing period.
`secondsSinceBeginningOfBillingPeriod(Int!)`
`secondsUntilEndOfBillingPeriod(Int!)`
`standingChargesToDate(PredictedBillChargeType!)`	Standing charges since the beginning of the current billing period.

{
  "consumptionChargesToDate": PredictedBillChargeType,
  "predictedConsumptionCharges": PredictedBillChargeType,
  "pastWeekConsumptionCharges": PredictedBillChargeType,
  "standingChargesToDate": PredictedBillChargeType,
  "predictedStandingCharges": PredictedBillChargeType,
  "capacityChargesToDate": PredictedBillChargeType,
  "pastWeekCapacityCharges": PredictedBillChargeType,
  "predictedCapacityCharges": PredictedBillChargeType,
  "demandChargesToDate": PredictedBillChargeType,
  "pastWeekDemandCharges": PredictedBillChargeType,
  "predictedDemandCharges": PredictedBillChargeType,
  "predictedConcessionCredit": PredictedBillCreditType,
  "concessionCreditToDate": PredictedBillCreditType,
  "secondsUntilEndOfBillingPeriod": 1,
  "secondsSinceBeginningOfBillingPeriod": 1
}

PredictedBillCreditType

Fields

Name Description

creditInCents(Decimal!)

Credit amount in cents (ex GST).

creditInCentsWithGst(Decimal!)

Credit amount in cents (inc GST).

{
  "creditInCents": "1.0",
  "creditInCentsWithGst": "1.0"
}

PredictedBillFailedToDeterminePeriodErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PredictedBillFixedBillingNotSupportedErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PredictedBillMetricsType

Fields

Name Description

averageDailyChargesPredicted(PredictedBillChargeType)

Average daily charges considering the whole billing period. If a nullable is returned, the billing options haven't been set properly and might require an Energy Specialist to fix it.

averageDailyChargesToDate(PredictedBillChargeType)

Average daily charges from the beginning of the billing period to date. Where 'to date' currently refers to the date of the last reading. If a nullable is returned, not enough days (less than one) have accrued since the beginning of the billing period. Therefore the daily average cost can't be calculated yet.

{
  "averageDailyChargesPredicted": PredictedBillChargeType,
  "averageDailyChargesToDate": PredictedBillChargeType
}

PredictedBillReadingNotFoundErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PredictedBillSteppedTariffNotSupportedErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PredictedBillTenantNotFoundErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PredictedBillType

Fields

Name	Description
`billEndsAt(DateTime)`
`billStartsAt(DateTime)`
`components(PredictedBillComponentsType)`	Components used to calculate the prediction equation.
`costInCents(Decimal)`
`costInCentsWithGst(Decimal)`
`lastReading(ElectricityMeterReadingType)`
`lastReadingDatetime(DateTime)`
`metrics(PredictedBillMetricsType)`	Additional metrics calculated from the predicted bill.
`predictedBillError(PredictedBillErrorUnion)`

{
  "costInCents": "1.0",
  "costInCentsWithGst": "1.0",
  "lastReadingDatetime": "2020-01-01T00:00:00.000Z",
  "billStartsAt": "2020-01-01T00:00:00.000Z",
  "billEndsAt": "2020-01-01T00:00:00.000Z",
  "lastReading": ElectricityAccumulationMeterReadingType,
  "components": PredictedBillComponentsType,
  "predictedBillError": PredictedBillBasicMeterNotSupportedErrorType,
  "metrics": PredictedBillMetricsType
}

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.

{
  "forPaymentsAfter": "abc123",
  "status": "abc123",
  "paymentMethod": PaymentInstructionType
}

PrepareAccountResult

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.

{
  "isNewAccount": true,
  "accountNumber": "abc123",
  "isNewUser": true,
  "userId": "abc123",
  "userNumber": "abc123"
}

PreviewAndCreatePaymentPlan

Output type of the previewAndCreatePaymentPlan mutation.

Fields

Name Description

createdPaymentPlan(PaymentPlanType)

Data for newly created payment plan of one was created.

paymentPlanPreview([PaymentPlanPreviewPaymentType])

Preview payments for a new payment plan.

{
  "paymentPlanPreview": [PaymentPlanPreviewPaymentType],
  "createdPaymentPlan": PaymentPlanType
}

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.

{
  "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.

{
  "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.

{
  "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.

{
  "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. Please use 'characteristics' instead. - Marked as deprecated on 2026-07-17. - Scheduled for removal on or after 2026-07-31.
`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. Please use 'schemes' instead. - Marked as deprecated on 2026-07-17. - Scheduled for removal on or after 2026-07-31.
`schemes(GenericScalar)`	The scheme labels for the variant.

{
  "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"
}

PricePerUnit

Fields

Name Description

amount(Decimal!)

        Monetary value of a single unit of the measurement.
        This is the smallest unit of currency e.g. cents for USD or yen for JPY.

unit(Unit)

Unit that monetary amount relates to eg. 27 cents per kwh.

{
  "amount": "1.0",
  "unit": "KILOWATT_HOURS"
}

PricingZoneType

Fields

Name Description

label(String)

Human readable label for the Gas pricing zone.

value(String)

Identifier value for the Gas pricing zone.

{
  "value": "abc123",
  "label": "abc123"
}

PrimaryResidenceType

Fields

Name	Description
`fromDate(Date!)`	Inclusive, industrytime
`id(ID!)`
`property(PropertyType)`
`toDate(Date)`	Exclusive, industrytime
`updatedAt(DateTime)`
`user(AccountUserType)`

{
  "id": "abc123",
  "fromDate": "2020-01-01",
  "toDate": "2020-01-01",
  "updatedAt": "2020-01-01T00:00:00.000Z",
  "property": PropertyType,
  "user": AccountUserType
}

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).

{
  "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.

Arguments

after (String)

before (String)

first (Int)

isHighPriority (Boolean)

Whether to filter to include or exclude high priority messages. If not supplied, no filtering will be performed.

last (Int)

offset (Int)

status(PrintBatchStatus)

The status of the print batch.

{
  "id": "abc123",
  "status": "OPEN",
  "messages": PrintMessageTypeConnection
}

PrintEventType

Fields

Name	Description
`eventType(String!)`
`id(ID!)`	The ID of the object
`message(PrintMessageType)`	Print message of the print event.
`occurredAt(DateTime!)`

{
  "id": "abc123",
  "eventType": "abc123",
  "occurredAt": "2020-01-01T00:00:00.000Z",
  "message": PrintMessageType
}

PrintMessageType

Represents a print communication.

Fields

Name	Description
`account(AccountType)`
`attachments([PrintAttachmentType])`	Attachments of the message.
`highPriority(Boolean)`	Comms that are marked as high priority.
`id(ID!)`	The ID of the object
`templateCode(String!)`

{
  "id": "abc123",
  "templateCode": "abc123",
  "attachments": [PrintAttachmentType],
  "account": AccountType,
  "highPriority": true
}

PrintMessageTypeConnection

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.

{
  "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

{
  "node": PrintMessageType,
  "cursor": "abc123"
}

ProcessHouseMove

Output type of the processHouseMove mutation.

Fields

Name Description

account(AccountType)

The account created or associated with the move in.

error(ProcessHouseMoveErrorUnion)

Error type for the house move in process.

{
  "account": AccountType,
  "error": DoesNotExistErrorType
}

ProcessHouseMoveInElectricity

Output type of the processHouseMoveInElectricity mutation.

Fields

Name Description

account(AccountType)

error(ProcessHouseMoveInElectricityErrorUnion)

Error type for the move in process.

{
  "account": AccountType,
  "error": DoesNotExistErrorType
}

ProcessHouseMoveInGas

Output type of the processHouseMoveInGas mutation.

Fields

Name Description

account(AccountType)

error(ProcessHouseMoveInGasErrorUnion)

Error type for the gas move in process.

{
  "account": AccountType,
  "error": DoesNotExistErrorType
}

Product

Fields

Name	Description
`addonRates([AddonFamilyType])`	Groupings of product rates associated with an add on. Arguments `availableAt` (`DateTime`) Datetime the rate is available at.
`availabilityStatus(ProductAvailability)`	The availability status of the product (eg. for public or restricted use).
`availableTo(DateTime)`	The date until which the product is available to be purchased.
`clientParams(JSONString)`	Additional metadata from client sources stored against the product. This data is not structural and should not be relied upon for customer-facing applications.
`code(String)`
`description(String)`	The description shown to customers during sign up process.
`displayName(String)`	The display name shown to customers during sign up process.
`dmoReference(ProductDmoReferenceType)`	Arguments `networkTariffCodes` (`[String]`) Electricity product related DMO reference.
`emissionsReduction(Decimal)`	The percentage of the product's emissions that are offset, if applicable, as a decimal number between 0 and 1.
`error(ProductErrorUnion)`
`fullName(String)`	The full descriptive name of the product.
`id(ID)`
`isStandingOffer(Boolean)`
`isVariable(Boolean)`	Whether the product's prices are variable or fixed.
`loyalty(LoyaltyType)`	Loyalty details if required for product.
`marketName(MarketName)`	Market the product is associated with.
`paginatedRates(RatesConnectionFieldConnection)`	Rates associated with a product. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `isBusiness` (`Boolean`) Optional boolean to determine the price default (only electricity). `last` (`Int`) `mirn` (`String`) Applies only for gas products. `nmi` (`String`) Applies only for electricity products. `onlyActiveRates` (`Boolean`) When false, negate any filtering done by RatesActiveAt and return every rate. `postcode` (`String`) Optional postcode to determine the price zone (gas/electricity). `ratesActiveAt` (`Date`) Return only rates active at this time. Defaults to now. `suburb` (`String`) Optional suburb to determine the price default (only electricity).
`params(JSONString)`	Additional metadata from various sources stored against the product. Used for servicing Consumer Data Right requirements.This data is not structural and should not be used for customer-facing applications. Deprecated The 'params' field is deprecated. Don't use this field for customer queries as data in this JSON isn't structured and may change. - Marked as deprecated on 2023-09-27. - Scheduled for removal on or after 2023-10-27.
`productRates([RateInterface])`	Deprecated The 'productRates' field is deprecated. Use paginatedRates instead. - Marked as deprecated on 2022-09-02. - Scheduled for removal on or after 2022-10-16.
`rank(Int)`	The rank of the product.
`term(Int)`	The length of time during which the product benefits apply for (in months).
`timeOfUseDescriptions([String])`	Time-of-use description lines for the electricity meter's network tariff. Null if the product isn't electricity or no description is available. Arguments `nmi` (`String!`) The NMI whose network tariff code(s) determine the time-of-use descriptions.

{
  "id": "abc123",
  "productRates": RateInterface,
  "paginatedRates": RatesConnectionFieldConnection,
  "addonRates": [AddonFamilyType],
  "dmoReference": ProductDmoReferenceType,
  "timeOfUseDescriptions": ["abc123"],
  "code": "abc123",
  "displayName": "abc123",
  "fullName": "abc123",
  "description": "abc123",
  "isStandingOffer": true,
  "marketName": "AUS_ELECTRICITY",
  "isVariable": true,
  "emissionsReduction": "1.0",
  "availabilityStatus": "EVERYONE",
  "availableTo": "2020-01-01T00:00:00.000Z",
  "term": 1,
  "rank": 1,
  "params": {"key": "value"},
  "clientParams": {"key": "value"},
  "loyalty": LoyaltyType
}

ProductCodeNotFoundErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

ProductCodeNotInQuote

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

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.

{
  "identifier": "abc123",
  "minimumQuantity": 1,
  "maximumQuantity": 1,
  "initialQuantity": 1
}

ProductDmoReferenceType

Deprecated: only used for mass-market elec and replaced by PriceReferenceInterface above.

Fields

Name	Description
`annualCost(Decimal!)`	The calculated annual cost, in $.
`effectiveFrom(Date!)`	The date the reference became effective.
`effectiveTo(Date)`	The last date on which the reference is effective.
`id(ID!)`	The unique identifier of the ProductDmoReference or ProductDMOComparison.
`ntcCombination([String]!)`	Relevant NTCs for this reference.
`planId(String)`	Plan Id.
`savingPercentage(Int!)`	The savings percentage, relative to the Usage Reference annual cost.

{
  "id": "abc123",
  "effectiveFrom": "2020-01-01",
  "effectiveTo": "2020-01-01",
  "ntcCombination": "abc123",
  "planId": "abc123",
  "annualCost": "1.0",
  "savingPercentage": 1
}

ProductDoesNotExist

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

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.

{
  "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.

{
  "characteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
  "schemes": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}

ProductRateOverrideConfigurationType

Configuration for Product Rate Override Configuration term.

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.
`indexationOptions(IndexationOptionsType)`	The indexation options for the product rate override configuration.
`isVariable(Boolean)`	Whether the term is variable.
`schedules([ProductRateOverrideScheduleType])`	The schedules for the product rate override configuration.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "indexationOptions": IndexationOptionsType,
  "schedules": [ProductRateOverrideScheduleType]
}

ProductRateOverrideItemType

Item for Product Rate Override Configuration term.

Fields

Name Description

pricePerUnit(Decimal)

The price per unit for the product rate override item.

productCode(String)

The product code for the product rate override item.

rateBand(String)

The rate band for the product rate override item.

{
  "productCode": "abc123",
  "rateBand": "abc123",
  "pricePerUnit": "1.0"
}

ProductRateOverrideScheduleType

Schedule for Product Rate Override Configuration term.

Fields

Name Description

effectiveFrom(DateTime)

The effective from date for the product rate override schedule.

items([ProductRateOverrideItemType])

The items for the product rate override schedule.

{
  "items": [ProductRateOverrideItemType],
  "effectiveFrom": "2020-01-01T00:00:00.000Z"
}

ProductRateType

Generic product rate.

Fields

Name	Description
`bandCategory(BandCategory)`	Category of band associated with a product rate.
`bandSubcategory(String)`	Subcategory of band associated with a product rate.
`currency(String)`
`id(ID)`	ID associated with product rate.
`pricePerUnit(Decimal!)`	Price in cents per unit.
`rateDescription(String)`	Description that will show up on the customer's bill.
`rateExcludingTax(Float)`	Unit cost before tax.
`rateIncludingTax(Float)`	Unit cost including tax.
`stepEnd(Float)`	End of the step the rate applies to (Exclusive).
`stepStart(Float)`	Start of the step the rate applies to.
`unitType(UnitType!)`	What the rate is for, e.g. kWh of electricity, MJ or Units of gas, or days on supply.
`validFrom(DateTime)`
`validTo(DateTime)`

{
  "currency": "abc123",
  "pricePerUnit": "1.0",
  "bandCategory": "STANDING_CHARGE",
  "bandSubcategory": "abc123",
  "rateExcludingTax": 1.0,
  "rateIncludingTax": 1.0,
  "rateDescription": "abc123",
  "unitType": "DAYS_ON_SUPPLY",
  "validFrom": "2020-01-01T00:00:00.000Z",
  "validTo": "2020-01-01T00:00:00.000Z",
  "stepStart": 1.0,
  "stepEnd": 1.0,
  "id": "abc123"
}

ProductReferenceType

Fields

Name	Description
`annualCost(Int!)`
`pricingZone(ProductReferencePricingZone!)`
`product(Product!)`	The product associated with this reference.
`savingPercentage(Int!)`	The saving percentage variance

{
  "pricingZone": "AGLNSW",
  "annualCost": 1,
  "savingPercentage": 1,
  "product": Product
}

ProductSwitchProcessType

Fields

Name	Description
`agreedAt(DateTime)`
`characteristics(JSONString)`	Product characteristics captured for this switch, forwarded to agreement creation.
`createdAt(DateTime)`
`newAgreement(CommonAgreementType)`	The agreement created by the product switch, once completed. Null until then. Requires the CANQUERYAGREEMENTS permission.
`offer(OfferType)`	The Offer selected for this switch, if it was created via the commercial quoting/offer flow rather than primitives or a QuotedProduct.
`product(SupplyProductType!)`	The product selected for the switch.
`status(String!)`	The current status of the product switch process.
`switchDate(DateTime!)`
`updatedAt(DateTime)`
`uuid(UUID!)`
`validTo(DateTime)`

{
  "uuid": "500c164d-38c7-4f74-9ac6-be210197e9e4",
  "switchDate": "2020-01-01T00:00:00.000Z",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T00:00:00.000Z",
  "agreedAt": "2020-01-01T00:00:00.000Z",
  "validTo": "2020-01-01T00:00:00.000Z",
  "status": "abc123",
  "newAgreement": CommonAgreementType,
  "product": SupplyProductType,
  "offer": OfferType,
  "characteristics": {"key": "value"}
}

PromotionAssignmentScheduleType

Represents a schedule for promotion assignment within a contract.

Fields

Name Description

discountTargets(JSONString)

        A mapping from discount codes to lists of targets.
        Each target is represented as:
        {
            'target_type': {'domain': ..., 'type': ...},
            'identifier': ...,
            'displayed_on_bill': ...,
            'eligibility_window': {'window_type': ..., 'window_data': ...}
        }
        Eligibility_window is optional. Supported window_type values are:
        'FIXED_PERIOD'
        (window_data: {'period': {'start': <ISO datetime>, 'end': <ISO datetime>}})
        and
        'RELATIVE_DURATION'
        (window_data: {'calendar_unit': 'day'|'week'|'month'|'year', 'count': <int>}).

promotionCode(String)

The promotion code for this schedule.

{
  "promotionCode": "abc123",
  "discountTargets": {"key": "value"}
}

PromotionAssignmentTermType

Represents a promotion assignment 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.
`schedules([PromotionAssignmentScheduleType])`	A list of promotion assignment schedules associated with the contract.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "schedules": [PromotionAssignmentScheduleType]
}

PropertyCanNotFoundErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

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.

{
  "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

{
  "node": PropertyInterface,
  "cursor": "abc123"
}

PropertyMoveOut

Output type of the propertyMoveOut mutation.

Fields

Name Description

possibleErrors([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

workflow(WorkflowType!)

Information on the workflow which is processing the move out.

{
  "workflow": WorkflowType,
  "possibleErrors": [PossibleErrorType]
}

PropertyNotFound

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

PropertyRichAddressType

Fields

Name	Description
`administrativeArea(String)`	Top-level administrative subdivision, e.g. US state, AU state/territory, NZ, region, IT region, JP prefecture. `AU`: Australia This must be one of `NSW`, `VIC`, `QLD`, `TAS`, `ACT`, `SA`, `NT`, `WA`. For addresses not within these locations, use the value that Australia Post uses, e.g. `ACT` for the Jervis Bay Territory or `WA` for Christmas Island.
`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 `showCountry` (`Boolean`) Whether to include the country. The country will be spelled out in all-caps on the last line, as per Universal Postal Union standards. `showName` (`Boolean`) Whether to include the name attached to this address. `showPostalCode` (`Boolean`) 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. `AU`, `GB`, `NZ`.
`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 `dependent_locality` field. This happens when data has been migrated from a legacy format, and that format had insufficient metadata to determine the appropriate field. If `structured_street_address` is also set, the value of this field will be a string generated from that value.
`structuredStreetAddress(GenericScalar)`	The 'street address' component, in a structured format. This field stores the same value as `street_address`, but with more detail; for instance, instead of `123 Example Street` it might be `{'street_number': '123', 'street_name': 'Example', 'street_type': 'Street'}`. In many cases this will be blank; we only use this field for Krakens where we need to supply this level of granularity to some third-party service, like a bulk mail provider. 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. `AU`: Australia The following keys may be present; all are optional. All keys have string values, and their meaning is the same as their aseXML counterparts. (Note that, unlike aseXML, all keys are provided at the top level, rather than being nested.) `flat_or_unit_type` `flat_or_unit_number` `floor_or_level_type` `floor_or_level_number` `building_or_property_name` `location_descriptor` `lot_number` `house_number_1` `house_number_suffix_1` `house_number_2` `house_number_suffix_2` `street_name` `street_type` `street_suffix` `postal_delivery_type` `postal_delivery_number_prefix` `postal_delivery_number_value` `postal_delivery_number_suffix` `IT`: Italy A structured street address is only returned when all three keys are known; otherwise the address is returned via `street_address`. `street_type`: e.g. `Via`, `Corso`, `Piazza` `street_name`: e.g. `Garibaldi` `street_number`: e.g. `67` `JP`: Japan The following keys may be present; all are optional. If keys are empty, they may be omitted from the response entirely. `chome` `banchi` `go` `edaban` `kana_building_name` `kanji_building_name` `building_number` `room_number` `address_code` `physical_location_identifier` `kana_company_name` `kanji_company_name` `NZ`: New Zealand The following keys may be present; all are optional. If keys are empty, they may be omitted from the response entirely. `flat_or_unit_type` `flat_or_unit_number` `floor_or_level_type` `floor_or_level_number` `property_name` `building_name` `house_number_1` `house_number_suffix_1` `house_number_2` `house_number_suffix_2` `street_prefix` `street_name` `street_type` `street_suffix` `rural_delivery_number` `mailtown` `postal_delivery_type` `postal_delivery_location` `postal_delivery_number_prefix` `postal_delivery_number_value` `postal_delivery_number_suffix` `US`: United States The following keys may be present; all are optional. If keys are empty, they may be omitted from the response entirely. `primary_number` `primary_name_prefix_dir` `primary_name` `primary_name_suffix` `primary_name_suffix_dir` `secondary_name` `secondary_number`
`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.

{
  "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"
}

PropertySearchResult

Fields

Name Description

property(PropertyType!)

The matched property.

score(Decimal!)

A score representing the degree of confidence for a match.

{
  "score": "1.0",
  "property": PropertyType
}

PropertyType

Fields

Name	Description
`address(String)`	The address of the property, formatted into a single string.
`addressLine1(String!)`
`addressLine2(String!)`
`addressLine3(String!)`
`addressLine4(String!)`
`addressLine5(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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `hierarchyName` (`String`) The name of the hierarchy to query within. `last` (`Int`)
`benchmarks([EnergyBenchmarkType])`	Estimated daily energy usage for households of different sizes in this property's neighbourhood (selected by postcode) for the season which overlaps the current billing period. If the property isn't on supply, or isn't on a fixed billing schedule, then we will return the benchmarks which would apply today instead. Returns null if we don't have benchmark data for this combination of postcode and season.
`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. Arguments `after` (`String`) `before` (`String`) `depth` (`Int`) Maximum depth of descendants to return. Defaults to 1 (immediate children). Set to null for all descendants. `first` (`Int`) `hierarchyName` (`String`) The name of the hierarchy to query within. `last` (`Int`)
`electricityMeterPoints([MeterPointType])`	Deprecated The 'electricityMeterPoints' field is deprecated. Use meterPoints instead. - Marked as deprecated on 2022-09-02. - Scheduled for removal on or after 2022-10-02.
`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 `after` (`String`) `before` (`String`) `endAt` (`DateTime`) Defaults to the far future which will return the most recent readings. `endOn` (`Date`) Latest date to return measurements for (inclusive). `first` (`Int`) `last` (`Int`) `startAt` (`DateTime`) Defaults to the far past which will return the oldest readings. `startOn` (`Date`) Earliest date to return measurements from. `timezone` (`String`) Timezone to use for grouping. Defaults to Kraken localtime. `utilityFilters` (`[UtilityFiltersInput]`) Filters for each utility being measured.
`meterPoints([MeterPointInterface])`
`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 `hierarchyName` (`String`) The name of the hierarchy to query within.
`postcode(String!)`
`richAddress(PropertyRichAddressType)`	Property rich address.
`splitAddress([String])`	List of address lines.
`state(StateChoices)`	State that the property resides in.

{
  "id": "abc123",
  "postcode": "abc123",
  "label": "abc123",
  "addressLine1": "abc123",
  "addressLine2": "abc123",
  "addressLine3": "abc123",
  "addressLine4": "abc123",
  "addressLine5": "abc123",
  "address": "abc123",
  "richAddress": PropertyRichAddressType,
  "splitAddress": ["abc123"],
  "occupancyPeriods": [OccupancyPeriodType],
  "coordinates": CoordinatesType,
  "embeddedNetwork": EmbeddedNetworkType,
  "parent": PropertyInterface,
  "descendants": PropertyConnection,
  "ancestors": PropertyConnection,
  "measurements": MeasurementConnection,
  "electricityMeterPoints": [MeterPointType],
  "meterPoints": MeterPointInterface,
  "benchmarks": [EnergyBenchmarkType],
  "state": "AUSTRALIAN_CAPITAL_TERRITORY"
}

ProviderType

Fields

Name	Description
`displayName(String!)`	The customer-facing display name of the provider.
`emergencyPhoneNumber(String!)`	The emergency contact phone number for the provider.
`id(String!)`	The AEMO participant identifier code for this provider.
`longName(String!)`	The full registered name of the provider.
`outagePhoneNumber(String)`	The outage reporting phone number for the provider.
`shortName(String!)`	The abbreviated name of the provider.

{
  "id": "abc123",
  "shortName": "abc123",
  "longName": "abc123",
  "displayName": "abc123",
  "emergencyPhoneNumber": "abc123",
  "outagePhoneNumber": "abc123"
}

ProvisionalTransactionConnectionTypeConnection

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.

{
  "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

{
  "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.

{
  "id": "abc123",
  "title": "abc123",
  "amount": 1,
  "date": "2020-01-01"
}

PublishMeterDataIssueEmail

Output type of the publishMeterDataIssueEmail mutation.

Fields

Name Description

result(PublishMeterDataIssueEmailOutputType)

The result of publishing a meter data issue email.

{
  
}

PublishMeterDataIssueEmailOutputType

Fields

Name Description

issueId(ID)

The ID of the MeterDataIssue.

{
  "issueId": "abc123"
}

PublishTransactionalMessagingExternalTrigger

Output type of the publishTransactionalMessagingExternalTrigger mutation.

Fields

Name Description

trigger(Trigger)

The trigger that has been published.

{
  
}

PublishTransactionalMessagingTrigger

Output type of the publishTransactionalMessagingTrigger mutation.

Fields

Name Description

possibleErrors([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

trigger(Trigger)

The trigger that has been published.

{
  "possibleErrors": [PossibleErrorType]
}

PurchaseVoucher

Output type of the purchaseVoucher mutation.

Fields

Name Description

voucherPurchase(VoucherPurchaseType)

The voucher purchase created from the mutation.

{
  "voucherPurchase": VoucherPurchaseType
}

PurchaseVouchers

Output type of the purchaseVouchers mutation.

Fields

Name Description

voucherPurchases([VoucherPurchaseType])

The voucher purchases created from the mutation.

{
  "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!)`	Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`)
`registeredAt(DateTime!)`
`token(String!)`
`user(AccountUserType!)`

{
  "id": "abc123",
  "registeredAt": "2020-01-01T00:00:00.000Z",
  "expiresAt": "2020-01-01T00:00:00.000Z",
  "user": AccountUserType,
  "messages": PrintMessageTypeConnection,
  "application": NotifiableApplicationType,
  "token": "abc123"
}

PushNotificationEventType

Fields

Name	Description
`eventType(String!)`
`id(ID!)`	The ID of the object
`message(PushNotificationMessageType)`	Push notification message of the push notification event.
`occurredAt(DateTime!)`

{
  "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.

{
  "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.

{
  "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.

{
  "magnitude": 1.0,
  "unit": "abc123",
  "description": "abc123"
}

QuarantineElectricitySelfMeterRead

Output type of the quarantineElectricitySelfMeterRead mutation.

Fields

Name Description

reading(ElectricityAccumulationMeterReadingType)

The reading, which is quarantined.

{
  "reading": ElectricityAccumulationMeterReadingType
}

QueryComplexityOutputType

Fields

Name Description

complexityValue(Int)

The complexity of the query.

{
  "complexityValue": 1
}

QuoteBespokeRateConfigurationType

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.

{
  "type": NonEmptyString,
  "identifier": "abc123",
  "isVariable": true
}

QuoteBespokeRateItemType

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.

{
  "identifier": "abc123",
  "rateSpecificationCode": "abc123",
  "pricePerUnit": "1.0"
}

QuoteBespokeRateScheduleType

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.

{
  "identifier": "abc123",
  "validFrom": "2020-01-01T00:00:00.000Z",
  "validTo": "2020-01-01T00:00:00.000Z"
}

QuoteBillDueDateConfigurationType

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.

{
  "type": NonEmptyString,
  "identifier": "abc123",
  "isVariable": true,
  "numberOfDays": 1,
  "typeOfDays": "abc123"
}

QuoteComponentType

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 `expireIn` (`Int`) Expiration time for S3 URLs in seconds. Defaults to 1 hour (3600 seconds).

{
  "identifier": "abc123",
  "productComponentIdentifier": "abc123",
  "costs": [QuoteCostType],
  "quotingParamsInputData": [QuotingParamType],
  "createdAt": "2020-01-01T00:00:00.000Z",
  "termsAndConditionsS3Urls": [TermsAndConditionsS3UrlType]
}

QuoteConfigurationExtraDetailItemType

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.

{
  "fieldCode": "abc123",
  "fieldValue": "abc123",
  "fieldType": "abc123"
}

QuoteConfigurationType

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.
`hasAgreementOverlap(Boolean)`	Whether this configuration's contract period overlaps an existing agreement for the account. An order cannot be created from this configuration while true.
`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.

{
  "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,
  "hasAgreementOverlap": true
}

QuoteConfigurationVariantProfileType

Fields

Name Description

characteristicValues(JSONString)

Characteristic values for this variant profile.

schemeLabels(JSONString)

Scheme labels for this variant profile.

{
  "characteristicValues": {"key": "value"},
  "schemeLabels": {"key": "value"}
}

QuoteContractedVolumeConfigurationType

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.

{
  "type": NonEmptyString,
  "identifier": "abc123",
  "isVariable": true
}

QuoteContractedVolumePeriodType

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(ContractedVolumeMeasurementPeriod!)`	The measurement cadence of the quantity.
`minimum(Decimal)`	Optional lower bound around the value (e.g. a take-or-pay floor).
`purpose(ContractedVolumePurpose!)`	The role of the quantity.
`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.

{
  "value": "1.0",
  "unit": "abc123",
  "marketName": "abc123",
  "measurementPeriod": "WHOLE_PERIOD",
  "purpose": "TRANCHE",
  "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"
}

QuoteCostType

Fields

Name Description

key(String!)

Name of the cost field.

value(QuoteCostUnionType)

Value of the cost field.

{
  "key": "abc123",
  "value": DecimalType
}

QuoteDelayerDaysConfigurationType

Fields

Name	Description
`days(Int)`	The number of days to delay payment collection.
`identifier(String)`	Unique identifier for the term.
`isVariable(Boolean)`	Whether this term uses variable rates.
`strategy(String)`	The strategy used to calculate delayer days.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "identifier": "abc123",
  "isVariable": true,
  "strategy": "abc123",
  "days": 1
}

QuoteRateGroupEligibilityConfigurationType

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.

{
  "type": NonEmptyString,
  "identifier": "abc123",
  "isVariable": true
}

QuoteRateGroupEligibilityPeriodType

Fields

Name Description

end(DateTime)

End of the effective period (None if open-ended).

start(DateTime)

Start of the effective period.

{
  "start": "2020-01-01T00:00:00.000Z",
  "end": "2020-01-01T00:00:00.000Z"
}

QuoteRateGroupEligibilityScheduleType

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.

{
  "productCode": "abc123",
  "rateGroupCode": "abc123",
  "isEligible": true,
  "supplyPointIdentifier": "abc123"
}

QuoteRequestType

Fields

Name Description

code(UUID!)

id(ID!)

quotedSupplyPoints([QuotedSupplyPointType])

{
  "id": "abc123",
  "code": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

QuoteTimeSeriesSpecificationEligibilityScheduleType

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.

{
  "productCode": "abc123",
  "timeSeriesSpecificationCode": "abc123",
  "isEligible": true,
  "supplyPointIdentifier": "abc123"
}

QuoteType_

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.

{
  "identifier": "abc123",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "productOfferingIdentifier": "abc123",
  "quoteComponents": [QuoteComponentType],
  "createdBy": ActorType
}

QuotedOfferingParamsType

Fields

Name Description

offeringComponents([QuotedOfferingParamsType])

Quoting components of this quote.

offeringIdentifier(ID)

Product offering identifier.

productComponents([QuotedProductComponentType])

Product component data including its quoting parameters.

{
  "offeringIdentifier": "abc123",
  "productComponents": [QuotedProductComponentType],
  "offeringComponents": [QuotedOfferingParamsType]
}

QuotedProductComponentType

Fields

Name Description

productCode(ID)

Product code.

quotingParams([QuotingParamType])

Quoting parameter definitions for this product.

{
  "productCode": "abc123",
  "quotingParams": [QuotingParamType]
}

QuotedProductType

Quoted product for a supply point

Fields

Name	Description
`id(ID!)`
`priceReference(PriceReferenceInterface)`	Return the Price Reference for the quoted supply point and product.
`product(Product)`	The associated product.
`productReference(ProductReferenceType)`	Return the DMO Usage Reference Data for the quoted MIRN.
`quotedRates([RateInterface])`	Current or future rates for this quote.
`wasSelected(Boolean!)`

{
  "id": "abc123",
  "wasSelected": true,
  "product": Product,
  "productReference": ProductReferenceType,
  "quotedRates": RateInterface
}

QuotedSupplyPointType

Quoted supply point

Fields

Name	Description
`agreement(AusAgreementInterface)`
`distributor(DistributorType)`	The distributor used for the quote.
`id(ID!)`
`marketName(String!)`
`quotedProducts([QuotedProductType])`	Arguments `filterHeroProducts` (`Boolean`) Return only the top hero products relating to the quote.
`referenceUsage(UsageReferenceType)`	Return the DMO Usage Reference Data for the quoted MIRN.
`supplyPoint(SupplyPointInterface)`	The associated supply point.
`usageReference(UsageReferenceInterface)`	Return the Usage Reference for the quoted supply point.

{
  "marketName": "abc123",
  "id": "abc123",
  "supplyPoint": SupplyPointInterface,
  "agreement": AusAgreementInterface,
  "referenceUsage": UsageReferenceType
}

QuotingEmbeddedProperty

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

QuotingNoSuitableProductsFound

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

QuotingNoSupplyPointsFoundOnProperty

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

QuotingParamType

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).
`nullable(Boolean)`	Whether the quoting parameter may be deliberately left empty, by passing `null` instead of a value. A nullable quoting parameter must still be provided.
`source(String)`	Source of the quoting parameter.
`type(String)`	Type of the quoting parameter.
`value(String)`	Value of the quoting parameter.

{
  "name": "abc123",
  "label": "abc123",
  "type": "abc123",
  "choices": ["abc123"],
  "source": "abc123",
  "nullable": true,
  "value": "abc123"
}

QuotingTermsAndConditionsCanNotBeFound

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

QuotingUnsupportedMarket

Fields

Name Description

message(String!)

{
  "message": "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.

{
  "name": "abc123",
  "period": AuxiliaryResultPeriodType,
  "agreement": CommonAgreementType,
  "start": "1.0",
  "end": "1.0",
  "unit": "KILOWATT_HOURS"
}

RangeTooWideErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

RateGroupEligibilityConfigurationType

Represents a rate group eligibility term of in a contract.

Note: This type is a stub, and will be fleshed out in the future.

Fields

Name	Description
`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.
`schedules([RateGroupEligibilityScheduleType])`	A list of rate group eligibility schedules associated with the contract.
`timeSeriesSpecificationSchedules([TimeSeriesSpecificationEligibilityScheduleType])`	A list of time series specification eligibility schedules associated with the contract.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "schedules": [RateGroupEligibilityScheduleType],
  "timeSeriesSpecificationSchedules": [TimeSeriesSpecificationEligibilityScheduleType]
}

RateGroupEligibilityPeriodType

Represents a period with a start and optional end date.

Note: This type is a stub, and will be fleshed out in the future.

Fields

Name Description

end(DateTime)

The end date and time of the period.

start(DateTime)

The start date and time of the period.

{
  "start": "2020-01-01T00:00:00.000Z",
  "end": "2020-01-01T00:00:00.000Z"
}

RateGroupEligibilityScheduleType

Represents a schedule for rate group eligibility within a contract.

Note: This type is a stub, and will be fleshed out in the future.

Fields

Name	Description
`effectivePeriod(RateGroupEligibilityPeriodType)`	The period during which this eligibility is effective.
`isEligible(Boolean)`	Indicates if the rate group is eligible.
`productCode(String)`	The product code associated with the rate group.
`rateGroupCode(String)`	The rate group code.
`supplyPointIdentifier(String)`	The external identifier of the supply point this schedule targets. When null, the schedule targets all agreements for the product.

{
  "productCode": "abc123",
  "rateGroupCode": "abc123",
  "supplyPointIdentifier": "abc123",
  "isEligible": true,
  "effectivePeriod": RateGroupEligibilityPeriodType
}

RateGroupPrices

Rate group prices for a product.

Fields

Name Description

prices([PriceForStream!]!)

The prices for the rate group.

rateGroup(String!)

The rate group code.

{
  "rateGroup": "abc123"
}

RatesConnectionFieldConnection

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([RatesConnectionFieldEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": RatesConnectionFieldEdge,
  "totalCount": 1,
  "edgeCount": 1
}

RatesConnectionFieldEdge

A Relay edge containing a RatesConnectionField and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(RateInterface)

The item at the end of the edge

{
  "node": RateInterface,
  "cursor": "abc123"
}

ReactivateCollectionProcessRecord

Output type of the reactivateCollectionProcessRecord mutation.

Fields

Name Description

collectionProcessReactivated(ReactivateCollectionProcessRecordOutputType)

The reactivated collection process record.

{
  
}

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.

{
  "number": "abc123",
  "status": "PENDING"
}

Reading

Fields

Name	Description
`extras([ReadingExtra])`	The requested extras present on this reading's underlying meter data. Only keys supplied via the `extras` argument are considered. Keys that disagree across aggregated raw readings have null value.
`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.

{
  "value": "1.0",
  "units": "abc123",
  "intervalStart": "2020-01-01T00:00:00.000Z",
  "intervalEnd": "2020-01-01T00:00:00.000Z",
  "qualities": [ReadingQualityMeta],
  "extras": [ReadingExtra]
}

ReadingCreationErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

ReadingExtra

Fields

Name Description

composition(ReadingExtraComposition)

UNIFORM when there is only one raw reading, or when every raw reading in an aggregation agrees on this extra; MIXED when they do not.

key(String)

The extra's key.

value(String)

The extra's Amphio value, stringified. Null when composition is MIXED.

{
  "key": "abc123",
  "value": "abc123",
  "composition": "UNIFORM"
}

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.

{
  "quality": "ACTUAL",
  "value": "1.0",
  "count": 1
}

Readings

Fields

Name Description

exportReadings(ExportReadingsConnection)

Readings representing outgoing utility flow e.g., solar generation.

Arguments

after (String)

before (String)

first (Int)

last (Int)

importReadings(ImportReadingsConnection)

Readings representing incoming utility flow e.g., usage or consumption.

Arguments

after (String)

before (String)

first (Int)

last (Int)

{
  "exportReadings": ExportReadingsConnection,
  "importReadings": ImportReadingsConnection
}

RebateType

Fields

Name	Description
`appliedTo([AppliedTo]!)`	What the rebate applies to.
`creditReason(String!)`	The value that populates the `reason` field in AccountCredits for this rebate.
`displayName(String!)`	Label for displaying the rebate on statements etc.
`endAt(DateTime)`	When eligibility for the rebate ends. If this field is null, the rebate should be treated as ongoing.
`percentageDiscount(Decimal)`	The percentage discount for the rebate, represented as a decimal number between 0 and 1, returned for percentage discount rebates.
`rebateCents(Decimal)`	The number of cents per day for the rebate, returned for pro rata rebates.
`startAt(DateTime)`	When eligibility for the rebate starts.

{
  "displayName": "abc123",
  "creditReason": "abc123",
  "rebateCents": "1.0",
  "percentageDiscount": "1.0",
  "startAt": "2020-01-01T00:00:00.000Z",
  "endAt": "2020-01-01T00:00:00.000Z",
  "appliedTo": "INVOICE"
}

RecordActivatedPaymentMethod

Output type of the recordActivatedPaymentMethod mutation.

Fields

Name Description

paymentMethod(PaymentMethodType)

The stored payment method.

{
  "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.

{
  "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.

{
  "noticeBatchIdentifier": "abc123"
}

RecordDepositAgreementAccepted

Output type of the recordDepositAgreementAccepted mutation.

Fields

Name Description

isRecorded(Boolean)

Whether the deposit agreement acceptance was successfully recorded.

{
  "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.

{
  "noticeBatchIdentifier": "abc123"
}

RecordFailedPayout

Output type of the recordFailedPayout mutation.

Fields

Name Description

noticeBatchIdentifier(String!)

The unique identifier of the notice batch created from the input.

{
  "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.

{
  "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.

{
  "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.

{
  "noticeBatchIdentifier": "abc123"
}

RecordSalesInteraction

Output type of the recordSalesInteraction 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.

{
  "opportunityNumber": "abc123",
  "dateOfCreation": "2020-01-01T00:00:00.000Z",
  "stage": "abc123",
  "funnelCode": "abc123"
}

RecordSuccessfulPayment

Output type of the recordSuccessfulPayment mutation.

Fields

Name Description

noticeBatchIdentifier(String!)

The unique identifier of the notice batch created from the input.

{
  "noticeBatchIdentifier": "abc123"
}

RecordSuccessfulPayout

Output type of the recordSuccessfulPayout mutation.

Fields

Name Description

noticeBatchIdentifier(String!)

The unique identifier of the notice batch created from the input.

{
  "noticeBatchIdentifier": "abc123"
}

RectangularButtonType

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.

{
  "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.

{
  "pointsRedeemed": 1
}

RedeemReferralClaimCode

Output type of the redeemReferralClaimCode mutation.

Fields

Name Description

success(Boolean!)

Whether or not the request was successful.

{
  "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.

{
  "id": 1,
  "value": "abc123",
  "referralScheme": ReferralSchemeType,
  "accountReferral": ReferralType,
  "isValid": true,
  "createdAt": "2020-01-01T00:00:00.000Z"
}

ReferralConnectionTypeConnection

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 `status`, this will only return the total payment amount of referrals with the specified status.
`totalCount(Int!)`	Total number of nodes.

{
  "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

{
  "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. Only make use of the referrerGivenName for privacy reasons. - Marked as deprecated on 2022-11-07. - Scheduled for removal on or after 2023-01-07.
`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.

{
  "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
}

ReferralSchemeTypes

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.

Please use domestic instead.

- Marked as deprecated on 2020-03-05.
- Scheduled for removal on or after 2024-01-01.

{
  "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.

{
  "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!)

{
  "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` field for a breakdown of this information.
`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. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`isAccountPayment(Boolean)`	Deprecated. Deprecated The 'isAccountPayment' field is deprecated. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`isCredit(Boolean)`	Deprecated. Deprecated The 'isCredit' field is deprecated. This information is provided by the __typename introspection query. - Marked as deprecated on 2020-06-19. - Scheduled for removal on or after 2022-11-15.
`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. Use `billingDocumentIdentifier` instead. - Marked as deprecated on 2023-11-30. - Scheduled for removal on or after 2024-06-01.
`title(String)`	Human-readable title describing the transaction.

{
  "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.

{
  "repayment": AccountRepaymentType
}

RefundPaymentRequestType

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.

{
  "requestId": "abc123",
  "amount": 1,
  "payment": AccountPaymentType,
  "reasonCode": "abc123",
  "status": "REQUESTED"
}

RefundRequestConnectionTypeConnection

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.

{
  "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

{
  "node": RefundPaymentRequestType,
  "cursor": "abc123"
}

RefundVoucher

Output type of the refundVoucher mutation.

Fields

Name Description

voucherPurchase(VoucherPurchaseType)

The voucher purchase that was refunded.

{
  "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.

{
  "key": "abc123",
  "viewer": AccountUserType
}

RegisterCustomerAsset

Output type of the registerCustomerAsset mutation.

Fields

Name Description

customerAsset(CustomerAssetType)

The registered customer asset.

{
  "customerAsset": CustomerAssetType
}

RegisterLeadFlowStatusEvent

Output type of the registerLeadFlowStatusEvent mutation.

Fields

Name Description

flowId(String)

ID of the registered flow status event.

{
  "flowId": "abc123"
}

RegisterNTCOverrideType

The network tariff code (NTC) the register will be billed to. This indicates the NTC has been overridden.

Fields

Name	Description
`effectiveNetworkTariffCode(String!)`
`endAt(DateTime)`
`id(Int)`
`startAt(DateTime!)`

{
  "id": 1,
  "effectiveNetworkTariffCode": "abc123",
  "startAt": "2020-01-01T00:00:00.000Z",
  "endAt": "2020-01-01T00:00:00.000Z"
}

RegisterOpportunityFlowStatusEvent

Output type of the registerOpportunityFlowStatusEvent mutation.

Fields

Name Description

flowId(String)

ID of the registered flow status event.

{
  "flowId": "abc123"
}

RegisterPushNotificationBinding

Output type of the registerPushNotificationBinding mutation.

Fields

Name Description

pushNotificationBinding(PushNotificationBindingType)

{
  "pushNotificationBinding": PushNotificationBindingType
}

RegisterReading

Fields

Name	Description
`digits(Int)`
`id(Int)`	The ID of the register reading.
`identifier(String)`
`isQuarantined(Boolean)`
`name(String)`
`qualityFlag(QualityFlag)`	Possible values: A: ACTUALMETERINGDATA E: FORWARDESTIMATEDDATA F: FINALSUBSTITUTEDDATA N: NULLDATA S: SUBSTITUTEDDATA V: VARIABLE_DATA
`qualityMethod(String)`	Possible values: 11: CHECK 12: CALCULATED 13: SCADA 14: RETROSPECTIVELIKEDAY 15: RETROSPECTIVEAVERAGELIKEDAY 16: AGREEDREMOTE 17: LINEARREMOTE 18: ALTERNATIVE 19: ZERO 20: PROSPECTIVELIKEDAY 21: FIVEMINUTENOHISTORICALDATA 22: PROSPECTIVEAVERAGELIKEDAY 23: PREVIOUSYEAR 24: DATASCALING 25: AVERAGEDAILYLOAD 51: PREVIOUSYEARMRIM 52: PREVIOUSREADMRIM 53: REVISIONMRIM 54: LINEARMRIM 55: AGREEDMRIM 56: AGREEDPRIORTOFIRSTREAD 57: CUSTOMERCLASSMRIM 58: ZEROMRIM 59: MRIMFIVEMINUTENOHISTORICALDATA 61: PREVIOUSYEARBASIC 62: PREVIOUSREADBASIC 63: CUSTOMERCLASSBASIC 64: AGREEDBASIC 65: ADL 66: REVISIONBASIC 67: CUSTOMERREAD 68: ZEROBASIC 69: LINEARINTERPOLATION 71: RECALCULATION 72: REVISEDTABLE 73: REVISEDALGORITHM 74: AGREEDCALCULATED 75: EXISTINGTABLE KI: KRAKENINTERPOLATION KP: KRAKENINTERPOLATIONPREVIOUSYEAR KE: KRAKENEXTRAPOLATION KA: KRAKENADL RA: KRAKENREMOVALALIGNED
`value(String)`

{
  "identifier": "abc123",
  "name": "abc123",
  "value": "abc123",
  "digits": 1,
  "isQuarantined": true,
  "id": 1,
  "qualityFlag": "A",
  "qualityMethod": "abc123"
}

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.

{
  "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

{
  "node": DeviceRegister,
  "cursor": "abc123"
}

RegularScheduleType

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.

{
  "paymentDay": 1,
  "frequency": "abc123",
  "frequencyMultiplier": 1
}

Reminder

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.

{
  "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.

{
  "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

{
  "campaignRemoved": true,
  "possibleErrors": [PossibleErrorType]
}

RemoveCampaignItems

Output type of the removeCampaignItems mutation.

Fields

Name Description

campaignItems([VoiceCampaignItemType])

{
  
}

RemoveConcession

Output type of the removeConcession mutation.

Fields

Name Description

concession(ConcessionType)

{
  "concession": ConcessionType
}

RemoveItemsFromRiskList

Output type of the removeItemsFromRiskList mutation.

Fields

Name Description

riskIdentifiers([RiskListItemType])

List of successfully removed risk identifiers.

{
  
}

RemovePartnerUserFromTeam

Output type of the removePartnerUserFromTeam mutation.

Fields

Name Description

partnerUser(PartnerUserType)

The partner user that was removed from the team.

{
  
}

RemovePropertyFromHierarchy

Output type of the removePropertyFromHierarchy mutation.

Fields

Name Description

property(PropertyType)

The property that was removed from the hierarchy.

{
  "property": PropertyType
}

RepaymentInterventionType

Fields

Name Description

outcome(String)

The repayment intervention outcome.

reason(String)

The repayment intervention reason.

{
  "outcome": "abc123",
  "reason": "abc123"
}

RepaymentRequestConnectionTypeConnection

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.

{
  "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

{
  "node": RepaymentRequestType,
  "cursor": "abc123"
}

RepaymentRequestType

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.

{
  "requestId": "abc123",
  "amount": 1,
  "reasonCode": "abc123",
  "method": "BANK_TRANSFER",
  "instruction": PaymentInstructionType,
  "status": "REQUESTED"
}

ReplaceLatestPaymentSchedule

Output type of the replaceLatestPaymentSchedule mutation.

Fields

Name Description

newSchedule(PaymentScheduleType)

The new payment schedule that has replaced the specified one.

replacedSchedule(PaymentScheduleType)

The payment schedule that was replaced.

{
  "replacedSchedule": PaymentScheduleType,
  "newSchedule": PaymentScheduleType
}

ReplacePartnerReferences

Output type of the replacePartnerReferences mutation.

Fields

Name Description

partner(AffiliateOrganisationType)

The updated partner.

{
  
}

RequestCADReport

Output type of the requestCadReport mutation.

Fields

Name Description

account(AccountType)

The account.

successful(Boolean)

Whether the request was accepted. When asynchronous generation is enabled, the email is sent by a background task.

{
  "account": AccountType,
  "successful": true
}

RequestDoubleOptIn

Output type of the requestDoubleOptIn mutation.

Fields

Name Description

consent(ConsentType)

The consent that was created or updated.

{
  "consent": ConsentType
}

RequestMIRNDiscovery

Output type of the requestMirnDiscovery mutation.

Fields

Name Description

discoveryRequest(MDHXProcessDiscoveryType)

error(MIRNDiscoveryErrorUnion)

{
  "error": MIRNDiscoveryRequestAlreadyTriggeredErrorType
}

RequestPasswordResetOutputType

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.

{
  "email": "abc123",
  "userNumber": "abc123"
}

RequestPrintedBill

Output type of the requestPrintedBill mutation.

Fields

Name Description

success(Boolean)

Whether the request was successful.

{
  "success": true
}

RequestRefundEligibilityType

Fields

Name Description

canRequestRefund(Boolean!)

Whether the account can request a refund.

reason(String)

The reason why a refund cannot be requested.

{
  "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.

{
  "requestId": "abc123",
  "status": "REQUESTED"
}

RequestedDateRangeType

Fields

Name Description

endDate(Date)

The end date of the date range.

startDate(Date)

The start date of the date range.

{
  "startDate": "2020-01-01",
  "endDate": "2020-01-01"
}

ReschedulePayment

Output type of the reschedulePayment mutation.

Fields

Name Description

error(ReschedulePaymentErrorUnion)

newAccountPayment(AccountPaymentType)

{
  "newAccountPayment": AccountPaymentType,
  "error": ExceededMaxSchedulableWorkingDaysErrorType
}

RescindContractOutput

Fields

Name Description

contract(Contract)

The contract rescinded.

{
  "contract": Contract
}

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.

This field is a relic of early Relay conventions and is no longer necessary.

- Marked as deprecated on 2026-07-29.
- Scheduled for removal on or after 2027-07-29.

errors([SerializerFieldErrorsType])

{
  "errors": [SerializerFieldErrorsType],
  "clientMutationId": "abc123"
}

ResetUserPasswordOutput

Fields

Name	Description
`failureCodes([String])`	A list of codes of which password validation the new password failed against if applicable. One of: - `password_too_short` - `password_too_common` - `password_reused` - `password_matches_current` - `password_has_too_few_numeric_characters` - `password_has_too_few_special_characters` - `password_has_too_few_lowercase_characters` - `password_has_too_few_uppercase_characters` - `password_contains_account_number` - `password_contains_part_of_email_address` Deprecated The 'failureCodes' field is deprecated. Please handle the KT-CT-5450 error and inspect the `validationErrors[].code` extension instead. Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
`failureReasons([String])`	A list of messages of which password validations the new password failed against if applicable. Deprecated The 'failureReasons' field is deprecated. Please handle the KT-CT-5450 error and inspect the `validationErrors[].message` extension instead. Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
`passwordUpdated(Boolean)`	True if the password update was successful, false otherwise. Deprecated The 'passwordUpdated' field is deprecated. Please handle the KT-CT-5450 error instead. Note that the KT-CT-5450 error will not be raised if you request any of the `failureCodes`, `failureReasons`, or `passwordUpdated` fields. - Marked as deprecated on 2025-04-07. - Scheduled for removal on or after 2025-10-04.
`userId(ID!)`	The ID of the user whose password was changed.

{
  "userId": "abc123",
  "passwordUpdated": true,
  "failureReasons": ["abc123"],
  "failureCodes": ["abc123"]
}

ResolveMeterDataIssue

Output type of the resolveMeterDataIssue mutation.

Fields

Name Description

meterDataIssueResolved(ResolveMeterDataIssueOutputType)

The resolved meter data issue.

{
  
}

ResolveMeterDataIssueOutputType

Output for resolving a MeterDataIssue.

Fields

Name Description

issueId(Int)

The ID of the MeterDataIssue.

status(MeterDataIssueStatus)

The new status of the meter data issue.

{
  "issueId": 1,
  "status": "OPEN"
}

RestorePreviousAgreement

Output type of the restorePreviousAgreement mutation.

Fields

Name Description

agreementRescission(AgreementRescissionType)

The agreement rescission whose previous agreement was restored.

restoredAgreement(DistributionAgreementType)

The previous agreement that was restored.

{
  "restoredAgreement": DistributionAgreementType
}

ResumeCollectionProcess

Output type of the resumeCollectionProcess mutation.

Fields

Name Description

collectionProcessResumed(ResumeCollectionProcessOutput)

Collection process resume output.

{
  
}

ResumeCollectionProcessOutput

Fields

Name Description

pauseRecords([CollectionProcessPauseStatusRecord])

Pause records on the collection process.

{
  
}

RetireCustomerAsset

Output type of the retireCustomerAsset mutation.

Fields

Name Description

customerAsset(CustomerAssetType)

The retired customer asset.

{
  "customerAsset": CustomerAssetType
}

RevokeAgreement

Output type of the revokeAgreement mutation.

Fields

Name Description

account(AccountType)

Account responsible for the revoked agreement.

{
  "account": AccountType
}

RevokeContractOutput

Fields

Name Description

contract(Contract)

The contract revoked.

{
  "contract": Contract
}

RevokePartnerUserAccess

Output type of the revokePartnerUserAccess mutation.

Fields

Name Description

partnerUser(RevokePartnerUserAccessType)

The result of the deletion.

{
  
}

RevokePartnerUserAccessType

The result of revoking a partner user access.

Fields

Name Description

partnerUserNumber(String!)

The number of the revoking partner user access.

{
  "partnerUserNumber": "abc123"
}

RevokeUserAccessFromBusiness

Output type of the revokeUserAccessFromBusiness mutation.

Fields

Name Description

roleCode(String)

The code of the role revoked from the user.

{
  "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.

{
  "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. `AU`: Australia This must be one of `NSW`, `VIC`, `QLD`, `TAS`, `ACT`, `SA`, `NT`, `WA`. For addresses not within these locations, use the value that Australia Post uses, e.g. `ACT` for the Jervis Bay Territory or `WA` for Christmas Island.
`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 `showCountry` (`Boolean`) Whether to include the country. The country will be spelled out in all-caps on the last line, as per Universal Postal Union standards. `showName` (`Boolean`) Whether to include the name attached to this address. `showPostalCode` (`Boolean`) 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. `AU`, `GB`, `NZ`.
`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 `dependent_locality` field. This happens when data has been migrated from a legacy format, and that format had insufficient metadata to determine the appropriate field. If `structured_street_address` is also set, the value of this field will be a string generated from that value.
`structuredStreetAddress(GenericScalar)`	The 'street address' component, in a structured format. This field stores the same value as `street_address`, but with more detail; for instance, instead of `123 Example Street` it might be `{'street_number': '123', 'street_name': 'Example', 'street_type': 'Street'}`. In many cases this will be blank; we only use this field for Krakens where we need to supply this level of granularity to some third-party service, like a bulk mail provider. 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. `AU`: Australia The following keys may be present; all are optional. All keys have string values, and their meaning is the same as their aseXML counterparts. (Note that, unlike aseXML, all keys are provided at the top level, rather than being nested.) `flat_or_unit_type` `flat_or_unit_number` `floor_or_level_type` `floor_or_level_number` `building_or_property_name` `location_descriptor` `lot_number` `house_number_1` `house_number_suffix_1` `house_number_2` `house_number_suffix_2` `street_name` `street_type` `street_suffix` `postal_delivery_type` `postal_delivery_number_prefix` `postal_delivery_number_value` `postal_delivery_number_suffix` `IT`: Italy A structured street address is only returned when all three keys are known; otherwise the address is returned via `street_address`. `street_type`: e.g. `Via`, `Corso`, `Piazza` `street_name`: e.g. `Garibaldi` `street_number`: e.g. `67` `JP`: Japan The following keys may be present; all are optional. If keys are empty, they may be omitted from the response entirely. `chome` `banchi` `go` `edaban` `kana_building_name` `kanji_building_name` `building_number` `room_number` `address_code` `physical_location_identifier` `kana_company_name` `kanji_company_name` `NZ`: New Zealand The following keys may be present; all are optional. If keys are empty, they may be omitted from the response entirely. `flat_or_unit_type` `flat_or_unit_number` `floor_or_level_type` `floor_or_level_number` `property_name` `building_name` `house_number_1` `house_number_suffix_1` `house_number_2` `house_number_suffix_2` `street_prefix` `street_name` `street_type` `street_suffix` `rural_delivery_number` `mailtown` `postal_delivery_type` `postal_delivery_location` `postal_delivery_number_prefix` `postal_delivery_number_value` `postal_delivery_number_suffix` `US`: United States The following keys may be present; all are optional. If keys are empty, they may be omitted from the response entirely. `primary_number` `primary_name_prefix_dir` `primary_name` `primary_name_suffix` `primary_name_suffix_dir` `secondary_name` `secondary_number`
`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.

{
  "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.

{
  "riskIdentifierId": "abc123"
}

RoleAssignment

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.

{
  "role": RoleInterface,
  "validFrom": "2020-01-01T00:00:00.000Z",
  "validTo": "2020-01-01T00:00:00.000Z"
}

RoleType

Fields

Name	Description
`frmp(String)`	The Financially Responsible Market Participant for this meter point.
`lnsp(String)`	The Local Network Service Provider for this meter point.
`mc(String)`	The Metering Coordinator responsible for managing metering at this connection point.
`mdp(String)`	The Meter Data Provider responsible for collecting and delivering metering data.
`mpb(String)`	The Metering Provider (Business) responsible for meter provision.
`mpc(String)`	The Metering Provider (Collection) responsible for meter data collection.

{
  "frmp": "abc123",
  "lnsp": "abc123",
  "mc": "abc123",
  "mdp": "abc123",
  "mpb": "abc123",
  "mpc": "abc123"
}

RoutingAttributeType

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).

{
  "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.

{
  "agreementRollover": AgreementRolloverType
}

SMSEventType

Fields

Name	Description
`eventType(String!)`
`id(ID!)`	The ID of the object
`message(SMSMessageType)`	SMS message of the SMS event.
`occurredAt(DateTime!)`

{
  "id": "abc123",
  "eventType": "abc123",
  "occurredAt": "2020-01-01T00:00:00.000Z",
  "message": SMSMessageType
}

SMSMessageType

Represents a SMS communication.

Fields

Name	Description
`account(AccountType)`	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.

{
  "id": "abc123",
  "sentAt": "2020-01-01T00:00:00.000Z",
  "account": AccountType,
  "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.

{
  "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.

{
  "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
}

SalesFunnel

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.

{
  "code": "abc123",
  "name": "abc123",
  "funnelType": "LEAD",
  "status": "DRAFT"
}

SalesFunnelRule

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.

{
  "funnelCode": "abc123",
  "productOfferingIdentifier": "abc123",
  "salesChannel": "abc123"
}

SalesFunnelStage

Fields

Name	Description
`code(String!)`	The per-funnel unique code for this stage.
`deprecated(Boolean!)`	Whether this stage is deprecated and no longer active.
`name(String!)`	The human-readable name for this stage.
`order(Int)`	The order of the stage.

{
  "code": "abc123",
  "name": "abc123",
  "order": 1,
  "deprecated": true
}

SaveCreditCheckOutcome

Output type of the saveCreditCheckOutcome mutation.

Fields

Name Description

checkId(UUID)

The check identifier echoed back from the saved outcome.

{
  "checkId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

SaveLeadContactLegalEntity

Output type of the saveLeadContactLegalEntity mutation.

Fields

Name Description

legalEntityIdentifier(String)

The identifier of the legal entity linked to the lead contact.

{
  "legalEntityIdentifier": "abc123"
}

SchedulabilityStatusType

Fields

Name Description

canReschedule(Boolean!)

description(String!)

{
  "description": "abc123",
  "canReschedule": true
}

ScheduleConnectionTypeConnection

Fields

Name	Description
`edgeCount(Int!)`	Number of nodes in the edge.
`edges([ScheduleConnectionTypeEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": ScheduleConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

ScheduleConnectionTypeEdge

A Relay edge containing a ScheduleConnectionType and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(LedgerPaymentScheduleType)

The item at the end of the edge

{
  "node": LedgerPaymentScheduleType,
  "cursor": "abc123"
}

ScheduleOverlapErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

ScheduleQuoteFollowUp

Output type of the scheduleQuoteFollowUp mutation.

Fields

Name Description

success(Boolean!)

Whether the message was scheduled successfully.

{
  "success": true
}

ScheduledPaymentMethodConnectionTypeConnection

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([ScheduledPaymentMethodConnectionTypeEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": ScheduledPaymentMethodConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

ScheduledPaymentMethodConnectionTypeEdge

A Relay edge containing a ScheduledPaymentMethodConnectionType and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(ScheduledPaymentMethodType)

The item at the end of the edge

{
  "node": ScheduledPaymentMethodType,
  "cursor": "abc123"
}

ScheduledPaymentMethodType

How payments on a schedule are collected between two dates: either with a payment method, or manually.

Fields

Name Description

collectionMethod(CollectionMethodUnion!)

How payments are collected during this period.

scheduledFrom(Date!)

The first date this collection method applies.

scheduledTo(Date)

The last date this collection method applies. Null if there is no defined end date.

{
  "scheduledFrom": "2020-01-01",
  "scheduledTo": "2020-01-01",
  "collectionMethod": AutomaticCollectionType
}

ScheduledTransactionType

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.

{
  "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.

{
  "id": "abc123",
  "typename": "abc123",
  "typeName": "abc123",
  "screenId": "abc123",
  "params": BackendScreenParam,
  "allowBack": true
}

SeasonType

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.

{
  "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.

{
  "id": "abc123",
  "typename": "abc123",
  "content": CardComponentType,
  "order": 1
}

SegmentType

Fields

Name Description

name(String!)

The segment name.

{
  "name": "abc123"
}

SelectProducts

Output type of the selectProducts mutation.

Fields

Name Description

success(Boolean!)

Whether we successfully marked the chosen quoted products as selected.

{
  "success": true
}

SelectedProductType

Fields

Name Description

code(String)

The selected product code.

displayName(String)

The selected product display name.

{
  "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.

{
  
}

SendCDRNotification

Output type of the sendCdrNotificationComms mutation.

Fields

Name Description

messages([MessageType])

The list of Messages created and sent.

{
  "messages": [MessageType]
}

SendChangeNMIDetailsRequest

Output type of the sendChangeNmiDetailsRequest mutation.

Fields

Name Description

result(SendChangeNMIDetailsRequestOutputType)

The result of sending the Change NMI Details request.

{
  
}

SendChangeNMIDetailsRequestOutputType

Fields

Name Description

issueId(Int)

The ID of the MeterDataIssue.

nmi(String)

The NMI for which the Change NMI Details request was sent.

{
  "issueId": 1,
  "nmi": "abc123"
}

SendCustomerDetailsRequest

Output type of the sendCustomerDetailsRequest mutation.

Fields

Name Description

transaction(ChromaTransactionType)

The transaction returned from the market gateway.

{
  
}

SendInkOutboundMessage

Output type of the sendInkOutboundMessage mutation.

Fields

Name Description

message(InkMessage!)

The Ink message that was enqueued for sending.

{
  "message": InkEmail
}

SendNextScheduledReadDateChangeRequest

Output type of the sendNextScheduledReadDateChangeRequest mutation.

Fields

Name Description

result(SendNextScheduledReadDateChangeRequestOutputType)

The result of sending the CR507x change request.

{
  
}

SendNextScheduledReadDateChangeRequestOutputType

Fields

Name Description

changeRequestId(ID)

The ID of the created change request. Null if a reminder was created instead.

nmi(String)

The NMI for which the CR507x was sent.

reminderCreated(Boolean)

True if the proposed date was invalid and a reminder was created instead of a change request.

{
  "nmi": "abc123",
  "changeRequestId": "abc123",
  "reminderCreated": true
}

SendOfferQuoteSummary

Output type of the sendOfferQuoteSummary mutation.

Fields

Name Description

success(Boolean!)

Whether the triggering of the offer quote summary was successful.

{
  "success": true
}

SendQuoteSummary

Output type of the sendQuoteSummary mutation.

Fields

Name Description

success(Boolean!)

Whether the triggering of the quote summary was successful.

{
  "success": true
}

SendSiteAccessNotification

Output type of the sendSiteAccessNotification mutation.

Fields

Name Description

transaction(ChromaTransactionType)

The transaction returned from Chroma.

{
  
}

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.

This field only echoes back the 'sendAt' value given in the mutation input, so it
carries no information the caller does not already have.

- Marked as deprecated on 2026-08-18.
- Scheduled for removal on or after 2026-09-01.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/1754/

{
  "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.

{
  "verificationStatus": true
}

SerializerErrorType

Fields

Name Description

code(String)

message(String)

{
  "message": "abc123",
  "code": "abc123"
}

SerializerFieldErrorsType

Fields

Name Description

errors([ErrorTypeUnion!])

field(String)

{
  "field": "abc123",
  "errors": SerializerErrorType
}

ServiceOrderChargeRecordConnectionTypeConnection

Fields

Name	Description
`edgeCount(Int!)`	Number of nodes in the edge.
`edges([ServiceOrderChargeRecordConnectionTypeEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": ServiceOrderChargeRecordConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

ServiceOrderChargeRecordConnectionTypeEdge

A Relay edge containing a ServiceOrderChargeRecordConnectionType and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(ServiceOrderChargeRecordType)

The item at the end of the edge

{
  "node": ServiceOrderChargeRecordType,
  "cursor": "abc123"
}

ServiceOrderChargeRecordType

Fields

Name	Description
`account(AccountType!)`
`charge(AccountChargeType)`	The charge.
`description(String!)`
`effectiveAt(DateTime!)`
`id(ID!)`
`netAmount(Int!)`	Price in Australian cents, excluding GST.
`productCode(String!)`

{
  "id": "abc123",
  "productCode": "abc123",
  "netAmount": 1,
  "description": "abc123",
  "effectiveAt": "2020-01-01T00:00:00.000Z",
  "account": AccountType,
  "charge": AccountChargeType
}

ServiceOrderFeeConnectionTypeConnection

Fields

Name	Description
`edgeCount(Int!)`	Number of nodes in the edge.
`edges([ServiceOrderFeeConnectionTypeEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": ServiceOrderFeeConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

ServiceOrderFeeConnectionTypeEdge

A Relay edge containing a ServiceOrderFeeConnectionType and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(ServiceOrderFeeType)

The item at the end of the edge

{
  "cursor": "abc123"
}

ServiceOrderFeeType

Fields

Name	Description
`description(String)`	A short description of the charge, to be displayed on customer-facing bills.
`effectiveFrom(Date)`	Date from which the fee is effective from.
`effectiveTo(Date)`	Date from which the fee is effective to. Can be null if it has no end.
`id(ID)`	Identifier for the associated service order fee.
`jurisdiction(JurisdictionChoices)`
`marketParticipant(String)`	The market the fee is participating in.
`price(Int)`	Price in Australian cents, excluding GST.
`productCode(String)`	The product code from the service order that will be charged.
`supplyType(SupplyType)`	Type of supplied good/service associated with the fee.

{
  "id": "abc123",
  "productCode": "abc123",
  "supplyType": "ELECTRICITY",
  "marketParticipant": "abc123",
  "jurisdiction": "AUSTRALIAN_CAPITAL_TERRITORY",
  "price": 1,
  "description": "abc123",
  "effectiveFrom": "2020-01-01",
  "effectiveTo": "2020-01-01"
}

SetLastConsumerChangeDateRecordToBeExpired

Output type of the setLastConsumerChangeDateRecordToBeExpired mutation.

Fields

Name Description

lastConsumerChangeDateId(String)

The ID of the LastConsumerChangeDate record that was updated.

{
  "lastConsumerChangeDateId": "abc123"
}

SetLoyaltyPointsUser

Output type of the setLoyaltyPointsUser mutation.

Fields

Name Description

newLoyaltyPointsUserId(String)

ID of the new Loyalty Points user.

{
  "newLoyaltyPointsUserId": "abc123"
}

SetOpportunityOutcome

Output type of the setOpportunityOutcome mutation.

Fields

Name Description

message(String)

Success message for now.

{
  "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.

{
  "accountNumber": "abc123"
}

SetQuoteConfigurationRatesRequestErrorsOutput

Output for the setQuoteConfigurationRatesRequestErrors mutation.

Fields

Name Description

quoteConfiguration(QuoteConfigurationType!)

The quote configuration associated with the updated rates request.

{
  
}

SetScheduleCollectionMethod

Output type of the setScheduleCollectionMethod mutation.

Fields

Name Description

schedule(PaymentScheduleType!)

Updated payment schedule.

{
  "schedule": PaymentScheduleType
}

SetUpDirectDebitInstruction

Output type of the setUpDirectDebitInstruction mutation.

Fields

Name Description

paymentInstruction(DirectDebitInstructionType)

The newly created direct debit payment instruction.

possibleErrors([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

{
  "paymentInstruction": DirectDebitInstructionType,
  "possibleErrors": [PossibleErrorType]
}

SetUpDirectDebitInstructionForBusiness

Output type of the setUpDirectDebitInstructionForBusiness mutation.

Fields

Name Description

paymentInstruction(DirectDebitInstructionType)

The created direct debit instruction.

{
  "paymentInstruction": DirectDebitInstructionType
}

SetUpDirectDebitInstructionFromStoredDetails

Output type of the setUpDirectDebitInstructionFromStoredDetails mutation.

Fields

Name Description

paymentInstruction(DirectDebitInstructionType)

The payment instruction that was created from stored details.

{
  "paymentInstruction": DirectDebitInstructionType
}

ShareGoodsQuote

Output type of the shareGoodsQuote mutation.

Fields

Name Description

share(GoodsQuoteShare)

Goods quote shared.

{
  "share": GoodsQuoteShare
}

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.

{
  "typeName": "abc123",
  "id": "abc123",
  "typename": "abc123",
  "screenId": "abc123",
  "errors": InputFieldErrorType
}

SimpleServicesAgreementType

An agreement for a Simple Services supply point (e.g. Direct Metering Agreement, Value Added Service).

Fields

Name	Description
`account(AccountType)`	The accounts for this agreement.
`agreedAt(DateTime)`
`agreedFrom(DateTime)`	The datetime the agreement was entered.
`agreedTo(DateTime)`	The datetime the agreement was terminated.
`bestOffer(BestOfferForAgreement)`	Get the best offer for an agreement. Arguments `asOf` (`DateTime`) The date time to calculate the best offer. Defaults to now. `eventSource` (`BestOfferEventSource`) What triggered this calculation. Recorded against the stored calculation, and has no effect on the returned costs. `pricesAsOf` (`DateTime`) The date time to calculate cost details.
`eligibleRebates([RebateType])`	Data about concession rebates that users associated with the agreement are eligible for. Arguments `endAt` (`DateTime`) Include eligibility data ending at this datetime. If this isn't provided, an open-ended range will be used. `rebateAmountEffectiveAt` (`DateTime`) The effective time for rebateCents and percentageDiscount data (defaults to now). `startAt` (`DateTime`) Include eligibility data starting at this datetime. If this isn't provided, an open-ended range will be used.
`id(Int)`	The ID of the agreement.
`isActive(String)`
`isRevoked(Boolean)`	Whether the agreement is revoked.
`meterPoint(MeterPointInterface)`
`product(Product)`	The product for this agreement.
`ratesAgreedAt(DateTime)`	The datetime the rates were agreed.
`rescissionDeadlineAt(DateTime)`	The deadline datetime for rescinding the agreement.
`supplyPoint(SupplyPointInterface!)`
`supplyType(String)`
`terminatedAt(DateTime)`
`validFrom(DateTime)`	The start datetime of the agreement.
`validTo(DateTime)`	The end datetime of the agreement.

{
  "id": 1,
  "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",
  "agreedFrom": "2020-01-01T00:00:00.000Z",
  "agreedTo": "2020-01-01T00:00:00.000Z",
  "isRevoked": true,
  "rescissionDeadlineAt": "2020-01-01T00:00:00.000Z",
  "ratesAgreedAt": "2020-01-01T00:00:00.000Z",
  "product": Product,
  "supplyType": "abc123",
  "isActive": "abc123",
  "meterPoint": MeterPointInterface,
  "supplyPoint": SupplyPointInterface,
  "eligibleRebates": [RebateType],
  "bestOffer": BestOfferForAgreement,
  "account": AccountType
}

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)`

{
  "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])

{
  "isSharingConsentGiven": true,
  "records": SpecialCircumstanceRecordType
}

StandingChargesWindowType

Fields

Name Description

charges([SummarizedConsumptionType!])

Summarized standing charges.

error(StandingChargesWindowErrorUnion)

Potential internal error types.

{
  "charges": [SummarizedConsumptionType],
  "error": DuplicateNTCForStandingChargeErrorType
}

StartCollectionProcess

Output type of the startCollectionProcess mutation.

Fields

Name Description

collectionProcessStarted(StartCollectionProcessOutput)

Details of collection process that has been started.

{
  
}

StartCollectionProcessOutput

Fields

Name Description

accountNumber(String)

Account number associated to the collection process.

number(String)

The number of the collection process record.

{
  "number": "abc123",
  "accountNumber": "abc123"
}

StartCustomerVerification

Output type of the startCustomerVerification mutation.

Fields

Name Description

verificationProcess(VerificationProcess)

The newly created verification process.

{
  "verificationProcess": VerificationProcess
}

StartGroupedCollectionProcess

Output type of the startGroupedCollectionProcess mutation.

Fields

Name Description

collectionProcessStarted(StartGroupedCollectionProcessOutput)

Details of the collection process that has been started.

{
  
}

StartGroupedCollectionProcessOutput

Fields

Name Description

accountNumber(String)

Account number associated to the collection process.

number(String)

The number of the collection process record.

{
  "number": "abc123",
  "accountNumber": "abc123"
}

StartMirnIdentification

Output type of the startMirnIdentification mutation.

Fields

Name Description

error(StartMirnIdentificationErrorUnion)

Any error that occurs during the fulfilment of this mutation.

identification(IdentificationType)

Mirn Identification reference.

{
  "identification": IdentificationType,
  "error": InvalidContactDetails
}

StartOnSiteJobsAppointmentBookingSession

Output type of the startOnSiteJobsAppointmentBookingSession mutation.

Fields

Name Description

appointmentBookingSessionId(UUID)

The Kraken booking ID for the appointment booking session.

{
  "appointmentBookingSessionId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

StartOnSiteJobsAppointmentBookingSessionForDraftAppointment

Output type of the startOnSiteJobsAppointmentBookingSessionForDraftAppointment mutation.

Fields

Name Description

appointmentBookingSessionId(UUID)

The Kraken booking ID for the appointment booking session.

{
  "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.

{
  "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.

{
  "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.

{
  "appointmentBookingSessionId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}

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.

{
  "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

{
  "node": StatementBillingDocumentType,
  "cursor": "abc123"
}

StatementBillingDocumentType

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. This field name is ambiguous and inconsistently populated. Use `paymentDate` for the date on which payment will be collected. Use `dueDate` for the last date any payment can be made before the bill is considered overdue. - Marked as deprecated on 2026-06-15. - Scheduled for removal on or after 2027-08-15.
`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 `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `orderBy` (`TransactionsOrderBy`) The order in which to return the transactions.
`uuid(UUID)`	Unique identifier for the statement billing document.

{
  "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
}

StatementHeldStatus

The held status of a statement.

Fields

Name Description

isHeld(Boolean)

Whether a statement is currently held.

reasons([String])

Reasons for statement being held.

{
  "isHeld": true,
  "reasons": ["abc123"]
}

StatementTotalType

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).

{
  "netTotal": 1,
  "taxTotal": 1,
  "grossTotal": 1
}

StatementType

Fields

Name	Description
`attachments(BillingAttachmentConnectionTypeConnection)`	Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`averageDailyUsage(Float)`	This field returns the average daily usage during the time period of a statement. Arguments `estimatedConsumptionOnly` (`Boolean`) Whether to calculate average daily usage with estimated consumption only.
`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 the statement is a final statement.
`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. This field is deprecated. Use the 'attachments' field instead. - Marked as deprecated on 2024-09-16. - Scheduled for removal on or after 2025-09-01.
`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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`userId(Int)`	Email recipient user ID.

{
  "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,
  "averageDailyUsage": 1.0
}

StatisticOutput

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.

{
  "type": "STANDING_CHARGE_COST",
  "label": "abc123",
  "description": "abc123",
  "costExclTax": EstimatedMoneyType,
  "costInclTax": EstimatedMoneyType,
  "value": "1.0"
}

StepType

A single step in a workflow.

Fields

Name Description

id(ID!)

name(String)

The name of the single step in the workflow.

status(Status)

The step's current processing status.

{
  "id": "abc123",
  "name": "abc123",
  "status": "SKIPPED"
}

StopAutomatedPayments

Output type of the stopAutomatedPayments mutation.

Fields

Name Description

accountNumber(String)

Number of the account for which automated payments were stopped.

{
  "accountNumber": "abc123"
}

StoreBankDetailsForLead

Output type of the storeBankDetailsForLead mutation.

Fields

Name Description

paymentMethodReference(String)

Reference of the mandate generated for the lead.

{
  "paymentMethodReference": "abc123"
}

StoreDirectDebitPaymentMethodDetails

Output type of the storeDirectDebitPaymentMethodDetails mutation.

Fields

Name Description

storedPaymentMethodDetailsReference(String)

The reference for the stored payment method details.

{
  "storedPaymentMethodDetailsReference": "abc123"
}

StorePaymentInstruction

Output type of the storePaymentInstruction mutation.

Fields

Name Description

paymentInstruction(PaymentInstructionType)

The stored payment instruction.

{
  "paymentInstruction": PaymentInstructionType
}

StoredIbanBankDetailsType

Anonymised IBAN bank details stored for a payment method.

Fields

Name Description

accountHolder(String!)

Name of the account holder.

iban(String!)

Masked IBAN. The full IBAN is never returned.

{
  "accountHolder": "abc123",
  "iban": "abc123"
}

StoredPaymentMethodDetailsType

Payment method details stored on a lead.

Fields

Name	Description
`convertedToInstructionAt(DateTime)`	When the details were used to set up a payment instruction, if they were.
`details(StoredBankDetailsUnion)`	The masked bank details. Null when no details are stored.
`paymentMethodReference(String!)`	The reference identifying these stored payment method details on the lead. Pass it to `removeBankDetailsForLead` to remove them.
`paymentType(String!)`	The payment type, e.g. DIRECT_DEBIT.
`storedAt(DateTime!)`	When the details were stored.
`vendor(String!)`	The vendor the payment method is stored with.
`vendorReference(String!)`	The value the vendor uses to identify these details in their records.

{
  "vendor": "abc123",
  "paymentType": "abc123",
  "vendorReference": "abc123",
  "storedAt": "2020-01-01T00:00:00.000Z",
  "convertedToInstructionAt": "2020-01-01T00:00:00.000Z",
  "details": StoredIbanBankDetailsType,
  "paymentMethodReference": "abc123"
}

StoredSortCodeBankDetailsType

Anonymised sort code bank details stored for a payment method.

Fields

Name Description

accountHolder(String!)

Name of the account holder.

accountNumber(String!)

Masked account number.

sortCode(String!)

Masked sort code.

{
  "accountHolder": "abc123",
  "accountNumber": "abc123",
  "sortCode": "abc123"
}

StringCharacteristicValueType

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.

{
  "value": "abc123",
  "characteristic": CharacteristicType,
  "stringValue": "abc123"
}

StringType

Graphene type object to represent string values

Fields

Name Description

stringValue(String!)

Value of this field.

{
  "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.

{
  "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

{
  "customerFeedback": CustomerFeedbackType,
  "possibleErrors": [PossibleErrorType]
}

SubmitRepaymentRequest

Output type of the submitRepaymentRequest mutation.

Fields

Name Description

repaymentRequest(RequestRepaymentOutputType)

The newly created repayment request.

{
  "repaymentRequest": RequestRepaymentOutputType
}

SubmitSupplyPointReadings

Output type of the submitSupplyPointReadings mutation.

Fields

Name Description

readings([SubmittedSupplyPointReading])

The readings that were submitted to the Amphio ingestion pipeline.

{
  "readings": [SubmittedSupplyPointReading]
}

SubmittedSupplyPointReading

Fields

Name	Description
`deviceId(String)`	Device identifier, if provided.
`direction(Direction)`	Direction of utility flow.
`intervalEnd(DateTime)`	Exclusive end of the reading interval.
`intervalStart(DateTime)`	Inclusive start of the reading interval.
`registerId(String)`	Register identifier, if provided.
`units(String)`	Units for the reading value.
`value(Decimal)`	The submitted reading value.

{
  "intervalStart": "2020-01-01T00:00:00.000Z",
  "intervalEnd": "2020-01-01T00:00:00.000Z",
  "value": "1.0",
  "units": "abc123",
  "direction": "IMPORT",
  "deviceId": "abc123",
  "registerId": "abc123"
}

SummarizedConsumptionType

Fields

Name	Description
`consumption(Float!)`
`cost(Float)`	The cost of this consumption, in Australian cents. Note that this value is approximate, and only takes into account the rate at which consumption is charged. It does not include supply charges, pay-on-time discounts, concessions, card fees, or anything else of the sort. It may also be absent, if the rate at which consumption was (or will be) charged isn't known to Kraken at the time.
`costWithGst(Float)`	The same value as the `cost` field but with GST included.
`endAt(DateTime!)`
`startAt(DateTime!)`

{
  "startAt": "2020-01-01T00:00:00.000Z",
  "endAt": "2020-01-01T00:00:00.000Z",
  "consumption": 1.0,
  "cost": 1.0,
  "costWithGst": 1.0
}

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. Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A' - Marked as deprecated on 2024-10-22. - Scheduled for removal on or after 2025-06-25.
`ledgerType(String)`
`name(String)`	The display name of the ledger.
`number(String)`	The canonical name of the ledger.
`paymentAdequacy(PaymentAdequacyDetailsType)`

{
  "id": "abc123",
  "name": "abc123",
  "ledgerType": "abc123",
  "number": "abc123",
  "currentBalance": 1,
  "paymentAdequacy": PaymentAdequacyDetailsType
}

SupplyDetailsType

Fields

Name Description

agreedCapacity(String)

The agreed capacity for this supply.

connectionUnits(String)

The connection units for this supply.

{
  "agreedCapacity": "abc123",
  "connectionUnits": "abc123"
}

SupplyOrServiceCharge

Supporting information for a customer charge resulting from a supply or service agreement

Fields

Name Description

agreements(AgreementConnection)

Agreements which were charged

Arguments

after (String)

before (String)

first (Int)

last (Int)

id(ID!)

The ID of the charge.

period(Period!)

The period that was charged.

{
  "id": "abc123",
  "period": Period,
  "agreements": AgreementConnection
}

SupplyPointConnectionTypeConnection

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.

{
  "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

{
  "node": SupplyPointType,
  "cursor": "abc123"
}

SupplyPointContextDataType

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.

{
  "externalIdentifier": "abc123",
  "marketName": "abc123",
  "requestedSupplyStartDate": "2020-01-01",
  "selectedProduct": SelectedProductType
}

SupplyPointFieldChoiceType

One selectable option of a choice field.

Fields

Name Description

label(String!)

The human-readable label for the option.

value(String!)

The value to send back when this option is selected.

{
  "value": "abc123",
  "label": "abc123"
}

SupplyPointFieldConditionType

One field/value condition within a visibility rule.

Fields

Name Description

fieldCode(String!)

The code of the field whose value the condition tests.

values([String!]!)

The values the tested field is compared against.

{
  "fieldCode": "abc123",
  "values": "abc123"
}

SupplyPointFieldDefinitionType

One enrollment field collected for a supply point in a given market.

Fields

Name	Description
`choices([SupplyPointFieldChoiceType!]!)`	The selectable options for a choice field. Empty for other field types.
`code(String!)`	The field code. May be a dotted path into the stored payload, e.g. 'contractedpowers.period1'.
`defaultValue(String)`	The value to pre-fill when the field has no stored value.
`fieldType(SupplyPointFieldTypeEnum!)`	The data type of the field.
`name(String!)`	The human-readable label for the field.
`required(Boolean!)`	Whether the field must always be provided.
`requiredRules([SupplyPointFieldRuleType!]!)`	Rules describing when the field becomes required, on top of `required`. Empty means the field is never conditionally required.
`section(SupplyPointFieldSectionType)`	The section grouping this field, if any.
`source(SupplyPointFieldSourceEnum!)`	Whether the field is populated by industry validation (`AUTO`) or entered by the agent (`AGENT`).
`visibilityRules([SupplyPointFieldRuleType!]!)`	Rules describing when the field is shown, on top of any section rules. Empty means always shown.

{
  "code": "abc123",
  "name": "abc123",
  "fieldType": "STR",
  "source": "AUTO",
  "required": true,
  "defaultValue": "abc123"
}

SupplyPointFieldDefinitionsType

The enrollment fields collected for supply points in one market.

Fields

Name Description

fields([SupplyPointFieldDefinitionType!]!)

The field definitions for the market, in display order.

hasPayloadValidator(Boolean!)

Whether the market has an industry validator, meaning supply point identifiers in it can be validated and their AUTO fields populated.

{
  "hasPayloadValidator": true
}

SupplyPointFieldRuleType

A rule describing when a field or section applies. Every NOT_IN rule must pass; an ANY rule needs one matching condition.

Fields

Name Description

conditions([SupplyPointFieldConditionType!]!)

The conditions the rule tests.

operator(SupplyPointFieldVisibilityOperatorEnum!)

How this rule's conditions combine.

{
  "operator": "NOT_IN"
}

SupplyPointFieldSectionType

A named group of fields sharing one visibility rule set.

Fields

Name Description

code(String!)

The code identifying the section.

name(String!)

The human-readable name of the section.

visibilityRules([SupplyPointFieldRuleType!]!)

Rules describing when the section is shown. Empty means always shown.

{
  "code": "abc123",
  "name": "abc123"
}

SupplyPointIndustryDataItemType

Fields

Name	Description
`code(String!)`	The field definition code. May be a dotted path into the stored payload, e.g. 'contractedpowers.period1'.
`displayValue(String!)`	The stored value for the field, formatted for display.
`label(String!)`	The human-readable label for the field.
`rawValue(String)`	The stored value for the field, serialised so it can be put back into an input control and sent back unchanged. Unlike `displayValue`, choice fields give their value rather than their label, and booleans give `true` / `false`. Join on `code` against `supplyPointFieldDefinitions` to learn the field's type.

{
  "code": "abc123",
  "label": "abc123",
  "displayValue": "abc123",
  "rawValue": "abc123"
}

SupplyPointInterfaceConnection

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.

{
  "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(SupplyPointInterface)

The item at the end of the edge

{
  "node": SupplyPointInterface,
  "cursor": "abc123"
}

SupplyPointMarketType

A market a supply point can be enrolled in.

Fields

Name Description

label(String!)

The human-readable name of the market.

name(String!)

The market code, to send back on a supply point.

{
  "name": "abc123",
  "label": "abc123"
}

SupplyPointOnEmbeddedProperty

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

SupplyPointOutageSummaryType

Fields

Name	Description
`duration(String)`	Duration of the Supply Point Outage.
`endDateTime(DateTime)`	End time of the Supply Point Outage.
`groupOutageNumber(String)`	The Group Outage identifier this Supply Point Outage belongs to, if any.
`number(String)`	The Supply Point Outage identifier.
`outageType(String)`	The type of the Supply Point Outage.
`startDateTime(DateTime)`	Start time of the Supply Point Outage.
`status(String)`	The status of the Supply Point Outage.

{
  "number": "abc123",
  "outageType": "abc123",
  "status": "abc123",
  "startDateTime": "2020-01-01T00:00:00.000Z",
  "endDateTime": "2020-01-01T00:00:00.000Z",
  "duration": "abc123",
  "groupOutageNumber": "abc123"
}

SupplyPointPortfolioWarningType

Set when the supply point is already in our portfolio but under a different or unresolvable account holder. Enrollment is still allowed; the agent needs to be told.

Fields

Name Description

conflict(PortfolioConflict!)

Why the identifier counts as already being in our portfolio.

{
  "conflict": "ON_SUPPLY"
}

SupplyPointRejectionType

Set when the distributor explicitly rejected the supply point, as opposed to validation failing for a technical reason. The supply point still counts as validated and the agent may enter the enrollment fields manually.

Fields

Name Description

code(String!)

The rejection reason code returned by the distributor.

description(String!)

The rejection reason as returned by the distributor.

{
  "code": "abc123",
  "description": "abc123"
}

SupplyPointTaxAdjustmentType

Represents a tax adjustment for a specific supply point.

Fields

Name	Description
`adjustmentType(String)`	The type of tax adjustment (e.g., EXEMPTION, REDUCTION).
`effectiveFrom(DateTime)`	When this adjustment becomes effective.
`effectiveTo(DateTime)`	When this adjustment ends (null if open-ended).
`qualifyingUsage(Decimal)`	The proportion of usage that qualifies for the adjustment (0-1).
`supplyPointId(ID)`	The ID of the supply point.
`taxCategory(String)`	The tax category for this adjustment.
`taxSubcategory(String)`	The tax subcategory for this adjustment.

{
  "supplyPointId": "abc123",
  "taxCategory": "abc123",
  "taxSubcategory": "abc123",
  "qualifyingUsage": "1.0",
  "adjustmentType": "abc123",
  "effectiveFrom": "2020-01-01T00:00:00.000Z",
  "effectiveTo": "2020-01-01T00:00:00.000Z"
}

SupplyPointType

Represents a SupplyPoint.

Fields

Name	Description
`devices(DevicesConnection)`	Get list of devices under a supply point. Arguments `after` (`String`) `before` (`String`) `deviceIdentifiers` (`[String]`) The ids of the devices to get. If not provided, all devices for the supply point will be returned. `first` (`Int`) `last` (`Int`)
`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. The possible errors that can be raised are: KT-CT-4721: Unsupported reading type. KT-CT-4729: Unknown reading extra requested. KT-CT-1113: Disabled GraphQL field requested. Arguments `endAt` (`DateTime!`) The exclusive end of the time period as an isoformatted string. `extras` (`[String!]`) Optional list of extra keys to include on each reading if present on the underlying raw meter data. Note, requesting extras may cause aggregation delays with large aggregation queries. `readingType` (`ReadingTypes!`) Get readings of only this type. `startAt` (`DateTime!`) The inclusive start of the time period as an isoformatted string. `timeGranularity` (`TimeGranularities`) Time buckets to group readings into. `timezone` (`String`) The timezone in which to return readings. `units` (`[Units]`) Optional filter to return readings only for specific list of units or unit (e.g., KILOWATTHOURS, METERSCUBED, LITER, etc.).

{
  "id": "abc123",
  "marketName": "abc123",
  "externalIdentifier": "abc123",
  "readings": Readings,
  "property": PropertyType,
  "devices": DevicesConnection
}

SupplyProductTagType

A product tag.

Fields

Name Description

code(String)

Tag code.

displayName(String)

Tag display name.

{
  "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. This field returned the incorrect terms and conditions. Please use 'termsAndConditions' instead. - Marked as deprecated on 2026-07-14. - Scheduled for removal on or after 2026-09-14.
`termsContractType(String)`	The product contract type.

{
  "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.

{
  "schedule": PaymentScheduleType
}

SyncAccountCampaignType

Fields

Name Description

campaign(SyncCampaignType)

The campaign that is linked to the account.

expiryDate(String)

Date when this link between account and campaign is no longer valid.

startDate(String)

Date when this link between account and campaign begins.

{
  "startDate": "abc123",
  "expiryDate": "abc123"
}

SyncAccountConnectionTypeConnection

Fields

Name	Description
`edgeCount(Int!)`	Number of nodes in the edge.
`edges([SyncAccountConnectionTypeEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": SyncAccountConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

SyncAccountConnectionTypeEdge

A Relay edge containing a SyncAccountConnectionType and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(SyncAccountType)

The item at the end of the edge

{
  "cursor": "abc123"
}

SyncAccountType

Fields

Name	Description
`accountType(AccountTypeChoices)`	The type of account.
`agreements([SyncAgreementType])`	The account's agreements.
`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)`	Forth line of the billing address.
`billingAddressLine5(String)`	Fifth line of the billing address.
`billingPostcode(String)`	The billing address's postcode.
`brand(BrandChoices)`	The brand code of the account's portfolio.
`business(SyncBusinessType)`	The account's business information if .
`campaigns([SyncAccountCampaignType])`	Linked account campaigns.
`commsDeliveryPreference(CommsDeliveryPreference)`	The account's delivery preference.
`linkedUserIds([String])`	The linked users' IDs.
`number(String)`	The account's number.
`portfolioNumber(String)`	The portfolio's number.
`status(AccountStatus)`	The status of account.

{
  "number": "abc123",
  "portfolioNumber": "abc123",
  "brand": "RED_ENERGY",
  "accountType": "BUSINESS",
  "status": "PENDING",
  "commsDeliveryPreference": "EMAIL",
  "billingAddressLine1": "abc123",
  "billingAddressLine2": "abc123",
  "billingAddressLine3": "abc123",
  "billingAddressLine4": "abc123",
  "billingAddressLine5": "abc123",
  "billingPostcode": "abc123",
  "linkedUserIds": ["abc123"]
}

SyncAccountUserRoleType

Fields

Name Description

accountNumber(String)

The account's number.

role(RoleString)

The user's role for the account.

{
  "accountNumber": "abc123",
  "role": RoleString
}

SyncAgreementType

Fields

Name	Description
`id(ID)`	The agreement's ID.
`isActive(Boolean)`	Whether the agreement is active.
`product(SyncProductType)`	The agreement's product.
`supplyPoint(SyncSupplyPointType)`	The agreement's supply point.
`supplyType(String!)`	The agreement's supply type.
`validFrom(DateTime)`	The agreement's valid from datetime.
`validTo(DateTime)`	The agreement's valid to datetime.

{
  "id": "abc123",
  "isActive": true,
  "validFrom": "2020-01-01T00:00:00.000Z",
  "validTo": "2020-01-01T00:00:00.000Z",
  "supplyType": "abc123"
}

SyncBusinessType

Fields

Name Description

name(String)

The account's business name.

number(String)

The account's business number.

{
  "name": "abc123",
  "number": "abc123"
}

SyncBusinessUserRoleType

Fields

Name	Description
`businessId(ID)`	The business's ID.
`businessName(String)`	The business's name.
`businessNumber(String)`	The business's number.
`role(RoleString)`	The user's role for the business.

{
  "businessId": "abc123",
  "businessNumber": "abc123",
  "businessName": "abc123",
  "role": RoleString
}

SyncCampaignType

Fields

Name	Description
`expiryDate(String)`	Date when the campaign is no longer valid.
`name(String)`	Corresponding unique campaign's name.
`slug(String)`	Corresponding unique campaign's slug.
`startDate(String)`	Date when the campaign begins.

{
  "name": "abc123",
  "slug": "abc123",
  "startDate": "abc123",
  "expiryDate": "abc123"
}

SyncEventType

Fields

Name	Description
`account(AccountType)`	The account for the event sync.
`accountUser(AccountUserType)`	The account user for the event sync.
`eventType(EventTypeChoices)`
`message(String)`
`syncBatchId(String)`

{
  "eventType": "ACCOUNT_CREATED",
  "account": AccountType,
  "accountUser": AccountUserType,
  "syncBatchId": "abc123",
  "message": "abc123"
}

SyncFamilyIssuesType

Fields

Name Description

notSafeToReceiveMoveInComms(Boolean)

Whether it is not safe to send move-in communications to this user.

notSafeToSendFdvPolicy(Boolean)

Whether it is not safe to send the FDV policy to this user.

{
  "notSafeToSendFdvPolicy": true,
  "notSafeToReceiveMoveInComms": true
}

SyncMeterPointType

Fields

Name Description

identifier(ID)

The meter point identifier.

identifierType(MeterPointIdentifierType)

The meter point identifier type.

{
  "identifier": "abc123",
  "identifierType": "NMI"
}

SyncOccupancyPeriodType

Fields

Name Description

effectiveFrom(DateTime!)

The occupancy effective from datetime.

effectiveTo(DateTime)

The occupancy effective to datetime.

{
  "effectiveFrom": "2020-01-01T00:00:00.000Z",
  "effectiveTo": "2020-01-01T00:00:00.000Z"
}

SyncPortfolioUserRoleType

Fields

Name Description

portfolioId(ID)

The portfolio's ID.

portfolioNumber(String)

The portfolio's number.

role(RoleString)

The user's role in the portfolio.

{
  "portfolioId": "abc123",
  "portfolioNumber": "abc123",
  "role": RoleString
}

SyncProductType

Fields

Name Description

code(String)

The product's code.

displayName(String)

The product's display name shown to customers during sign up process.

{
  "code": "abc123",
  "displayName": "abc123"
}

SyncPropertyType

Fields

Name	Description
`addressLine1(String)`	The property's first address line.
`addressLine2(String)`	The property's second address line.
`addressLine3(String)`	The property's third address line.
`addressLine4(String)`	The property's forth address line.
`addressLine5(String)`	The property's fifth address line.
`id(ID)`	The property identifier.
`occupancyPeriods([SyncOccupancyPeriodType])`	Occupancy periods for this property linked to the upstream account.
`postcode(String)`	The property's postcode.

{
  "id": "abc123",
  "addressLine1": "abc123",
  "addressLine2": "abc123",
  "addressLine3": "abc123",
  "addressLine4": "abc123",
  "addressLine5": "abc123",
  "postcode": "abc123"
}

SyncSupplyPointType

Fields

Name Description

id(ID)

The supply point's ID.

meterPoint(SyncMeterPointType)

The supply point's meter point.

property(SyncPropertyType)

The supply point's property.

{
  "id": "abc123"
}

SynchronousOneOffPayment

Output type of the synchronousOneOffPayment mutation.

Fields

Name Description

payment(AccountPaymentType)

Details about the payment. Its status reflects the outcome: cleared if the payment succeeded, failed if it was declined, or requested if the vendor did not give a definitive response.

{
  "payment": AccountPaymentType
}

TagType

Represents a tag used for classifying offerings and products.

Fields

Name Description

code(String!)

Unique tag code.

displayName(String!)

Display name of the tag.

{
  "code": "abc123",
  "displayName": "abc123"
}

TariffPeriodType

Fields

Name	Description
`demandThreshold(Decimal)`	Demand threshold.
`endDate(String)`	The end date of the tariff period in a calendar year in mm-dd format.
`startDate(String)`	The start date of the tariff period in a calendar year in mm-dd format.
`timeOfUse([TimeOfUseType])`	Times of use for this rate.

{
  "startDate": "abc123",
  "endDate": "abc123",
  "timeOfUse": [TimeOfUseType],
  "demandThreshold": "1.0"
}

TaskResult

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.

{
  "status": "STARTED",
  "result": {"key": "value"},
  "error": "abc123"
}

TaxAdjustmentConfigurationType

Represents a tax adjustment configuration term in a contract.

This term stores tax adjustment details for supply points associated with the contract.

Fields

Name	Description
`adjustments([SupplyPointTaxAdjustmentType])`	List of supply point tax adjustments.
`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.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "adjustments": [SupplyPointTaxAdjustmentType]
}

Team

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').

{
  "id": "abc123",
  "name": "abc123",
  "ref": "abc123"
}

TeamGroup

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').

{
  "name": "abc123",
  "ref": "abc123"
}

TeamLocation

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').

{
  "ref": "abc123",
  "friendlyName": "abc123"
}

TemporarySpecialCircumstanceRecordType

Any special circumstances that the user has notified us about, which may entitle them to some specialist services. These circumstances have an end date, after which they will not longer apply. Having young children is an example of this in the UK.

Fields

Name	Description
`createdAt(DateTime)`	The date and time the special circumstance record was created.
`expiryDate(Date)`
`id(ID)`
`internalCode(String)`
`summary(String)`

{
  "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.

{
  "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.

{
  "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

{
  "agreement": CommonAgreementType,
  "possibleErrors": [PossibleErrorType]
}

TerminateContractOutput

Fields

Name Description

contract(Contract)

The contract terminated.

{
  "contract": Contract
}

TerminateCreditTransferPermission

Output type of the terminateCreditTransferPermission mutation.

Fields

Name Description

validTo(DateTime)

Datetime when the credit transfer permission ends.

{
  "validTo": "2020-01-01T00:00:00.000Z"
}

TerminationFeeMarketConfigType

Fields

Name Description

amount(Decimal)

The fee amount (in lowest currency unit).

feeType(TerminationFeeTypeEnum)

The type of termination fee.

marketName(NonEmptyString)

The market associated with this fee configuration.

{
  "marketName": NonEmptyString,
  "amount": "1.0",
  "feeType": "FLAT"
}

TerminationFeeType

Represents the termination term of a contract.

Fields

Name	Description
`amount(Decimal)`	The fee amount. Null if the term has more than one market configuration. Deprecated The 'amount' field is deprecated. Please use 'marketConfigs' instead, which supports a fee per market. - Marked as deprecated on 2026-09-29. - Scheduled for removal on or after 2027-06-01.
`description(NonEmptyString)`	The description of the term.
`displayName(NonEmptyString)`	The display name of the term.
`feeType(TerminationFeeTypeEnum)`	The type of termination fee. Null if the term has more than one market configuration. Deprecated The 'feeType' field is deprecated. Please use 'marketConfigs' instead, which supports a fee per market. - Marked as deprecated on 2026-09-29. - Scheduled for removal on or after 2027-06-01.
`identifier(NonEmptyString)`	The identifier of the term.
`isVariable(Boolean)`	Whether the term is variable.
`marketConfigs([TerminationFeeMarketConfigType])`	Per-market fee configurations.
`marketName(NonEmptyString)`	The market of the termination fee. Null if the term has more than one market configuration. Deprecated The 'marketName' field is deprecated. Please use 'marketConfigs' instead, which supports a fee per market. - Marked as deprecated on 2026-09-29. - Scheduled for removal on or after 2027-06-01.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "marketConfigs": [TerminationFeeMarketConfigType],
  "amount": "1.0",
  "feeType": "FLAT",
  "marketName": NonEmptyString
}

TermsAndConditionsCanNotBeFoundErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

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.

{
  "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

{
  "node": TermsAndConditionsType,
  "cursor": "abc123"
}

TermsAndConditionsS3UrlType

Fields

Name Description

name(String)

The display name of the terms and conditions.

s3Url(String)

The S3 URL to the terms and conditions file.

{
  "name": "abc123",
  "s3Url": "abc123"
}

TermsAndConditionsType

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)`

{
  "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.

{
  "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.

{
  "name": "abc123"
}

ThirdPartyPermission

Holds information about a specific permission.

Fields

Name Description

permission(String)

The short name of the permission.

{
  "permission": "abc123"
}

TimeOfUseBandUsageType

Fields

Name	Description
`band(String!)`	The name of the time-of-use band (timeslot) this usage was recorded in. 'UNCOVERED' when no activation rule matched.
`qualities([ReadingQualityMeta]!)`	A breakdown of this band's value and raw reading count by quality group.
`units(String)`	The units of this usage value, e.g. KILOWATT_HOURS.
`value(Decimal!)`	The summed consumption value for this band within the period.

{
  "band": "abc123",
  "value": "1.0",
  "units": "abc123",
  "qualities": ReadingQualityMeta
}

TimeOfUseDevice

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.

registers(TimeOfUseRegistersConnection)

The registers associated with this device.

Arguments

after (String)

before (String)

first (Int)

last (Int)

registerIdentifiers ([String])

The ids of the registers to get. If not provided, all registers for device will be returned.

timeOfUseUsage([TimeOfUseUsagePeriodType]!)

Usage for this device, aggregated across all of its registers into calendar periods and split by time-of-use band according to the requested scheme. Useful as a fallback when registers is empty, e.g. for devices whose readings don't carry a register identifier.

The possible errors that can be raised are:

KT-CT-15504: Overlapping time-of-use activation rules.
KT-CT-1113: Disabled GraphQL field requested.

{
  "deviceIdentifier": "abc123",
  "registers": TimeOfUseRegistersConnection,
  "timeOfUseUsage": TimeOfUseUsagePeriodType
}

TimeOfUseDeviceRegister

Fields

Name Description

registerIdentifier(String)

The id of the register. This field can only be provided in the output if register level readings are also requested.

timeOfUseUsage([TimeOfUseUsagePeriodType]!)

Usage for this register, organised into calendar periods and split by time-of-use band according to the requested scheme.

The possible errors that can be raised are:

KT-CT-15504: Overlapping time-of-use activation rules.
KT-CT-1113: Disabled GraphQL field requested.

{
  "registerIdentifier": "abc123",
  "timeOfUseUsage": TimeOfUseUsagePeriodType
}

TimeOfUseDevicesConnection

Pagination for time-of-use devices.

Fields

Name	Description
`edgeCount(Int!)`	Number of nodes in the edge.
`edges([TimeOfUseDevicesEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": TimeOfUseDevicesEdge,
  "totalCount": 1,
  "edgeCount": 1
}

TimeOfUseDevicesEdge

A Relay edge containing a TimeOfUseDevices and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(TimeOfUseDevice)

The item at the end of the edge

{
  "node": TimeOfUseDevice,
  "cursor": "abc123"
}

TimeOfUseOverrideType

Represents a time-of-use override to be applied in a contract.

Note: This type is a stub, and will be fleshed out in the future.

Fields

Name	Description
`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.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true
}

TimeOfUseReadingsType

Fields

Name Description

devices(TimeOfUseDevicesConnection)

The devices associated with this supply point.

Arguments

after (String)

before (String)

deviceIdentifiers ([String])

The ids of the devices to get. If not provided, all devices for the supply point will be returned.

first (Int)

last (Int)

timeGranularity(TimeGranularities!)

The time granularity used to bucket usage into periods.

{
  "timeGranularity": "FIVE_MIN",
  "devices": TimeOfUseDevicesConnection
}

TimeOfUseRegistersConnection

Pagination for time-of-use device registers.

Fields

Name	Description
`edgeCount(Int!)`	Number of nodes in the edge.
`edges([TimeOfUseRegistersEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": TimeOfUseRegistersEdge,
  "totalCount": 1,
  "edgeCount": 1
}

TimeOfUseRegistersEdge

A Relay edge containing a TimeOfUseRegisters and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(TimeOfUseDeviceRegister)

The item at the end of the edge

{
  "node": TimeOfUseDeviceRegister,
  "cursor": "abc123"
}

TimeOfUseSchemeType

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.

{
  "name": "abc123",
  "timezone": "abc123",
  "timeslots": TimeSlotWithActivationRuleType
}

TimeOfUseSummaryType

Fields

Name Description

label(String)

The label for this time of use slot.

usage(Decimal)

The estimated usage for this time of use slot.

{
  "label": "abc123",
  "usage": "1.0"
}

TimeOfUseType

Fields

Name Description

days([Weekday])

The days that the rate applies to.

endTime(DateTime)

End time on the last day of the period this year.

startTime(DateTime)

Start time on the first day of the period this year.

{
  "days": "MON",
  "startTime": "2020-01-01T00:00:00.000Z",
  "endTime": "2020-01-01T00:00:00.000Z"
}

TimeOfUseUsagePeriodType

Fields

Name Description

periodEnd(DateTime!)

The exclusive end of this usage period.

periodStart(DateTime!)

The inclusive start of this usage period.

usage([TimeOfUseBandUsageType]!)

Usage within this period, split by time-of-use band.

{
  "periodStart": "2020-01-01T00:00:00.000Z",
  "periodEnd": "2020-01-01T00:00:00.000Z",
  "usage": TimeOfUseBandUsageType
}

TimeSeriesSpecificationEligibilityScheduleType

Represents a schedule for time series specification eligibility within a contract.

Note: This type is a stub, and will be fleshed out in the future.

Fields

Name	Description
`effectivePeriod(RateGroupEligibilityPeriodType)`	The period during which this eligibility is effective.
`isEligible(Boolean)`	Indicates if the time series specification is eligible.
`productCode(String)`	The product code associated with the time series specification.
`supplyPointIdentifier(String)`	The external identifier of the supply point this schedule targets. When null, the schedule targets all agreements for the product.
`timeSeriesSpecificationCode(String)`	The time series specification code.

{
  "productCode": "abc123",
  "timeSeriesSpecificationCode": "abc123",
  "supplyPointIdentifier": "abc123",
  "isEligible": true,
  "effectivePeriod": RateGroupEligibilityPeriodType
}

TimeSlotWithActivationRuleType

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.

{
  "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
}

TimelineArgumentType

Fields

Name Description

name(String!)

The name of the placeholder this value fills in the translated message.

value(String!)

The display value for the placeholder.

{
  "name": "abc123",
  "value": "abc123"
}

TimelineEventConnection

Fields

Name	Description
`edgeCount(Int!)`	Number of nodes in the edge.
`edges([TimelineEventEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": TimelineEventEdge,
  "totalCount": 1,
  "edgeCount": 1
}

TimelineEventEdge

A Relay edge containing a TimelineEvent and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(TimelineEventType)

The item at the end of the edge

{
  "cursor": "abc123"
}

TimelineEventType

Fields

Name	Description
`createdBy(String)`	The user that recorded the event, if any.
`details([TimelineMessageType!]!)`	Messages describing the event, safe to show to the viewer.
`kind(String!)`	The kind of event. Clients choose how to present it from this value; client-defined kinds may appear and have no details.
`occurredAt(DateTime!)`	When the event occurred.

{
  "kind": "abc123",
  "occurredAt": "2020-01-01T00:00:00.000Z",
  "createdBy": "abc123"
}

TimelineMessageType

Fields

Name Description

arguments([TimelineArgumentType!]!)

The values to fill into the translated message.

code(String!)

A stable message identifier for the client to translate.

{
  "code": "abc123"
}

TrancheTargetConfigurationType

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.
`targetMarketConfiguration([TrancheTargetMarketConfigurationType])`	The target market configurations for this tranche.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "targetMarketConfiguration": [TrancheTargetMarketConfigurationType]
}

TrancheTargetFeeMarketType

Fields

Name	Description
`amount(Decimal)`	The residual fee amount for this market.
`feeType(FeeType)`	The type of fee applied to this market.
`marketName(String)`	The name of the market this residual fee configuration applies to.
`unit(String)`	The unit for the residual fee amount (e.g. '£/MWh').

{
  "marketName": "abc123",
  "feeType": "RESIDUAL_FEE",
  "unit": "abc123",
  "amount": "1.0"
}

TrancheTargetFeeType

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.
`markets([TrancheTargetFeeMarketType])`	The per-market residual fees.
`type(NonEmptyString)`	The type of the term.

{
  "type": NonEmptyString,
  "displayName": NonEmptyString,
  "description": NonEmptyString,
  "identifier": NonEmptyString,
  "isVariable": true,
  "markets": [TrancheTargetFeeMarketType]
}

TrancheTargetMarketConfigurationType

Fields

Name	Description
`calculationPeriodFrequency(CalculationPeriodFrequency)`	The frequency at which the calculation period is assessed.
`consumptionComparisonInterval(ConsumptionComparisonInterval)`	The granularity at which metered consumption is compared against the base volume in the rate calculation.
`marketName(String)`	The name of the market this target configuration applies to.
`useConsumptionForRate(Boolean)`	Whether actual consumption should be used in the rate calculation.
`useResidualVolumeForRate(Boolean)`	Whether residual volume should be used in the rate calculation.

{
  "marketName": "abc123",
  "calculationPeriodFrequency": "MONTHLY",
  "useConsumptionForRate": true,
  "useResidualVolumeForRate": true,
  "consumptionComparisonInterval": "SINGLE"
}

TransactionAmountType

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).

{
  "net": 1,
  "tax": 1,
  "gross": 1
}

TransactionConnectionTypeConnection

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.

{
  "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

{
  "node": TransactionType,
  "cursor": "abc123"
}

TransferLeadOpportunities

Output type of the transferLeadOpportunities mutation.

Fields

Name Description

opportunitiesTransferred(Int)

Number of opportunities transferred.

{
  "opportunitiesTransferred": 1
}

TransferLedgerBalance

Output type of the transferLedgerBalance mutation.

Fields

Name Description

balanceTransfer(AccountBalanceTransferType)

Balance transfer details.

{
  "balanceTransfer": AccountBalanceTransferType
}

TransferLoyaltyPointsBetweenUsers

Output type of the transferLoyaltyPointsBetweenUsers mutation.

Fields

Name Description

pointsTransferred(Int)

The number of loyalty points that were transferred.

{
  "pointsTransferred": 1
}

Trigger

Fields

Name	Description
`accounts(AccountConnectionTypeConnection!)`	The accounts related to this trigger. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`processingStatus(TriggerProcessingStatus!)`	The current processing status of this trigger.
`triggerTypeCode(String!)`	The trigger type code for this trigger.

{
  "id": "abc123",
  "triggerTypeCode": "abc123",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "accountsLinkedAt": "2020-01-01T00:00:00.000Z",
  "accounts": AccountConnectionTypeConnection,
  "processingStatus": "UNPROCESSED"
}

TriggerC4Request

Output type of the triggerC4Request mutation.

Fields

Name Description

result(TriggerC4RequestOutputType)

The result of triggering the C4 request.

{
  
}

TriggerC4RequestOutputType

Fields

Name Description

issueId(Int)

The ID of the MeterDataIssue.

nmi(String)

The NMI for which the C4 request was sent.

{
  "issueId": 1,
  "nmi": "abc123"
}

TriggerCollectionProcessMessage

Output type of the triggerCollectionProcessMessage mutation.

Fields

Name Description

triggerResult(TriggerCollectionProcessMessageOutput)

Details of the triggered communication.

{
  
}

TriggerCollectionProcessMessageOutput

Fields

Name Description

fuguTriggerId(String)

The unique identifier of the triggered communication.

{
  "fuguTriggerId": "abc123"
}

TriggerElectricityHouseMoveOut

Output type of the triggerElectricityHouseMoveOut mutation.

Fields

Name Description

error(TriggerElectricityHouseMoveErrorUnion)

The error encountered when trying to trigger the electricity house move out process, if any.

workflow(WorkflowType)

The workflow information which can be used to track the async processing progress.

{
  "workflow": WorkflowType,
  "error": UnableToDeterminePhoneContactDetailsErrorType
}

TriggerGasHouseMoveOut

Output type of the triggerGasHouseMoveOut mutation.

Fields

Name Description

error(TriggerGasHouseMoveErrorUnion)

workflow(WorkflowType)

The workflow information which can be used to track the async processing progress.

{
  "workflow": WorkflowType,
  "error": CouldNotStartWorkflowErrorType
}

TriggerPmdRequest

Output type of the triggerPmdRequest mutation.

Fields

Name Description

result(TriggerPmdRequestOutputType)

The result of triggering the PMD request.

{
  
}

TriggerPmdRequestOutputType

Fields

Name	Description
`failedDateRanges([FailedDateRangeType!])`	The date ranges for which PMD requests failed to send.
`issueId(ID)`	The ID of the MeterDataIssue.
`nmi(String)`	The NMI for which the PMD request was sent.
`requestedDateRanges([RequestedDateRangeType!])`	The date ranges for which PMD requests were successfully sent.

{
  "issueId": "abc123",
  "nmi": "abc123"
}

TriggerStandalonePaymentRequest

Output type of the triggerStandalonePaymentRequest mutation.

Fields

Name Description

paymentNotification(PaymentNotification)

Payment notification trigerred for standalone payment request.

{
  "paymentNotification": PaymentNotification
}

TriggerVmdRequest

Output type of the triggerVmdRequest mutation.

Fields

Name Description

result(TriggerVmdRequestOutputType)

The result of triggering the VMD request.

{
  
}

TriggerVmdRequestOutputType

Fields

Name Description

issueId(Int)

The ID of the MeterDataIssue.

nmi(String)

The NMI for which the VMD request was sent.

{
  "issueId": 1,
  "nmi": "abc123"
}

UnableToAdjustMoveDateErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnableToCancelServiceOrderErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnableToDeleteScheduleType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnableToDeterminePhoneContactDetailsErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnableToEstimate

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnableToMatchPaymentDateToLedgerSchedulesErrorType

Fields

Name Description

maxDate(Date)

Max date that the payment can be rescheduled to.

maxDays(Int)

Maximum number of days the payment can be extended by.

message(String!)

{
  "message": "abc123",
  "maxDate": "2020-01-01",
  "maxDays": 1
}

UnableToParseAEMOAPIResponseErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnableToPerformDiscoveryErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnableToQuoteErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnableToUndoMoveErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnableToUpdateScheduleType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnableToValidateReadingType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnableToWithdrawChangeRequestErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnenrollAccountFromLoyaltyProgram

Output type of the unenrollAccountFromLoyaltyProgram mutation.

Fields

Name Description

outcome(UnenrollAccountFromLoyaltyProgramOutcome)

Outcome of the loyalty points campaign enrollment.

{
  
}

UnenrollAccountFromLoyaltyProgramOutcome

Fields

Name Description

hasUnenrolled(Boolean)

Indicates whether the account has been unenrolled from the loyalty points campaign.

{
  "hasUnenrolled": true
}

UnlinkCustomerBusinessFromLegalEntity

Output type of the unlinkCustomerBusinessFromLegalEntity mutation.

Fields

Name Description

legalEntity(LegalEntityType)

The legal entity the customer business was unlinked from.

{
  
}

UnlinkInternalCompanyFromLegalEntity

Output type of the unlinkInternalCompanyFromLegalEntity mutation.

Fields

Name Description

legalEntity(LegalEntityType)

The legal entity the internal company was unlinked from.

{
  
}

UnlinkPartnerFromLegalEntity

Output type of the unlinkPartnerFromLegalEntity mutation.

Fields

Name Description

legalEntity(LegalEntityType)

The legal entity the partner was unlinked from.

{
  
}

UnsupportedBrandErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UnsupportedMarketErrorType

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UpdateAPIException

Output type of the updateApiException mutation.

Fields

Name Description

apiException(APIExceptionType)

The updated APIException.

{
  
}

UpdateAPIExceptionNote

Output type of the updateApiExceptionNote mutation.

Fields

Name Description

apiException(APIExceptionType)

The updates APIExceptionNote.

{
  
}

UpdateAccountAddressMutation

Output type of the updateAccountAddress mutation.

Fields

Name Description

viewer(AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

{
  "viewer": AccountUserType
}

UpdateAccountBillingAddress

Output type of the updateAccountBillingAddress mutation.

Fields

Name Description

account(AccountType)

The updated account.

{
  "account": AccountType
}

UpdateAccountBillingEmail

Output type of the updateAccountBillingEmail mutation.

Fields

Name Description

account(AccountInterface)

Account that was changed.

{
  "account": AccountInterface
}

UpdateAccountBillingName

Output type of the updateAccountBillingName mutation.

Fields

Name Description

account(AccountInterface)

Account that was changed.

{
  "account": AccountInterface
}

UpdateAccountConsents

Output type of the updateAccountConsents mutation.

Fields

Name Description

consents([ConsentType!]!)

Consents linked to this account.

{
  "consents": ConsentType
}

UpdateAccountElectricityProduct

Output type of the updateAccountElectricityProduct mutation.

Fields

Name Description

account(AccountType)

error(ElectricityProductSwitchingErrorUnion)

{
  "account": AccountType,
  "error": UnsupportedBrandErrorType
}

UpdateAccountGasProduct

Output type of the updateAccountGasProduct mutation.

Fields

Name Description

account(AccountType)

error(GasProductSwitchingErrorUnion)

{
  "account": AccountType,
  "error": UnsupportedBrandErrorType
}

UpdateAccountReference

Output type of the updateAccountReference mutation.

Fields

Name Description

accountReference(AccountReferenceType)

{
  "accountReference": AccountReferenceType
}

UpdateAccountReferralStatus

Output type of the updateAccountReferralStatus mutation.

Fields

Name Description

accountReferral(ReferralType)

The updated account referral instance.

{
  "accountReferral": ReferralType
}

UpdateAccountRichAddressMutation

Output type of the updateAccountRichAddress mutation.

Fields

Name Description

viewer(AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

{
  "viewer": AccountUserType
}

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)`

{
  "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.

{
  "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.

{
  "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.

{
  "goodsPurchase": GoodsPurchase
}

UpdateAffiliateLink

Output type of the updateAffiliateLink mutation.

Fields

Name Description

affiliateLink(AffiliateLinkType)

The updated affiliate link.

{
  
}

UpdateAffiliateOrganisation

Output type of the updateAffiliateOrganisation mutation.

Fields

Name Description

affiliateOrganisation(AffiliateOrganisationType)

The updated affiliate organisation.

{
  
}

UpdateAgentAuxiliaryStatus

Output type of the updateAgentAuxiliaryStatus mutation.

Fields

Name Description

success(Boolean)

Whether the auxiliary status was successfully updated.

{
  "success": true
}

UpdateAgreementPeriod

Output type of the updateAgreementPeriod mutation.

Fields

Name Description

account(AccountType)

Account responsible for the update agreement.

{
  "account": AccountType
}

UpdateAgreementRescission

Output type of the updateAgreementRescission mutation.

Fields

Name Description

agreementRescission(AgreementRescissionType)

The updated agreement rescission instance.

{
  
}

UpdateAgreementRollover

Output type of the updateAgreementRollover mutation.

Fields

Name Description

agreementRollover(AgreementRolloverType)

The update agreement rollover.

{
  "agreementRollover": AgreementRolloverType
}

UpdateAutoTopUpAmount

Output type of the updateAutoTopUpAmount mutation.

Fields

Name Description

schedule(PaymentScheduleType)

The new schedule created.

{
  "schedule": PaymentScheduleType
}

UpdateBusiness

Output type of the updateBusiness mutation.

Fields

Name Description

business(BusinessType)

The updated business.

{
  "business": BusinessType
}

UpdateCampaignAccountExpiryDate

Output type of the updateCampaignAccountExpiryDate mutation.

Fields

Name Description

campaignAccount(AccountCampaignType)

The campaign account with the updated expiry date.

{
  "campaignAccount": AccountCampaignType
}

UpdateCollectionProcessRecordLatestStep

Output type of the updateCollectionProcessRecordLatestStep mutation.

Fields

Name Description

updatedCollectionProcessRecord(UpdateCollectionProcessRecordLatestStepOutputType)

The updated collection process record.

{
  
}

UpdateCollectionProcessRecordLatestStepOutputType

Fields

Name Description

latestStep(CollectionProcessStepType)

The updated latest step of the collection process record.

number(String)

The number of the collection process record.

{
  "number": "abc123"
}

UpdateCollectionProcessRecordToActive

Output type of the updateCollectionProcessRecordToActive mutation.

Fields

Name Description

collectionProcessActivated(UpdateCollectionProcessRecordToActiveOutputType)

Whether the collection process was successfully updated.

{
  
}

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.

{
  "number": "abc123",
  "status": "PENDING"
}

UpdateCollectionProcessRecordToComplete

Output type of the updateCollectionProcessRecordToComplete mutation.

Fields

Name Description

collectionProcessComplete(UpdateCollectionProcessRecordToCompleteOutputType)

Whether the collection process was successfully updated.

{
  
}

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.

{
  "number": "abc123",
  "status": "PENDING"
}

UpdateCommsDeliveryPreference

Output type of the updateCommsDeliveryPreference mutation.

Fields

Name Description

account(AccountInterface)

{
  "account": AccountInterface
}

UpdateConcession

Output type of the updateConcession mutation.

Fields

Name Description

concession(ConcessionType)

{
  "concession": ConcessionType
}

UpdateDCAProceeding

Output type of the updateDcaProceeding mutation.

Fields

Name Description

dcaProceedingUpdateStatus(DCAProceedingUpdateStatus)

Whether the update has been applied.

{
  
}

UpdateDocumentAccessibilityPreference

Output type of the updateDocumentAccessibilityPreference mutation.

Fields

Name Description

account(AccountType)

Account that was changed.

{
  "account": AccountType
}

UpdateElecMeterPointAccessDetails

Output type of the updateElecMeterPointAccessDetails mutation.

Fields

Name Description

meterPoint(MeterPointType)

The target meter point.

{
  "meterPoint": MeterPointType
}

UpdateExportPaymentMethod

Output type of the updateExportPaymentMethod mutation.

Fields

Name Description

exportRepaymentDetails(ExportRepaymentDetailsType)

Updated export repayment details.

{
  "exportRepaymentDetails": ExportRepaymentDetailsType
}

UpdateGroupOutageStatus

Output type of the updateGroupOutageStatus mutation.

Fields

Name Description

groupOutage(GroupOutageStatusType)

The Group Outage after its status was updated.

{
  
}

UpdateHardshipAgreement

Output type of the updateHardshipAgreement mutation.

Fields

Name Description

updatedHardshipAgreement(HardshipAgreementType)

The updated hardship agreement.

{
  "updatedHardshipAgreement": HardshipAgreementType
}

UpdateKnowledgeDatabaseArticleFromText

Output type of the updateKnowledgeDatabaseArticleFromText mutation.

Fields

Name Description

articleId(Int)

The ID of the updated article.

{
  "articleId": 1
}

UpdateLeadDetails

Output type of the updateLeadDetails mutation.

Fields

Name Description

updatedLeadData(JSONString)

Arguments passed.

{
  "updatedLeadData": {"key": "value"}
}

UpdateLeadStage

Output type of the updateLeadStage mutation.

Fields

Name Description

updatedLeadData(JSONString)

Arguments passed.

{
  "updatedLeadData": {"key": "value"}
}

UpdateLegalEntity

Output type of the updateLegalEntity mutation.

Fields

Name Description

legalEntity(LegalEntityType)

The updated legal entity.

{
  
}

UpdateMessageTags

Output type of the updateMessageTags mutation.

Fields

Name Description

tags([InkTag!]!)

Confirmed tags.

{
  
}

UpdateMetadata

Output type of the updateMetadata mutation.

Fields

Name Description

metadata(Metadata)

{
  "metadata": Metadata
}

UpdateNotesOnOpportunity

Output type of the updateNotesOnOpportunity mutation.

Fields

Name Description

opportunityNumber(String)

The number of the opportunity.

{
  "opportunityNumber": "abc123"
}

UpdateOfferGroupOnOpportunity

Output type of the updateOfferGroupOnOpportunity mutation.

Fields

Name Description

opportunityNumber(String)

The number of the opportunity.

{
  "opportunityNumber": "abc123"
}

UpdateOnSiteJobsAppointment

Output type of the updateOnSiteJobsAppointment mutation.

Fields

Name Description

onSiteJobsAppointment(OnSiteJobsAppointmentType)

The Appointment that was updated.

{
  
}

UpdateOnSiteJobsRequest

Output type of the updateOnSiteJobsRequest mutation.

Fields

Name Description

onSiteJobsRequest(OnSiteJobsRequestType)

The updated request.

{
  
}

UpdateOnSiteJobsVendorComplaint

Output type of the updateOnSiteJobsVendorComplaint mutation.

Fields

Name Description

onSiteJobsVendorComplaint(OnSiteJobsVendorComplaintType)

The updated vendor complaint.

{
  
}

UpdateOpportunityAddress

Output type of the updateOpportunityAddress mutation.

Fields

Name Description

opportunityNumber(String)

The unique number of the opportunity.

{
  "opportunityNumber": "abc123"
}

UpdateOpportunityAssignment

Output type of the updateOpportunityAssignment mutation.

Fields

Name Description

updatedOpportunityData(JSONString)

Arguments passed.

{
  "updatedOpportunityData": {"key": "value"}
}

UpdateOpportunityDetails

Output type of the updateOpportunityDetails mutation.

Fields

Name Description

updatedData(JSONString)

Arguments updated.

{
  "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.

{
  "extraDetails": {"key": "value"}
}

UpdateOpportunityProductSelection

Output type of the updateOpportunityProductSelection mutation.

Fields

Name Description

updatedData(JSONString)

Arguments updated.

{
  "updatedData": {"key": "value"}
}

UpdateOpportunitySalesDetails

Output type of the updateOpportunitySalesDetails mutation.

Fields

Name Description

updatedOpportunityData(JSONString)

Arguments passed.

{
  "updatedOpportunityData": {"key": "value"}
}

UpdateOpportunityStage

Output type of the updateOpportunityStage mutation.

Fields

Name Description

message(String)

Placeholder success message for now.

{
  "message": "abc123"
}

UpdateOpportunitySupplyPoints

Output type of the updateOpportunitySupplyPoints mutation.

Fields

Name Description

opportunityNumber(String)

The number of the updated opportunity.

{
  "opportunityNumber": "abc123"
}

UpdateOptionsLanguagePreference

Output type of the updateOptionsLanguagePreference mutation.

Fields

Name Description

optionsLanguagePreference(OptionsLanguagePreferenceChoices)

The selected language preference.

{
  "optionsLanguagePreference": "ENGLISH"
}

UpdatePassword

Output type of the updatePassword mutation.

Fields

Name Description

viewer(AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

{
  "viewer": AccountUserType
}

UpdatePaymentSchedule

Output type of the updatePaymentSchedule mutation.

Fields

Name Description

error(UpdatePaymentScheduleErrorUnion)

Handled errors related to payment schedule updates.

schedule(PaymentScheduleType)

Updated payment schedule.

{
  "schedule": PaymentScheduleType,
  "error": DoesNotExistErrorType
}

UpdatePortfolioOperationsTeam

Output type of the updatePortfolioOperationsTeam mutation.

Fields

Name Description

portfolio(PortfolioType)

The updated portfolio.

{
  "portfolio": PortfolioType
}

UpdatePrimaryResidence

Output type of the updatePrimaryResidence mutation.

Fields

Name Description

error(UpdatePrimaryResidenceErrorUnion)

The error type and message.

primaryResidence(PrimaryResidenceType)

The updated primary residence.

{
  "primaryResidence": PrimaryResidenceType,
  "error": AccountUserCanNotFoundErrorType
}

UpdateProcessedHouseMoveDate

Output type of the updateProcessedHouseMoveDate mutation.

Fields

Name Description

account(AccountType)

error(UpdateProcessedHouseMoveDateErrorUnion)

{
  "account": AccountType,
  "error": DoesNotExistErrorType
}

UpdateProductPricesOutput

Rate group prices for a product.

Fields

Name Description

prices([RateGroupPrices!]!)

The rate group prices.

{
  
}

UpdatePropertyAddress

Output type of the updatePropertyAddress mutation.

Fields

Name Description

property(PropertyType)

The property whose address was updated.

{
  "property": PropertyType
}

UpdateQuoteConfigurationOutput

Output for the updateQuoteConfiguration mutation.

Fields

Name Description

quoteConfiguration(QuoteConfigurationType!)

The updated quote configuration.

{
  
}

UpdateRegisterNTCOverride

Output type of the updateRegisterNtcOverride mutation.

Fields

Name Description

meterPoint(MeterPointType)

The target meter point.

{
  "meterPoint": MeterPointType
}

UpdateSiteworksRequest

Output type of the updateSiteworksRequest mutation.

Fields

Name Description

siteworksRequest(CoreSiteworksRequestType)

The siteworks request after the update.

{
  
}

UpdateUserAddressMutation

Output type of the updateUserAddress mutation.

Fields

Name Description

viewer(AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

{
  "viewer": AccountUserType
}

UpdateUserMutation

Output type of the updateUser mutation.

Fields

Name Description

possibleErrors([PossibleErrorType])

Field with the possible errors of the query/mutation.

Deprecated

viewer(AccountUserType)

{
  "viewer": AccountUserType,
  "possibleErrors": [PossibleErrorType]
}

UpdateUserRichAddressMutation

Output type of the updateUserRichAddress mutation.

Fields

Name Description

viewer(AccountUserType)

The currently authenticated user.

This field requires the Authorization header to be set.

{
  "viewer": AccountUserType
}

UsageReferenceType

Fields

Name	Description
`accountType(UsageReferenceAccountType!)`
`pricingZone(UsageReferencePricingZone!)`
`state(UsageReferenceState!)`
`totalUsage(Int!)`	The reference supply usage in MJ

{
  "pricingZone": "AGLNSW",
  "state": "ACT",
  "accountType": "DOMESTIC",
  "totalUsage": 1
}

UsageSummaryType

Fields

Name	Description
`controlledLoad(Decimal)`	Controlled load usage summary.
`endAt(DateTime)`	The ending date and time this usage summary covers.
`export([TimeOfUseSummaryType])`	Solar export usage summary. Will be null for system generated usage estimates.
`standard([TimeOfUseSummaryType])`	Usage summary for the different time of use slots. Basic meters will have a single ALLDAY entry.
`startAt(DateTime)`	The starting date and time this usage summary covers.

{
  "controlledLoad": "1.0",
  "startAt": "2020-01-01T00:00:00.000Z",
  "endAt": "2020-01-01T00:00:00.000Z"
}

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.

{
  "forPaymentsAfter": "abc123"
}

UserNotFound

Fields

Name Description

message(String!)

{
  "message": "abc123"
}

UserRole

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.

{
  "code": "abc123",
  "name": "abc123",
  "description": "abc123",
  "permissionCodes": "abc123"
}

UserSyncPayloadType

Fields

Name	Description
`accountUserId(ID)`	The account user's ID.
`accountUserRoles([SyncAccountUserRoleType])`	List of account user roles.
`accounts(SyncAccountConnectionTypeConnection)`	List of accounts on the portfolios. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`) `offset` (`Int`)
`alternativePhoneNumbers([String])`	List of alternative phone numbers for the account user.
`businessUserRoles([SyncBusinessUserRoleType])`	List of business user roles.
`dateOfBirth(String)`	The account user's date of birth.
`email(String)`	The account user's email address.
`familyIssues(SyncFamilyIssuesType)`	The account user's family issues record.
`familyName(String)`	The account user's family name.
`givenName(String)`	The account user's given name.
`hasFamilyIssues(Boolean)`	Whether the account user has family issues.
`landline(String)`	The account user's landline phone number.
`mobile(String)`	The account user's mobile phone number.
`portfolioUserRoles([SyncPortfolioUserRoleType])`	List of portfolio user roles.

{
  "accountUserId": "abc123",
  "givenName": "abc123",
  "familyName": "abc123",
  "dateOfBirth": "abc123",
  "hasFamilyIssues": true,
  "email": "abc123",
  "mobile": "abc123",
  "landline": "abc123",
  "alternativePhoneNumbers": ["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.

{
  "isValid": true,
  "cleanedDescriptor": AddressFieldDescriptorType
}

ValidateAgreementRollover

Output type of the validateAgreementRollover mutation.

Fields

Name Description

agreementRollover(AgreementRolloverType)

The validated agreement rollover.

{
  "agreementRollover": AgreementRolloverType
}

ValidateConcession

Output type of the validateConcession mutation.

Fields

Name Description

concession(ConcessionType)

{
  "concession": ConcessionType
}

ValidateEmail

Output type of the validateEmail mutation.

Fields

Name Description

isValid(Boolean)

Whether the email is valid or not.

{
  "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.

{
  "deviceIsValid": true
}

ValidatePhone

Output type of the validatePhone mutation.

Fields

Name Description

isValid(Boolean)

Whether the phone number is valid or not.

{
  "isValid": true
}

ValidateSupplyPoint

Output type of the validateSupplyPoint mutation.

Fields

Name	Description
`portfolioWarning(SupplyPointPortfolioWarningType)`	Set when the supply point is already in our portfolio under a different or unresolvable account holder. Enrollment is still allowed.
`rejection(SupplyPointRejectionType)`	Set when the distributor rejected the supply point. The supply point still counts as validated, with no reported values.
`source(String)`	Where the reported values came from, when it was not the live industry service. `sips` means they were read from the central industry database, which is refreshed periodically and so may be out of date.
`supplyPoint(LeadSupplyPointType!)`	The validated supply point. Its `industryData` carries the values the validation service reported, which the agent may review and amend before saving.

{
  "source": "abc123"
}

ValidationErrorFieldType

Fields

Name Description

inputPath([String])

message(String)

{
  "inputPath": ["abc123"],
  "message": "abc123"
}

ValidationErrorType

Error type for resolving input validation errors.

Fields

Name Description

fieldErrors([ValidationErrorFieldType])

{
  "fieldErrors": [ValidationErrorFieldType]
}

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.

{
  "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. Please use 'characteristics' instead. - Marked as deprecated on 2026-07-17. - Scheduled for removal on or after 2026-07-31.
`characteristics(GenericScalar!)`	The characteristic values for the variant.
`schemeLabels(JSONString)`	The scheme labels for the variant. Deprecated The 'schemeLabels' field is deprecated. Please use 'schemes' instead. - Marked as deprecated on 2026-07-17. - Scheduled for removal on or after 2026-07-31.
`schemes(GenericScalar)`	The scheme labels for the variant.

{
  "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.

{
  "contract": Contract
}

VerificationProcess

Fields

Name Description

status(String)

Verification process status.

type(String)

Verification type.

userNumber(String)

Customer with pending verification.

{
  "userNumber": "abc123",
  "status": "abc123",
  "type": "abc123"
}

VerifyCustomer

Output type of the verifyCustomer mutation.

Fields

Name Description

user(AccountUserType)

The currently authenticated user.

{
  "user": AccountUserType
}

VerifyEmail

Output type of the verifyEmail mutation.

Fields

Name Description

isVerified(Boolean)

Whether the email is verified.

{
  "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.

{
  "token": "abc123"
}

VerifyPayerBankAccountDetails

Output type of the verifyPayerBankAccountDetails mutation.

Fields

Name Description

result(PayerVerificationResult!)

The outcome of the payer verification.

{
  "result": "MATCH"
}

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.

{
  "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

{
  "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.

{
  "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

{
  "cursor": "abc123"
}

VoiceCampaignItemType

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 `call_window_start`, this determines the time window in which the item should be called. Specified as ISO 8601 format.
`callWindowStart(DateTime)`	Together with `call_window_end`, this determines the time window in which the item should be called. Specified as ISO 8601 format.
`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. `"UNASSIGNED": An item that is ready to be assigned to an agent "ASSIGNED": An item that is assigned to an agent and ready to contact "IN_PROGRESS": An item where a call is currently in progress "COMPLETE": An item has been contacted, and does not need to be re-contacted "REMOVED": An item that was removed without being contacted`

{
  "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"}
}

VoiceCampaignType

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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)
`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. Arguments `after` (`String`) `before` (`String`) `first` (`Int`) `last` (`Int`)

{
  "id": "abc123",
  "name": "abc123",
  "description": "abc123",
  "customOutboundPhoneNumber": "abc123",
  "status": "ACTIVE",
  "campaignType": "PREVIEW",
  "preventDuplicateRecords": true
}

VoucherPurchaseConnectionTypeConnection

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.

{
  "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

{
  "node": VoucherPurchaseType,
  "cursor": "abc123"
}

VoucherPurchaseType

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.

{
  "id": "abc123",
  "charge": AccountChargeType,
  "chargeBalanceTransfer": AccountBalanceTransferType,
  "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"
}

VoucherRedemptionType

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.

{
  "id": "abc123",
  "credit": AccountCreditType,
  "claimedAt": "2020-01-01T00:00:00.000Z",
  "isReversed": true
}

VouchersBalanceDetail

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.

{
  "redeemableToday": 1,
  "redeemableInFuture": 1
}

WaterFiltersOutput

Fields

Name Description

deviceId(String)

Serial number.

marketSupplyPointId(String)

Meter point reference.

readingFrequencyType(ReadingFrequencyType)

The frequency of the reading.

{
  "marketSupplyPointId": "abc123",
  "deviceId": "abc123",
  "readingFrequencyType": "RAW_INTERVAL"
}

WhatsAppTextMessage

Fields

Name Description

body(String!)

Whatsapp text message body.

{
  "body": "abc123"
}

WithdrawDunning

Output type of the withdrawDunning mutation.

Fields

Name Description

withdrawSuccessful(Boolean)

Whether the dunning process was withdrawn successfully.

{
  "withdrawSuccessful": true
}

WorkScheduleType

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.

{
  "identifier": "abc123",
  "name": "abc123",
  "isOpen": true,
  "isPublicHoliday": true,
  "openOrClosedReason": "CLOSED_DUE_TO_PUBLIC_HOLIDAY"
}

WorkflowType

A workflow manages a set of long-running steps of a user journey. This type represents a single run of a given workflow.

Fields

Name	Description
`id(ID!)`
`name(String)`	The name of the business flow that the workflow is affiliated to.
`status(Status)`	The workflow's current processing status.
`steps([StepType])`	The steps of the workflow.

{
  "id": "abc123",
  "name": "abc123",
  "status": "SKIPPED",
  "steps": [StepType]
}

WorkflowTypeConnectionTypeConnection

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([WorkflowTypeConnectionTypeEdge]!)`	Contains the nodes in this connection.
`pageInfo(PageInfo!)`	Pagination data for this connection.
`totalCount(Int!)`	Total number of nodes.

{
  "pageInfo": PageInfo,
  "edges": WorkflowTypeConnectionTypeEdge,
  "totalCount": 1,
  "edgeCount": 1
}

WorkflowTypeConnectionTypeEdge

A Relay edge containing a WorkflowTypeConnectionType and its cursor.

Fields

Name Description

cursor(String!)

A cursor for use in pagination

node(WorkflowType)

The item at the end of the edge

{
  "node": WorkflowType,
  "cursor": "abc123"
}

WrongMarket

Fields

Name Description

message(String!)

{
  "message": "abc123"
}