Objects
Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.
API Site
APIBrownoutEdge
A Relay edge containing a APIBrownout and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(APIBrownout) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}APIExceptionConnectionTypeEdge
A Relay edge containing a APIExceptionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(APIExceptionType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}AcceptGoodsQuote
The possible errors that can be raised are:
- KT-CT-8223: Unauthorized.
- KT-CT-8201: Received an invalid quoteId.
- KT-CT-8224: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
goodsPurchase(GoodsPurchase) | Goods purchase created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}AcceptOfferForQuoting
Accept a quoting offer in an offer group.
The possible errors that can be raised are:
- KT-CT-12402: Unable to accept offer.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
offer(OfferType) | Accepted quoting offer. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"offer": OfferType
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountApplicationConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountApplicationConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountApplicationConnectionTypeEdge
A Relay edge containing a AccountApplicationConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountApplicationType) | The item at the end of the edge |
Example
{
"node": AccountApplicationType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
coolingOffEndDate(Date) | Last day of the cooling off period. Barring changes or objections, the account will be gained on the next business day after this date. This value will only be returned for current applications. |
dateOfSale(Date) | Date at which this account decided to switch to us. |
isMigrated(Boolean) | Whether this account application represents a migration into the current system or a regular gain. |
migrationSource(String) | The source system for a migrated account. This could be the previous supplier or the previous account management system. |
preferredSsd(Date) | Preferred supply start date. If null, it means ASAP. |
salesChannel(String!) | |
salesSubchannel(String) | The sales subchannel used when signing up. This could for example be a price comparison site. |
status(AccountApplicationStatus!) |
Example
{
"status": "CURRENT",
"salesChannel": "abc123",
"salesSubchannel": "abc123",
"dateOfSale": "2020-01-01",
"coolingOffEndDate": "2020-01-01",
"isMigrated": true,
"migrationSource": "abc123",
"preferredSsd": "2020-01-01"
}AccountCampaignConnectionTypeConnection
Paginator of Account Campaigns
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountCampaignConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountCampaignConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountCampaignConnectionTypeEdge
A Relay edge containing a AccountCampaignConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountCampaignType) | The item at the end of the edge |
Example
{
"node": AccountCampaignType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
campaignExpiryDate(Date) | The date on which the associated campaign itself concludes. |
expiryDate(Date) | The date on which the account's participation in the campaign ends. |
name(String) | The name of the campaign. |
slug(String) | The slug of the campaign. |
startDate(Date) | The date that the account's link to the campaign started. |
Example
{
"campaignExpiryDate": "2020-01-01",
"name": "abc123",
"slug": "abc123",
"expiryDate": "2020-01-01",
"startDate": "2020-01-01"
}Fields
| Name | Description |
|---|---|
data(JSONString) | A JSON object containing unstructured data about the account charge. |
updatedAt(DateTime) | The date and time the metadata was last updated. |
Example
{
"data": {"key": "value"},
"updatedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
cclAmount(BigInt) | The climate change levy amount of the charge. |
displayNote(String) | The display note for the charge. |
grossAmount(BigInt) | The gross amount of the charge. |
id(ID) | The ID of the account charge. |
metadata(AccountChargeMetadataType) | JSON metadata containing unstructured data about the account charge. |
netAmount(BigInt) | The net amount of the charge. |
note(String) | The note for the charge. |
reason(String) | The reason for the charge. |
salesTaxAmount(BigInt) | The sales tax amount of the charge. |
Example
{
"id": "abc123",
"netAmount": 1,
"grossAmount": 1,
"salesTaxAmount": 1,
"cclAmount": 1,
"reason": "abc123",
"note": "abc123",
"displayNote": "abc123",
"metadata": AccountChargeMetadataType
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountConnectionTypeEdge
A Relay edge containing a AccountConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountType) | The item at the end of the edge |
Example
{
"node": AccountType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
data(JSONString!) | |
updatedAt(DateTime!) |
Example
{
"data": {"key": "value"},
"updatedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
grossAmount(BigInt!) | |
id(ID!) | |
metadata(AccountCreditMetadataType) | |
netAmount(BigInt!) | |
note(String!) | |
reason(String!) | |
salesTaxAmount(BigInt!) |
Example
{
"id": "abc123",
"grossAmount": 1,
"netAmount": 1,
"salesTaxAmount": 1,
"note": "abc123",
"reason": "abc123",
"metadata": AccountCreditMetadataType
}Fields
| Name | Description |
|---|---|
electricityEstimation(ElecEstimatedUsageAndCostType) | Electricity usage (kWh) and cost estimation. |
gasEstimation(GasEstimatedUsageAndCostType) | Gas usage (MJ) and cost estimation. |
Example
{
"electricityEstimation": ElecEstimatedUsageAndCostType,
"gasEstimation": GasEstimatedUsageAndCostType
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountEventConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountEventConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountEventConnectionTypeEdge
A Relay edge containing a AccountEventConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountEvent) | The item at the end of the edge |
Example
{
"node": EmailEventType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
category(String!) | |
fetchUrl(String) | |
filename(String!) | |
id(ID!) | The ID of the object |
isReady(Boolean) | Is the file ready for use / downloadable? |
isUploaded(Boolean) | Is the file uploaded to S3? |
sizeInBytes(Int) |
Example
{
"id": "abc123",
"filename": "abc123",
"category": "abc123",
"isUploaded": true,
"isReady": true,
"fetchUrl": "abc123",
"sizeInBytes": 1
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountFileAttachmentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountFileAttachmentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountFileAttachmentConnectionTypeEdge
A Relay edge containing a AccountFileAttachmentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountFileAttachment) | The item at the end of the edge |
Example
{
"node": AccountFileAttachment,
"cursor": "abc123"
}AccountHazardType
A hazard associated with an account.
Fields
| Name | Description |
|---|---|
code(String) | The hazard code. |
description(String) | The hazard description. |
hazardRemarks(String) | Remarks about the hazard. |
lastVerifiedBy(String) | The user who last verified the hazard. |
lastVerifiedDate(Date) | The date the hazard was last verified. |
name(String) | The hazard name. |
Example
{
"code": "abc123",
"name": "abc123",
"description": "abc123",
"lastVerifiedBy": "abc123",
"lastVerifiedDate": "2020-01-01",
"hazardRemarks": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
loyaltyPoints(Int) | The number of loyalty points the account (or user with the given id) has. |
totalMonetaryAmount(Int) | The net monetary value of the loyalty points in the currency's sub-units. |
Example
{
"loyaltyPoints": 1,
"totalMonetaryAmount": 1
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountPaymentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountPaymentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountPaymentConnectionTypeEdge
A Relay edge containing a AccountPaymentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountPaymentType) | The item at the end of the edge |
Example
{
"node": AccountPaymentType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amount(BigInt!) | Amount of payment in the currency's minor unit |
id(ID!) | |
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. Arguments
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. |
Example
{
"id": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"reference": "abc123",
"transactionType": "DD_FIRST_COLLECTION",
"status": "SCHEDULED",
"source": "abc123",
"paymentInstruction": PaymentInstructionType,
"surchargeAmount": 1,
"schedulabilityStatus": SchedulabilityStatusType,
"maxRescheduleDays": 1,
"refundableAmount": 1
}Fields
| Name | Description |
|---|---|
account(AccountType!) | |
createdAt(DateTime!) | |
namespace(String!) | The namespace for the reference will be one of the following strings: essentialenergy.bpay-client-reference-numbers essentialenergy.centrepay-client-reference-numbers essentialenergy.anz-client-reference-numbers essentialenergy.aus-post-client-reference-numbers |
updatedAt(DateTime!) | |
value(String!) |
Example
{
"namespace": "abc123",
"value": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"account": AccountType
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountReminderConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountReminderConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountReminderConnectionTypeEdge
A Relay edge containing a AccountReminderConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Reminder) | The item at the end of the edge |
Example
{
"node": Reminder,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountRepaymentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountRepaymentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountRepaymentConnectionTypeEdge
A Relay edge containing a AccountRepaymentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountRepaymentType) | The item at the end of the edge |
Example
{
"node": AccountRepaymentType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amount(BigInt!) | Amount of payment in the currency's minor unit |
id(ID!) | |
paymentDate(Date!) | The date this payment is scheduled to be debited |
status(AccountRepaymentStatusOptions) | The current status of the repayment. |
Example
{
"id": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"status": "REQUESTED"
}Fields
| Name | Description |
|---|---|
accountType(AccountTypeChoices) | The type of account. |
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 |
agreements([AusAgreementInterface]) | Retrieve all agreements under this account. Note that when |
allProperties([PropertyType]) | All properties associated with the account, regardless of APEP. |
annualStatements(AnnualStatementConnectionTypeConnection) | Fetch annual statements for the account. |
applications(AccountApplicationConnectionTypeConnection) | Applications by this account to become our customer. More recent applications will be listed first. Arguments
The account application status. |
assistanceAgreements([AssistanceAgreementType]) | Assistance agreements for account. |
balance(Int!) | The current account balance. Arguments
If this variable is set to true, the balance will be calculated based on the sum of balances on all ledgers configured to contribute to this account's balance. Otherwise, only the main ledger's balance will be fetched (legacy behaviour). If you are unsure, set this value to true. |
bill(BillInterface) | Fetch a specific issued bill (invoice/statement) for the account. Arguments
The unique identifier of the bill.
The unique identifier of the bill. A pending billing document will not have an identifier yet. And not all finalized billing documents will have an identifier. Prefer using the id field unless advised by Kraken.
The number of the ledger for the bill. When provided, only the period- or item-based documentfor this account that is linked to that ledger is returned; pre-kraken, collective bills, and legacy bills are excluded. |
billingAddress(String) | The billing address of the account. |
billingAddressLine1(String) | |
billingAddressLine2(String) | |
billingAddressLine3(String) | |
billingAddressLine4(String) | |
billingAddressLine5(String) | |
billingAddressPostcode(String) | |
billingCountryCode(String) | |
billingDeliveryPointIdentifier(String) | |
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. |
bills(BillConnectionTypeConnection) | Fetch issued bills (invoices/statements) for the account. Arguments
Optional date representing the beginning of the search results. This date value is inclusive.
Include bills without PDFs.
Include held statements within the results.
Include pre-Kraken / historical statements within the results.
Include open statements. This flag needs to be used along with includeBillsWithoutPDF=false otherwise results will prove unexpected.
Optional date representing the beginning of the search results based on issued date. This date value is inclusive.
Optional date representing the end of the search results based on issued date. This date value is exclusive.
The number of a ledger for the bill. When provided, only period- or item-based documents for this account that are linked to that ledger are returned; collective bills and legacy bills are excluded. Historic/pre-Kraken bills are unaffected by this filter and are included or excluded solely by includeHistoricStatements.
Only include bills emailed to the current user's email.
The order in which to return the bills.
Optional date representing the end of the search results. This date value is exclusive. |
brand(String) | The brand of the account. |
business(BusinessType) | Business info related to a business account. |
businessType(BusinessTypeOptions) | The company type of a business account. Deprecated The 'businessType' field is deprecated. |
campaigns([AccountCampaignType]) | The campaigns associated with an account. |
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. |
complaints(ComplaintConnectionTypeConnection) | The complaints associated with an account. |
consents([ConsentType!]!) | Consents linked to this account. |
contributionAgreements([ContributionAgreementType]) | Contribution agreements for account. |
createdAt(DateTime) | Datetime that the account was created at. |
debtCollectionProceedings([DebtCollectionProceedingType]) | Debt collection proceedings for account. |
directDebitInstructions(DirectDebitInstructionConnectionTypeConnection) | The direct debit instructions of the account Arguments
Filter the direct debit instructions by status |
documentAccessibility(DocumentAccessibilityChoices) | The document accessibility preference of the account. |
dueCharges([DueChargesType]) | Fetch a list of due charges for an account. Due charges are defined for each issued statement as:
(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 You may use Arguments
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
Filter the account events by their type.
|
fileAttachments([AccountFileAttachment]) | Files attached to this account. |
hasActiveDebtCollectionProceeding(Boolean!) | True if there is an active debt collection proceeding for this account. False otherwise. |
hasActiveDunningProcess(Boolean!) | Whether the account has an active dunning process. |
hasWriteOffLedgers(Boolean) | True if the account has written off ledgers. False otherwise. |
hazards([AccountHazardType]) | List of hazards associated with the account. These do not come from the market data. Deprecated The 'hazards' field is deprecated. |
id(ID!) | |
isInHardship(Boolean) | True if there is an active Hardship Agreement for this account. False otherwise. |
isMeasured(Boolean) | Whether the account's active water agreements are measured or unmeasured. Only considers AUS_WATER market agreements. Null if no active water agreements exist. |
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. |
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
The ledger number to calculate maximum refund for. |
metadata([Metadata]) | Metadata associated with the account. |
notes([AccountNoteType]) | Notes for the account. |
number(String) | A code that uniquely identifies the account. |
overdueBalance(Int) | The current account overdue balance. |
paginatedFileAttachments(AccountFileAttachmentConnectionTypeConnection) | Files attached to this account. |
paginatedPaymentForecast(PaymentForecastConnectionTypeConnection) | Paginated payment forecasts for an account. Starts from today's date (inclusive). The interface supports Arguments
The end date to retrieve forecasts for. This end date is inclusive.
The ledger to return payment forecasts from. Defaults to the main ledger when no ID is passed.
The number of the ledger to return payment forecasts from. Defaults to the main ledger when no number is passed. |
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. Arguments
The end date to retrieve forecasts for. This end date is inclusive.
The ledger to return payment forecasts from. Defaults to the main ledger when no ID is passed.
The number of the ledger to return payment forecasts from. Defaults to the main ledger when no number is passed. |
paymentMethods(PaymentInstructionConnectionTypeConnection) | The payment instructions of the account. Arguments
Filter the payment instructions by status. |
paymentPlans(PaymentPlanConnectionTypeConnection) | The payment plans that have been created for this account. |
paymentSchedules(PaymentScheduleConnectionTypeConnection) | The schedules that describe how we would expect to take payments for an account on a given month. Arguments
If false, we remove the currently valid schedule if it has already fulfilled its purpose and will have no further impact on customer payments, along with any schedules which are not valid from today.
The ledger id to return the payment schedules from.
The ledger number to return the payment schedules from.
The ledger to return transactions from.
|
payments(AccountPaymentConnectionTypeConnection) | The payments made into an account from a payment instruction. Arguments
Whether to include payment promises (of any kind: made, broken or fulfilled) or not. The default is to include them.
The id of the ledger to return payments from.
WARNING: Will be mandatory in future versions The number of the ledger to return payments from.
Filter for payments that were taken for a particular reason.
|
portfolio(PortfolioType) | The portfolio this account is linked to. |
preferredLanguageForComms(String) | The language that the account preferred for communications. |
previousProperties([PropertyType]) | |
properties([PropertyType]) | Arguments
|
provisionalTransactions(ProvisionalTransactionConnectionTypeConnection) | |
references([AccountReferenceType]) | Account references linked to this account. |
referrals(ReferralConnectionTypeConnection) | The referrals created by this account. Arguments
Only return referrals with the specified status. Return all referrals by default. |
referralsCreated(Int) | Number of referrals created by this account. |
reminders(AccountReminderConnectionTypeConnection) | The reminders associated with an account. |
repayments(AccountRepaymentConnectionTypeConnection) | The repayments that have been requested for this account. Arguments
Only return repayments whose status matches one of these statuses. |
requestRefundEligibility(RequestRefundEligibilityType) | Details about the eligibility status for requesting a refund. Arguments
The ledger number to check refund eligibility. |
rewards([RewardType]) | The rewards applied to this account. |
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
Optional date representing the beginning of the postedDate range filter. This date value is inclusive.
In a multi-ledger scenario, include all ledgers' transactions if
The ledger to return transactions from.
The number of the ledger to return transactions from.
The order in which to return the transactions.
Optional date representing the end of the postedDate range filter. This date value is exclusive.
Include only these specific transaction types in the result.
Exclude these specific transaction types from the result. |
updatedAt(DateTime) | Datetime that the account was updated at. |
urn(String) | Unique reference number from a 3rd party enrolment. |
Example
{
"id": "abc123",
"number": "abc123",
"status": "PENDING",
"complaints": ComplaintConnectionTypeConnection,
"brand": "abc123",
"balance": 1,
"overdueBalance": 1,
"urn": "abc123",
"billingName": "abc123",
"billingSubName": "abc123",
"billingEmail": "abc123",
"billingAddress": "abc123",
"billingAddressLine1": "abc123",
"billingAddressLine2": "abc123",
"billingAddressLine3": "abc123",
"billingAddressLine4": "abc123",
"billingAddressLine5": "abc123",
"billingAddressPostcode": "abc123",
"billingCountryCode": "abc123",
"billingDeliveryPointIdentifier": "abc123",
"splitBillingAddress": ["abc123"],
"address": RichAddressType,
"portfolio": PortfolioType,
"ledgers": [LedgerType],
"metadata": [Metadata],
"canRequestRefund": true,
"requestRefundEligibility": RequestRefundEligibilityType,
"payments": AccountPaymentConnectionTypeConnection,
"repayments": AccountRepaymentConnectionTypeConnection,
"paymentPlans": PaymentPlanConnectionTypeConnection,
"paymentSchedules": PaymentScheduleConnectionTypeConnection,
"paymentForecast": [PaymentForecastType],
"paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
"referrals": ReferralConnectionTypeConnection,
"referralsCreated": 1,
"rewards": [RewardType],
"activeReferralSchemes": ReferralSchemeTypes,
"transactions": TransactionConnectionTypeConnection,
"provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
"annualStatements": AnnualStatementConnectionTypeConnection,
"bills": BillConnectionTypeConnection,
"billingOptions": BillingOptionsType,
"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,
"agreements": AusAgreementInterface,
"properties": [PropertyType],
"previousProperties": [PropertyType],
"dueCharges": [DueChargesType],
"paymentExtensionInfo": PaymentExtensionInfoType,
"lifeSupport": LifeSupportType,
"serviceOrders": ElectricityServiceOrderType,
"changeRequests": [ChangeRequestType],
"estimatedUsageAndCost": AccountEstimatedUsageAndCostType,
"linkedUserIds": ["abc123"],
"hasWriteOffLedgers": true,
"totalBalanceOwing": 1,
"updatedAt": "2020-01-01T00:00:00.000Z",
"hazards": [AccountHazardType],
"allProperties": [PropertyType],
"isMeasured": true,
"hasActiveDunningProcess": true,
"hasActiveDebtCollectionProceeding": true
}AccountUserCommsPreferences
Information about the preferences set up for a user.
Fields
| Name | Description |
|---|---|
emailFormat(EmailFormats) | What format the user would like to receive their emails in. |
fontSizeMultiplier(Float) | This setting allows the user to adjust the default font size of the communications sent to them. |
isOptedInMeterReadingConfirmations(Boolean) | Whether the user has opted in to receive meter reading confirmation emails. |
isOptedInToClientMessages(Boolean) | Whether a user has opted in to receive messages from the client or client group. For example, for Octopus Energy this describes whether a user is opted in to offers from Octopus Investments. |
isOptedInToLifeSupportCall(Boolean) | Whether the user is opted in to life support call. |
isOptedInToOfferMessages(Boolean) | Whether a user has opted in to receive messages offering discounts or other services not directly related to the services the client provides. |
isOptedInToRecommendedMessages(Boolean) | Whether a user has opted in to receive messages we recommend they read, but are not vital to the utilities the client provides. For example, these could be reminders that the client will take a payment. |
isOptedInToSmsMessages(Boolean) | Whether the user has opted in to receive SMS messages. |
isOptedInToThirdPartyMessages(Boolean) | Whether a user has opted in to receive messages from the client's preferred third parties. |
isOptedInToUpdateMessages(Boolean) | Whether a user has opted in to receive messages updating them on client activities. |
isUsingInvertedEmailColours(Boolean) | Whether a user has opted to have inverted colours in their emails. This is currently only relevant to the Octopus Energy brand, whose emails have a dark background by default. |
preferredHoldMusic(Songs) | Song which will be used as hold music for the user. |
smsOptInLastChangeDate(DateTime) | The date the SMS opt-in was last changed. |
Example
{
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"emailFormat": "TEXT",
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 1.0,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"preferredHoldMusic": "NO_SONG_PREFERRED",
"smsOptInLastChangeDate": "2020-01-01T00:00:00.000Z",
"isOptedInToLifeSupportCall": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AccountUserConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AccountUserConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AccountUserConnectionTypeEdge
A Relay edge containing a AccountUserConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AccountUserType) | The item at the end of the edge |
Example
{
"node": AccountUserType,
"cursor": "abc123"
}AccountUserConsents
Information about the consents for an account user.
Fields
| Name | Description |
|---|---|
consents([ConsentType!]!) | Consents linked to this user. |
Example
{
"consents": ConsentType
}Fields
| Name | Description |
|---|---|
isSensitive(Boolean) | Whether the value is sensitive and encrypted. |
namespace(String) | The namespace for the property. |
value(String) | The property value. |
Example
{
"namespace": "abc123",
"value": "abc123",
"isSensitive": true
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}AccountUserPermission
Holds information about a specific permission.
Fields
| Name | Description |
|---|---|
permission(String) | The short name of the permission. |
Example
{
"permission": "abc123"
}AccountUserRoleType
The role a user has in association with one account.
Fields
| Name | Description |
|---|---|
account(AccountType!) | |
id(ID!) | |
role(RoleString) | The account role. |
user(AccountUserType!) |
Example
{
"id": "abc123",
"user": AccountUserType,
"account": AccountType,
"role": RoleString
}AccountUserType
User objects are the core of the authentication system. They typically represent a customer who manages a portfolio of one or more accounts.
Fields
| Name | Description |
|---|---|
accountUserRoles([AccountUserRoleType]) | List of roles a user has for each account they're linked to. Arguments
Optionally filter the user's account roles to only return those linked to specific accounts. |
accounts([AccountInterface]) | List of accounts that the user is linked to either via portfolio role or account role. Arguments
Optionally filter the user's accounts to only return those linked to portfolios on the specified brands.
Optionally exclude accounts with any of the given account types.
Optionally exclude accounts that have never had an agreement.
Optionally restrict user accounts to only return those with the specified account numbers.
Optionally restrict user accounts to only return those linked to portfolios on public facing brands. |
address(RichAddressType) | This user's address. |
alternativePhoneNumbers([String]) | List of alternative phone numbers for the account user. |
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
If provided, filters the bills down to only the specified accounts. Any account numbers the user doesn't have access to will be ignored.
Optional date representing the beginning of the search results. This date value is inclusive.
Include bills without PDFs.
Include held statements within the results.
Include pre-Kraken / historical statements within the results.
Include open statements. This flag needs to be used along with includeBillsWithoutPDF=false otherwise results will prove unexpected.
Optional date representing the beginning of the search results based on issued date. This date value is inclusive.
Optional date representing the end of the search results based on issued date. This date value is exclusive.
Only include bills emailed to the current user's email.
The order in which to return the bills.
Optional date representing the end of the search results. This date value is exclusive. |
businesses(BusinessConnectionTypeConnection) | List of businesses that the user has access to through their granted roles. |
concessions([ConcessionType]) | A list of concessions for the user. |
consents([ConsentType!]!) | Consents linked to this user. |
createdAt(DateTime!) | |
dateOfBirth(Date) | AccountUser's date of birth. |
details([AccountUserDetailType]) | List of details linked to this user. |
displayName(String) | We recommend you use fullName instead of this field. Deprecated The 'displayName' field is deprecated. |
email(String!) | |
familyName(String!) | |
firstName(String) | We recommend you use preferredName or fullName instead of this field. Deprecated The 'firstName' field is deprecated. |
fullName(String) | The user's full name. |
givenName(String!) | |
hasFamilyIssues(Boolean) | Whether there are family issues. |
id(ID!) | |
isActive(Boolean) | Whether this user is active. |
isDeceased(Boolean!) | Designates whether this user is deceased. |
isInHardship(Boolean) | True if user is linked to an account with an active hardship agreement. |
label(String) | A free text field to help identifying the customer (e.g. for a job title). |
landline(String!) | |
landlinePhoneNumber(String) | The user's landline phone number. Deprecated The 'landlinePhoneNumber' field is deprecated. |
lastName(String) | We recommend you use preferredName or fullName instead of this field. Deprecated The 'lastName' field is deprecated. |
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 in 10 seconds. This field requires the |
mobile(String!) | |
number(String) | A code that uniquely identifies the account user. |
paymentMethods(PaymentInstructionConnectionTypeConnection) | List payment instructions linked to this user. |
permissions([AccountUserPermission]) | Holds information about the permissions of the current viewer. |
portfolioId(ID) | We recommend you use portfolioIds instead of this field. Deprecated The 'portfolioId' field is deprecated. |
portfolioIds([ID]) | List of portfolio ids that the user is linked to via their portfolio roles. Arguments
Optionally filter the user's portfolios to only return those linked to specified brands.
Optionally restrict the user portfolios to only return those linked to public facing brands. |
portfolioUserRoles([PortfolioUserRoleType]) | List of roles a user has for each portfolio they're linked to. |
portfolios(PortfolioConnectionTypeConnection) | List of portfolios that the user is linked to via their portfolio roles. Arguments
Optionally filter the user's portfolios to only return those linked to specified brands.
Optionally restrict the user portfolios to only return those linked to public facing brands. |
preferences(AccountUserCommsPreferences) | |
preferredName(String) | The user's preferred name. |
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
If provided, filters the transactions down to only the specified accounts. Any account numbers the user doesn't have access to will be ignored.
Exclude imported transaction types from the result.
Exclude transactions which have not yet been issued.
Optional date representing the beginning of the postedDate range filter. This date value is inclusive.
The order in which to return the transactions.
Optional date representing the end of the postedDate range filter. This date value is exclusive. |
Example
{
"id": "abc123",
"number": "abc123",
"accounts": AccountInterface,
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"mobile": "abc123",
"landline": "abc123",
"title": "abc123",
"pronouns": "abc123",
"isDeceased": true,
"liveSecretKey": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"portfolios": PortfolioConnectionTypeConnection,
"address": RichAddressType,
"dateOfBirth": "2020-01-01",
"label": "abc123",
"isActive": true,
"details": [AccountUserDetailType],
"permissions": [AccountUserPermission],
"displayName": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"fullName": "abc123",
"preferredName": "abc123",
"portfolioId": "abc123",
"portfolioIds": ["abc123"],
"businesses": BusinessConnectionTypeConnection,
"specialCircumstances": SpecialCircumstancesType,
"preferences": AccountUserCommsPreferences,
"landlinePhoneNumber": "abc123",
"alternativePhoneNumbers": ["abc123"],
"hasFamilyIssues": true,
"isInHardship": true,
"accountUserRoles": [AccountUserRoleType],
"portfolioUserRoles": [PortfolioUserRoleType],
"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
}Fields
| Name | Description |
|---|---|
code(String!) | The code of the problem. |
description(String!) | A human readable description of the problem. |
Example
{
"code": "abc123",
"description": "abc123"
}AddCampaignToAccount
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-7427: No campaign found with given slug.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
campaignAdded(Boolean) | Whether the campaign was successfully added. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"campaignAdded": true
}Fields
| Name | Description |
|---|---|
event(CustomEventType) | Resulting Kraken event This field requires the |
Example
{
"event": CustomEventType
}AddProperty
Add a property to an account.
The possible errors that can be raised are:
- KT-CT-6623: Unauthorized.
- KT-CT-6629: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
property(PropertyType) | The property that was added to the account. |
Example
{
"possibleErrors": [PossibleErrorType],
"property": PropertyType
}Fields
| Name | Description |
|---|---|
addonRates([AddonRateType]) | Rates associated with addon. |
family(String) | Add on family name associated with rates. |
Example
{
"family": "abc123",
"addonRates": [AddonRateType]
}Fields
| Name | Description |
|---|---|
addon(AddonType) | Add on details for rate. |
productRate(RateInterface) | Product rate for addon. |
Example
{
"addon": AddonType,
"productRate": RateInterface
}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. |
Example
{
"band": "abc123",
"title": "abc123",
"family": "abc123",
"description": "abc123",
"percentGreen": "1.0"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AgreementEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AgreementEdge,
"totalCount": 1,
"edgeCount": 1
}AgreementEdge
A Relay edge containing a Agreement and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CommonAgreementType) | The item at the end of the edge |
Example
{
"node": CommonAgreementType,
"cursor": "abc123"
}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!) |
Example
{
"id": "abc123",
"number": "abc123",
"agreement": DistributionAgreementType,
"rolledOnTo": DistributionAgreementType,
"rolloverType": "DEFAULT",
"expectedSendDate": "2020-01-01",
"status": "PENDING",
"params": {"key": "value"},
"failureReason": "abc123",
"actualSendDate": "2020-01-01",
"suppressComms": true,
"tags": ["abc123"],
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
allocationAmount(Int!) | The amount of the transaction that has been allocated to the billing document. A positive amount indicates money received from the customer (payments, credits). A negative amount indicates money paid to the customer (repayments). |
allocationReason(String) | Reason for the allocation intention. |
transactionAmount(Int!) | The amount of the transaction. A positive amount indicates money received from the customer (payments, credits). A negative amount indicates money paid to the customer (repayments). |
transactionId(Int!) | ID of the allocated transaction. |
transactionType(TransactionTypes!) | The type of the transaction. |
Example
{
"transactionId": 1,
"transactionType": "CREDIT",
"transactionAmount": 1,
"allocationAmount": 1,
"allocationReason": "abc123"
}AllocationType
Represents an allocation of a fulfilment to an obligation.
Fields
| Name | Description |
|---|---|
amount(Int!) | The amount of the allocation (in minor currency units), unsigned. |
fulfilment(FulfilmentType!) | The fulfilment that is allocated. |
Example
{
"amount": 1,
"fulfilment": FulfilmentType
}AlreadyLinkedError
Returned when an account already has a LINE account linked to it.
Fields
| Name | Description |
|---|---|
type(LineLinkErrorType!) | The type of error that occurred. |
Example
{
"type": "NO_MATCHING_LINE_LINK"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}AmendPayment
The possible errors that can be raised are:
- KT-CT-3924: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-3970: The account cannot amend payments.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
payment(AccountPaymentType) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}AnimationType
A media element containing an animation, such as a Lottie.
Fields
| Name | Description |
|---|---|
accessibilityHidden(Boolean) | Whether the element is hidden from view. |
accessibilityLabel(String) | Accessible description of the element. |
horizontalAlignment(Alignment) | The horizontal alignment of the media. |
id(ID) | Unique identifier of the object. |
mediaUrl(String!) | The resource URL of the media. |
typename(String) | The name of the object's type. |
width(ItemSizeType) | The measurement of the element. |
Example
{
"width": FractionSizeType,
"mediaUrl": "abc123",
"horizontalAlignment": "START",
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([AnnualStatementConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": AnnualStatementConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}AnnualStatementConnectionTypeEdge
A Relay edge containing a AnnualStatementConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AnnualStatementType) | The item at the end of the edge |
Example
{
"node": AnnualStatementType,
"cursor": "abc123"
}AnnualStatementType
Annual statements that are sent to the account. They summarize important information about usage and tariffs.
Example
{
"periodStartsAt": "2020-01-01T00:00:00.000Z",
"periodEndsAt": "2020-01-01T00:00:00.000Z",
"id": "abc123",
"pdfUrl": "abc123"
}AnnulmentBillingDocumentType
An annulment is a billing document that annuls another billing document.
Fields
| Name | Description |
|---|---|
annulledBillingDocumentId(Int!) | ID of the billing document annulled by this annulment. |
firstIssued(DateTime) | First time the annulment was issued. |
id(Int!) | ID for the annulment billing document. |
pdfUrl(String) | URL to the PDF of the annulment. |
Example
{
"id": 1,
"annulledBillingDocumentId": 1,
"firstIssued": "2020-01-01T00:00:00.000Z",
"pdfUrl": "abc123"
}AppSessionConnectionTypeEdge
A Relay edge containing a AppSessionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(AppSessionType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}AssistanceAgreementType
A single Assistance Agreement.
Fields
| Name | Description |
|---|---|
activeFrom(Date) | The start datetime of the agreement. |
activeTo(Date) | The end datetime of the agreement, if any. |
assistanceType(String) | The type of assistance provided by the agreement. |
Example
{
"assistanceType": "abc123",
"activeFrom": "2020-01-01",
"activeTo": "2020-01-01"
}AttachmentType
Represents a file to attach to a communication
Fields
| Name | Description |
|---|---|
filename(String!) | |
id(ID!) | |
temporaryUrl(String) | Temporary URL at which the attachment is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). |
Example
{
"id": "abc123",
"filename": "abc123",
"temporaryUrl": "abc123"
}Fields
| Name | Description |
|---|---|
clientId(String) | The client ID of the application. |
name(String) | The name of the application. |
Example
{
"name": "abc123",
"clientId": "abc123"
}BackendScreenEvent
Returns an Action to perform, e.g. a screen to load.
BackendScreenEvents are specific types of Action which trigger a mutation in the Kraken backend. They return an action (any type), such as a ScreenActionType (which is then used to load the next screen). Any action registered in the registry should really be an "event" with some side-effect in the backend.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-8002: No event found.
- KT-CT-8003: Event has no execute function.
- KT-CT-8004: Error executing event in the backend.
- KT-CT-8007: Incorrect or missing parameters for backend screen event.
- KT-GB-9310: Account ineligible for joining Octoplus.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
action(ActionType) | An action to perform. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"action": DeeplinkActionType
}BackendScreenEventActionType
An action which triggers some event in the Kraken backend.
Fields
| Name | Description |
|---|---|
eventId(String!) | The ID of the event to trigger. |
id(ID) | Unique identifier of the object. |
params([BackendScreenParam]!) | List of key-value pairs to pass as parameters to the event. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"eventId": "abc123",
"params": BackendScreenParam
}BackendScreenParam
A key-value pair (both Strings) which is passed as a parameter to a screen.
Example
{
"key": "abc123",
"value": "abc123"
}Fields
| Name | Description |
|---|---|
areValid(Boolean!) | Indicates whether the provided bank details are valid. |
message(String) | Provides additional information about validation result. |
Example
{
"areValid": true,
"message": "abc123"
}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. |
Example
{
"usageEnergy": 1.0,
"usageCost": 1,
"exportEnergy": 1.0,
"exportEarning": 1,
"concessionDiscount": 1,
"totalCost": 1
}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. |
includesSolarExport(Boolean) | Whether or not solar export is included. |
usage(BestOfferReportUsage) | The best offer report usage. |
Example
{
"estimatedCurrentProductCost": 1,
"allProductsChecked": [BestOfferProductEstimate],
"usage": BestOfferReportUsage,
"bestOfferProduct": Product,
"estimatedBestOfferProductCost": 1,
"bestOfferDifference": 1,
"includesSolarExport": true
}Fields
| Name | Description |
|---|---|
estimatedCost(Int) | The estimated cost for the best offer product. |
product(Product) | The product for the best offer product estimate. |
Example
{
"product": Product,
"estimatedCost": 1
}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. |
Example
{
"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. |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | The date the transaction was posted. |
reasonCode(String) | Returns the reason. |
title(String) | A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123",
"consumption": Consumption,
"detail": SupplyOrServiceCharge
}BillConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BillConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}BillConnectionTypeEdge
A Relay edge containing a BillConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BillInterface) | The item at the end of the edge |
Example
{
"node": BillInterface,
"cursor": "abc123"
}BillCredit
A credit to the customer from the energy retailer.
Fields
| Name | Description |
|---|---|
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
createdAt(DateTime) | The date time when the transaction is created. |
id(ID) | The unique identifier for the transaction. |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | The date the transaction was posted. |
reasonCode(String) | Returns the reason. |
title(String) | A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123"
}BillPayment
A payment from the customer to the energy supplier.
Fields
| Name | Description |
|---|---|
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
createdAt(DateTime) | The date time when the transaction is created. |
id(ID) | The unique identifier for the transaction. |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | The date the transaction was posted. |
reasonCode(String) | Returns the reason. |
title(String) | A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123"
}BillRefund
A refund to the customer from the energy supplier.
Fields
| Name | Description |
|---|---|
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
createdAt(DateTime) | The date time when the transaction is created. |
id(ID) | The unique identifier for the transaction. |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | The date the transaction was posted. |
reasonCode(String) | Returns the reason. |
title(String) | A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"amounts": TransactionAmountType,
"title": "abc123",
"note": "abc123",
"reasonCode": "abc123"
}BillRepresentationConnectionTypeConnection
A connection that can provide links to the representations of a bill.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BillRepresentationConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillRepresentationConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}BillRepresentationConnectionTypeEdge
A Relay edge containing a BillRepresentationConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BillRepresentationType) | The item at the end of the edge |
Example
{
"node": BillRepresentationType,
"cursor": "abc123"
}BillRepresentationType
representations are associated with a bill files and can be used to provide additional information to the customer.
Fields
| Name | Description |
|---|---|
code(String) | The type of representation. |
filename(String) | The name of the file. |
temporaryUrl(String) | The |
temporaryUrlExpiresAt(DateTime) | The expiry datetime field of the temporary URL. |
version(Int) | The version of the representation. |
Example
{
"code": "abc123",
"version": 1,
"temporaryUrl": "abc123",
"temporaryUrlExpiresAt": "2020-01-01T00:00:00.000Z",
"filename": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BillTransactionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillTransactionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}BillTransactionConnectionTypeEdge
A Relay edge containing a BillTransactionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BillTransactionType) | The item at the end of the edge |
Example
{
"node": BillTransactionType,
"cursor": "abc123"
}BillingAttachmentConnectionTypeConnection
A connection that can provide links to the attachments of the bill.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BillingAttachmentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BillingAttachmentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}BillingAttachmentConnectionTypeEdge
A Relay edge containing a BillingAttachmentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BillingAttachmentType) | The item at the end of the edge |
Example
{
"node": BillingAttachmentType,
"cursor": "abc123"
}BillingAttachmentType
Attachments are associated with a bill files and can be used to provide additional information to the customer.
Fields
| Name | Description |
|---|---|
filename(String) | The name of the file. |
temporaryUrl(String) | The |
temporaryUrlExpiresAt(DateTime) | The expiry datetime field of the temporary URL. |
Example
{
"temporaryUrl": "abc123",
"temporaryUrlExpiresAt": "2020-01-01T00:00:00.000Z",
"filename": "abc123"
}Fields
| Name | Description |
|---|---|
allocationIntentions([AllocationIntentionType]!) | Allocation intentions for the billing document. |
allocations([AllocationType]!) | Allocations for the billing document. |
dueDate(Date!) | The date when the payment is due for the billing document. |
expectedAmount(Int!) | The expected amount for the billing document (in minor currency units). |
remainingAmount(Int!) | The amount that remains to be paid for the billing document (in minor currency units). |
Example
{
"dueDate": "2020-01-01",
"expectedAmount": 1,
"remainingAmount": 1,
"allocationIntentions": AllocationIntentionType,
"allocations": AllocationType
}BillingOptionsType
Information about an account's billing schedule.
Fields
| Name | Description |
|---|---|
currentBillingPeriodEndDate(Date) | The date on which the current billing cycle will end. Null if the account is on flexible billing. |
currentBillingPeriodStartDate(Date) | The date on which the current billing cycle started. |
isFixed(Boolean!) | If true, this account is billed on specific day of a regular cycle. If false, the billing schedule is flexible, depending on when meter readings are submitted. |
nextBillingDate(Date) | The next date on which this account will next be billed. This is the same as the start date for their next bill cycle. Null if the account is on flexible billing. |
periodLength(AccountBillingOptionsPeriodLength) | |
periodLengthMultiplier(Int) | |
periodStartDay(Int) | The day of the month on which the account's billing period should start. |
Example
{
"periodStartDay": 1,
"periodLength": "MONTHLY",
"periodLengthMultiplier": 1,
"isFixed": true,
"currentBillingPeriodStartDate": "2020-01-01",
"currentBillingPeriodEndDate": "2020-01-01",
"nextBillingDate": "2020-01-01"
}BusinessConnectionTypeConnection
Paginator of Businesses
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([BusinessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": BusinessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}BusinessConnectionTypeEdge
A Relay edge containing a BusinessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(BusinessType) | The item at the end of the edge |
Example
{
"node": BusinessType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
key(String!) | The key of the business detail. |
value(String) | The value of the business detail. |
Example
{
"key": "abc123",
"value": "abc123"
}Fields
| Name | Description |
|---|---|
endAt(DateTime) | The end date and time of the segment period. |
id(ID!) | The ID of the business segment period. |
segment(SegmentType!) | The segment associated with this period. |
startAt(DateTime) | The start date and time of the segment period. |
Example
{
"id": "abc123",
"segment": SegmentType,
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
billingAddress(RichAddressType) | The billing address of the business. |
businessType(BusinessTypeOptions) | The company type of a business account. |
details([BusinessDetailType]) | The details of the business. |
id(ID!) | The business ID. |
legalAddress(RichAddressType) | The legal address of the business. |
linkedAccountNumber(ID!) | Account number linked to this business. The possible errors that can be raised are:
Deprecated The 'linkedAccountNumber' field is deprecated. |
linkedAccountNumbers([ID]!) | Account numbers linked to this business. |
name(String!) | The business' name. |
number(String!) | The business' number. |
numberType(BusinessNumberTypeEnum) | Which kind of business type the |
paymentMethods(PaymentInstructionConnectionTypeConnection) | List payment instructions owned by this business. |
sectors([BusinessSectorString!]!) | The sectors the business operates in. |
segmentName(String) | The segment this business is assigned to. |
Example
{
"id": "abc123",
"name": "abc123",
"number": "abc123",
"businessType": "SOLE_TRADER",
"sectors": BusinessSectorString,
"details": [BusinessDetailType],
"billingAddress": RichAddressType,
"legalAddress": RichAddressType,
"linkedAccountNumber": "abc123",
"linkedAccountNumbers": "abc123",
"segmentName": "abc123",
"paymentMethods": PaymentInstructionConnectionTypeConnection,
"numberType": "ABN"
}CallTagConnectionTypeEdge
A Relay edge containing a CallTagConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CallTagType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}CancelCentrepayDeduction
Mutation for cancelling an existing CentrepayDeduction
The possible errors that can be raised are:
- KT-AU-3923: Centrepay Deduction with provided ID does not exist.
- KT-AU-3924: You do not have permission to administer this Centrepay Deduction.
- KT-AU-3925: Cannot cancel this Centrepay Deduction.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
centrepayDeduction(CentrepayDeductionType!) | Details of Centrepay Deduction to be cancelled. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"centrepayDeduction": CentrepayDeductionType
}CancelRepaymentRequest
Cancel a repayment or refund request.
The possible errors that can be raised are:
- KT-CT-4231: Unauthorized.
- KT-CT-3930: The repayment or refund request does not exist.
- KT-CT-3931: This repayment or refund request cannot be cancelled.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
repaymentRequest(CancelRepaymentRequestOutputType) | The cancelled repayment/refund request. |
Example
{
"possibleErrors": [PossibleErrorType],
"repaymentRequest": CancelRepaymentRequestOutputType
}CancelRepaymentRequestOutputType
Output from cancelling a repayment or refund request.
Fields
| Name | Description |
|---|---|
requestId(String) | The ID of the cancelled request. |
status(RepaymentRequestStatus) | The current status of the cancelled request. |
Example
{
"requestId": "abc123",
"status": "REQUESTED"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"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. |
Example
{
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123",
"items": TextType
}Fields
| Name | Description |
|---|---|
cards([CardComponentType]!) | The list of cards. |
id(ID) | Unique identifier of the object. |
typename(String) | The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"cards": CardComponentType
}Fields
| Name | Description |
|---|---|
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. |
Example
{
"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
Mutation for changing (updating details of) an existing CentrepayDeduction
The possible errors that can be raised are:
- KT-AU-3923: Centrepay Deduction with provided ID does not exist.
- KT-AU-3924: You do not have permission to administer this Centrepay Deduction.
- KT-AU-3928: Cannot Cannot change validFrom date of Deduction that is already active.
- KT-AU-3920: Cannot provide both validTo and targetAmount values.
- KT-AU-3927: No change data provided.
- KT-AU-3926: Cannot change this Centrepay Deduction.
- KT-AU-3930: Centrepay Deduction amount cannot be greater than Target Amount.
- KT-AU-3916: Centrepay Deduction amount must be greater than $10.00.
- KT-AU-3914: Centrepay Deduction valid_to date must be later than today.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
centrepayDeduction(CentrepayDeductionType!) | Details of Centrepay Deduction to be changed. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"centrepayDeduction": CentrepayDeductionType
}Fields
| Name | Description |
|---|---|
actualChangeDate(Date) | |
actualEndDate(Date) | |
changeReason(String!) | |
direction(DirectionChoices) | |
id(ID!) | |
identifier(String!) | |
meterPoint(MeterPointType) | |
proposedDate(Date) | |
status(ChangeRequestStatus!) |
Example
{
"id": "abc123",
"identifier": "abc123",
"status": "INITIATED",
"changeReason": "abc123",
"proposedDate": "2020-01-01",
"actualChangeDate": "2020-01-01",
"actualEndDate": "2020-01-01",
"meterPoint": MeterPointType,
"direction": "INBOUND"
}CharacteristicType
A characteristic associated with a product.
Fields
| Name | Description |
|---|---|
code(String!) | The code of the characteristic. |
description(String!) | The description of the characteristic. |
name(String!) | The name of the characteristic. |
values([CharacteristicValueUnion]!) | The possible values for the characteristic (can be strings or integers). |
Example
{
"code": "abc123",
"name": "abc123",
"description": "abc123",
"values": StringCharacteristicValueType
}Charge
A charge to the customer.
Fields
| Name | Description |
|---|---|
accountNumber(String) | Unique identifier of the account the transaction belongs to. |
amount(Int) | Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
balanceCarriedForward(Int) | The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
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. |
isAccountPayment(Boolean) | Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
isBasedOnEstimatedReadings(Boolean) | Whether the charge is based on one or more estimated readings. Deprecated The 'isBasedOnEstimatedReadings' field is deprecated. |
isCredit(Boolean) | Deprecated. Deprecated The 'isCredit' field is deprecated. |
isHeld(Boolean) | Whether the statement this transaction is on has been held. A held statement is not sent to a customer automatically, but is instead marked for manual attention by operations staff. Returns False if a statement is not linked with the transaction. |
isIssued(Boolean) | Whether this transaction has been issued on any billing document.Note: Look for the most recently issued transaction instead of looking through all transactions as some accounts may have initial transactions that were not issued.This will return False if the transaction is not associated with any billing documents. |
isReversed(Boolean!) | |
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. |
title(String) | Human-readable title describing the transaction. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123",
"consumption": Consumption,
"detail": SupplyOrServiceCharge,
"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. |
Example
{
"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
}Fields
| Name | Description |
|---|---|
code(String) | The charge reason code. |
display(String) | The charge reason display text. |
group(String) | The group the charge reason belongs to (if applicable). |
isDeprecated(Boolean) | Whether the charge reason is deprecated. |
isHidden(Boolean) | Whether the charge reason is hidden. |
isTaxExempt(Boolean) | Whether the charge reason is sales tax exempt. |
Example
{
"code": "abc123",
"display": "abc123",
"isDeprecated": true,
"isTaxExempt": true,
"isHidden": true,
"group": "abc123"
}ChargesBreakdownConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ChargesBreakdownConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ChargesBreakdownConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ChargesBreakdownConnectionTypeEdge
A Relay edge containing a ChargesBreakdownConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ChargesBreakdownType) | The item at the end of the edge |
Example
{
"node": ChargesBreakdownType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
charge(Int) | Charge in minor currency. |
periodEnd(Date) | The end date of the period the charge is for (exclusive). |
periodStart(Date) | The start date of the period the charge is for (inclusive). |
Example
{
"periodStart": "2020-01-01",
"periodEnd": "2020-01-01",
"charge": 1
}Fields
| Name | Description |
|---|---|
marketSpId(Int) | The market supply point ID for the charging configuration. |
Example
{
"marketSpId": 1
}Fields
| Name | Description |
|---|---|
paramsList([ChargingConfigurationParamsType]) | List of charging configuration params. |
Example
{
"paramsList": [ChargingConfigurationParamsType]
}CloseActionType
Closes the screen.
Fields
| Name | Description |
|---|---|
accessibilityHidden(Boolean) | Whether the element is hidden from view. |
accessibilityLabel(String) | Accessible description of the element. |
id(ID) | Unique identifier of the object. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"accessibilityHidden": true,
"accessibilityLabel": "abc123"
}CloseInkLiveChatConversation
The possible errors that can be raised are:
- KT-CT-7616: Not yet implemented.
- KT-CT-7643: The Live Chat was not found.
- KT-CT-7644: Ink Live Chat conversation not found.
- KT-CT-7652: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
liveChatConversation(InkLiveChatConversation) | The live chat conversation. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"liveChatConversation": InkLiveChatConversation
}CollectPayment
The possible errors that can be raised are:
- KT-CT-3932: Invalid data.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
payment(AccountPaymentType) | Details about the collected payment. Note that we might not be able to collect the payment (e.g. if there is no usable payment instruction), in which case the status of the returned payment might be failed or cancelled. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": AccountPaymentType
}Fields
| Name | Description |
|---|---|
attachments(BillingAttachmentConnectionTypeConnection) | |
billType(BillTypeEnum) | The type of the bill. |
constituents(ConstituentConnection) | Constituents of the bill. |
fromDate(Date) | The date of the bill is covered from. |
id(ID) | The ID of the bill. |
issuedDate(Date) | The date the bill was sent to the customer. |
reversalsAfterClose(StatementReversalsAfterClose!) | How many charges have been reversed after the close date. |
temporaryUrl(String) | Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
toDate(Date) | The date of the bill is covered to. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"constituents": ConstituentConnection
}Fields
| Name | Description |
|---|---|
fieldSpecificRateLimits(FieldSpecificRateLimitInformationConnectionTypeConnection!) | Information about the current state of the rate limiting for rate limited fields at the time of the request. |
pointsAllowanceRateLimit(PointsAllowanceRateLimitInformation) | Information about points-allowance rate limit for viewer. |
Example
{
"pointsAllowanceRateLimit": PointsAllowanceRateLimitInformation,
"fieldSpecificRateLimits": FieldSpecificRateLimitInformationConnectionTypeConnection
}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
The datetime to check the characteristic value at. |
id(ID!) | |
isActive(Boolean) | Whether the agreement is currently active. |
isRevoked(Boolean) | Whether the agreement is revoked. |
params(JSONString) | General parameters providing additional information about the agreement. |
product(SupplyProductType) | The product associated with the agreement. |
rescissionDeadlineAt(DateTime) | The deadline until which the customer is allowed to rescind this agreement. If it is null, rescission is not permitted. |
supplyPoint(SupplyPointType!) | The agreement's supply point. |
terminatedAt(DateTime) | |
validFrom(DateTime!) | |
validTo(DateTime) |
Example
{
"id": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"agreedAt": "2020-01-01T00:00:00.000Z",
"terminatedAt": "2020-01-01T00:00:00.000Z",
"rescissionDeadlineAt": "2020-01-01T00:00:00.000Z",
"account": 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"}
}ComplaintConnectionTypeConnection
Paginator of Complaint type.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ComplaintConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ComplaintConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ComplaintConnectionTypeEdge
A Relay edge containing a ComplaintConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ComplaintType) | The item at the end of the edge |
Example
{
"node": ComplaintType,
"cursor": "abc123"
}ComplaintContactConnectionTypeConnection
Paginator of Complaint contact type.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ComplaintContactConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ComplaintContactConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ComplaintContactConnectionTypeEdge
A Relay edge containing a ComplaintContactConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ComplaintContactType) | The item at the end of the edge |
Example
{
"node": ComplaintContactType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
actionTaken(String!) | Description of action taken. |
createdAt(DateTime!) | Created at for contact. |
email(String) | Complaint email. |
landline(String) | Complaint landline. |
mobile(String) | Complaint phone. |
name(String!) | Complainant name. |
preferredCommunicationMethod(String) | Complaint preferred method. |
status(String!) | Status of complaint. |
summary(String) | Complaint summary. |
Example
{
"name": "abc123",
"actionTaken": "abc123",
"status": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"mobile": "abc123",
"email": "abc123",
"landline": "abc123",
"preferredCommunicationMethod": "abc123",
"summary": "abc123"
}Fields
| Name | Description |
|---|---|
assigneeId(ID) | Complaint Assignee. |
contacts(ComplaintContactConnectionTypeConnection) | Complaint contacts. |
creationDate(Date) | Complaint creation date. |
id(ID!) | |
resolutionDate(Date) | Complaint resolution date. |
subtype(String) | Complaint subtype. |
type(String) | Complaint type. |
Example
{
"id": "abc123",
"contacts": ComplaintContactConnectionTypeConnection,
"type": "abc123",
"subtype": "abc123",
"creationDate": "2020-01-01",
"resolutionDate": "2020-01-01",
"assigneeId": "abc123"
}CompleteStandalonePayment
Completes an initiated standalone payment.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3823: Unauthorized.
- KT-CT-3974: Unauthorized.
- KT-CT-3975: Unable to complete standalone payment.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
payment(CompleteStandalonePaymentOutput) | The completed standalone payment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": CompleteStandalonePaymentOutput
}CompleteStandalonePaymentOutput
Result of the complete standalone payment operation.
Fields
| Name | Description |
|---|---|
status(PaymentIntentCompletionStatus!) | The status of the standalone payment. |
Example
{
"status": "CLEARED"
}ComponentListType
A list of components which comprise a screen.
This is a legacy type; GenericBackendScreen should be preferred. This is because API clients
should not need to explicitly query for screen attributes like items - these fields are
embedded in the screenData field.
Fields
| Name | Description |
|---|---|
accessibilityHidden(Boolean) | Whether the element is hidden from view. |
accessibilityLabel(String) | Accessible description of the element. |
id(ID) | Unique identifier of the object. |
items([ItemType]!) | The list of components. Deprecated The 'items' field is deprecated. |
name(String!) | The name of the screen. |
refreshFrequency(Int) | The refresh / polling frequency in milliseconds. |
screenData(String) | Serialized JSON representation of the screen. |
typename(String) | The name of the object's type. |
Example
{
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123",
"name": "abc123",
"refreshFrequency": 1,
"screenData": "abc123",
"items": TextType
}Fields
| Name | Description |
|---|---|
existingCardNumber(String) | The number of the existing concession card. |
existingCardType(ConcessionCardType) | The type of the existing concession card. |
message(String!) |
Example
{
"message": "abc123",
"existingCardNumber": "abc123",
"existingCardType": "CENTRELINK_PENSIONER"
}Example
{
"id": "abc123",
"fromDate": "2020-01-01",
"toDate": "2020-01-01"
}Fields
| Name | Description |
|---|---|
cardLabel(String) | Readable description for the card type. |
cardType(ConcessionCardType) | The card type. |
Example
{
"cardType": "CENTRELINK_PENSIONER",
"cardLabel": "abc123"
}Fields
| Name | Description |
|---|---|
failureCode(String) | |
failureReason(String) | |
id(ID!) | |
isCardValid(Boolean!) | |
method(ConcessionCardValidationMethod) | |
notes(String) | |
validatedAt(Date!) | |
validationDt(DateTime) |
Example
{
"id": "abc123",
"validatedAt": "2020-01-01",
"isCardValid": true,
"validationDt": "2020-01-01T00:00:00.000Z",
"failureCode": "abc123",
"failureReason": "abc123",
"notes": "abc123",
"method": "API"
}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) |
Example
{
"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
Confirm a requested consent.
This mutation will update the value of the consent associated with the provided token to ACCEPTED.
The possible errors that can be raised are:
- KT-CT-9016: Consent management not enabled.
- KT-CT-9020: Invalid consent expiring token.
- KT-CT-9021: Consent expiring token not found.
- KT-CT-9022: Consent for given token already accepted.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
consent(ConsentType) | The consent that was created or updated. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}Fields
| Name | Description |
|---|---|
code(String) | The code of the consent type. |
value(String) | The value to update the consent to. |
Example
{
"code": "abc123",
"value": "abc123"
}ConsentType
A consent given by a signing identity for a consent type.
Fields
| Name | Description |
|---|---|
code(String!) | Unique code given to this consent type. |
id(BigInt!) | id of the consent. |
type(ConsentTypeType) | The type of the consent. |
value(ConsentValue!) | Value of the consent. |
Example
{
"id": 1,
"code": "abc123",
"value": "ACCEPTED",
"type": ConsentTypeType
}ConsentTypeType
A type of consent that a signing identity can accept or reject to.
Fields
| Name | Description |
|---|---|
code(String!) | Unique code given to this consent type. |
defaultValue(ConsentValue!) | Default value of the consent type. |
description(String!) | Description of the consent type. |
name(String!) | Name of the consent type. |
Example
{
"code": "abc123",
"description": "abc123",
"name": "abc123",
"defaultValue": "ACCEPTED"
}ConstituentConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ConstituentEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ConstituentEdge,
"totalCount": 1,
"edgeCount": 1
}ConstituentEdge
A Relay edge containing a Constituent and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ConstituentInterface) | The item at the end of the edge |
Example
{
"node": ConstituentInterface,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
endDate(Date) | End date of the consumption period. |
quantity(Decimal) | Amount of energy or resource consumed. |
startDate(Date) | Start date of the consumption period. |
supplyCharge(Int) | Supply charge amount in minor currency units. |
unit(ConsumptionUnit) | |
usageCost(Int) | Cost for the consumption usage in minor currency units. |
Example
{
"startDate": "2020-01-01",
"endDate": "2020-01-01",
"quantity": "1.0",
"unit": "kWh",
"usageCost": 1,
"supplyCharge": 1
}ConsumptionBreakdownConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ConsumptionBreakdownConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ConsumptionBreakdownConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ConsumptionBreakdownConnectionTypeEdge
A Relay edge containing a ConsumptionBreakdownConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ConsumptionBreakdownType) | The item at the end of the edge |
Example
{
"node": ConsumptionBreakdownType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
charges(ChargesBreakdownConnectionTypeConnection) | Charges grouped per displayed period. |
marketName(String) | Name of the market the charges are for. |
Example
{
"marketName": "abc123",
"charges": ChargesBreakdownConnectionTypeConnection
}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. |
Example
{
"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 |
Example
{
"node": ConsumptionType,
"cursor": "abc123"
}ConsumptionType
Energy consumption between two points in time.
Example
{
"value": "1.0",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
location(Location) | The phone number location type. |
number(String) | The phone number. |
prefix(String) | The phone number prefix. |
serviceComment(String) | Comment for the phone service type. |
serviceType(AustralianTelephoneServiceType) | The phone number service type. |
Example
{
"number": "abc123",
"prefix": "abc123",
"serviceType": "FIXED_VOICE",
"location": "HOME",
"serviceComment": "abc123"
}Fields
| Name | Description |
|---|---|
businessName(String) | The business name of the contact. |
familyName(String) | The family name of the contact person. |
givenName(String) | The given name of the contact person. |
nameType(PersonNameType) | The name type. |
phones([ContactPersonPhoneType]) | The list of phone details of the contact person. |
title(String) | The title of the contact person. |
Example
{
"businessName": "abc123",
"title": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"nameType": "AKA",
"phones": [ContactPersonPhoneType]
}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. |
party(ContractParty) | The party (Account or Business) that entered into this contract. |
signedAt(DateTime) | Date when the contract was signed. |
status(ContractStatus) | The status of the contract. |
subject([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. |
Example
{
"identifier": NonEmptyString,
"title": "abc123",
"party": AccountType,
"subject": [AccountType],
"status": "REVOKED",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"signedAt": "2020-01-01T00:00:00.000Z",
"cancelledAt": "2020-01-01T00:00:00.000Z",
"lifecycle": ContractVersion,
"terms": TermInterface
}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. |
party(ContractParty) | The party (Account or Business) that entered into this contract. |
signedAt(DateTime) | Date when the contract was signed. |
status(ContractStatus) | The status of the contract. |
subject([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. |
Example
{
"identifier": NonEmptyString,
"title": "abc123",
"party": AccountType,
"subject": [AccountType],
"status": "REVOKED",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"signedAt": "2020-01-01T00:00:00.000Z",
"cancelledAt": "2020-01-01T00:00:00.000Z",
"lifecycle": ContractVersion
}ContractVersion
Represents a version of a contract with its effective date.
Fields
| Name | Description |
|---|---|
effectiveFrom(DateTime) | The date from which this version of the contract becomes effective. |
versionReference(Int) | The reference number for this contract version. |
Example
{
"versionReference": 1,
"effectiveFrom": "2020-01-01T00:00:00.000Z"
}ContributionAgreementType
A single Contribution Agreement.
Fields
| Name | Description |
|---|---|
activeFrom(DateTime) | The start datetime of the agreement. |
activeTo(DateTime) | The end datetime of the agreement, if any. |
amount(Int) | The amount contributed per interval. Note, this is in the smallest domination that the currecy support. e.g. Pence, Cents, Yen, etc. |
contributionScheme(ContributionSchemeType) | The scheme to which the agreement contributes. |
id(ID!) | |
interval(Interval) | The frequency of contributions. |
periods(ContributionPeriodConnection) | The periods over which contributions have been made. |
Example
{
"id": "abc123",
"contributionScheme": ContributionSchemeType,
"interval": "MONTHLY",
"activeFrom": "2020-01-01T00:00:00.000Z",
"activeTo": "2020-01-01T00:00:00.000Z",
"amount": 1,
"periods": ContributionPeriodConnection
}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. |
Example
{
"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. |
Example
{
"pageInfo": PageInfo,
"edges": ContributionPeriodEdge,
"totalCount": 1,
"edgeCount": 1
}ContributionPeriodEdge
A Relay edge containing a ContributionPeriod and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ContributionPeriodType) | The item at the end of the edge |
Example
{
"node": ContributionPeriodType,
"cursor": "abc123"
}ContributionPeriodType
A single Contribution Period.
Fields
| Name | Description |
|---|---|
agreement(ContributionAgreementType!) | |
fulfilledAt(DateTime) | When the contribution was fulfilled |
id(ID!) | |
periodFrom(DateTime) | The datetime the marks the beginning of the period. |
periodTo(DateTime) | The datetime the marks the end of the period. |
Example
{
"id": "abc123",
"agreement": ContributionAgreementType,
"fulfilledAt": "2020-01-01T00:00:00.000Z",
"periodFrom": "2020-01-01T00:00:00.000Z",
"periodTo": "2020-01-01T00:00:00.000Z"
}ContributionSchemeType
A single Contribution Scheme.
Fields
| Name | Description |
|---|---|
acceptingContributions(Boolean!) | Is this scheme currently accepting contributions? |
code(String!) | |
displayName(String!) | |
id(ID!) | |
taxable(Boolean!) | Are contributions to this scheme taxable? |
Example
{
"id": "abc123",
"code": "abc123",
"displayName": "abc123",
"taxable": true,
"acceptingContributions": true
}Example
{
"latitude": 1.0,
"longitude": 1.0
}CoreSiteworksAppointmentType
An appointment linked to a request
Fields
| Name | Description |
|---|---|
appointmentDate(Date) | The date of the appointment in local time. |
createdAt(DateTime!) | |
externalReference(String!) | |
id(UUID!) | |
jobType(String) | The type of job for the appointment. |
status(OnSiteJobsAppointmentStatus) | The current status of the appointment. |
timeSlotEnd(Time) | The end time of the appointment slot in local time. |
timeSlotStart(Time) | The start time of the appointment slot in local time. |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"externalReference": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"status": "PENDING",
"appointmentDate": "2020-01-01",
"timeSlotStart": "00:00:00.000Z",
"timeSlotEnd": "00:00:00.000Z",
"jobType": "abc123"
}CoreSiteworksRequestConnectionTypeEdge
A Relay edge containing a CoreSiteworksRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CoreSiteworksRequestType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}CreateAccountPaymentSchedule
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3815: No active payment schedule found for this account.
- KT-CT-3822: Unauthorized.
- KT-CT-3923: Unauthorized.
- KT-CT-3941: Invalid data.
- KT-CT-3942: An unexpected error occurred.
- KT-CT-3947: An unexpected error occurred.
- KT-CT-3960: Invalid value for payment day.
- KT-CT-3961: Cannot update plan-associated payment schedule.
- KT-CT-3962: No new value provided to update payment schedule.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
schedule(PaymentScheduleType!) | New payment schedule. |
Example
{
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}CreateAccountReference
Create an account reference.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-8310: Invalid data.
- KT-CT-8311: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
accountReference(AccountReferenceType) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}CreateCentrepayDeduction
Mutation for creating a new CentrepayDeduction linked to an account
The possible errors that can be raised are:
- KT-CT-3923: Unauthorized.
- KT-AU-3913: Centrepay Deduction valid_from date cannot be before today.
- KT-AU-3914: Centrepay Deduction valid_to date must be later than today.
- KT-AU-3915: Centrepay Deduction validto date must be later than validfrom date.
- KT-AU-3916: Centrepay Deduction amount must be greater than $10.00.
- KT-AU-3920: Cannot provide both validTo and targetAmount values.
- KT-AU-3912: Cannot create a Centrepay Deduction with these details.
- KT-AU-3930: Centrepay Deduction amount cannot be greater than Target Amount.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
centrepayDeduction(CentrepayDeductionType!) | Details of resulting request to add a Centrepay Deduction. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"centrepayDeduction": CentrepayDeductionType
}CreateComplaint
The possible errors that can be raised are:
- KT-CT-10801: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
complaint(ComplaintType) | The complaint that has been created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"complaint": ComplaintType
}Fields
| Name | Description |
|---|---|
concession(ConcessionType) | |
error(ConcessionCreationErrorUnion) |
Example
{
"concession": ConcessionType,
"error": ConcessionAlreadyExistsErrorType
}CreateContributionAgreement
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-9601: Invalid data.
- KT-CT-9602: Unable to create contribution agreement.
- KT-CT-9605: Contribution amount cannot be 0 or negative.
- KT-CT-9606: Scheme is not accepting contributions at this time.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
contributionAgreement(ContributionAgreementType) | The created contribution agreement. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"contributionAgreement": ContributionAgreementType
}Fields
| Name | Description |
|---|---|
creditCardInstruction(DirectDebitInstructionType) |
Example
{
"creditCardInstruction": DirectDebitInstructionType
}CreateCreditTransferPermission
Mutation to create a credit transfer permission.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3827: The ledger is not valid.
- KT-CT-3828: At least one of the provided ledgers must be a credit storage ledger.
- KT-CT-3829: The credit transfer permission already exists.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
validFrom(DateTime) | Datetime when the credit transfer permission is valid. |
Example
{
"possibleErrors": [PossibleErrorType],
"validFrom": "2020-01-01T00:00:00.000Z"
}CreateCustomerFeedback
The possible errors that can be raised are:
- KT-CT-5516: Invalid data.
- KT-CT-1111: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
customerFeedback(CustomerFeedbackType) | The created customer feedback object. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"customerFeedback": CustomerFeedbackType
}Fields
| Name | Description |
|---|---|
error(ReadingValidationSaveErrorUnion) | Error types associated to handled errors during electricity reading generation. |
readings([ElectricityAccumulationMeterReadingType]) | Electricity readings generated from input. |
Example
{
"readings": [ElectricityAccumulationMeterReadingType],
"error": MultipleMeterpointsValidationErrorType
}CreateDirectDebitInstruction
The possible errors that can be raised are:
- KT-CT-3940: Invalid data.
- KT-CT-3923: Unauthorized.
- KT-CT-3979: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
directDebitInstruction(DirectDebitInstructionType) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"directDebitInstruction": DirectDebitInstructionType
}CreateFixedPaymentSchedule
Mutation for creating a fixed payment Schedule instance using the authenticated user.
Fields
| Name | Description |
|---|---|
error(FixedPaymentScheduleErrorUnion) | |
paymentSchedule(PaymentScheduleType) | The payment schedule created. |
Example
{
"paymentSchedule": PaymentScheduleType,
"error": OutOfBoundsPaymentDayErrorType
}Fields
| Name | Description |
|---|---|
error(GasReadingValidationSaveErrorUnion) | Error types associated to handled errors during gas reading generation. |
readings([GasMeterReadingType]) | Gas readings generated from input. |
Example
{
"readings": [GasMeterReadingType],
"error": ReadingCreationErrorType
}CreateGoodsPurchase
The possible errors that can be raised are:
- KT-CT-8206: Invalid data.
- KT-CT-1131: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
goodsPurchase(GoodsPurchase) | Goods purchase created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}CreateGoodsQuote
The possible errors that can be raised are:
- KT-CT-8202: Invalid data.
- KT-CT-8205: Unable to create quote.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
goodsQuote(GoodsQuote) | Goods quote created for the customer. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"goodsQuote": GoodsQuote
}CreateGoodsQuoteWithoutAccount
The possible errors that can be raised are:
- KT-CT-8202: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
goodsQuote(GoodsQuote) | Goods quote created for the customer. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"goodsQuote": GoodsQuote
}CreateHardshipAgreement
The possible errors that can be raised are:
- KT-CT-11612: Overlapping hardship agreement exists.
- KT-CT-12901: Account not found.
- KT-CT-10950: Invalid date range.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
newHardshipAgreement(HardshipAgreementType) | The created hardship agreement ID. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"newHardshipAgreement": HardshipAgreementType
}CreateInkLiveChatMessage
The possible errors that can be raised are:
- KT-CT-7616: Not yet implemented.
- KT-CT-1111: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-7642: No account user was found for the given fromHandle.
- KT-CT-7641: Live Chat message with this message ID has already been processed.
- KT-CT-7645: The user is not authorized to access this Live Chat.
- KT-CT-7622: Attachment bucket is invalid.
- KT-CT-7623: Attachment path is invalid.
- KT-CT-7621: Attachment not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
liveChatConversation(InkLiveChatConversation) | The live chat conversation. |
messageRelayId(String!) | The ID of the Ink Live Chat message that was created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"liveChatConversation": InkLiveChatConversation,
"messageRelayId": "abc123"
}CreateMfaDevice
Create a multi-factor authentication (MFA) device for user.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-1151: MFA device not found.
- KT-CT-1153: Unable to create MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
deviceEmail(String) | Email address to send the MFA code by default. |
devicePhone(String) | Phone number to send the MFA code by default. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
totpSecret(String) | Secret to setup Time-based One-Time Passwords (TOTP) in your authenticator or password manager manually. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceEmail": "abc123",
"devicePhone": "abc123",
"totpSecret": "abc123"
}CreateNewAgreementFromProductSwitchProcess
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4924: Unauthorized.
- KT-CT-1509: Unable to create agreement.
- KT-CT-1507: Agreement product switch date is not within the acceptable range.
- KT-CT-1510: Product switch process not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
agreement(CommonAgreementType) | The new agreement created. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"agreement": CommonAgreementType
}CreateOfferGroupForQuoting
Create a quoting offer group.
The possible errors that can be raised are:
- KT-CT-12401: Unable to create offer group.
- KT-CT-12405: Missing rates for quoting.
- KT-CT-12406: Product not configured correctly for quoting.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
offerGroup(CreateOfferGroupType) | Quoting Offer Group. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"offerGroup": CreateOfferGroupType
}Fields
| Name | Description |
|---|---|
identifier(ID) | Identifier of the Offer Group. |
offers([OfferType]) | One or more Offers contained in the Offer Group. |
Example
{
"identifier": "abc123",
"offers": [OfferType]
}CreatePaymentActionIntent
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3980: Invalid ledger identifier.
- KT-CT-3981: Unauthorized.
- KT-CT-3982: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
token(ID!) | The action intent token. |
Example
{
"possibleErrors": [PossibleErrorType],
"token": "abc123"
}CreatePaymentExtension
Creates payment extension according to the received options.
Taken action would be one of the following:
- if payment instruction is NOT supplied and the account is on a manual payment, sets up one or two payment promise(s)
- if payment instruction is NOT supplied and the account is on an scheduled payment (direct debit/card), creates payment holiday
- if payment instruction is supplied, sets up payment schedules for one or two instalment(s)
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.
Payment Holiday means that when a customer is on a scheduled payment, the payments will not come out from customer's bank account for the period indicated.
Fields
| Name | Description |
|---|---|
paymentExtension(PaymentExtensionUnionType) |
Example
{
"paymentExtension": PaymentPromiseType
}Fields
| Name | Description |
|---|---|
paymentSchedule(PaymentScheduleType) | The payment schedule created. |
Example
{
"paymentSchedule": PaymentScheduleType
}Fields
| Name | Description |
|---|---|
error(CreatePrimaryResidenceErrorUnion) | |
primaryResidence(PrimaryResidenceType) |
Example
{
"primaryResidence": PrimaryResidenceType,
"error": AccountUserCanNotFoundErrorType
}CreateProfileEventAndPublish
If the event is an update, and it is a "forced sync", then its isOverride flag should be set to True.
Fields
| Name | Description |
|---|---|
error(CreateUserProfileEventAndPublishErrorUnion) | |
syncEvent(SyncEventType) |
Example
{
"syncEvent": SyncEventType,
"error": CreateUserProfileEventAndPublishAccountNumberNotProvidedError
}CreateReferral
Use a referral code to create a referral and trigger a referral reward. This is for customers to refer other customers so it only works with friend referrals and not partner referrals. This will try to find a user with given referral code as their personal referral code. If found, it will create an AccountReferral instance for the given account number.
The possible errors that can be raised are:
- KT-CT-6723: Unauthorized.
- KT-CT-6710: Unable to create referral.
- KT-CT-6711: Accounts may not self-refer.
- KT-CT-6713: Referring and referred account brands do not match.
- KT-CT-6712: Invalid reference.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
referredAccountRewardAmount(Int) | The reward amount to be issued to the referred account, in smallest currency subunits. |
Example
{
"possibleErrors": [PossibleErrorType],
"referredAccountRewardAmount": 1
}Fields
| Name | Description |
|---|---|
alternativePhoneNumbers([String]) | List of alternative phone numbers for the account user. |
error(AlternativeNumberErrorUnion) | Potential error message for the mutation. |
Example
{
"alternativePhoneNumbers": ["abc123"],
"error": AlternativeNumberValidationErrorType
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"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 Deprecated The 'amount' field is deprecated. |
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
balanceCarriedForward(Int) | The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
billingDocumentIdentifier(ID) | The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document. |
createdAt(DateTime) | The date time when the transaction is created. |
hasStatement(Boolean) | Returns True if the transaction is linked with a statement. |
id(ID) | Unique identifier for the transaction. |
isAccountCharge(Boolean) | Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
isAccountPayment(Boolean) | Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
isCredit(Boolean) | Deprecated. Deprecated The 'isCredit' field is deprecated. |
isHeld(Boolean) | Whether the statement this transaction is on has been held. A held statement is not sent to a customer automatically, but is instead marked for manual attention by operations staff. Returns False if a statement is not linked with the transaction. |
isIssued(Boolean) | Whether this transaction has been issued on any billing document.Note: Look for the most recently issued transaction instead of looking through all transactions as some accounts may have initial transactions that were not issued.This will return False if the transaction is not associated with any billing documents. |
isReversed(Boolean!) | |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | Date when the transaction was posted to the account. |
reasonCode(String) | Returns the reason. |
statementId(ID) | Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
title(String) | Human-readable title describing the transaction. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123"
}Fields
| Name | Description |
|---|---|
code(String) | The credit reason code. |
display(String) | The credit reason display text. |
group(String) | The group the credit reason belongs to (if applicable). |
isDeprecated(Boolean) | Whether the credit reason is deprecated. |
isHidden(Boolean) | Whether the credit reason is hidden. |
isTaxExempt(Boolean) | Whether the credit reason is sales tax exempt. |
Example
{
"code": "abc123",
"display": "abc123",
"isDeprecated": true,
"isTaxExempt": true,
"isHidden": true,
"group": "abc123"
}Fields
| Name | Description |
|---|---|
accountNumber(String) | The number of the account linked to this permission. |
ledgerNumber(String) | The number of the ledger linked to this permission. |
validFrom(DateTime) | The datetime from which the permission is valid. |
validTo(DateTime) | The datetime to which the permission is valid. |
Example
{
"ledgerNumber": "abc123",
"accountNumber": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
accountNumber(String) | The number of the account linked to this permission. |
ledgerNumber(String) | The number of the ledger linked to this permission. |
validFrom(DateTime) | The datetime from which the permission is valid. |
validTo(DateTime) | The datetime to which the permission is valid. |
Example
{
"ledgerNumber": "abc123",
"accountNumber": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
fromSourceLedgers([CreditTransferPermissionFromSourceLedgerType]) | Permissions for credit transfers when the ledger is the target. |
toTargetLedgers([CreditTransferPermissionToTargetLedgerType]) | Permissions for credit transfers when the ledger is the source. |
Example
{
"fromSourceLedgers": [CreditTransferPermissionFromSourceLedgerType],
"toTargetLedgers": [CreditTransferPermissionToTargetLedgerType]
}Fields
| Name | Description |
|---|---|
account(String) | |
category(String!) | |
content(JSONString) | |
occurredAt(DateTime!) | |
subcategory(String!) |
Example
{
"occurredAt": "2020-01-01T00:00:00.000Z",
"category": "abc123",
"subcategory": "abc123",
"content": {"key": "value"},
"account": "abc123"
}CustomerFeedbackFormConnectionTypeConnection
Paginator of Customer Feedback Form.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([CustomerFeedbackFormConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": CustomerFeedbackFormConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}CustomerFeedbackFormConnectionTypeEdge
A Relay edge containing a CustomerFeedbackFormConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(CustomerFeedbackFormType) | The item at the end of the edge |
Example
{
"node": CustomerFeedbackFormType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
id(ID) | The unique identifier for the customer feedback form. |
name(String) | The name of the customer feedback form. |
Example
{
"id": "abc123",
"name": "abc123"
}Fields
| Name | Description |
|---|---|
id(ID!) | |
rawScore(Int) | The value attached to the source |
submittedAt(DateTime) | The datetime the feedback was submitted |
Example
{
"id": "abc123",
"rawScore": 1,
"submittedAt": "2020-01-01T00:00:00.000Z"
}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. |
Example
{
"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. |
Example
{
"id": "abc123",
"typename": "abc123",
"dashboardItems": SectionType,
"serialisedDashboardItems": "abc123"
}Fields
| Name | Description |
|---|---|
suffix(String!) | The suffix of the datastream. |
Example
{
"suffix": "abc123"
}DecimalType
Graphene type object to represent float values
Fields
| Name | Description |
|---|---|
decimalValue(Decimal!) | Value of this field. |
Example
{
"decimalValue": "1.0"
}DeeplinkActionType
An action which navigates to the URL of another backend screen.
Fields
| Name | Description |
|---|---|
id(ID) | Unique identifier of the object. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
url(String!) | The URL to navigate to. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"url": "abc123"
}DeleteMfaDevice
Delete a multi-factor authentication (MFA) device for the authenticated user.
The possible errors that can be raised are:
- KT-CT-1150: MFA device not found.
- KT-CT-1154: Unable to delete MFA device.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
deviceDeleted(Boolean) | Flag to indicate if the MFA device has been successfully deleted. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceDeleted": true
}Fields
| Name | Description |
|---|---|
account(AccountType) | Account related to payment schedule. |
error(DeletePaymentScheduleErrorUnion) | Handled errors related to payment schedule deletion. |
Example
{
"account": AccountType,
"error": DoesNotExistErrorType
}DeletePushNotificationBinding
The possible errors that can be raised are:
- KT-CT-5411: Invalid token or no push notification binding found for the given account user.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
status(DeletePushNotificationBindingOutput) |
Example
{
"possibleErrors": [PossibleErrorType],
"status": "SUCCESSFUL"
}Fields
| Name | Description |
|---|---|
alternativePhoneNumbers([String]) | List of alternative phone numbers for the account user. |
error(AlternativeNumberErrorUnion) | Potential error message for the mutation. |
Example
{
"alternativePhoneNumbers": ["abc123"],
"error": AlternativeNumberValidationErrorType
}Fields
| Name | Description |
|---|---|
deviceIdentifier(String) | The id of the device. This field can only be provided in the output if device level readings are also requested. |
readings(Readings) | Get readings from a readable device e.g., a supply point, device, or register. Arguments
The exclusive end of the time period as an isoformatted string.
Get readings of only this type.
The inclusive start of the time period as an isoformatted string.
Time buckets to group readings into.
The timezone in which to return readings.
Optional filter to return readings only for specific list of units or unit (e.g., KILOWATTHOURS, METERSCUBED, LITER, etc.). |
registers(RegistersConnection) | The registers associated with this device. |
Example
{
"readings": Readings,
"deviceIdentifier": "abc123",
"registers": RegistersConnection
}Fields
| Name | Description |
|---|---|
readings(Readings) | Get readings from a readable device e.g., a supply point, device, or register. Arguments
The exclusive end of the time period as an isoformatted string.
Get readings of only this type.
The inclusive start of the time period as an isoformatted string.
Time buckets to group readings into.
The timezone in which to return readings.
Optional filter to return readings only for specific list of units or unit (e.g., KILOWATTHOURS, METERSCUBED, LITER, etc.). |
registerIdentifier(String) | The id of the register. This field can only be provided in the output if register level readings are also requested. |
Example
{
"readings": Readings,
"registerIdentifier": "abc123"
}DevicesConnection
Pagination for devices.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([DevicesEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": DevicesEdge,
"totalCount": 1,
"edgeCount": 1
}DevicesEdge
A Relay edge containing a Devices and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Device) | The item at the end of the edge |
Example
{
"node": Device,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
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. |
Example
{
"nmi": "abc123",
"isEligible": true,
"reason": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([DirectDebitInstructionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": DirectDebitInstructionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}DirectDebitInstructionConnectionTypeEdge
A Relay edge containing a DirectDebitInstructionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(DirectDebitInstructionType) | The item at the end of the edge |
Example
{
"node": DirectDebitInstructionType,
"cursor": "abc123"
}DirectDebitInstructionType
Direct Debit Instructions
Fields
| Name | Description |
|---|---|
accountHolder(String!) | |
cardExpiryMonth(Int) | |
cardExpiryYear(Int) | |
cardPaymentNetwork(String) | |
iban(String!) | |
id(ID!) | |
instructionType(String!) | |
lastFourDigitsOfAccountNumber(String) | The last four digits of the account number. Deprecated The 'lastFourDigitsOfAccountNumber' field is deprecated. |
maskedAccountIdentifier(String) | A masked reference to a recurring payment method. |
maskedIban(String) | A masked version of the IBAN. |
owners([PaymentInstructionOwnerType]) | The owners of the financial account this instruction represents. |
sortCode(String!) | |
status(String!) |
Example
{
"id": "abc123",
"status": "abc123",
"sortCode": "abc123",
"iban": "abc123",
"accountHolder": "abc123",
"instructionType": "abc123",
"cardPaymentNetwork": "abc123",
"cardExpiryMonth": 1,
"cardExpiryYear": 1,
"lastFourDigitsOfAccountNumber": "abc123",
"maskedAccountIdentifier": "abc123",
"maskedIban": "abc123",
"owners": [PaymentInstructionOwnerType]
}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. |
eligibleRebates([RebateType]) | Data about concession rebates that users associated with the agreement are eligible for. Arguments
Include eligibility data ending at this datetime. If this isn't provided, an open-ended range will be used.
The effective time for rebateCents and percentageDiscount data (defaults to now).
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. |
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. |
Example
{
"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",
"supplyPoint": SupplyPointInterface,
"account": AccountType,
"agreedFrom": "2020-01-01T00:00:00.000Z",
"agreedTo": "2020-01-01T00:00:00.000Z",
"isRevoked": true,
"rescissionDeadlineAt": "2020-01-01T00:00:00.000Z",
"product": Product,
"supplyType": "abc123",
"isActive": "abc123",
"meterPoint": MeterPointType,
"eligibleRebates": [RebateType],
"bestOffer": BestOfferForAgreement
}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. |
Example
{
"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
}Fields
| Name | Description |
|---|---|
field(String!) | The input field that failed database lookup. |
Example
{
"field": "abc123"
}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. |
Example
{
"amount": 1,
"statement": StatementType,
"billingDocument": PeriodBasedDocumentType,
"dueDate": "2020-01-01"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}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. |
Example
{
"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!) |
Example
{
"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. |
eligibleRebates([RebateType]) | Data about concession rebates that users associated with the agreement are eligible for. Arguments
Include eligibility data ending at this datetime. If this isn't provided, an open-ended range will be used.
The effective time for rebateCents and percentageDiscount data (defaults to now).
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. |
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. |
Example
{
"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",
"supplyPoint": ElectricitySupplyPointType,
"account": AccountType,
"agreedFrom": "2020-01-01T00:00:00.000Z",
"agreedTo": "2020-01-01T00:00:00.000Z",
"isRevoked": true,
"rescissionDeadlineAt": "2020-01-01T00:00:00.000Z",
"product": Product,
"supplyType": "abc123",
"isActive": "abc123",
"meterPoint": MeterPointType,
"eligibleRebates": [RebateType],
"bestOffer": BestOfferForAgreement
}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. |
Example
{
"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"
}Fields
| Name | Description |
|---|---|
registers([ElectricityRegisterType]) | Registers associated with this consumption. |
summarizedConsumption([SummarizedConsumptionType]) | Summarized costed consumption data. |
Example
{
"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). |
Example
{
"averageDailyLoad": 1.0
}Fields
| Name | Description |
|---|---|
deviceId(String) | The identifier of the device associated to this reading. |
marketSupplyPointId(String) | The identifier of the market supply point associated to this reading. |
readingDirection(ReadingDirectionType) | Reading direction is based on the utility generated or consumed by the customer. |
readingFrequencyType(ReadingFrequencyType) | The frequency of the reading. |
readingQuality(ReadingQualityType) | |
registerId(String) | The identifier of the register associated to this reading. |
Example
{
"readingDirection": "CONSUMPTION",
"registerId": "abc123",
"readingQuality": "ACTUAL",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123"
}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. |
Example
{
"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. |
Example
{
"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 |
Example
{
"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. |
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. |
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. |
sequenceNumber(String) | The sequence number of the meter. |
serialNumber(String!) | |
status(MeterStatus!) | |
transmissionNodeIdentifier(String) | The Transmission Node Identifier (TNI) code from the AEMO CATSTNICODES table. |
Example
{
"id": "abc123",
"serialNumber": "abc123",
"activeFrom": "2020-01-01T00:00:00.000Z",
"activeTo": "2020-01-01T00:00:00.000Z",
"meterPoint": MeterPointType,
"status": "C",
"installationType": "BASIC",
"nextScheduledReadDate": "2020-01-01",
"readTypeMethod": "M",
"readTypeMode": "T",
"readTypeFrequency": "A_1",
"consumptionUnits": "abc123",
"requiresCotFinalReading": true,
"fuelType": "abc123",
"consumption": ConsumptionConnection,
"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"
}Fields
| Name | Description |
|---|---|
error(ElectricityMoveInDatesErrorUnion) | |
moveInDates([Date]) |
Example
{
"moveInDates": ["2020-01-01"],
"error": DoesNotExistErrorType
}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 |
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) |
Example
{
"id": "abc123",
"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,
"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 |
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 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
This field requires the Deprecated The 'consumptionSummary' field is deprecated. Arguments
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
How granular the returned results should be
Include estimated readings
Include readings that have been quarantined in Kraken
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
Olson timezone identifier to use (e.g. |
controlledLoad(String!) | |
dataStream(ElectricityDataStreamType) | |
dialFormatDecimals(Int) | |
dialFormatDigits(Int) | |
id(ID!) | |
identifier(String!) | MSATS RegisterId. |
isActive(Boolean!) | |
isExportRegister(Boolean!) | Arguments
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. |
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 This field requires the Deprecated The 'readingsSummary' field is deprecated. Arguments
Readings which happened after the end of this day will be excluded.
Include estimated readings
Include readings that have been quarantined in Kraken
Data granularity desired for the summary results
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!) |
Example
{
"id": "abc123",
"identifier": "abc123",
"activeFrom": "2020-01-01T00:00:00.000Z",
"dataStream": ElectricityDataStreamType,
"timeOfDay": "abc123",
"multiplier": "1.0",
"status": "C",
"networkTariffCode": "abc123",
"dialFormatDigits": 1,
"dialFormatDecimals": 1,
"suffix": "abc123",
"controlledLoad": "abc123",
"unitOfMeasure": "MWH",
"networkTariffCodeOverride": [RegisterNTCOverrideType],
"isExportRegister": true,
"isActive": true,
"isReactive": true,
"readingsSummary": [DailyElectricityMeterReadingType],
"consumptionSummary": SummarizedConsumptionType,
"billableTariffCode": "abc123"
}Fields
| Name | Description |
|---|---|
chargeRecords(ServiceOrderChargeRecordConnectionTypeConnection) | |
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. |
Example
{
"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"
}Fields
| Name | Description |
|---|---|
externalSupplyPointIdentifier(String) | The legacy identifier DEBTORNUM associated with the supply point, if available. |
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. |
Example
{
"id": "abc123",
"marketName": "abc123",
"property": PropertyType,
"meterPoint": MeterPointType,
"externalSupplyPointIdentifier": "abc123"
}EmailAttachmentType
Represents a file to attach to a email message.
Fields
| Name | Description |
|---|---|
filename(String!) | The filename of the attachment. |
id(ID!) | The ID of the attachment. |
temporaryUrl(String) | Temporary URL at which the attachment is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). |
Example
{
"id": "abc123",
"filename": "abc123",
"temporaryUrl": "abc123"
}Fields
| Name | Description |
|---|---|
eventType(String!) | |
id(ID!) | The ID of the object |
message(EmailType) | Email message of the email event. Returns null for message's sent/received by other user's on the account. |
occurredAt(DateTime!) |
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": EmailType
}EmailType
Represents an email communication
Fields
| Name | Description |
|---|---|
attachments([EmailAttachmentType]) | Attachments of the email message. |
channel(String!) | |
createdAt(DateTime!) | The date and time the email was created. |
fromEmail(String!) | The address the email was sent from. |
fromNumber(String!) | |
htmlBody(String) | HTML body of the email message. |
id(ID!) | The ID of the email. |
recipient(String) | Email recipient. |
sender(String) | Email sender. |
sentAt(DateTime) | The date and time the email was sent. |
subject(String) | Subject line of the email message. |
supportSiteUrl(String) | URL to view the email in the support site. |
templateCode(String!) | The email template code. |
textBody(String) | Text body of the email message. |
toAddress(String!) | The email address of the recipient. |
toNumber(String!) |
Example
{
"id": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"sentAt": "2020-01-01T00:00:00.000Z",
"templateCode": "abc123",
"toAddress": "abc123",
"fromEmail": "abc123",
"subject": "abc123",
"attachments": [EmailAttachmentType],
"textBody": "abc123",
"htmlBody": "abc123",
"supportSiteUrl": "abc123",
"toNumber": "abc123",
"fromNumber": "abc123",
"channel": "abc123",
"sender": "abc123",
"recipient": "abc123"
}Fields
| Name | Description |
|---|---|
deviceId(String) | The identifier of the device associated to this reading. |
marketSupplyPointId(String) | The identifier of the market supply point associated to this reading. |
readingDirection(ReadingDirectionType) | Reading direction is based on the utility generated or consumed by the customer. |
readingFrequencyType(ReadingFrequencyType) | The frequency of the reading. |
readingQuality(ReadingQualityType) | |
registerId(String) | The identifier of the register associated to this reading. |
Example
{
"readingDirection": "CONSUMPTION",
"registerId": "abc123",
"readingQuality": "ACTUAL",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123"
}EmbeddedNetworkType
Represents an embedded network that holds multiple embedded properties.
Fields
| Name | Description |
|---|---|
embeddedProperties([EmbeddedPropertyType]) | Get details about properties in an embedded network. |
id(ID!) | |
name(String!) | A unique name/code for the network |
Example
{
"id": "abc123",
"name": "abc123"
}EndContributionAgreement
The possible errors that can be raised are:
- KT-CT-9603: Unable to find contribution agreement.
- KT-CT-4123: Unauthorized.
- KT-CT-9604: Unable to end contribution agreement.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
contributionAgreement(ContributionAgreementType) | The created contribution agreement. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"contributionAgreement": ContributionAgreementType
}EnergyMixDataType
Energy mix data can include the latest carbon intensity index in a region.
Fields
| Name | Description |
|---|---|
carbonIntensityIndex(String) | Current carbon intensity index. |
Example
{
"carbonIntensityIndex": "abc123"
}EnrollAccountInLoyaltyProgram
Enroll an account into the loyalty program.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9213: ineligible loyalty points enrollment.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
outcome(EnrollAccountInLoyaltyProgramOutcome) | Outcome of the loyalty points campaign enrollment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"outcome": EnrollAccountInLoyaltyProgramOutcome
}Fields
| Name | Description |
|---|---|
hasEnrolled(Boolean) | Whether or not this account has been enrolled in the loyalty points campaign. |
Example
{
"hasEnrolled": true
}EnrollmentCancelled
Enrollment was successfully cancelled.
Fields
| Name | Description |
|---|---|
enrollmentProcess(EnrollmentProcess!) | The Enrollment process that was cancelled. |
message(String!) | The message to display to the user on Enrollment initiation. |
Example
{
"message": "abc123",
"enrollmentProcess": JoinSupplierProcessType
}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. |
Example
{
"switchStartDate": "2020-01-01",
"supplyStartDate": "2020-01-01",
"status": "INITIATED"
}Fields
| Name | Description |
|---|---|
field(String!) | |
messages([String!]!) |
Example
{
"field": "abc123",
"messages": "abc123"
}Fields
| Name | Description |
|---|---|
costCurrency(String!) | Monetary currency of the statistic in ISO-4217 format. |
estimatedAmount(Decimal!) | |
pricePerUnit(PricePerUnit) | Net price per unit of the statistic if applicable. |
Example
{
"estimatedAmount": "1.0",
"costCurrency": "abc123",
"pricePerUnit": PricePerUnit
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"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. |
Example
{
"pageInfo": PageInfo,
"edges": ExportReadingsEdge,
"totalCount": 1,
"edgeCount": 1
}ExportReadingsEdge
A Relay edge containing a ExportReadings and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Reading) | The item at the end of the edge |
Example
{
"node": Reading,
"cursor": "abc123"
}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. |
Example
{
"accountNumber": "abc123",
"isConfigured": true,
"nextRepaymentDate": "2020-01-01",
"lastRepaymentDate": "2020-01-01",
"paymentMethod": "abc123"
}ExternalAccountEventConnectionTypeEdge
A Relay edge containing a ExternalAccountEventConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ExternalAccountEvent) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}ExternalSalesInfoType
GraphQL type representing external sales information.
This type is used to represent sales records that originate from external systems or processes outside of Kraken's direct tracking mechanisms.
Fields
| Name | Description |
|---|---|
salesRecordIdentifier(String) | The unique identifier for the sales record. |
Example
{
"salesRecordIdentifier": "abc123"
}Fields
| Name | Description |
|---|---|
description(String) | Description of the extra for the parent node. |
label(String) | Display label of the extra for the parent node. |
value(String) | Value of the extra. |
Example
{
"label": "abc123",
"description": "abc123",
"value": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
field(String) | The name of the GraphQL field for which the rate is limited. |
isBlocked(Boolean) | Whether the viewer is currently blocked from making requests to this field due to exceeding the allowed request rate. |
rate(String) | Indicates the rate limit allowed for this field (e.g. 10/m). |
ttl(Int) | Time to live: The time remaining before the user is unblocked from making requests to this field. |
Example
{
"field": "abc123",
"rate": "abc123",
"ttl": 1,
"isBlocked": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([FieldSpecificRateLimitInformationConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": FieldSpecificRateLimitInformationConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}FieldSpecificRateLimitInformationConnectionTypeEdge
A Relay edge containing a FieldSpecificRateLimitInformationConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(FieldSpecificRateLimitInformation) | The item at the end of the edge |
Example
{
"node": FieldSpecificRateLimitInformation,
"cursor": "abc123"
}FloatType
Graphene type object to represent float values
Fields
| Name | Description |
|---|---|
floatValue(Float!) | Value of this field. |
Example
{
"floatValue": 1.0
}Fields
| Name | Description |
|---|---|
effectiveAt(DateTime!) | The time at which forced reauthentication is effective. Kraken and refresh tokens issued before this time will be invalid. |
tokensInvalidated(Boolean!) | Reports whether the mutation applied successfully. Should always be 'true'. |
Example
{
"tokensInvalidated": true,
"effectiveAt": "2020-01-01T00:00:00.000Z"
}FormScreenType
A screen type for forms with input fields.
Combines display items with input fields (TextField, Checkbox, Toggle), and provides primary/secondary buttons for form submission.
Note: header and footer are embedded in screenData and not exposed as separate GraphQL fields, following the pattern of ComponentListType.
Fields
| Name | Description |
|---|---|
accessibilityHidden(Boolean) | Whether the element is hidden from view. |
accessibilityLabel(String) | Accessible description of the element. |
id(ID) | Unique identifier of the object. |
name(String!) | The name of the screen. |
refreshFrequency(Int) | The refresh / polling frequency in milliseconds. |
screenData(String) | Serialized JSON representation of the screen. |
typename(String) | The name of the object's type. |
Example
{
"accessibilityHidden": true,
"accessibilityLabel": "abc123",
"id": "abc123",
"typename": "abc123",
"name": "abc123",
"refreshFrequency": 1,
"screenData": "abc123"
}Fields
| Name | Description |
|---|---|
content(JSONString) | |
errors([SerializerFieldErrorsType]) | |
id(Int) |
Example
{
"id": 1,
"content": {"key": "value"},
"errors": [SerializerFieldErrorsType]
}FractionSizeType
A fractional measurement.
Fields
| Name | Description |
|---|---|
fraction(Decimal!) | The fractional value. |
id(ID) | Unique identifier of the object. |
typename(String) | The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"fraction": "1.0"
}FulfilmentType
Represents an amount of money that can be used to fulfil an obligation.
Fields
| Name | Description |
|---|---|
amount(Int!) | The amount of the fulfilment (in minor currency units), unsigned. |
sourceIdentifier(String) | The database ID of the fulfilment source, e.g. the database ID of the payment. |
sourceType(FulfilmentSourceType) | The type of the fulfilment source, e.g. PAYMENT. |
Example
{
"sourceType": "UNKNOWN",
"sourceIdentifier": "abc123",
"amount": 1
}FundingSourceAmountConnectionTypeConnection
This field is a connection type. Connections are used to implement cursor based pagination.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([FundingSourceAmountConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": FundingSourceAmountConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}FundingSourceAmountConnectionTypeEdge
A Relay edge containing a FundingSourceAmountConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(FundingSourceAmountType) | The item at the end of the edge |
Example
{
"node": FundingSourceAmountType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amount(Int) | Amount used from a funding source in minor currency. |
reason(String) | Reason why the funding source was used. |
Example
{
"reason": "abc123",
"amount": 1
}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. |
eligibleRebates([RebateType]) | Data about concession rebates that users associated with the agreement are eligible for. Arguments
Include eligibility data ending at this datetime. If this isn't provided, an open-ended range will be used.
The effective time for rebateCents and percentageDiscount data (defaults to now).
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. |
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. |
Example
{
"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",
"supplyPoint": GasSupplyPointType,
"account": AccountType,
"agreedFrom": "2020-01-01T00:00:00.000Z",
"agreedTo": "2020-01-01T00:00:00.000Z",
"isRevoked": true,
"rescissionDeadlineAt": "2020-01-01T00:00:00.000Z",
"product": Product,
"supplyType": "abc123",
"isActive": "abc123",
"meterPoint": GasMeterPointType,
"eligibleRebates": [RebateType],
"bestOffer": BestOfferForAgreement
}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. |
Example
{
"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. |
Example
{
"registerId": "abc123",
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123"
}Fields
| Name | Description |
|---|---|
address(MeterPointAddressType) | |
agreements([AusAgreementInterface]) | A list of agreements belonging to an account that is linked to the logged in user. Arguments
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]) | |
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. |
Example
{
"id": 1,
"meters": [GasMeterType],
"status": "abc123",
"agreements": AusAgreementInterface,
"identifier": "abc123",
"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. |
Example
{
"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 |
Example
{
"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) |
Example
{
"id": "abc123",
"meter": GasMeterType,
"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"
}Fields
| Name | Description |
|---|---|
activeFrom(DateTime) | |
activeTo(DateTime) | |
consumption(ConsumptionConnection) | Energy consumption recorded by the meter. |
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) | |
requiresCotFinalReading(Boolean) | Whether this meter requires a final change of tenancy (COT) reading. |
serialNumber(String!) | |
status(GasMeterStatus) | |
supplyPointIdentifier(String) |
Example
{
"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
}Fields
| Name | Description |
|---|---|
error(GasMoveInDatesErrorUnion) | |
moveInDates([Date]) |
Example
{
"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) |
Example
{
"id": "abc123",
"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,
"pricingZone": PricingZoneType
}Fields
| Name | Description |
|---|---|
chargeRecords(ServiceOrderChargeRecordConnectionTypeConnection) | |
meterPoint(MeterPointType) | |
orderNumber(String) | |
responseCode(String) | |
scheduledDate(Date) | |
serviceOrder(Int) | |
status(ServiceOrderStatus) | |
type(JobEnquiryCodeChoices) |
Example
{
"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"
}Fields
| Name | Description |
|---|---|
chargeRecords(ServiceOrderChargeRecordConnectionTypeConnection) | |
meterPoint(MeterPointType) | |
orderNumber(String) | |
responseCode(String) | |
scheduledDate(Date) | |
serviceOrder(Int) | |
status(ServiceOrderStatus) | |
type(SpecialReadReasonCodeChoices) |
Example
{
"orderNumber": "abc123",
"status": "PENDING",
"meterPoint": MeterPointType,
"serviceOrder": 1,
"responseCode": "abc123",
"scheduledDate": "2020-01-01",
"chargeRecords": ServiceOrderChargeRecordConnectionTypeConnection,
"type": "FINAL_READ"
}Fields
| Name | Description |
|---|---|
externalSupplyPointIdentifier(String) | The legacy identifier DEBTORNUM associated with the supply point, if available. |
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. |
Example
{
"id": "abc123",
"marketName": "abc123",
"property": PropertyType,
"meterPoint": MeterPointInterface,
"externalSupplyPointIdentifier": "abc123"
}GenericBackendScreen
A generic backend screen that can be used to define any type of screen.
Fields
| Name | Description |
|---|---|
name(String!) | The name of the screen. |
refreshFrequency(Int) | The refresh / polling frequency in milliseconds. |
screenData(String) | Serialized JSON representation of the screen. |
Example
{
"name": "abc123",
"refreshFrequency": 1,
"screenData": "abc123"
}GetEmbeddedSecretForNewPaymentInstruction
Get the client secret needed to create a new payment instruction using an embedded form.
The possible errors that can be raised are:
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
secretKey(String) |
Example
{
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}GetEmbeddedSecretForNewPaymentInstructionWithoutAccount
Get the client secret needed to create a new stored payment instruction using an embedded form.
This mutation is specifically for saving payment methods for future use, without immediately creating a payment instruction tied to a specific ledger or account.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
secretKey(String) | The client secret needed to create a new stored payment instruction. |
Example
{
"possibleErrors": [PossibleErrorType],
"secretKey": "abc123"
}GetHostedUrlForNewPaymentInstruction
Get external URL where the user can set up a payment instruction.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3979: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
url(String) | URL at which payment instruction can be set up. |
Example
{
"possibleErrors": [PossibleErrorType],
"url": "abc123"
}Fields
| Name | Description |
|---|---|
currency(String) | Currency. |
grossAmount(Float) | Gross amount. |
netAmount(Float) | Net amount. |
type(String) | Grant type. |
Example
{
"type": "abc123",
"netAmount": 1.0,
"grossAmount": 1.0,
"currency": "abc123"
}Fields
| Name | Description |
|---|---|
availableFrom(Date) | Product available from. |
availableTo(Date) | Product available to. |
code(String) | Product code. |
currency(String) | Currency. |
customerName(String) | Product customer name. |
description(String) | Product description. |
grossPricePerUnit(Float) | Gross price per unit. |
id(Int) | Product ID. |
internalName(String) | Product internal name. |
marketName(String) | Market of the product. |
notes(String) | Product notes. |
pricePerUnit(Float) | Price per unit. |
productType(GoodsProductType) | Type of the product. |
Example
{
"id": 1,
"marketName": "abc123",
"productType": GoodsProductType,
"code": "abc123",
"internalName": "abc123",
"customerName": "abc123",
"notes": "abc123",
"description": "abc123",
"availableFrom": "2020-01-01",
"availableTo": "2020-01-01",
"pricePerUnit": 1.0,
"grossPricePerUnit": 1.0,
"currency": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([GoodsProductConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": GoodsProductConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}GoodsProductConnectionTypeEdge
A Relay edge containing a GoodsProductConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(GoodsProduct) | The item at the end of the edge |
Example
{
"node": GoodsProduct,
"cursor": "abc123"
}Example
{
"code": "abc123",
"internalName": "abc123"
}Fields
| Name | Description |
|---|---|
clientParams(JSONString) | Client parameters of the purchase. |
code(String) | Purchase code. |
goodsGrants([GoodsGrant]) | Grants that apply in this purchase. |
goodsSaleItems([GoodsSaleItem]) | Sale items in this purchase. |
ledgerId(ID) | Ledger ID associated to the purchase. Deprecated The 'ledgerId' field is deprecated. |
ledgerNumber(String) | The ledger number associated to the purchase. |
marketName(String!) | Market name of the purchase. |
marketParams(JSONString) | Market parameters of the purchase. |
Example
{
"code": "abc123",
"ledgerId": "abc123",
"ledgerNumber": "abc123",
"goodsSaleItems": [GoodsSaleItem],
"goodsGrants": [GoodsGrant],
"marketName": "abc123",
"marketParams": {"key": "value"},
"clientParams": {"key": "value"}
}Fields
| Name | Description |
|---|---|
code(String) | Code of the quote. |
goodsQuotedProducts([GoodsQuotedProduct]) | Products of this quote. |
hasQuoteExpired(Boolean) | Indicates whether or not the quote is expired. |
id(ID) | ID of the quote. |
quotedAt(DateTime) | Date and time when the quote was created. |
totalNetAmount(Int) | Total net amount of the quote in cents. |
Example
{
"id": "abc123",
"code": "abc123",
"totalNetAmount": 1,
"quotedAt": "2020-01-01T00:00:00.000Z",
"goodsQuotedProducts": [GoodsQuotedProduct],
"hasQuoteExpired": true
}Fields
| Name | Description |
|---|---|
currency(String) | Currency. |
netAmount(Int) | Net amount. |
numberOfUnits(Int) | Number of units. |
pricePerUnit(Int) | Price per unit. |
product(String) | Product code. |
Example
{
"product": "abc123",
"numberOfUnits": 1,
"pricePerUnit": 1,
"netAmount": 1,
"currency": "abc123"
}Fields
| Name | Description |
|---|---|
currency(String) | Currency. |
grossAmount(Float) | Gross amount. |
netAmount(Float) | Net amount. |
numberOfUnits(Int) | Number of units. |
pricePerUnit(Float) | Price per unit. |
product(String) | Product code. |
Example
{
"product": "abc123",
"numberOfUnits": 1,
"pricePerUnit": 1.0,
"netAmount": 1.0,
"grossAmount": 1.0,
"currency": "abc123"
}HardshipAgreementType
Represents a Hardship Agreement for a particular Account.
Fields
| Name | Description |
|---|---|
createdAt(DateTime!) | |
endDate(Date) | |
exitReason(HardshipAgreementExitReason) | |
exitReasonDetails(String) | Extra details for the exit reason |
hardshipDetails(String!) | These are internal notes detailing the hardship. |
hardshipEntryReason(HardshipAgreementHardshipEntryReason) | |
hardshipType(HardshipAgreementHardshipType!) | |
id(ID!) | |
paymentPlanDetails(String!) | |
startDate(Date!) |
Example
{
"id": "abc123",
"hardshipType": "DEATH_IN_FAMILY",
"hardshipDetails": "abc123",
"hardshipEntryReason": "SELF_IDENTIFIED",
"paymentPlanDetails": "abc123",
"startDate": "2020-01-01",
"endDate": "2020-01-01",
"exitReason": "INITIAL_PAYMENT_PLAN_NOT_ESTABLISHED",
"exitReasonDetails": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z"
}HasFamilyIssues
Mutation to flag a user for Family Domestic Violence (FDV) / family issues.
The possible errors that can be raised are:
- KT-AU-5418: Invalid input for family issues mutation.
- KT-AU-5416: Family issues flag cannot be removed through this mutation.
- KT-AU-5417: Account not found for user.
- KT-AU-5419: Cannot set delivery preference 'EMAIL' for user without an email specified.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
accountUser(AccountUserType) | The updated account user. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountUser": AccountUserType
}Fields
| Name | Description |
|---|---|
isHeld(Boolean) | Whether a statement is currently held. |
reason(String) | Reason for statement being held. |
Example
{
"isHeld": true,
"reason": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) | |
problems([AcquisitionProblemType]!) | A list of problems that blocked the move in. |
Example
{
"message": "abc123",
"problems": AcquisitionProblemType
}Fields
| Name | Description |
|---|---|
discoveryStatus(Status) | Current status of discovery. |
marketIdentifier(String) | The market identifier discovered. |
reference(String) | The discovery process reference. |
Example
{
"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. |
Example
{
"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. |
Example
{
"pageInfo": PageInfo,
"edges": ImportReadingsEdge,
"totalCount": 1,
"edgeCount": 1
}ImportReadingsEdge
A Relay edge containing a ImportReadings and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Reading) | The item at the end of the edge |
Example
{
"node": Reading,
"cursor": "abc123"
}InitiateHostedStandalonePayment
Initiate a standalone payment and return the url where the customer can complete it.
The possible errors that can be raised are:
- KT-CT-1128: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3943: Invalid ledger.
- KT-CT-3957: No collection method provided.
- KT-CT-3958: Provide either ledger ID or ledger number.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
payment(InitiateHostedStandalonePaymentOutput) | The details required to refer to and complete a hosted payment. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": InitiateHostedStandalonePaymentOutput
}InitiateHostedStandalonePaymentOutput
Tokens required to collect and retrieve a standalone payment.
Fields
| Name | Description |
|---|---|
retrievalToken(String!) | The retrieval token for this standalone payment. |
url(String!) | The url for the customer to complete the payment. |
Example
{
"retrievalToken": "abc123",
"url": "abc123"
}InitiateProductSwitch
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4619: Quote with given code not found.
- KT-CT-4624: Unable to accept the given product code.
- KT-CT-4924: Unauthorized.
- KT-CT-4626: No product selected for the given quote code.
- KT-CT-4719: No supply point found for identifier provided.
- KT-CT-1509: Unable to create agreement.
- KT-CT-1507: Agreement product switch date is not within the acceptable range.
- KT-CT-4640: Unable to get market or client params from quoted product.
- KT-CT-4627: No products are available for this quote.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
productCode(String!) | The selected product for a specific product switch. |
switchDate(Date!) | The date at which the product switch becomes effective. |
Example
{
"possibleErrors": [PossibleErrorType],
"productCode": "abc123",
"switchDate": "2020-01-01"
}InitiateStandalonePayment
Initiate a standalone payment and return the client secret required to complete it.
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3943: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
payment(InitiateStandalonePaymentOutput) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"payment": InitiateStandalonePaymentOutput
}InitiateStandalonePaymentOutput
Tokens required to collect and retrieve a standalone payment.
Fields
| Name | Description |
|---|---|
retrievalToken(String!) | The retrieval token for this standalone payment. |
secretToken(String!) | The secret used to collect the payment. |
Example
{
"retrievalToken": "abc123",
"secretToken": "abc123"
}Fields
| Name | Description |
|---|---|
all([InkContactChannelIdentity!]!) | All contacts for this conversation. |
default(InkContactChannelIdentity) | The default contact for this conversation. |
Example
{
"default": InkContactChannelIdentity,
"all": InkContactChannelIdentity
}Fields
| Name | Description |
|---|---|
channel(InkCommunicationChannel!) | The channel of the contact. |
displayName(String!) | The name to display to the user. |
handle(String!) | The handle. |
Example
{
"channel": "EMAIL",
"handle": "abc123",
"displayName": "abc123"
}Fields
| Name | Description |
|---|---|
accountNumber(String) | The number of the Kraken account that the conversation is from. |
accountUsers([AccountUserType!]) | The account users on the conversation. |
buckets([InkBucket!]) | The buckets the conversation is currently in. |
contactChannelIdentities(InkContactChannelIdentities!) | The contact channel identities associated with this conversation. |
events(InkConversationEventsConnection!) | Conversation events. |
id(ID!) | |
status(InkConversationStatus!) | The status of the conversation. |
tags([InkTag!]) | The tags on the conversation. |
Example
{
"id": "abc123",
"status": "OPEN",
"contactChannelIdentities": InkContactChannelIdentities,
"accountUsers": [AccountUserType],
"accountNumber": "abc123",
"events": InkConversationEventsConnection
}Fields
| Name | Description |
|---|---|
edges([InkConversationEventsEdge!]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
Example
{
"pageInfo": PageInfo,
"edges": InkConversationEventsEdge
}InkConversationEventsEdge
A Relay edge containing a InkConversationEvents and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(InkConversationEvent!) | The item at the end of the edge |
Example
{
"node": InkNewMessage,
"cursor": "abc123"
}InkEmail
This type wraps around the Message type for emails.
Fields
| Name | Description |
|---|---|
attachments([InkMessageAttachment!]!) | Attachments on the message. |
cc([String!]!) | CC recipients on the message. |
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
conversationId(Int!) | The integer ID of the conversation this message belongs to. |
conversationRelayId(String!) | The relay ID of the conversation this message belongs to. |
delivery(InkMessageDelivery!) | The delivery status of the message. |
direction(InkMessageDirection!) | The direction of the email. |
displayContent(String!) | The content of the message. |
fromHandle(String!) | From email address. |
isChannelEmail(Boolean!) | Is this an message an email. |
occurredAt(DateTime!) | The time the message was sent/received. |
subject(String!) | The email subject. |
tags([InkTag!]!) | All Tags associated with a message. |
toHandles([String!]) | The addresses that the message was sent to. |
Example
{
"direction": "INBOUND",
"toHandles": ["abc123"],
"fromHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"subject": "abc123",
"displayContent": "abc123",
"attachments": InkMessageAttachment,
"cc": "abc123",
"isChannelEmail": true,
"conversationId": 1,
"conversationRelayId": "abc123"
}InkGenericMessage
This message type is used for messages that belong to contact channels without a more granular message type.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
conversationId(Int!) | The integer ID of the conversation this message belongs to. |
conversationRelayId(String!) | The relay ID of the conversation this message belongs to. |
delivery(InkMessageDelivery!) | The delivery status. |
direction(InkMessageDirection!) | The direction of the message. |
displayContent(String!) | The content of the message. |
fromHandle(String!) | The identity the message was sent from. |
id(ID!) | The ID of the object |
occurredAt(DateTime!) | The time the message was sent/received at. |
toHandle(String!) | The identity the message was sent to. |
Example
{
"id": "abc123",
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"displayContent": "abc123",
"conversationId": 1,
"conversationRelayId": "abc123"
}InkLine
This type wraps around the Message type for LINE message.
Fields
| Name | Description |
|---|---|
attachments([InkMessageAttachment!]!) | Attachments on the LINE message. |
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
delivery(InkMessageDelivery!) | The delivery status of the message. |
direction(InkMessageDirection!) | The direction of the message. |
fromHandle(String!) | From LINE id. |
isChannelLine(Boolean!) | Is this a LINE message. |
lineMessage(LineMessage!) | The line message content. |
occurredAt(DateTime!) | The time the message was sent/received. |
tags([InkTag!]!) | All Tags associated with a message. |
toHandle(String!) | To LINE id. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"lineMessage": LineTextMessage,
"isChannelLine": true,
"attachments": InkMessageAttachment
}InkLiveChatConversation
Ink live chat
Fields
| Name | Description |
|---|---|
relayId(ID!) | The relay ID of the live chat conversation. |
Example
{
"relayId": "abc123"
}InkLiveChatMessage
This type wraps around the Message type for a Live Chat message.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
delivery(InkMessageDelivery!) | The delivery status. |
direction(InkMessageDirection!) | The direction of the message. |
displayContent(String!) | The content of the message. |
fromHandle(String!) | The identity the message was sent from. |
id(ID!) | The ID of the object |
occurredAt(DateTime!) | The time the message was sent/received at. |
toHandle(String!) | The identity the message was sent to. |
Example
{
"id": "abc123",
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"displayContent": "abc123"
}Fields
| Name | Description |
|---|---|
fetchUrl(String) | The url for fetching the attachment. |
filename(String!) | The filename. |
sizeInBytes(Int) | The size in bytes. |
Example
{
"filename": "abc123",
"fetchUrl": "abc123",
"sizeInBytes": 1
}Fields
| Name | Description |
|---|---|
status(InkMessageDeliveryStatus!) | Message delivery status. |
Example
{
"status": "PENDING"
}InkNewMessage
This types is used for both the message-received and message-sent conversation events.
Fields
| Name | Description |
|---|---|
message(InkMessage!) | The message. |
occurredAt(DateTime!) | The time the conversation event occurred. |
Example
{
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": InkEmail
}InkPost
This type wraps around the Message type for Post.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
conversationId(Int!) | The integer ID of the conversation this message belongs to. |
conversationRelayId(String!) | The relay ID of the conversation this message belongs to. |
displayContent(String!) | The notes left when a message was uploaded. |
fromHandle(String!) | The from property id. |
isChannelPost(Boolean!) | Determine if the message is a post message. |
rawPlainTextContent(String!) | The content of the message. |
toHandle(String!) | The to property id. |
Example
{
"fromHandle": "abc123",
"toHandle": "abc123",
"displayContent": "abc123",
"rawPlainTextContent": "abc123",
"isChannelPost": true,
"contactChannelIdentity": InkContactChannelIdentity,
"conversationId": 1,
"conversationRelayId": "abc123"
}InkSMS
This type wraps around the Message type for SMS.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | The contact channel identity. |
delivery(InkMessageDelivery!) | The delivery status. |
direction(InkMessageDirection!) | The direction of the message. |
displayContent(String!) | The content of the message. |
fromHandle(String!) | The phone number the message was sent from. |
isChannelSms(Boolean!) | Is this an SMS message. |
occurredAt(DateTime!) | The time the message was sent/received at. |
tags([InkTag!]!) | All Tags associated with a message. |
toHandle(String!) | The phone number the message was sent to. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"displayContent": "abc123",
"isChannelSms": true
}InkTwilioWhatsApp
This type wraps around the Message type for a Twilio WhatsApp message.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | Twilio WhatsApp message contact channel identity. |
delivery(InkMessageDelivery!) | Message delivery status. |
direction(InkMessageDirection!) | The direction of the message. |
fromHandle(String!) | From WhatsApp number. |
occurredAt(DateTime!) | Date when the conversation event was created. |
tags([InkTag!]!) | All Tags associated with a message. |
toHandle(String!) | To WhatsApp number. |
vendorId(String) | The vendor id. |
whatsappContent(WhatsAppTextMessage!) | Whatsapp message content. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"vendorId": "abc123",
"whatsappContent": WhatsAppTextMessage
}InkWhatsApp
This type wraps around the Message type for WhatsApp message.
Fields
| Name | Description |
|---|---|
contactChannelIdentity(InkContactChannelIdentity!) | Whatsapp message contact channel identity. |
delivery(InkMessageDelivery!) | Whatsapp message delivery status. |
direction(InkMessageDirection!) | The direction of the message. |
fromHandle(String!) | From WhatsApp phone number. |
isChannelWhatsapp(Boolean!) | Whether or not the message is a whatsapp message. |
occurredAt(DateTime!) | Date when the conversation event was created. |
tags([InkTag!]!) | All Tags associated with a message. |
toHandle(String!) | Whatsapp contact phone number. |
vendorId(String) | The vendor id. |
whatsappContent(WhatsAppTextMessage!) | Whatsapp message content. |
Example
{
"direction": "INBOUND",
"fromHandle": "abc123",
"toHandle": "abc123",
"delivery": InkMessageDelivery,
"contactChannelIdentity": InkContactChannelIdentity,
"occurredAt": "2020-01-01T00:00:00.000Z",
"vendorId": "abc123",
"whatsappContent": WhatsAppTextMessage,
"isChannelWhatsapp": true
}InputFieldErrorType
Represents a validation error for a specific input field.
Fields
| Name | Description |
|---|---|
errorMessage(String!) | The error message to display for this field. |
inputFieldKey(String!) | The key of the input field with the error. |
inputFieldValue(String!) | The value that was submitted for the field. |
Example
{
"inputFieldKey": "abc123",
"inputFieldValue": "abc123",
"errorMessage": "abc123"
}Fields
| Name | Description |
|---|---|
characteristic(CharacteristicType) | The product characteristic. |
integerValue(Int!) | The integer value of the characteristic. |
value(String) | A string representation of a characteristic value, for convenience. |
Example
{
"value": "abc123",
"characteristic": CharacteristicType,
"integerValue": 1
}IntegerType
Graphene type object to represent integer values
Fields
| Name | Description |
|---|---|
integerValue(Int!) | Value of this field. |
Example
{
"integerValue": 1
}Fields
| Name | Description |
|---|---|
accumulation(Decimal) | Deprecated The 'accumulation' field is deprecated. |
durationInSeconds(Int!) | The duration of the measurement. |
endAt(DateTime!) | The end datetime of the measurement. |
metaData(MeasurementsMetadataOutput) | This type will return more granular data about the measurement. |
readAt(DateTime!) | The datetime the measurement was taken. |
source(String!) | The data source of the measurement. |
startAt(DateTime!) | The start datetime of the measurement. |
unit(String!) | The unit of the measurement. |
value(Decimal!) | The value of the measurement. |
Example
{
"source": "abc123",
"metaData": MeasurementsMetadataOutput,
"value": "1.0",
"unit": "abc123",
"readAt": "2020-01-01T00:00:00.000Z",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z",
"durationInSeconds": 1,
"accumulation": "1.0"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}InvalidatePaymentInstruction
Invalidates a payment instruction.
The possible errors that can be raised are:
- KT-CT-3926: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
instruction(InvalidatePaymentInstructionOutput) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"instruction": InvalidatePaymentInstructionOutput
}InvalidatePaymentInstructionOutput
Output for invalidating an arbitrary payment instruction.
Fields
| Name | Description |
|---|---|
id(Int) |
Example
{
"id": 1
}InvalidatePreSignedToken
Invalidate a previously issued expiring/pre-signed token.
This mutation can be used to invalidate the token itself.
To invalidate tokens issued to a particular user, use InvalidatePreSignedTokensForUser mutation.
The possible errors that can be raised are:
- KT-CT-1129: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
token(PreSignedToken) |
Example
{
"possibleErrors": [PossibleErrorType],
"token": PreSignedToken
}InvoiceBillingDocumentConnectionTypeConnection
An invoice is a bill that contains individual transactions (i.e. charges, credits, payments, and repayments). These may come from any period of time.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([InvoiceBillingDocumentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": InvoiceBillingDocumentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}InvoiceBillingDocumentConnectionTypeEdge
A Relay edge containing a InvoiceBillingDocumentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(InvoiceBillingDocumentType) | The item at the end of the edge |
Example
{
"node": InvoiceBillingDocumentType,
"cursor": "abc123"
}InvoiceBillingDocumentType
An invoice is a bill that contains individual transactions (i.e. charges, credits, payments, and repayments). These may come from any period of time.
Fields
| Name | Description |
|---|---|
annulledBy(AnnulmentBillingDocumentType) | Billing document that annuls this invoice. |
documentDebtPosition(BillingDocumentPositionType) | Position of the billing document in the delinquent debt tracking system. |
firstIssued(DateTime) | First time the invoice was issued. |
id(Int) | Unique identifier for the invoice billing document. |
invoicedAmount(Int) | The invoiced amount of the billing document. |
number(String) | The unique billing document's reference that can be used for identifying it externally. |
paymentDueDate(Date) | The date due for payment for the invoice. |
pdfUrl(String) | URL to the PDF of the Invoice. |
totalCharges(InvoiceTotalType) | The total amounts for all charges on the invoice. |
totalCredits(InvoiceTotalType) | The total amounts for all credits on the invoice. |
transactions(BillTransactionConnectionTypeConnection) | Transactions on the invoice Arguments
The order in which to return the transactions. |
Example
{
"id": 1,
"firstIssued": "2020-01-01T00:00:00.000Z",
"pdfUrl": "abc123",
"annulledBy": AnnulmentBillingDocumentType,
"number": "abc123",
"invoicedAmount": 1,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"transactions": BillTransactionConnectionTypeConnection,
"documentDebtPosition": BillingDocumentPositionType,
"paymentDueDate": "2020-01-01"
}Fields
| Name | Description |
|---|---|
grossTotal(Int) | The gross total amount for the statement (in minor currency units). |
netTotal(Int) | The net total amount for the statement (in minor currency units). |
taxTotal(Int) | The total amount of tax on the statement (in minor currency units). |
Example
{
"netTotal": 1,
"taxTotal": 1,
"grossTotal": 1
}Fields
| Name | Description |
|---|---|
attachments(BillingAttachmentConnectionTypeConnection) | |
billType(BillTypeEnum) | The type of the bill. |
fromDate(Date) | The date of the bill is covered from. |
grossAmount(Int) | This field returns the total gross amount of the bill in pence. |
id(ID) | The ID of the bill. |
identifier(String) | The unique identifier of a bill. It will usually be present on the billing document itself. Note: a bill that hasn't been issued yet will not have an identifier; and not all issued bills will have an identifier assigned to them, in which case this will be null. |
isAnnulled(Boolean!) | Whether the billing document has been annulled. |
issuedDate(Date) | The date the bill was sent to the customer. |
representations(BillRepresentationConnectionTypeConnection) | |
reversalsAfterClose(StatementReversalsAfterClose!) | How many charges have been reversed after the close date. |
temporaryUrl(String) | Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
toDate(Date) | The date of the bill is covered to. |
totalCharges(InvoiceTotalType) | The total amounts for all charges on the invoice. |
totalCredits(InvoiceTotalType) | The total amounts for all credits on the invoice. |
totalPayments(Int) | The sum of all previous payments made that are included towards this invoice. |
transactions(BillTransactionConnectionTypeConnection) | Transactions on the given billing document. Arguments
When provided, only entries that are linked to that ledger are returned.
The order in which to return the transactions.
Include only these specific transaction types in the result. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"identifier": "abc123",
"grossAmount": 1,
"isAnnulled": true,
"totalCharges": InvoiceTotalType,
"totalCredits": InvoiceTotalType,
"totalPayments": 1,
"transactions": BillTransactionConnectionTypeConnection,
"representations": BillRepresentationConnectionTypeConnection
}ItemProfileType
Represents the characteristics and configuration of an ordered item.
Fields
| Name | Description |
|---|---|
characteristics(JSONString) | The characteristic values for this item profile. |
Example
{
"characteristics": {"key": "value"}
}JoinSupplierAcceptTermsAndConditions
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-4501: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean) | Indicator that the mutation has completed successfully. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([JoinSupplierLedgerAssignmentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": JoinSupplierLedgerAssignmentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}JoinSupplierLedgerAssignmentConnectionTypeEdge
A Relay edge containing a JoinSupplierLedgerAssignmentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(JoinSupplierLedgerAssignmentType) | The item at the end of the edge |
Example
{
"node": JoinSupplierLedgerAssignmentType,
"cursor": "abc123"
}JoinSupplierLedgerAssignmentType
A ledger with its associated supply points.
Multiple supply points may be assigned to the same ledger. This type groups them for convenient querying.
Fields
| Name | Description |
|---|---|
ledgerName(String) | The ledger name. |
ledgerNumber(String) | The ledger number. |
ledgerSupplyPoints([LedgerSupplyPointType]) | The supply points associated with the ledger. |
ledgerType(String) | The ledger type. |
Example
{
"ledgerNumber": "abc123",
"ledgerType": "abc123",
"ledgerName": "abc123",
"ledgerSupplyPoints": [LedgerSupplyPointType]
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([JoinSupplierProcessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": JoinSupplierProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}JoinSupplierProcessConnectionTypeEdge
A Relay edge containing a JoinSupplierProcessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(JoinSupplierProcessType) | The item at the end of the edge |
Example
{
"node": JoinSupplierProcessType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
affiliateLink(AffiliateLinkType) | Affiliate link for the join supplier journey. |
note(String) | The note associated with this join supplier process data. |
offerGroupIdentifier(NonEmptyString) | Unique identifier for the offer group. |
requestedAt(DateTime!) | When the journey was requested. |
salesChannel(String) | Sales channel. |
salesSubchannel(String) | Sales subchannel. |
storedPaymentMethodDetailsReference(String) | Reference to the stored payment method details. |
supplyPointContexts([SupplyPointContextDataInterface]) | The supply point context data. |
Example
{
"requestedAt": "2020-01-01T00:00:00.000Z",
"salesChannel": "abc123",
"salesSubchannel": "abc123",
"offerGroupIdentifier": NonEmptyString,
"supplyPointContexts": SupplyPointContextDataInterface,
"note": "abc123",
"storedPaymentMethodDetailsReference": "abc123"
}JoinSupplierProcessType
Represents a Join Supplier process.
Fields
| Name | Description |
|---|---|
currentProcessData(JoinSupplierProcessDataType) | The current process data associated with the Join Supplier process. |
id(ID) | The ID or the primary key of the lifecycle process. |
ledgerAssignments(JoinSupplierLedgerAssignmentConnectionTypeConnection) | The ledgers associated with the supply points in the process. |
number(String) | The unique identifier of the process. |
status(LifecycleSupplyPointProcessStatus) | The status of the process. |
subtype(String) | The subtype of the process. |
supplyPoints(SupplyPointConnectionTypeConnection!) | The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"supplyPoints": SupplyPointConnectionTypeConnection,
"number": "abc123",
"subtype": "abc123",
"currentProcessData": JoinSupplierProcessDataType,
"ledgerAssignments": JoinSupplierLedgerAssignmentConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
identifier(String) | The unique identifier for the sales record. |
opportunityNumber(String) | The opportunity code associated with the sales record. |
Example
{
"identifier": "abc123",
"opportunityNumber": "abc123"
}Fields
| Name | Description |
|---|---|
affiliateOrganisationName(String) | The name of the affiliate organisation associated with the sales record. |
identifier(String) | The unique identifier for the sales record. |
salesChannel(String) | The sales channel associated with the sales record. |
Example
{
"identifier": "abc123",
"salesChannel": "abc123",
"affiliateOrganisationName": "abc123"
}KrakenVersionType
Information about what version of Kraken is being executed by this service.
Fields
| Name | Description |
|---|---|
SHA(String) | The git commit SHA that is being executed. |
isPinned(Boolean) | Whether this version is pinned to a specific version. |
number(String) | The version number that is being executed. |
Example
{
"number": "abc123",
"SHA": "abc123",
"isPinned": true
}Fields
| Name | Description |
|---|---|
lnspId(String) | The LNSP id (Local Network Service Provider). |
tariffPeriods([TariffPeriodType]) | Tariff periods for this rate and LNSP. |
Example
{
"lnspId": "abc123",
"tariffPeriods": [TariffPeriodType]
}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. |
Example
{
"id": "abc123",
"shortName": "abc123",
"longName": "abc123",
"displayName": "abc123",
"emergencyPhoneNumber": "abc123",
"outagePhoneNumber": "abc123"
}LeadsEdge
A Relay edge containing a Leads and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Lead) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([LeavePropertyProcessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": LeavePropertyProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}LeavePropertyProcessConnectionTypeEdge
A Relay edge containing a LeavePropertyProcessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(LeavePropertyProcessType) | The item at the end of the edge |
Example
{
"node": LeavePropertyProcessType,
"cursor": "abc123"
}LeavePropertyProcessType
Represents a Leave Property process.
Fields
| Name | Description |
|---|---|
id(ID) | The ID or the primary key of the lifecycle process. |
status(LifecycleSupplyPointProcessStatus) | The status of the process. |
supplyPoints(SupplyPointConnectionTypeConnection!) | The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"supplyPoints": SupplyPointConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([LeaveSupplierProcessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": LeaveSupplierProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}LeaveSupplierProcessConnectionTypeEdge
A Relay edge containing a LeaveSupplierProcessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(LeaveSupplierProcessType) | The item at the end of the edge |
Example
{
"node": LeaveSupplierProcessType,
"cursor": "abc123"
}LeaveSupplierProcessType
Represents a Leave Supplier process. Conceptually, it contains information related to supply points that are associated with a Leave Supplier journey.
Fields
| Name | Description |
|---|---|
id(ID) | The ID or the primary key of the lifecycle process. |
number(String) | The unique identifier of the process. |
status(LifecycleSupplyPointProcessStatus) | The status of the process. |
subtype(String) | The subtype of the process. |
supplyPoints(SupplyPointConnectionTypeConnection!) | The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"number": "abc123",
"supplyPoints": SupplyPointConnectionTypeConnection,
"subtype": "abc123"
}Fields
| Name | Description |
|---|---|
externalIdentifier(String) | Supply point external identifier. Empty string if not set. |
marketName(String) | Market name for the supply point. |
Example
{
"externalIdentifier": "abc123",
"marketName": "abc123"
}LedgerType
Ledgers provide the foundation of Kraken’s bookkeeping functionality. Similar to a bank account, they allow us to keep track of financial activity on a particular Kraken account.
Fields
| Name | Description |
|---|---|
acceptsPayments(Boolean) | Whether payments can be posted onto this ledger. |
affectsAccountBalance(Boolean) | Whether this ledger's balance contributes to the account's balance. |
agreements(AgreementConnection) | The charged supply agreements of the ledger. |
amountOwedByCustomer(Int) | The amount owed from the customer perspective. A positive value implies the customer owes the business, while a negative amount implies the customer is in credit. |
balance(Int) | The current balance on the ledger in minor units of currency. |
creditTransferPermissionsData(CreditTransferPermissionsDataType) | Permissions data for credit transfers involving the given ledger. |
currentDirectDebitInstructionInvalidatedWithVendor(Boolean) | True if the current direct debit instruction has been invalidated by vendor. False otherwise. |
debtLedger(LedgerType) | The debt ledger assigned to this ledger. |
id(ID) | Deprecated The 'ledgerId' field is deprecated. |
invoices(InvoiceBillingDocumentConnectionTypeConnection) | An invoice is a bill that contains individual transactions (i.e. charges, credits, payments, and repayments). These may come from any period of time. Arguments
Exclude invoices that were issued by external systems. Does not apply to legacy bills.
The id of the invoice.
The order the invoices should be returned in. |
ledgerType(String) | The ledger type code. |
name(String) | The display name of the ledger. |
number(String) | The canonical name of the ledger. |
paymentAdequacy(PaymentAdequacyDetailsType) | |
paymentPreferenceAtTime(PaymentPreferenceUnion) | The customer's preferred payment method at a point in time. The possible errors that can be raised are:
Arguments
The time at which to know the payment preference. |
paymentPreferences(PaymentPreferenceConnectionTypeConnection) | The customer's preferred payment methods. |
paymentsWithNonConcludedRePresentation(PaymentWithNonConcludedRePresentationConnectionTypeConnection) | Payments with non-concluded re-presentation. |
refundRequests(RefundRequestConnectionTypeConnection) | Refund requests for a given ledger. |
repaymentRequests(RepaymentRequestConnectionTypeConnection) | Repayment requests for a given ledger. |
statements(StatementBillingDocumentConnectionTypeConnection) | A statement is a billing document that contains all entries on a ledger during a period of time. A customer can understand how their ledger's balance has changed by looking at each statement in series. |
supportsInvoices(Boolean) | Is it possible for this ledger to contain invoices. |
supportsStatements(Boolean) | Is it possible for this ledger to contain statements. |
transactions(TransactionConnectionTypeConnection) | Transactions on the given ledger. Arguments
Optional date representing the beginning of the postedDate range filter. This date value is inclusive.
The order in which to return the transactions.
Optional date representing the end of the postedDate range filter. This date value is exclusive.
Include only these specific transaction types in the result. |
usablePaymentInstructions(PaymentInstructionConnectionTypeConnection) | The usable payment instructions for this ledger. |
Example
{
"id": "abc123",
"name": "abc123",
"number": "abc123",
"ledgerType": "abc123",
"balance": 1,
"amountOwedByCustomer": 1,
"affectsAccountBalance": true,
"statements": StatementBillingDocumentConnectionTypeConnection,
"invoices": InvoiceBillingDocumentConnectionTypeConnection,
"transactions": TransactionConnectionTypeConnection,
"repaymentRequests": RepaymentRequestConnectionTypeConnection,
"refundRequests": RefundRequestConnectionTypeConnection,
"acceptsPayments": true,
"paymentAdequacy": PaymentAdequacyDetailsType,
"creditTransferPermissionsData": CreditTransferPermissionsDataType,
"paymentPreferences": PaymentPreferenceConnectionTypeConnection,
"paymentPreferenceAtTime": PreferredInstruction,
"debtLedger": LedgerType,
"agreements": AgreementConnection,
"usablePaymentInstructions": PaymentInstructionConnectionTypeConnection,
"supportsStatements": true,
"supportsInvoices": true,
"currentDirectDebitInstructionInvalidatedWithVendor": true,
"paymentsWithNonConcludedRePresentation": PaymentWithNonConcludedRePresentationConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
details(String) | |
id(ID!) | |
isOwnedByKraken(Boolean) | |
lifeSupportDate(Date) | |
lifeSupportEquipment(LifeSupportEquipment) | |
lifeSupportStatus(LifeSupportStatus) | |
preferredContactMethod(LifeSupportPreferredContactMethod) |
Example
{
"id": "abc123",
"isOwnedByKraken": true,
"lifeSupportStatus": "REGISTERED_NO_MEDICAL_CONFIRMATION",
"lifeSupportEquipment": "OXYGEN_CONCENTRATOR",
"lifeSupportDate": "2020-01-01",
"details": "abc123",
"preferredContactMethod": "POSTAL_ADDRESS"
}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]) |
Example
{
"hasLifeSupportRecord": true,
"records": [LifeSupportRecordType]
}Fields
| Name | Description |
|---|---|
joinSupplierProcesses(JoinSupplierProcessConnectionTypeConnection) | List of JoinSupplierProcess for an account. |
leavePropertyProcesses(LeavePropertyProcessConnectionTypeConnection) | List of LeavePropertyProcess for an account. |
leaveSupplierProcesses(LeaveSupplierProcessConnectionTypeConnection) | List of LeaveSupplierProcess for an account. |
occupyPropertyProcesses(OccupyPropertyProcessConnectionTypeConnection) | List of OccupyPropertyProcess for an account. |
Example
{
"leaveSupplierProcesses": LeaveSupplierProcessConnectionTypeConnection,
"joinSupplierProcesses": JoinSupplierProcessConnectionTypeConnection,
"occupyPropertyProcesses": OccupyPropertyProcessConnectionTypeConnection,
"leavePropertyProcesses": LeavePropertyProcessConnectionTypeConnection
}LineCommonError
A base error type. Should be used for general application or lower level errors.
Fields
| Name | Description |
|---|---|
field(String) | The field that for which this error should be associated. |
message(String!) | The error message to display to the user. |
Example
{
"message": "abc123",
"field": "abc123"
}LineEmoji
A LINE specific emoji object. refs: https://developers.line.biz/en/reference/messaging-api/#text-message
Fields
| Name | Description |
|---|---|
emojiId(String!) | The emoji id. |
index(Int!) | The location of the emoji in the message. |
length(Int) | The length of the emoji string placeholder. |
productId(String!) | The product id. |
Example
{
"index": 1,
"length": 1,
"productId": "abc123",
"emojiId": "abc123"
}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!) |
Example
{
"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",
"currency": "AUD_CENTS",
"chargeTarget": "abc123",
"rate": RateInterface,
"charge": AccountChargeType,
"consumptionIsEstimated": true
}LineLinkRedirectResponse
Link Successful. Complete link process with LINE.
Fields
| Name | Description |
|---|---|
redirectUrl(String!) |
Example
{
"redirectUrl": "abc123"
}Fields
| Name | Description |
|---|---|
keywords([String!]!) | Keywords describing the sticker. |
packageId(String!) | Sticker package id. |
resourceType(String!) | Sticker resource type. |
stickerId(String!) | Sticker id. |
text(String!) | Text used to customize some stickers. |
Example
{
"packageId": "abc123",
"stickerId": "abc123",
"resourceType": "abc123",
"keywords": "abc123",
"text": "abc123"
}Fields
| Name | Description |
|---|---|
displayContent(String!) | The display content. |
emojis([LineEmoji!]) | The emojis in the message. |
Example
{
"displayContent": "abc123",
"emojis": [LineEmoji]
}LinkActionType
An action which navigates to any URL.
Fields
| Name | Description |
|---|---|
id(ID) | Unique identifier of the object. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
url(String!) | The URL to navigate to. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"url": "abc123"
}LinkTokenNotFound
Returned when no LineAccountLink record matching the parameters exists.
Fields
| Name | Description |
|---|---|
type(LineLinkErrorType!) | The type of error that occurred. |
Example
{
"type": "NO_MATCHING_LINE_LINK"
}Fields
| Name | Description |
|---|---|
averageMonthlyCharge(Int) | The combined average montly cost for all markets based on usage. |
balanceAdjustment(Int) | Suggested temporary adjustment to ongoing usage amount to cover debt or overpayment. |
consumption(ConsumptionBreakdownConnectionTypeConnection) | Breakdown of customer's estimated or real usage per market and per month. |
currentBalance(Int) | The balance the ledger has at the time of review. |
existingMonthlyAmount(Int) | The amount the customer is paying monthly at the time of the review. |
reviewedOn(Date) | The date that we used to calculate the review of the ledger. |
suggestedNewMonthlyAmount(Int) | The suggested monthly payment amount in minor currency following the payment adequacy review. |
targetBalance(Int) | The balance we expect the ledger to have at the end period of the review. |
Example
{
"suggestedNewMonthlyAmount": 1,
"consumption": ConsumptionBreakdownConnectionTypeConnection,
"averageMonthlyCharge": 1,
"existingMonthlyAmount": 1,
"balanceAdjustment": 1,
"currentBalance": 1,
"targetBalance": 1,
"reviewedOn": "2020-01-01"
}LoyaltyPointLedgerEntryType
A Loyalty Point ledger entry.
Fields
| Name | Description |
|---|---|
accountNumber(String) | The account number associated with the entry. |
balanceBroughtForward(String) | Equal to the |
balanceCarriedForward(String) | Equal to the |
id(ID!) | |
idempotencyKey(UUID) | A unique idempotency key for the operation. |
ledgerType(String) | The |
postedAt(DateTime) | The date the points were added to the ledger. |
reasonCode(String) | The reason the entry was being added. |
value(String) | The value of the charge or credit. |
Example
{
"id": "abc123",
"ledgerType": "abc123",
"value": "abc123",
"balanceBroughtForward": "abc123",
"balanceCarriedForward": "abc123",
"reasonCode": "abc123",
"idempotencyKey": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"postedAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123"
}Fields
| Name | Description |
|---|---|
isEligible(Boolean) | Whether the account is eligible to join the loyalty points program. |
primaryIneligibilityReason(String) | The primary reason for ineligibility, if any. |
Example
{
"isEligible": true,
"primaryIneligibilityReason": "abc123"
}Fields
| Name | Description |
|---|---|
scheme(String) | The loyalty scheme in use. |
Example
{
"scheme": "abc123"
}Fields
| Name | Description |
|---|---|
accountPayment(AccountPaymentType) |
Example
{
"accountPayment": AccountPaymentType
}Example
{
"message": "abc123",
"field": "abc123"
}MarketSupplyQuotedProductConnectionTypeConnection
Pagination for quoted products.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([MarketSupplyQuotedProductConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MarketSupplyQuotedProductConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}MarketSupplyQuotedProductConnectionTypeEdge
A Relay edge containing a MarketSupplyQuotedProductConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(MarketSupplyQuotedProductType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}MarketSupplyQuotedSupplyPointConnectionTypeConnection
Pagination for quoted supply points.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([MarketSupplyQuotedSupplyPointConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MarketSupplyQuotedSupplyPointConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}MarketSupplyQuotedSupplyPointConnectionTypeEdge
A Relay edge containing a MarketSupplyQuotedSupplyPointConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(MarketSupplyQuotedSupplyPointType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
errors([ErrorType]) | A list of any errors that occurred while running this mutation. |
token(String) | A Kraken Token that can be used to authenticate to the API, masquerading as the desired user. |
Example
{
"token": "abc123",
"errors": [ErrorType]
}Fields
| Name | Description |
|---|---|
amount(Int) | The maximum amount available to be requested as a refund. |
reasonToRecommendAmount(MaximumRefundReasonChoices) | The reason why a specific amount is the maximum available to be requested as a refund. |
recommendedBalance(Int) | The recommended minimum balance an account should have when asking for a refund. |
Example
{
"amount": 1,
"reasonToRecommendAmount": "MAX_AVAILABLE_AMOUNT",
"recommendedBalance": 1
}MeasurementConnection
Pagination for measurements.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([MeasurementEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MeasurementEdge,
"totalCount": 1,
"edgeCount": 1
}MeasurementEdge
A Relay edge containing a Measurement and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(MeasurementInterface) | The item at the end of the edge |
Example
{
"node": MeasurementInterface,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
metaData(MeasurementsMetadataOutput) | This type will return more granular data about the measurement. |
readAt(DateTime!) | The datetime the measurement was taken. |
source(String!) | The data source of the measurement. |
unit(String!) | The unit of the measurement. |
value(Decimal!) | The value of the measurement. |
Example
{
"source": "abc123",
"metaData": MeasurementsMetadataOutput,
"value": "1.0",
"unit": "abc123",
"readAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
extras([ExtrasOutput]) | Extras relating to the parent measurement node. |
statistics([StatisticOutput]) | Statistics relating to the parent measurement node. |
utilityFilters(UtilityFiltersOutput) | The source information relating to the parent measurement node. |
Example
{
"utilityFilters": ElectricityFiltersOutput,
"statistics": [StatisticOutput],
"extras": [ExtrasOutput]
}MessageEdge
A Relay edge containing a Message and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(Message) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}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!) |
Example
{
"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]
}Fields
| Name | Description |
|---|---|
key(String!) | The key for the metadata. |
value(JSONString) | The metadata value. |
Example
{
"key": "abc123",
"value": {"key": "value"}
}MeterDetailType
GraphQL type for MeterDetail attrs dataclass.
Fields
| Name | Description |
|---|---|
capabilityType(String) | Meter capability type. |
category(String) | Meter category. |
id(ID!) | Meter ID. |
isSmart(Boolean!) | Whether the meter is a smart meter. |
make(String) | Meter make. |
meterPointReference(String) | Meter point reference. |
model(String) | Meter model. |
numberOfDigits(Int) | Number of digits on the meter display. |
readings(ReadingConnectionTypeConnection) | All readings for the meter. |
serialNumber(String) | Meter serial number. |
status(String) | Meter status. |
Example
{
"id": "abc123",
"serialNumber": "abc123",
"meterPointReference": "abc123",
"isSmart": true,
"category": "abc123",
"make": "abc123",
"model": "abc123",
"numberOfDigits": 1,
"capabilityType": "abc123",
"status": "abc123",
"readings": ReadingConnectionTypeConnection
}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) |
Example
{
"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"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}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. |
agreements([AusAgreementInterface]) | A list of agreements belonging to an account that is linked to the logged in user. Arguments
|
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
This field requires the Arguments
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
How granular the returned results should be.
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
Include estimated readings.
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
Olson timezone identifier to use (e.g. |
criticalLoadFlag(Boolean) | Indicates if the meter point is classified as critical load. |
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. |
depotCode(String) | The code of the depot that services the meter point. |
depotDescription(String) | The description of the depot that services the meter point. |
disconnectionMethod(String) | The method of disconnection for the meter point. |
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. |
feeder(String) | The high voltage distribution feeder that supplies the meter point. |
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. |
lnspSupplyEndDate(DateTime) | The end datetime of the distributor's supply contract for the meter point. |
lnspSupplyStartDate(DateTime) | The start datetime of the distributor's supply contract for the meter point. |
mainSubstation(String) | |
meters([ElectricityMeterType]) | The electricity meters installed at this meter point. |
nmiChecksum(String) | The check character that is sometimes suffixed to the NMI. For the NMI itself, refer to the |
nmiClassification(String) | The NMI classification describing the flow of electricity at the connection point, e.g. SMALL, LARGE, GENERATR. |
outageContact(OutageContactType) | The outage contact for the meter point. |
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: 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
Include basic meters.
Include estimated readings.
Include readings that have been quarantined in Kraken.
Include registers that cannot be billed.
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. |
sharedFuseGroupIdentifier(String) | The shared fuse group identifier for the meter point. |
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
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
This field requires the Deprecated The 'standingChargesSummary' field is deprecated. Arguments
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
How granular the returned results should be
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
Olson timezone identifier to use (e.g. |
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
This field requires the Arguments
|
status(String) | The Financial Responsible Market Participant status. Deprecated The 'status' field is deprecated. |
substation(String) | The distribution substation that supplies the meter point. |
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. |
Example
{
"id": 1,
"meters": [ElectricityMeterType],
"status": "abc123",
"agreements": AusAgreementInterface,
"identifier": "abc123",
"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",
"substation": "abc123",
"mainSubstation": "abc123",
"feeder": "abc123",
"depotCode": "abc123",
"depotDescription": "abc123",
"criticalLoadFlag": true,
"outageContact": OutageContactType,
"lnspSupplyStartDate": "2020-01-01T00:00:00.000Z",
"lnspSupplyEndDate": "2020-01-01T00:00:00.000Z",
"disconnectionMethod": "abc123",
"sharedFuseGroupIdentifier": "abc123"
}MeterReadingEstimationReadingConnection
Paginator for estimations of meter readings.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([MeterReadingEstimationReadingEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": MeterReadingEstimationReadingEdge,
"totalCount": 1,
"edgeCount": 1
}MeterReadingEstimationReadingEdge
A Relay edge containing a MeterReadingEstimationReading and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(MeterReadingEstimationReadingType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
serialNumber(String!) | The serial number of the meter. |
Example
{
"serialNumber": "abc123"
}Fields
| Name | Description |
|---|---|
deviceType(String) | The type of MFA device. |
isConfirmed(Boolean) | Whether the MFA device is confirmed or not. |
Example
{
"deviceType": "abc123",
"isConfirmed": true
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
error(MoveInDatesErrorUnion) | Potential error message for the query. |
moveInDates([Date]) | Suitable dates for a move in. |
Example
{
"moveInDates": ["2020-01-01"],
"error": DoesNotExistErrorType
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
error(MoveOutDatesErrorUnion) | |
moveOutDates([Date]) |
Example
{
"moveOutDates": ["2020-01-01"],
"error": DoesNotExistErrorType
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
field(String!) | The input field that matched more than one object in the database. |
Example
{
"field": "abc123"
}Fields
| Name | Description |
|---|---|
nmi(String!) | The supply point identifier (NMI) for the record. |
Example
{
"nmi": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"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!) | |
id(ID!) | |
name(String!) | Human readable name for the app. |
pushNotificationBindings([PushNotificationBindingType!]!) | |
service(NotifiableApplicationService!) |
Example
{
"id": "abc123",
"name": "abc123",
"bundleId": "abc123",
"service": "GCM",
"externalProvider": "PINPOINT",
"externalProjectId": "abc123",
"description": "abc123",
"pushNotificationBindings": PushNotificationBindingType
}ObtainKrakenJSONWebToken
The unifying approach used to get a Kraken token (JWT: JSON Web Token) with different types of input.
The currently supported inputs are: - account user email/password combination - account user API key - organization live secret key - pre-signed key - refresh token
The possible errors that can be raised are:
- KT-CT-1135: Invalid data.
- KT-CT-1134: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
payload(GenericScalar!) | The body payload of the Kraken Token. The same information can be obtained by using JWT decoding tools on the value of the |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
refreshExpiresIn(Int) | A Unix timestamp representing the point in time at which the refresh token will expire. |
refreshToken(String) | A token that can be used in a subsequent call to |
token(String!) | The Kraken Token. Can be used in the |
Example
{
"possibleErrors": [PossibleErrorType],
"token": "abc123",
"payload": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"refreshToken": "abc123",
"refreshExpiresIn": 1
}OccupancyPeriodType
An occupancy period for a property.
Fields
| Name | Description |
|---|---|
accountNumber(String) | Account number associated with this occupancy period. |
effectiveFrom(DateTime) | Date the occupancy period is effective from. |
effectiveTo(DateTime) | Date the occupancy period is effective to. |
id(ID) | The unique ID of the occupancy period. |
isOccupier(Boolean) | Whether the account associated with the occupancy period is an occupier account type. |
numberOfOccupants(Int) | Number of occupants associated with this occupancy period. |
Example
{
"id": "abc123",
"effectiveFrom": "2020-01-01T00:00:00.000Z",
"effectiveTo": "2020-01-01T00:00:00.000Z",
"isOccupier": true,
"accountNumber": "abc123",
"numberOfOccupants": 1
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([OccupyPropertyProcessConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": OccupyPropertyProcessConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}OccupyPropertyProcessConnectionTypeEdge
A Relay edge containing a OccupyPropertyProcessConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OccupyPropertyProcessType) | The item at the end of the edge |
Example
{
"node": OccupyPropertyProcessType,
"cursor": "abc123"
}OccupyPropertyProcessType
Represents a Occupy Property process.
Fields
| Name | Description |
|---|---|
id(ID) | The ID or the primary key of the lifecycle process. |
occupyAt(DateTime!) | |
status(LifecycleSupplyPointProcessStatus) | The status of the process. |
supplyPoints(SupplyPointConnectionTypeConnection!) | The supply points associated with the process. |
Example
{
"id": "abc123",
"status": "PENDING",
"occupyAt": "2020-01-01T00:00:00.000Z",
"supplyPoints": SupplyPointConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
createdAt(DateTime) | The date and time when Offer Group was created. |
createdBy(ActorType) | The Actor who created the Offer Group. |
identifier(ID) | Identifier of the Offer Group. |
offers([OfferType]) | One or more Offers contained in the Offer Group. |
Fields
| Name | Description |
|---|---|
acceptedAt(DateTime) | The date and time when Offer was accepted. |
createdBy(ActorType) | The Actor who created the Offer. |
description(String) | Description of the Offer. |
identifier(ID) | Identifier of the Offer. |
quote(QuoteType_) | The Quote this Offer is related to. |
rejectedAt(DateTime) | The date and time when Offer was rejected. |
validFrom(DateTime) | The date and time from which the Offer becomes valid. |
validTo(DateTime) | The date and time until which the Offer remains valid. |
Example
{
"identifier": "abc123",
"quote": QuoteType_,
"description": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"acceptedAt": "2020-01-01T00:00:00.000Z",
"rejectedAt": "2020-01-01T00:00:00.000Z",
"createdBy": ActorType
}OnSiteJobsAppointmentActionConnectionTypeEdge
A Relay edge containing a OnSiteJobsAppointmentActionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OnSiteJobsAppointmentActionType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}OnSiteJobsAppointmentConnectionTypeEdge
A Relay edge containing a OnSiteJobsAppointmentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OnSiteJobsAppointmentType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}OnSiteJobsAssetConnectionTypeEdge
A Relay edge containing a OnSiteJobsAssetConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OnSiteJobsAssetType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}OnSiteJobsJobTypeType
Represents a job type available for on-site jobs requests.
Fields
| Name | Description |
|---|---|
id(String!) | The unique identifier for the job type. |
name(String!) | The human-readable name of the job type. |
Example
{
"id": "abc123",
"name": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([OnSiteJobsRequestActionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": OnSiteJobsRequestActionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}OnSiteJobsRequestActionConnectionTypeEdge
A Relay edge containing a OnSiteJobsRequestActionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OnSiteJobsRequestActionType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}OnSiteJobsRequestConnectionTypeEdge
A Relay edge containing a OnSiteJobsRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OnSiteJobsRequestType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([OpportunitiesEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": OpportunitiesEdge,
"totalCount": 1,
"edgeCount": 1
}OpportunitiesEdge
A Relay edge containing a Opportunities and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(OpportunityOutput) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}OrderDetailsType
Represents the details of an Order.
Fields
| Name | Description |
|---|---|
order(OrderType) | The order details. The possible errors that can be raised are:
|
resources([OrderResource]) | The resources associated with the order. The possible errors that can be raised are:
|
status(OrderStatus) | The current status of the order. The possible errors that can be raised are:
|
Example
{
"status": "PENDING"
}OrderItemType
Represents an item being ordered.
Fields
| Name | Description |
|---|---|
code(NonEmptyString) | The code identifying the item. |
marketData(JSONString) | Market-specific data for the item. |
profile(ItemProfileType) | The profile containing characteristics of the item. |
Example
{
"profile": ItemProfileType,
"marketData": {"key": "value"},
"code": NonEmptyString
}OrderLineDateRangeType
Represents a period defined by specific start and end dates.
Fields
| Name | Description |
|---|---|
end(DateTime) | The end date and time of the period. Null indicates an infinite/rolling period. |
start(DateTime!) | The start date and time of the period. |
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z"
}OrderLineDurationType
Represents a period defined by duration in seconds.
Fields
| Name | Description |
|---|---|
duration(Float!) | The duration in seconds. |
Example
{
"duration": 1.0
}OrderLineType
Represents a line item in an order.
Fields
| Name | Description |
|---|---|
item(OrderItemType) | The item being ordered. |
period(OrderLinePeriodType) | The period for which this order line is valid. Can be a range or a duration. |
target(AccountType) | The target customer for this order line. |
terms([TermInterface]) | The terms applicable to this order line. |
Example
{
"item": OrderItemType,
"period": OrderLineDateRangeType,
"target": AccountType,
"terms": TermInterface
}Fields
| Name | Description |
|---|---|
businessName(String) | The business name of the outage contact. |
emailAddress1(String) | The primary email address of the contact person. |
familyName(String) | The family name of the contact person. |
givenName(String) | The given name of the contact person. |
lastModifiedAt(DateTime) | The date and time when the contact person was last modified by the initiator. |
nameType(PersonNameType) | The name type. |
phone1(ContactPersonPhoneType) | The primary phone details of the contact person. Deprecated The 'phone1' field is deprecated. |
phone2(ContactPersonPhoneType) | The secondary phone details of the contact person. Deprecated The 'phone2' field is deprecated. |
phoneNumber1(String) | The primary phone number of the contact person. Deprecated The 'phoneNumber1' field is deprecated. |
phoneNumber1ServiceType(String) | The primary phone number service type of the contact person. Deprecated The 'phoneNumber1ServiceType' field is deprecated. |
phoneNumber2(String) | The secondary phone number of the contact person. Deprecated The 'phoneNumber2' field is deprecated. |
phoneNumber2ServiceType(String) | The secondary phone number service type of the contact person. Deprecated The 'phoneNumber2ServiceType' field is deprecated. |
phones([ContactPersonPhoneType]) | The list of phone details of the contact person. |
postalAddress(RichAddressType) | The postal address of the contact person. |
suffix(String) | The suffix of the contact person. |
title(String) | The title of the contact person. |
Example
{
"businessName": "abc123",
"title": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"suffix": "abc123",
"emailAddress1": "abc123",
"phoneNumber1": "abc123",
"phoneNumber1ServiceType": "abc123",
"phoneNumber2": "abc123",
"phoneNumber2ServiceType": "abc123",
"postalAddress": RichAddressType,
"nameType": "AKA",
"lastModifiedAt": "2020-01-01T00:00:00.000Z",
"phone1": ContactPersonPhoneType,
"phone2": ContactPersonPhoneType,
"phones": [ContactPersonPhoneType]
}PageInfo
The Relay compliant PageInfo type, containing data necessary to paginate this connection.
Fields
| Name | Description |
|---|---|
endCursor(String) | When paginating forwards, the cursor to continue. |
hasNextPage(Boolean!) | When paginating forwards, are there more items? |
hasPreviousPage(Boolean!) | When paginating backwards, are there more items? |
startCursor(String) | When paginating backwards, the cursor to continue. |
Example
{
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123",
"endCursor": "abc123"
}Example
{
"role": "abc123",
"party": "abc123"
}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 Deprecated The 'amount' field is deprecated. |
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
balanceCarriedForward(Int) | The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
billingDocumentIdentifier(ID) | The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document. |
createdAt(DateTime) | The date time when the transaction is created. |
hasStatement(Boolean) | Returns True if the transaction is linked with a statement. |
id(ID) | Unique identifier for the transaction. |
isAccountCharge(Boolean) | Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
isAccountPayment(Boolean) | Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
isCredit(Boolean) | Deprecated. Deprecated The 'isCredit' field is deprecated. |
isHeld(Boolean) | Whether the statement this transaction is on has been held. A held statement is not sent to a customer automatically, but is instead marked for manual attention by operations staff. Returns False if a statement is not linked with the transaction. |
isIssued(Boolean) | Whether this transaction has been issued on any billing document.Note: Look for the most recently issued transaction instead of looking through all transactions as some accounts may have initial transactions that were not issued.This will return False if the transaction is not associated with any billing documents. |
isLateFailedPayment(Boolean!) | Whether a payment has been reversed due to a late failure.Sometimes a payment is marked cleared, only for Kraken to be notified days/weeks later that the payment has failed. |
isReversed(Boolean!) | |
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. |
title(String) | Human-readable title describing the transaction. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123",
"isLateFailedPayment": true,
"paymentTransactionType": "DD_FIRST_COLLECTION",
"methodCDR": "DIRECT_DEBIT"
}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. |
Example
{
"isCurrentlyExempt": true
}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) |
Example
{
"isEligibleForPaymentExtension": true,
"requestedAt": "AFTER_DUE_DATE",
"isInVictoria": true
}Fields
| Name | Description |
|---|---|
paymentExtensionEligibility(PaymentExtensionEligibilityType) | Payment extension eligibility information. |
paymentExtensionOptions(PaymentExtensionOptionsType) | Options for setting up a payment extension. |
Example
{
"paymentExtensionOptions": PaymentExtensionOptionsType,
"paymentExtensionEligibility": PaymentExtensionEligibilityType
}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. |
Example
{
"payInFull": "2020-01-01",
"weekly": "2020-01-01",
"fortnightly": "2020-01-01",
"fullAmount": 1,
"instalmentAmount": 1
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentForecastConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentForecastConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentForecastConnectionTypeEdge
A Relay edge containing a PaymentForecastConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentForecastType) | The item at the end of the edge |
Example
{
"node": PaymentForecastType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amount(Int) | |
date(Date) | |
method(ScheduleType) | The payment method used for the forecasted payment. |
paymentNumber(Int) |
Example
{
"paymentNumber": 1,
"date": "2020-01-01",
"amount": 1,
"method": "BACS_TRANSFER"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentInstructionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentInstructionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentInstructionConnectionTypeEdge
A Relay edge containing a PaymentInstructionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentInstructionType) | The item at the end of the edge |
Example
{
"node": PaymentInstructionType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
accountUser(AccountUserType) | The account user who is an owner of this payment instruction. |
business(BusinessType) | The business who is an owner of this payment instruction. |
Example
{
"accountUser": AccountUserType,
"business": BusinessType
}PaymentInstructionType
Payment Instructions
Fields
| Name | Description |
|---|---|
accountHolder(String!) | |
accountType(String) | |
bankCode(String) | |
cardExpiryMonth(Int) | |
cardExpiryYear(Int) | |
cardNumber(String!) | |
cardPaymentNetwork(String) | |
cardType(String) | |
iban(String!) | |
id(ID!) | |
instructionType(String!) | |
maskedAccountIdentifier(String) | A masked reference to a recurring payment method. |
owners([PaymentInstructionOwnerType]) | The owners of the financial account this instruction represents. |
sortCode(String!) | |
status(String!) | |
supplementaryLedger(SupplementaryLedgerType) | The supplementary ledger for this payment instruction. |
validFrom(DateTime!) | |
vendor(String!) |
Example
{
"id": "abc123",
"status": "abc123",
"sortCode": "abc123",
"iban": "abc123",
"accountHolder": "abc123",
"instructionType": "abc123",
"cardPaymentNetwork": "abc123",
"cardExpiryMonth": 1,
"cardExpiryYear": 1,
"supplementaryLedger": SupplementaryLedgerType,
"bankCode": "abc123",
"accountType": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"vendor": "abc123",
"cardNumber": "abc123",
"cardType": "abc123",
"maskedAccountIdentifier": "abc123",
"owners": [PaymentInstructionOwnerType]
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentPlanConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentPlanConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentPlanConnectionTypeEdge
A Relay edge containing a PaymentPlanConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentPlanType) | The item at the end of the edge |
Example
{
"node": PaymentPlanType,
"cursor": "abc123"
}PaymentPlanPaymentType
An object that represents a planned payment for a payment plan.
Example
{
"payableDate": "2020-01-01",
"amount": 1,
"paymentType": "abc123"
}Fields
| Name | Description |
|---|---|
amount(Int!) | The payable amount of this payment. |
payableDate(Date!) | The payable date of this payment. |
Example
{
"payableDate": "2020-01-01",
"amount": 1
}PaymentPlanType
An object that represents a payment plan.
Fields
| Name | Description |
|---|---|
acceptedAt(DateTime) | |
account(AccountType!) | |
id(ID!) | |
initialScheduleType(String!) | |
ledgerNumber(String) | The ledger number for this payment plan or None if one does not exist. |
nextPayment(PaymentPlanPaymentType) | The next planned payment for this payment plan. |
offerExpiresAt(DateTime) | |
offeredAt(DateTime) | |
payments([PaymentPlanPaymentType!]!) | |
status(String!) | |
strategyDisplayName(String) | The display name of the strategy used for this payment plan or None if one does not exist. |
strategyName(String!) | |
updatedAt(DateTime!) |
Example
{
"id": "abc123",
"account": AccountType,
"initialScheduleType": "abc123",
"strategyName": "abc123",
"status": "abc123",
"offeredAt": "2020-01-01T00:00:00.000Z",
"offerExpiresAt": "2020-01-01T00:00:00.000Z",
"acceptedAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"payments": PaymentPlanPaymentType,
"nextPayment": PaymentPlanPaymentType,
"strategyDisplayName": "abc123",
"ledgerNumber": "abc123"
}PaymentPreferenceConnectionTypeConnection
Pagination object for PaymentPreferenceUnion
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentPreferenceConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentPreferenceConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentPreferenceConnectionTypeEdge
A Relay edge containing a PaymentPreferenceConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentPreferenceUnion) | The item at the end of the edge |
Example
{
"node": PreferredInstruction,
"cursor": "abc123"
}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]) |
Example
{
"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. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentRequestConnectionTypeEdge
A Relay edge containing a PaymentRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentRequestType) | The item at the end of the edge |
Example
{
"node": PaymentRequestType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
customerAmount(Int) | The amount the customer is expected to pay in minor currency. |
expectedPaymentDate(Date) | The date the payment is expected to be made. |
fundingSourceAmounts(FundingSourceAmountConnectionTypeConnection) | The amount that was funded by each funding source. |
paymentStatus(String) | The status of the payment. |
totalAmount(Int) | The total amount of the payment in minor currency. |
Example
{
"expectedPaymentDate": "2020-01-01",
"paymentStatus": "abc123",
"totalAmount": 1,
"customerAmount": 1,
"fundingSourceAmounts": FundingSourceAmountConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
paymentRequest(PaymentRequestConnectionTypeConnection) | A list of payment requests for a given ledger. |
Example
{
"paymentRequest": PaymentRequestConnectionTypeConnection
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentScheduleConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentScheduleConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentScheduleConnectionTypeEdge
A Relay edge containing a PaymentScheduleConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentScheduleType) | The item at the end of the edge |
Example
{
"node": PaymentScheduleType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
args(JSONString) | The arguments of the delay configuration. |
code(String) | The code of the delay configuration. |
Example
{
"code": "abc123",
"args": {"key": "value"}
}Fields
| Name | Description |
|---|---|
description(String) | A human-readable description of the value. |
direction(PaymentDayDirectionType) | Direction of payment day. |
Example
{
"direction": "OF_MONTH",
"description": "abc123"
}PaymentScheduleType
An object that represents when we have agreed to take payments from a payment instruction.
Fields
| Name | Description |
|---|---|
delayConfiguration(PaymentScheduleDelayConfigurationType) | The delay configuration for this payment schedule. |
id(ID!) | |
isExemptFromPaymentAdequacy(Boolean) | If the payment schedule is exempt from payment adequacy. |
isPaymentHoliday(Boolean) | |
isVariablePaymentAmount(Boolean!) | |
ledgerNumber(String) | The ledger number of the payment schedule. |
paymentAdequacyAdjustment(Int) | |
paymentAdequacyAdjustmentExpiryDate(Date) | |
paymentAmount(Int!) | |
paymentDay(Int) | |
paymentDayDetails(PaymentSchedulePaymentDayDetailsType) | Details of the payment_day value. |
paymentFrequency(PaymentFrequencyOptions) | The frequency of the payment schedule. |
paymentFrequencyMultiplier(Int!) | |
paymentHolidayReason(String!) | |
reason(PaymentScheduleReasonOptions) | The reason the payment schedule was created. |
scheduleType(ScheduleType) | The method of payment for the schedule. Deprecated The 'scheduleType' field is deprecated. |
supplementaryLedger(SupplementaryLedgerType) | The supplementary ledger for this payment schedule, if it is on one. |
totalDebtAmount(Int) | The sum of the payment adequacy contributions on the payment schedule that are expected to be taken before the debt repayment is complete. |
trigger(ScheduleTrigger) | The cause for requesting payment on a schedule. |
validFrom(Date!) | |
validTo(Date) |
Example
{
"id": "abc123",
"supplementaryLedger": SupplementaryLedgerType,
"validFrom": "2020-01-01",
"validTo": "2020-01-01",
"reason": "GENERAL_ACCOUNT_PAYMENT",
"paymentHolidayReason": "abc123",
"paymentDay": 1,
"paymentFrequency": "Weekly",
"paymentFrequencyMultiplier": 1,
"paymentAmount": 1,
"paymentAdequacyAdjustment": 1,
"paymentAdequacyAdjustmentExpiryDate": "2020-01-01",
"isVariablePaymentAmount": true,
"totalDebtAmount": 1,
"isPaymentHoliday": true,
"scheduleType": "BACS_TRANSFER",
"paymentDayDetails": PaymentSchedulePaymentDayDetailsType,
"delayConfiguration": PaymentScheduleDelayConfigurationType,
"isExemptFromPaymentAdequacy": true,
"ledgerNumber": "abc123",
"trigger": "PLAN"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PaymentWithNonConcludedRePresentationConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PaymentWithNonConcludedRePresentationConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PaymentWithNonConcludedRePresentationConnectionTypeEdge
A Relay edge containing a PaymentWithNonConcludedRePresentationConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PaymentWithNonConcludedRePresentationType) | The item at the end of the edge |
Example
{
"node": PaymentWithNonConcludedRePresentationType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amountPayable(Int) | The amount expected for this payment in minor currency units. |
payableDate(Date) | The date this payment is scheduled to be debited. |
Example
{
"amountPayable": 1,
"payableDate": "2020-01-01"
}Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
accountNumber(String!) | The bill account number. |
attachments(BillingAttachmentConnectionTypeConnection) | |
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
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. |
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. |
issuedDate(Date) | The date the bill was sent to the customer. |
openingBalance(Int) | This field returns the opening balance of a statement. Arguments
When provided, the opening balance for this ledger on this statement. Required if multiple ledgers are affected by this statement. |
printedCopyRequests([Date]) | List of dates when a printed copy of this bill was requested. |
representations(BillRepresentationConnectionTypeConnection) | |
reversalsAfterClose(StatementReversalsAfterClose!) | How many charges have been reversed after the close date. |
temporaryUrl(String) | Requesting this field generates a temporary URL at which bill is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). This field can raise an error with errorClass NOT_FOUND if the bill document has not been created/issued yet. This field is deprecated use 'attachments' field instead. Deprecated The 'temporaryUrl' field is deprecated. |
toDate(Date) | The date of the constituent bill covered to. |
totalCharges(StatementTotalType) | The total amounts for all charges on the billing document. |
totalCredits(StatementTotalType) | The total amounts for all credits on the statement. |
totalRepayments(BigInt) | This field returns the total amount of repayments on a statement. |
transactions(BillTransactionConnectionTypeConnection) | Transactions on the given billing document. Arguments
When provided, only entries that are linked to that ledger are returned.
The order in which to return the transactions.
Include only these specific transaction types in the result. |
transactionsTmp(TransactionConnectionTypeConnection) | Transactions on the bill. Note: this field is temporary while we design an an updated version of these APIs for new issuance. |
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. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"identifier": "abc123",
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"isAnnulled": true,
"transactions": BillTransactionConnectionTypeConnection,
"openingBalance": 1,
"closingBalance": 1,
"documentDebtPosition": BillingDocumentPositionType,
"representations": BillRepresentationConnectionTypeConnection,
"printedCopyRequests": ["2020-01-01"],
"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
}Fields
| Name | Description |
|---|---|
buttonAction(ActionType!) | The action to perform when the button is pressed. |
buttonStyle(ButtonStyle) | The button style. |
id(ID) | Unique identifier of the object. |
title(String!) | Title text of the button. |
typename(String) | The name of the object's type. |
Example
{
"buttonStyle": "PRIMARY",
"title": "abc123",
"buttonAction": DeeplinkActionType,
"id": "abc123",
"typename": "abc123"
}Fields
| Name | Description |
|---|---|
isBlocked(Boolean) | Whether the viewer has been blocked due to spending all its allowed points. |
limit(Int) | The maximum number of points the viewer gets for requests per hour. |
remainingPoints(Int) | The remaining points for the viewer in one hour time limit. |
ttl(Int) | Time To Live: UNIX timestamp when the viewer will get a new allowance of points. |
usedPoints(Int) | The points used so far in one hour time limit. |
Example
{
"limit": 1,
"remainingPoints": 1,
"usedPoints": 1,
"ttl": 1,
"isBlocked": true
}PointsSizeType
A measurement in points.
Fields
| Name | Description |
|---|---|
id(ID) | Unique identifier of the object. |
points(Int!) | The points value. |
typename(String) | The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"points": 1
}PortfolioConnectionTypeConnection
Paginator of Operations Team
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PortfolioConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PortfolioConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PortfolioConnectionTypeEdge
A Relay edge containing a PortfolioConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PortfolioType) | The item at the end of the edge |
Example
{
"node": PortfolioType,
"cursor": "abc123"
}PortfolioType
An object that represents a portfolio.
Fields
| Name | Description |
|---|---|
accounts(AccountConnectionTypeConnection) | The accounts associated with this portfolio. |
ancestors(PortfolioConnectionTypeConnection) | The ancestors of the given portfolio. |
billingName(String) | |
brand(String) | The brand code associated with the portfolio. |
collectiveBilling(Boolean!) | |
createdAt(DateTime!) | |
depth(Int) | The depth of the portfolio in the hierarchy. |
descendants(PortfolioConnectionTypeConnection) | The descendants of the given portfolio. |
id(ID!) | |
leadAccountNumber(String) | The lead account for this portfolio. |
name(String) | The name of the portfolio. |
number(String!) | |
operationsTeam(OperationsTeamType) | Operations team for this portfolio. |
parent(PortfolioType) | The parent portfolio of the given portfolio, if any. |
updatedAt(DateTime!) |
Example
{
"id": "abc123",
"number": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"billingName": "abc123",
"collectiveBilling": true,
"leadAccountNumber": "abc123",
"brand": "abc123",
"name": "abc123",
"depth": 1,
"parent": PortfolioType,
"ancestors": PortfolioConnectionTypeConnection,
"descendants": PortfolioConnectionTypeConnection,
"accounts": AccountConnectionTypeConnection
}PortfolioUserRoleType
The role a user has in association with one portfolio.
Fields
| Name | Description |
|---|---|
id(ID!) | |
portfolio(PortfolioType!) | Portfolio object. |
role(RoleString) | The portfolio role. |
user(AccountUserType!) |
Example
{
"id": "abc123",
"user": AccountUserType,
"role": RoleString,
"portfolio": PortfolioType
}PossibleErrorType
The GraphQL error type for displaying information about GraphQL errors that might be raised from the API.
Fields
| Name | Description |
|---|---|
code(String) | The error code that might be returned from the query/mutation. |
description(String) | The error description that might be returned from the query/mutation. |
message(String) | The error message that might be returned from the query/mutation. |
type(String) | The error type that might be returned from the query/mutation. |
Example
{
"message": "abc123",
"code": "abc123",
"type": "abc123",
"description": "abc123"
}PossibleErrorsOutputType
Information and possible errors of the requested query/mutation.
Fields
| Name | Description |
|---|---|
authErrors(Boolean) | Whether the possible authentication errors are included. |
name(String) | Name of the query/mutation whose possible errors are returned. |
possibleErrors([PossibleErrorType]) | List of the errors the query/mutation is susceptible of raising. |
type(query_type) | Type of the query (query or mutation). |
Example
{
"name": "abc123",
"type": "query",
"authErrors": true,
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
attachments(BillingAttachmentConnectionTypeConnection) | |
averageDailyUsage(Float) | |
billType(BillTypeEnum) | The type of the bill. |
fromDate(Date) | The date of the constituent bill covered from. |
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. |
toDate(Date) | The date of the constituent bill covered to. |
totalConsumption(Float) | |
totalConsumptionCost(Float) | |
totalFeedInCost(Float) | |
totalFeedInEnergy(Float) | |
totalSupplyCost(Float) |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"identifier": "abc123",
"params": {"key": "value"},
"grossAmount": 1,
"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. |
Example
{
"key": "abc123",
"scope": "SUBMIT_METER_READINGS",
"isValid": true
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Example
{
"costInCents": "1.0",
"costInCentsWithGst": "1.0"
}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. |
Example
{
"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
}Fields
| Name | Description |
|---|---|
creditInCents(Decimal!) | Credit amount in cents (ex GST). |
creditInCentsWithGst(Decimal!) | Credit amount in cents (inc GST). |
Example
{
"creditInCents": "1.0",
"creditInCentsWithGst": "1.0"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}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. |
Example
{
"averageDailyChargesPredicted": PredictedBillChargeType,
"averageDailyChargesToDate": PredictedBillChargeType
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}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) |
Example
{
"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. |
Example
{
"forPaymentsAfter": "abc123",
"status": "abc123",
"paymentMethod": PaymentInstructionType
}PreviewAndCreatePaymentPlan
Mutation for previewing or creating a new payment plan.
The possible errors that can be raised are:
- KT-CT-3923: Unauthorized.
- KT-AU-3917: Unable to preview payment plan.
- KT-AU-3919: Unable to create payment plan.
- KT-AU-3918: Unable to create payment plan.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
createdPaymentPlan(PaymentPlanType) | Data for newly created payment plan of one was created. |
paymentPlanPreview([PaymentPlanPreviewPaymentType]) | Preview payments for a new payment plan. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentPlanPreview": [PaymentPlanPreviewPaymentType],
"createdPaymentPlan": PaymentPlanType
}Fields
| Name | Description |
|---|---|
amount(Decimal!) | |
unit(Unit) | Unit that monetary amount relates to eg. 27 cents per kwh. |
Example
{
"amount": "1.0",
"unit": "KILOWATT_HOURS"
}Fields
| Name | Description |
|---|---|
label(String) | Human readable label for the Gas pricing zone. |
value(String) | Identifier value for the Gas pricing zone. |
Example
{
"value": "abc123",
"label": "abc123"
}Fields
| Name | Description |
|---|---|
fromDate(Date!) | Inclusive, industrytime |
id(ID!) | |
property(PropertyType) | |
toDate(Date) | Exclusive, industrytime |
updatedAt(DateTime) | |
user(AccountUserType) |
Example
{
"id": "abc123",
"user": AccountUserType,
"property": PropertyType,
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"updatedAt": "2020-01-01T00:00:00.000Z"
}PrintAttachmentType
Represents a print attachment
Fields
| Name | Description |
|---|---|
filename(String!) | |
id(ID!) | |
s3Bucket(String!) | |
s3Key(String!) | |
temporaryUrl(String) | Temporary URL at which the attachment is available. This URL will expire after approximately an hour. It is intended for redirection purposes, NOT persistence in any form (e.g. inclusion in emails or the body of a web page). |
Example
{
"id": "abc123",
"filename": "abc123",
"s3Bucket": "abc123",
"s3Key": "abc123",
"temporaryUrl": "abc123"
}Fields
| Name | Description |
|---|---|
eventType(String!) | |
id(ID!) | The ID of the object |
message(PrintMessageType) | Print message of the print event. |
occurredAt(DateTime!) |
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": PrintMessageType
}PrintMessageType
Represents a print communication.
Fields
| Name | Description |
|---|---|
account(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!) |
Example
{
"id": "abc123",
"templateCode": "abc123",
"account": AccountType,
"attachments": [PrintAttachmentType],
"highPriority": true
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PrintMessageTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PrintMessageTypeEdge,
"totalCount": 1,
"edgeCount": 1
}PrintMessageTypeEdge
A Relay edge containing a PrintMessageType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PrintMessageType) | The item at the end of the edge |
Example
{
"node": PrintMessageType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
addonRates([AddonFamilyType]) | Groupings of product rates associated with an add on. Arguments
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
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
Optional boolean to determine the price default (only electricity).
Applies only for gas products.
Applies only for electricity products.
When false, negate any filtering done by RatesActiveAt and return every rate.
Optional postcode to determine the price zone (gas/electricity).
Return only rates active at this time. Defaults to now.
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. |
productRates([RateInterface]) | Deprecated The 'productRates' field is deprecated. |
rank(Int) | The rank of the product. |
term(Int) | The length of time during which the product benefits apply for (in months). |
Example
{
"id": "abc123",
"productRates": RateInterface,
"paginatedRates": RatesConnectionFieldConnection,
"addonRates": [AddonFamilyType],
"dmoReference": ProductDmoReferenceType,
"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
}ProductDmoReferenceType
Deprecated: only used for mass-market elec and replaced by PriceReferenceInterface above.
Fields
| Name | Description |
|---|---|
annualCost(Decimal!) | |
effectiveFrom(Date!) | The date on which the Product DMO first becomes effective |
effectiveTo(Date) | The final date on which the Product DMO is effective |
id(ID!) | |
ntcCombination([String!]!) | Network Tariff Codes that applies to the DMO Product |
planId(String) | an optional ID assigned by the vendor (e.g. EME id) |
savingPercentage(Int!) | The saving percentage variance related to the DMO |
Example
{
"id": "abc123",
"effectiveFrom": "2020-01-01",
"effectiveTo": "2020-01-01",
"ntcCombination": "abc123",
"planId": "abc123",
"annualCost": "1.0",
"savingPercentage": 1
}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) |
Example
{
"id": "abc123",
"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
}Fields
| Name | Description |
|---|---|
annualCost(Int!) | |
pricingZone(ProductReferencePricingZone!) | |
product(Product!) | The product associated with this reference. |
savingPercentage(Int!) | The saving percentage variance |
Example
{
"pricingZone": "AGLNSW",
"annualCost": 1,
"savingPercentage": 1,
"product": Product
}PropertyConnection
Paginated list of properties.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([PropertyEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": PropertyEdge,
"totalCount": 1,
"edgeCount": 1
}PropertyEdge
A Relay edge containing a Property and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(PropertyInterface) | The item at the end of the edge |
Example
{
"node": PropertyInterface,
"cursor": "abc123"
}PropertyHazardType
A hazard associated with a property.
Fields
| Name | Description |
|---|---|
category(String) | The category of the hazard type. |
code(String) | The hazard type code. |
description(String) | The hazard type description. |
hazardRemarks(String) | Remarks about the hazard. Deprecated The 'hazardRemarks' field is deprecated. |
lastVerifiedBy(String) | The user who last verified the hazard. |
lastVerifiedDate(Date) | The date the hazard was last verified. |
longDescription(String) | A detailed description of the hazard. |
name(String) | The hazard name. Deprecated The 'name' field is deprecated. |
priority(String) | The priority level of the hazard. |
Example
{
"code": "abc123",
"description": "abc123",
"category": "abc123",
"lastVerifiedBy": "abc123",
"lastVerifiedDate": "2020-01-01",
"longDescription": "abc123",
"priority": "abc123",
"name": "abc123",
"hazardRemarks": "abc123"
}PropertyMoveOut
This mutation triggers the process of leaving a property: the Leave Property core lifecycle journey.
Initially this mutation supports leaving a property with CES market supply points. In the future, it can support any market and be the one endpoint for all leave property journeys.
The possible errors that can be raised are:
- KT-CT-6622: Unauthorized.
- KT-CT-6623: Unauthorized.
- KT-AU-6610: Move out process validation failed.
- KT-AU-6611: Unable to move out of property.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
workflow(WorkflowType!) | Information on the workflow which is processing the move out. |
Example
{
"possibleErrors": [PossibleErrorType],
"workflow": WorkflowType
}Fields
| Name | Description |
|---|---|
administrativeArea(String) | Top-level administrative subdivision, e.g. US state, AU state/territory, NZ, region, IT region, JP prefecture.
|
asString(String) | The entire formatted address represented as a single string, as it would be written on an envelope. The formatting of this field may vary according to the country of the address (which may not match this Kraken installation's home country). It may also change if we update our address-formatting code or if our understanding of the correct formatting for a given country changes. Avoid parsing individual components of an address out of this field's value; use the other fields on this type instead. Arguments
Whether to include the country. The country will be spelled out in all-caps on the last line, as per Universal Postal Union standards.
Whether to include the name attached to this address.
Whether to include the postal code attached to this address. |
country(String) | ISO 3166-1 alpha-2 code of the country this address belongs
to, e.g. |
deliveryPointIdentifier(String) | Identifier used by the local postal service for this address, e.g. AU DPID, GB postcode + Delivery Point Suffix, US Zip-9 + Delivery Point. This is the value that gets encoded in the barcode printed on the envelope by large-volume bulk mail providers. |
dependentLocality(String) | UK dependent localities, or neighbourhoods or boroughs in some other locations. |
locality(String) | City or town portion of an address, e.g. US city, AU suburb/town, NZ suburb and city/town, IT comune, UK post town. |
name(String) | A personal name. |
organization(String) | The name of a business or organisation. |
postalCode(String) | Postal code (ZIP code in the US). |
sortingCode(String) | Sorting code, e.g. FR CEDEX code. This field is not used in many countries. |
streetAddress(String) | The 'street address' component. This value can (and often will) contain newline characters when appropriate. In some cases, data may appear in this field instead of the
below fields; e.g. a UK post town name may appear here
instead of in the If |
structuredStreetAddress(GenericScalar) | The 'street address' component, in a structured format. This field stores the same value as The exact structure of this value depends on the country of the address, which is not necessarily the same as the country this Kraken is configured to serve. For addresses outside of the countries listed below, this field will be left blank.
|
Example
{
"name": "abc123",
"organization": "abc123",
"streetAddress": "abc123",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "abc123",
"locality": "abc123",
"administrativeArea": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"country": "abc123",
"deliveryPointIdentifier": "abc123",
"asString": "abc123"
}Fields
| Name | Description |
|---|---|
property(PropertyType!) | The matched property. |
score(Decimal!) | A score representing the degree of confidence for a match. |
Example
{
"score": "1.0",
"property": PropertyType
}Fields
| Name | Description |
|---|---|
activeWaterMeters([MeterDetailType!]) | All active water meters for the property. |
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. |
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. |
createdAt(DateTime) | Datetime that the property was created at. |
descendants(PropertyConnection) | Descendant properties in the specified hierarchy. Returns empty list if the property is not in the hierarchy. |
electricityMeterPoints([MeterPointType]) | Deprecated The 'electricityMeterPoints' field is deprecated. |
embeddedNetwork(EmbeddedNetworkType) | The embedded network this property belongs to, if any. |
externalIdentifier(String) | External identifier for the property, if available. |
hasLifeSupportRecord(Boolean) | If the property has a current life support record. |
hazards([PropertyHazardType]) | List of hazards associated with the property. These do not come from the market data. |
id(String) | |
label(String) | An optional label for the property. |
measurements(MeasurementConnection) | Measurements at a property Arguments
Defaults to the far future which will return the most recent readings.
Latest date to return measurements for (inclusive).
Defaults to the far past which will return the oldest readings.
Earliest date to return measurements from.
Timezone to use for grouping. Defaults to Kraken localtime.
Filters for each utility being measured. |
metadata([Metadata]) | Metadata associated with the account. |
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
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. |
Example
{
"id": "abc123",
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "abc123",
"addressLine4": "abc123",
"addressLine5": "abc123",
"postcode": "abc123",
"label": "abc123",
"address": "abc123",
"richAddress": PropertyRichAddressType,
"splitAddress": ["abc123"],
"occupancyPeriods": [OccupancyPeriodType],
"coordinates": CoordinatesType,
"embeddedNetwork": EmbeddedNetworkType,
"parent": PropertyInterface,
"descendants": PropertyConnection,
"ancestors": PropertyConnection,
"measurements": MeasurementConnection,
"electricityMeterPoints": [MeterPointType],
"meterPoints": MeterPointInterface,
"benchmarks": [EnergyBenchmarkType],
"state": "AUSTRALIAN_CAPITAL_TERRITORY",
"externalIdentifier": "abc123",
"metadata": [Metadata],
"hazards": [PropertyHazardType],
"createdAt": "2020-01-01T00:00:00.000Z",
"activeWaterMeters": [MeterDetailType],
"hasLifeSupportRecord": true
}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. |
Example
{
"id": "abc123",
"shortName": "abc123",
"longName": "abc123",
"displayName": "abc123",
"emergencyPhoneNumber": "abc123",
"outagePhoneNumber": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ProvisionalTransactionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ProvisionalTransactionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ProvisionalTransactionConnectionTypeEdge
A Relay edge containing a ProvisionalTransactionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ProvisionalTransactionType) | The item at the end of the edge |
Example
{
"node": ProvisionalTransactionType,
"cursor": "abc123"
}ProvisionalTransactionType
A provisional transaction represents some debit or credit to or from a customer's account which we cannot yet finalise for some reason, but which is still useful to keep a note of, and display to the customer. Provisional transactions are purely to give guidance in the absence of finalised information. We therefore only return provisional transactions that have not been finalised. When a transaction is finalised, it is available through the transactions field.
Fields
| Name | Description |
|---|---|
amount(Int) | The amount in pence for this provisional transaction. It will be negative for charges, positive for credits. |
date(Date) | The date at which the charge should be applied to the account. |
id(ID!) | |
title(String) | A user readable string that indicates what this transaction relates to. |
Example
{
"id": "abc123",
"title": "abc123",
"amount": 1,
"date": "2020-01-01"
}PushNotificationBindingType
Represents a pairing of a single app installation to an account user.
Fields
| Name | Description |
|---|---|
application(NotifiableApplicationType!) | |
expiresAt(DateTime!) | |
id(ID!) | |
messages(PrintMessageTypeConnection!) | |
registeredAt(DateTime!) | |
token(String!) | |
user(AccountUserType!) |
Example
{
"id": "abc123",
"messages": PrintMessageTypeConnection,
"user": AccountUserType,
"token": "abc123",
"application": NotifiableApplicationType,
"registeredAt": "2020-01-01T00:00:00.000Z",
"expiresAt": "2020-01-01T00:00:00.000Z"
}QuantityType
Graphene type object to represent Quantity(magnitude, unit)
Fields
| Name | Description |
|---|---|
magnitude(Float!) | The numeric value of this field. |
unit(String!) | Unit of this field. |
Example
{
"magnitude": 1.0,
"unit": "abc123"
}Fields
| Name | Description |
|---|---|
costs([QuoteCostType]) | The cost for quoting this product. |
createdAt(DateTime) | The date and time when the quote component was created. |
identifier(ID) | Identifier of the Quote. |
productComponentIdentifier(ID) | Identifier of the Product Component. |
quotingParamsInputData([QuotingParamType]) | The input data used for quoting this product component. |
termsAndConditionsS3Urls([TermsAndConditionsS3UrlType]) | S3 URLs for terms and conditions linked to this quote component. Arguments
Expiration time for S3 URLs in seconds. Defaults to 1 hour (3600 seconds). |
Example
{
"identifier": "abc123",
"productComponentIdentifier": "abc123",
"costs": [QuoteCostType],
"quotingParamsInputData": [QuotingParamType],
"createdAt": "2020-01-01T00:00:00.000Z",
"termsAndConditionsS3Urls": [TermsAndConditionsS3UrlType]
}Fields
| Name | Description |
|---|---|
key(String!) | Name of the cost field. |
value(QuoteCostUnionType) | Value of the cost field. |
Example
{
"key": "abc123",
"value": DecimalType
}Fields
| Name | Description |
|---|---|
createdAt(DateTime) | The date and time when the quote was created. |
createdBy(ActorType) | The Actor who created the Quote. |
identifier(ID) | Identifier of the Quote. |
productOfferingIdentifier(ID) | The product offering identifier this Quote is related to. |
quoteComponents([QuoteComponentType]) | Quote components of this quote. |
Example
{
"identifier": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"productOfferingIdentifier": "abc123",
"quoteComponents": [QuoteComponentType],
"createdBy": ActorType
}Fields
| Name | Description |
|---|---|
offeringComponents([QuotedOfferingParamsType]) | Quoting components of this quote. |
offeringIdentifier(ID) | Product offering identifier. |
productComponents([QuotedProductComponentType]) | Product component data including its quoting parameters. |
Example
{
"offeringIdentifier": "abc123",
"productComponents": [QuotedProductComponentType],
"offeringComponents": [QuotedOfferingParamsType]
}Fields
| Name | Description |
|---|---|
productCode(ID) | Product code. |
quotingParams([QuotingParamType]) | Quoting parameter definitions for this product. |
Example
{
"productCode": "abc123",
"quotingParams": [QuotingParamType]
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}Fields
| Name | Description |
|---|---|
choices([String]) | Choices of the quoting parameter if present. |
name(String) | Name of the quoting parameter. |
source(String) | Source of the quoting parameter. |
type(String) | Type of the quoting parameter. |
value(String) | Value of the quoting parameter. |
Example
{
"name": "abc123",
"type": "abc123",
"choices": ["abc123"],
"source": "abc123",
"value": "abc123"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "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. |
Example
{
"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 |
Example
{
"node": RateInterface,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
intervalEnd(DateTime) | The exclusive end of this reading's interval. |
intervalStart(DateTime) | The inclusive start of this reading's interval. |
quality(String) | The quality of this reading if applicable. |
source(String) | The source of this reading if applicable. |
units(String) | This reading's units. |
value(Decimal) | The recorded value for this reading. |
Example
{
"value": "1.0",
"units": "abc123",
"intervalStart": "2020-01-01T00:00:00.000Z",
"intervalEnd": "2020-01-01T00:00:00.000Z",
"source": "abc123",
"quality": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ReadingConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ReadingConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}ReadingConnectionTypeEdge
A Relay edge containing a ReadingConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ReadingType) | The item at the end of the edge |
Example
{
"node": ReadingType,
"cursor": "abc123"
}ReadingType
A reading from a water meter.
Fields
| Name | Description |
|---|---|
holdReasons([String!]!) | List of reasons why the reading is held. |
id(ID!) | |
isHeld(Boolean!) | True if the reading is currently held. |
isQuarantined(Boolean!) | True if the reading has been quarantined. |
notes(String!) | Notes for submitting a reading. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
readingDate(Date!) | Date of reading. |
reason(String!) | The reason for the reading submission. |
source(String!) | The origin of the reading submission. |
valueCubicMetres(Decimal!) | A cumulative value displaying total consumption that can roll over when the maximum is reached. |
Example
{
"id": "abc123",
"valueCubicMetres": "1.0",
"source": "abc123",
"reason": "abc123",
"possibleErrors": [PossibleErrorType],
"readingDate": "2020-01-01",
"notes": "abc123",
"isQuarantined": true,
"isHeld": true,
"holdReasons": "abc123"
}Fields
| Name | Description |
|---|---|
exportReadings(ExportReadingsConnection) | Readings representing outgoing utility flow e.g., solar generation. |
importReadings(ImportReadingsConnection) | Readings representing incoming utility flow e.g., usage or consumption.. |
Example
{
"exportReadings": ExportReadingsConnection,
"importReadings": ImportReadingsConnection
}Fields
| Name | Description |
|---|---|
appliedTo([AppliedTo]!) | What the rebate applies to. |
creditReason(String!) | The value that populates the |
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. |
Example
{
"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"
}Fields
| Name | Description |
|---|---|
buttonAction(ActionType!) | The action to perform when the button is pressed. |
buttonStyle(ButtonStyle) | The button style. |
id(ID) | Unique identifier of the object. |
title(String!) | Title text of the button. |
typename(String) | The name of the object's type. |
variant(ButtonVariance) | Colour style of button eg. filled, outlined, text_only. |
Example
{
"buttonStyle": "PRIMARY",
"title": "abc123",
"buttonAction": DeeplinkActionType,
"id": "abc123",
"typename": "abc123",
"variant": "FILLED"
}RedeemLoyaltyPointsForAccountCredit
Redeem Loyalty Points as account credit.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9201: No Loyalty Point ledger found for the user.
- KT-CT-9202: Loyalty Points adapter not configured.
- KT-CT-9203: No ledger entries for the ledger.
- KT-CT-9205: Insufficient Loyalty Points.
- KT-CT-9206: Indivisible points.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9209: Negative Loyalty Points balance.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
pointsRedeemed(Int) | The number of loyalty points that were redeemed. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsRedeemed": 1
}RedeemReferralClaimCode
The possible errors that can be raised are:
- KT-CT-6723: Unauthorized.
- KT-CT-6724: Referral claim code not found.
- KT-CT-6725: Referral claim code redeeming error.
- KT-CT-6726: Referral claim code has already been redeemed.
- KT-CT-6727: Referral claim code is not available.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean!) | Whether or not the request was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}ReferralClaimCodeType
Referral claim code is a way of claiming promotional benefit coming from the partner-reward referral schemes.
Fields
| Name | Description |
|---|---|
accountReferral(ReferralType) | Account referral associated with the claim code. |
createdAt(DateTime) | Datetime when claim code was generated. |
id(Int) | Id of claim code instance. |
isValid(Boolean) | Whether the referral claim code is valid and available for use. |
referralScheme(ReferralSchemeType) | Referral scheme claim code belongs to. |
value(String) | Value of claim code. |
Example
{
"id": 1,
"value": "abc123",
"referralScheme": ReferralSchemeType,
"accountReferral": ReferralType,
"isValid": true,
"createdAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([ReferralConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
referringUserTotalPaymentAmount(Int!) | Total payment amount given to the referring account in the smallest unit. of the client's currency. If you filter the referrals by |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": ReferralConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1,
"referringUserTotalPaymentAmount": 1
}ReferralConnectionTypeEdge
A Relay edge containing a ReferralConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(ReferralType) | The item at the end of the edge |
Example
{
"node": ReferralType,
"cursor": "abc123"
}ReferralSchemeType
A referral scheme is a way for one account to earn a reward for referring another. This is achieved by the referred account using a url (provided by the referring account) to sign up.
Fields
| Name | Description |
|---|---|
canBeReferred(Boolean) | Whether the current account is eligible to be referred under this scheme. |
code(String) | The unique code for the scheme. |
combinedRewardAmount(Int) | The reward amount received by the referrer and the referee combined. |
isUsageAtCapacity(Boolean) | True if the the scheme has limit of uses, and if the usage is at capacity. |
loyaltyPointsBonus(Int) | The number of loyalty points to be awarded to the referrer in addition to the reward amount. |
maxRecurrence(Int) | Max number of times this referral code can be credited to a given account. |
referralDisplayUrl(String) | A referral url for display purposes. |
referralUrl(String) | A fully qualified url give people to create accounts referred by this scheme. |
referredRewardAmount(Int) | The reward amount received by the referred party. |
referrerFamilyName(String) | The family name of the person making the referral. Deprecated The 'referrerFamilyName' field is deprecated. |
referrerGivenName(String) | The given name of the person making the referral. |
referrerRewardAmount(Int) | The reward amount received by the referrer. |
schemeType(String) | Scheme type of the referral scheme. |
Example
{
"referralUrl": "abc123",
"referralDisplayUrl": "abc123",
"referrerRewardAmount": 1,
"referredRewardAmount": 1,
"combinedRewardAmount": 1,
"loyaltyPointsBonus": 1,
"canBeReferred": true,
"code": "abc123",
"referrerGivenName": "abc123",
"referrerFamilyName": "abc123",
"schemeType": "abc123",
"maxRecurrence": 1,
"isUsageAtCapacity": true
}Fields
| Name | Description |
|---|---|
business(ReferralSchemeType) | A business scheme type. |
domestic(ReferralSchemeType) | A domestic scheme type. |
friendsAndFamily(ReferralSchemeType) | A friends and family scheme type. Deprecated The 'friendsAndFamily' field is deprecated. |
Example
{
"domestic": ReferralSchemeType,
"business": ReferralSchemeType,
"friendsAndFamily": ReferralSchemeType
}ReferralType
Details of an account referral
Fields
| Name | Description |
|---|---|
code(String) | The referral code. |
combinedPaymentAmount(Int) | The payment amount in the smallest unit of the clients currency received by the referrer and the referee combined. |
id(ID!) | |
paymentDate(Date) | The date when the payment was made. |
paymentStatus(String) | The status of the payment. |
referredUserJoinDate(DateTime) | The date the referred user joined. |
referredUserName(String) | The name of the referred user. |
referredUserPaymentAmount(Int) | Payment amount given to the referred account in the smallest unit of the client's currency. |
referringUserPaymentAmount(Int) | Payment amount given to the referring account in the clients fractional currency unit. |
schemeType(ReferralSchemeTypeChoices) | The type of reward scheme. |
Example
{
"id": "abc123",
"paymentDate": "2020-01-01",
"schemeType": "REFERRAL_REWARD",
"code": "abc123",
"referredUserName": "abc123",
"paymentStatus": "abc123",
"referredUserJoinDate": "2020-01-01T00:00:00.000Z",
"referredUserPaymentAmount": 1,
"referringUserPaymentAmount": 1,
"combinedPaymentAmount": 1
}Refund
A refund to the customer from the energy supplier.
Fields
| Name | Description |
|---|---|
accountNumber(String) | Unique identifier of the account the transaction belongs to. |
amount(Int) | Gross amount including tax (when payable). Refer to the Deprecated The 'amount' field is deprecated. |
amounts(TransactionAmountType) | The net, tax and gross amounts for the transaction. Note: for payments and repayments, only the net amount is returned. |
balanceCarriedForward(Int) | The customer's resulting balance after this transaction has been applied, in the smallest unit of currency. |
billingDocumentIdentifier(ID) | The unique identifier for the most recent billing document linked with the transaction.Note: a transaction may be linked with multiple documents, but this field will only return the identifier for the most recent billing document. |
createdAt(DateTime) | The date time when the transaction is created. |
hasStatement(Boolean) | Returns True if the transaction is linked with a statement. |
id(ID) | Unique identifier for the transaction. |
isAccountCharge(Boolean) | Deprecated. Deprecated The 'isAccountCharge' field is deprecated. |
isAccountPayment(Boolean) | Deprecated. Deprecated The 'isAccountPayment' field is deprecated. |
isCredit(Boolean) | Deprecated. Deprecated The 'isCredit' field is deprecated. |
isHeld(Boolean) | Whether the statement this transaction is on has been held. A held statement is not sent to a customer automatically, but is instead marked for manual attention by operations staff. Returns False if a statement is not linked with the transaction. |
isIssued(Boolean) | Whether this transaction has been issued on any billing document.Note: Look for the most recently issued transaction instead of looking through all transactions as some accounts may have initial transactions that were not issued.This will return False if the transaction is not associated with any billing documents. |
isReversed(Boolean!) | |
note(String) | Returns the note field value for the transaction, which contains additional info. |
postedDate(Date) | Date when the transaction was posted to the account. |
reasonCode(String) | Returns the reason. |
statementId(ID) | Returns None if a statement is not linked with the transaction. Deprecated The 'statementId' field is deprecated. |
title(String) | Human-readable title describing the transaction. |
Example
{
"id": "abc123",
"postedDate": "2020-01-01",
"createdAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"amount": 1,
"amounts": TransactionAmountType,
"balanceCarriedForward": 1,
"isCredit": true,
"isAccountCharge": true,
"isAccountPayment": true,
"isHeld": true,
"isIssued": true,
"title": "abc123",
"billingDocumentIdentifier": "abc123",
"statementId": "abc123",
"isReversed": true,
"hasStatement": true,
"note": "abc123",
"reasonCode": "abc123"
}Fields
| Name | Description |
|---|---|
amount(Int) | The amount of money requested. |
payment(AccountPaymentType) | The payment which is being refunded. |
reasonCode(String) | Internal code for the reason the refund is being requested. |
requestId(ID) | The ID of the refund request. |
status(RepaymentRequestStatus) | The current status of the refund request. |
Example
{
"requestId": "abc123",
"amount": 1,
"payment": AccountPaymentType,
"reasonCode": "abc123",
"status": "REQUESTED"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([RefundRequestConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": RefundRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}RefundRequestConnectionTypeEdge
A Relay edge containing a RefundRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(RefundPaymentRequestType) | The item at the end of the edge |
Example
{
"node": RefundPaymentRequestType,
"cursor": "abc123"
}RegenerateSecretKey
Regenerate the user's API key.
Fields
| Name | Description |
|---|---|
key(String!) | The generated key value, which is only ever available once (here). |
viewer(AccountUserType) | The currently authenticated user. |
Example
{
"key": "abc123",
"viewer": AccountUserType
}RegisterNTCOverrideType
The network tariff code (NTC) the register will be billed to. This indicates the NTC has been overridden.
Example
{
"id": 1,
"effectiveNetworkTariffCode": "abc123",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
pushNotificationBinding(PushNotificationBindingType) |
Example
{
"pushNotificationBinding": PushNotificationBindingType
}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) |
Example
{
"identifier": "abc123",
"name": "abc123",
"value": "abc123",
"digits": 1,
"isQuarantined": true,
"id": 1,
"qualityFlag": "A",
"qualityMethod": "abc123"
}Fields
| Name | Description |
|---|---|
registerId(String!) | The register ID of the register. |
serialNumber(String!) | The serial number of the meter. |
Example
{
"serialNumber": "abc123",
"registerId": "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. |
Example
{
"pageInfo": PageInfo,
"edges": RegistersEdge,
"totalCount": 1,
"edgeCount": 1
}RegistersEdge
A Relay edge containing a Registers and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(DeviceRegister) | The item at the end of the edge |
Example
{
"node": DeviceRegister,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
assigneeId(ID) | The id of the user responsible for completing the reminder. |
assigneeTeamId(ID) | The id of the team responsible for completing the reminder. |
assigneeTeamName(String) | The name of the team responsible for completing the reminder. |
assigneeUsername(String) | The username of the user responsible for completing the reminder. |
content(String) | Reminder content. |
createdAt(DateTime) | The date and time the account reminder was created. |
dueAt(DateTime) | When the reminder is due. |
id(Int) | The unique ID of the reminder. |
isKrakenManaged(Boolean) | If the reminder is managed by Kraken. |
reminderTypeName(String) | The reminder type name. |
reopenInkConversation(Boolean) | Reopen ink conversation. |
Example
{
"id": 1,
"reminderTypeName": "abc123",
"isKrakenManaged": true,
"content": "abc123",
"dueAt": "2020-01-01T00:00:00.000Z",
"assigneeUsername": "abc123",
"assigneeId": "abc123",
"assigneeTeamName": "abc123",
"assigneeTeamId": "abc123",
"reopenInkConversation": true,
"createdAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
concession(ConcessionType) |
Example
{
"concession": ConcessionType
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([RepaymentRequestConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": RepaymentRequestConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}RepaymentRequestConnectionTypeEdge
A Relay edge containing a RepaymentRequestConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(RepaymentRequestType) | The item at the end of the edge |
Example
{
"node": RepaymentRequestType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
amount(Int) | The amount of money requested. |
instruction(PaymentInstructionType) | The payment instruction, if any, associated with the repayment request. |
method(RepaymentMethod) | The method by which the money will be transferred to the customer. |
reasonCode(String) | Classifier code for repayment reason. |
requestId(String) | The ID of the repayment request. |
status(RepaymentRequestStatus) | The current status of the repayment request. |
Example
{
"requestId": "abc123",
"amount": 1,
"reasonCode": "abc123",
"method": "BANK_TRANSFER",
"instruction": PaymentInstructionType,
"status": "REQUESTED"
}Fields
| Name | Description |
|---|---|
newSchedule(PaymentScheduleType) | The new payment schedule that has replaced the specified one. |
replacedSchedule(PaymentScheduleType) | The payment schedule that was replaced. |
Example
{
"replacedSchedule": PaymentScheduleType,
"newSchedule": PaymentScheduleType
}RequestCADReport
The possible errors that can be raised are:
- KT-AU-3811: Missing or invalid mutation inputs.
- KT-CT-3823: Unauthorized.
- KT-CT-6420: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
account(AccountType) | The account. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
successful(Boolean) | Whether the email with the data was sent. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountType,
"successful": true
}RequestDoubleOptIn
Request a double opt in for a consent.
This mutation will create a consent with a value of PENDING and publish a double opt-in requested transactional messaging trigger.
The possible errors that can be raised are:
- KT-CT-9019: Invalid input.
- KT-CT-9018: Account not found.
- KT-CT-1111: Unauthorized.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-9023: Consent already accepted.
- KT-CT-1199: Too many requests.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
consent(ConsentType) | The consent that was created or updated. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"consent": ConsentType
}Fields
| Name | Description |
|---|---|
email(String) | The email that requested a password reset email. |
userNumber(String) | The number of the user that requested a password reset email. |
Example
{
"email": "abc123",
"userNumber": "abc123"
}RequestPrintedBill
Request an issued bill to be printed and (re)posted to billing address of the account.
The possible errors that can be raised are:
- KT-CT-3824: Unauthorized.
- KT-CT-9705: The billing document has not been issued.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean) | Whether the request was successful. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}Fields
| Name | Description |
|---|---|
canRequestRefund(Boolean!) | Whether the account can request a refund. |
reason(String) | The reason why a refund cannot be requested. |
Example
{
"canRequestRefund": true,
"reason": "abc123"
}RequestRepaymentOutputType
Output for creating a repayment request.
Fields
| Name | Description |
|---|---|
requestId(String) | The ID of the repayment request. |
status(RepaymentRequestStatus) | The current status of the repayment request. |
Example
{
"requestId": "abc123",
"status": "REQUESTED"
}Fields
| Name | Description |
|---|---|
error(ReschedulePaymentErrorUnion) | |
newAccountPayment(AccountPaymentType) |
Example
{
"newAccountPayment": AccountPaymentType,
"error": ExceededMaxSchedulableWorkingDaysErrorType
}Fields
| Name | Description |
|---|---|
clientMutationId(String) | |
errors([SerializerFieldErrorsType]) |
Example
{
"errors": [SerializerFieldErrorsType],
"clientMutationId": "abc123"
}Fields
| Name | Description |
|---|---|
failureCodes([String]) | A list of codes of which password validation the new password failed against if applicable.
One of:
- Deprecated The 'failureCodes' field is deprecated. |
failureReasons([String]) | A list of messages of which password validations the new password failed against if applicable. Deprecated The 'failureReasons' field is deprecated. |
passwordUpdated(Boolean) | True if the password update was successful, false otherwise. Deprecated The 'passwordUpdated' field is deprecated. |
userId(ID!) | The ID of the user whose password was changed. |
Example
{
"userId": "abc123",
"passwordUpdated": true,
"failureReasons": ["abc123"],
"failureCodes": ["abc123"]
}RewardType
A reward is based on a scheme that an account has applied for in order to be
eligible for a discount. Examples can include signup, promo, or partner codes that
were applied to an account.
Fields
| Name | Description |
|---|---|
code(String) | The referral code. |
id(ID!) | |
paymentDate(Date) | The date when the payment was made. |
paymentStatus(ReferralStatusChoices) | The status of the reward payment. |
rewardAmount(Int) | Reward amount given to the account in the smallest unit of the clients currency. |
schemeType(ReferralSchemeTypeChoices) | The type of reward scheme. |
Example
{
"id": "abc123",
"paymentDate": "2020-01-01",
"schemeType": "REFERRAL_REWARD",
"code": "abc123",
"rewardAmount": 1,
"paymentStatus": "Pending"
}RichAddressType
A postal address.
This data model is based on the structure used by Google's libaddressinput library—so you can use it, or other libraries that use its data model and reference data, to accept input.
All fields can be blank, except for country which must
always be supplied.
If you only need the address in a single string, use the
asString property. If you need the address as a list of
lines, use the asString property, then use
.splitlines() (or your programming language's
equivalent) on the resulting value.
Fields
| Name | Description |
|---|---|
administrativeArea(String) | Top-level administrative subdivision, e.g. US state, AU state/territory, NZ, region, IT region, JP prefecture.
|
asString(String) | The entire formatted address represented as a single string, as it would be written on an envelope. The formatting of this field may vary according to the country of the address (which may not match this Kraken installation's home country). It may also change if we update our address-formatting code or if our understanding of the correct formatting for a given country changes. Avoid parsing individual components of an address out of this field's value; use the other fields on this type instead. Arguments
Whether to include the country. The country will be spelled out in all-caps on the last line, as per Universal Postal Union standards.
Whether to include the name attached to this address.
Whether to include the postal code attached to this address. |
country(String) | ISO 3166-1 alpha-2 code of the country this address belongs
to, e.g. |
deliveryPointIdentifier(String) | Identifier used by the local postal service for this address, e.g. AU DPID, GB postcode + Delivery Point Suffix, US Zip-9 + Delivery Point. This is the value that gets encoded in the barcode printed on the envelope by large-volume bulk mail providers. |
dependentLocality(String) | UK dependent localities, or neighbourhoods or boroughs in some other locations. |
locality(String) | City or town portion of an address, e.g. US city, AU suburb/town, NZ suburb and city/town, IT comune, UK post town. |
name(String) | A personal name. |
organization(String) | The name of a business or organisation. |
postalCode(String) | Postal code (ZIP code in the US). |
sortingCode(String) | Sorting code, e.g. FR CEDEX code. This field is not used in many countries. |
streetAddress(String) | The 'street address' component. This value can (and often will) contain newline characters when appropriate. In some cases, data may appear in this field instead of the
below fields; e.g. a UK post town name may appear here
instead of in the If |
structuredStreetAddress(GenericScalar) | The 'street address' component, in a structured format. This field stores the same value as The exact structure of this value depends on the country of the address, which is not necessarily the same as the country this Kraken is configured to serve. For addresses outside of the countries listed below, this field will be left blank.
|
Example
{
"name": "abc123",
"organization": "abc123",
"streetAddress": "abc123",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "abc123",
"locality": "abc123",
"administrativeArea": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"country": "abc123",
"deliveryPointIdentifier": "abc123",
"asString": "abc123"
}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. |
Example
{
"frmp": "abc123",
"lnsp": "abc123",
"mc": "abc123",
"mdp": "abc123",
"mpb": "abc123",
"mpc": "abc123"
}Fields
| Name | Description |
|---|---|
eventType(String!) | |
id(ID!) | The ID of the object |
message(SMSMessageType) | SMS message of the SMS event. |
occurredAt(DateTime!) |
Example
{
"id": "abc123",
"eventType": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"message": SMSMessageType
}SMSMessageType
Represents a SMS communication.
Fields
| Name | Description |
|---|---|
account(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. |
Example
{
"id": "abc123",
"sentAt": "2020-01-01T00:00:00.000Z",
"account": AccountType,
"sender": "abc123",
"recipient": "abc123",
"textBody": "abc123",
"attachments": [AttachmentType]
}Example
{
"description": "abc123",
"canReschedule": true
}ScheduleQuoteFollowUp
Schedule a quote follow up message to the provided recipient.
The possible errors that can be raised are:
- KT-CT-4619: Quote with given code not found.
- KT-CT-4632: Invalid recipient information.
- KT-CT-4633: Mutation not enabled in this environment.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
success(Boolean!) | Whether the message was scheduled successfully. |
Example
{
"possibleErrors": [PossibleErrorType],
"success": true
}Fields
| Name | Description |
|---|---|
action(String) | Whether the scheduled transaction is a 'charge' or a 'credit'. |
ancillaryData(JSONString) | Additional data that is consumed and associated with the scheduled transaction. |
displayNote(String) | Optional short note about the scheduled transaction for customer display. |
grossAmount(BigInt) | The gross amount of the scheduled transaction. |
internalNote(String) | Optional short note about the scheduled transaction for internal use. |
ledgerNumber(String) | The ledger the scheduled transaction is for. |
metadata(JSONString) | Any extra data that is associated with scheduled transaction. |
netAmount(BigInt) | The net amount of the scheduled transaction. |
postedAfter(DateTime) | The datetime after which the scheduled transaction can be added to the ledger. |
reason(String) | The reason why the scheduled transaction is added to the account. |
salesTaxAmount(BigInt) | The tax amount of the scheduled transaction. |
salesTaxRate(Decimal) | The tax rate of the scheduled transaction. |
Example
{
"action": "abc123",
"grossAmount": 1,
"netAmount": 1,
"salesTaxAmount": 1,
"salesTaxRate": "1.0",
"reason": "abc123",
"ancillaryData": {"key": "value"},
"metadata": {"key": "value"},
"internalNote": "abc123",
"displayNote": "abc123",
"postedAfter": "2020-01-01T00:00:00.000Z",
"ledgerNumber": "abc123"
}ScreenActionType
An action which calls another backend screen via its screen id.
Fields
| Name | Description |
|---|---|
allowBack(Boolean!) | Whether to allow returning to the original caller screen. |
id(ID) | Unique identifier of the object. |
params([BackendScreenParam]!) | Map of the parameters (key-value pairs) to pass to the next backend screen. |
screenId(String!) | The ID of the screen to navigate to. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"typeName": "abc123",
"screenId": "abc123",
"params": BackendScreenParam,
"allowBack": true
}SectionType
A section containing a list of cards or carousel items
Fields
| Name | Description |
|---|---|
content(SectionContent!) | The content of the section. |
id(ID) | Unique identifier of the object. |
order(Int!) | The order of the section. |
typename(String) | The name of the object's type. |
Example
{
"id": "abc123",
"typename": "abc123",
"content": CardComponentType,
"order": 1
}Fields
| Name | Description |
|---|---|
code(String) | The selected product code. |
displayName(String) | The selected product display name. |
Example
{
"code": "abc123",
"displayName": "abc123"
}Example
{
"message": "abc123",
"code": "abc123"
}Fields
| Name | Description |
|---|---|
errors([ErrorTypeUnion!]) | |
field(String) |
Example
{
"field": "abc123",
"errors": SerializerErrorType
}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. |
Example
{
"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 |
Example
{
"node": ServiceOrderChargeRecordType,
"cursor": "abc123"
}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!) |
Example
{
"id": "abc123",
"account": AccountType,
"productCode": "abc123",
"netAmount": 1,
"description": "abc123",
"effectiveAt": "2020-01-01T00:00:00.000Z",
"charge": AccountChargeType
}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 |
Example
{
"cursor": "abc123"
}SetLoyaltyPointsUser
Set the Loyalty Points user for the account.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-9214: Couldn't assign user loyalty points role.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
newLoyaltyPointsUserId(String) | ID of the new Loyalty Points user. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"newLoyaltyPointsUserId": "abc123"
}SetUpDirectDebitInstruction
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3940: Invalid data.
- KT-CT-5415: Account user not found.
- KT-CT-11103: Business not found.
- KT-CT-3971: Instruction owners are not valid.
- KT-CT-3979: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
paymentInstruction(DirectDebitInstructionType) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}SetUpDirectDebitInstructionForBusiness
The possible errors that can be raised are:
- KT-CT-3940: Invalid data.
- KT-CT-3956: Temporary error occurred.
- KT-CT-11107: Unauthorized.
- KT-CT-3948: Could not set up direct debit instruction.
- KT-CT-3971: Instruction owners are not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
paymentInstruction(DirectDebitInstructionType) | The created direct debit instruction. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}SetUpDirectDebitInstructionFromStoredDetails
The possible errors that can be raised are:
- KT-CT-3956: Temporary error occurred.
- KT-CT-3948: Could not set up direct debit instruction.
- KT-CT-3971: Instruction owners are not valid.
- KT-CT-5415: Account user not found.
- KT-CT-11103: Business not found.
- KT-CT-4123: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
paymentInstruction(DirectDebitInstructionType) | The payment instruction that was created from stored details. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": DirectDebitInstructionType
}ShareGoodsQuote
The possible errors that can be raised are:
- KT-CT-4122: Invalid email.
- KT-CT-8203: Received an invalid quote code.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
share(GoodsQuoteShare) | Goods quote shared. |
Example
{
"possibleErrors": [PossibleErrorType],
"share": GoodsQuoteShare
}ShowInputFieldErrorsActionType
An action that instructs the app to display validation errors on input fields.
Fields
| Name | Description |
|---|---|
errors([InputFieldErrorType]!) | List of field-level validation errors to display. |
id(ID) | Unique identifier of the object. |
screenId(String) | Optional ID of the form screen these errors apply to. |
typeName(String) | The name of the action object's type. |
typename(String) | The name of the object's type. |
Example
{
"typeName": "abc123",
"id": "abc123",
"typename": "abc123",
"screenId": "abc123",
"errors": InputFieldErrorType
}SpecialCircumstanceRecordType
Any special circumstances that the user has notified us about, which may entitle them to some specialist services.
Fields
| Name | Description |
|---|---|
createdAt(DateTime) | The date and time the special circumstance record was created. |
id(ID) | |
internalCode(String) | |
summary(String) |
Example
{
"id": "abc123",
"summary": "abc123",
"internalCode": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z"
}SpecialCircumstancesType
Information about the special circumstances that relate to a user.
Fields
| Name | Description |
|---|---|
isSharingConsentGiven(Boolean) | Whether the user has consented for their data to be given to the appropriate industry or regulatory bodies. We typically only ask for this once, so this field can be used to decide whether to ask the user for their initial consent. |
records([SpecialCircumstanceRecordUnion]) |
Example
{
"isSharingConsentGiven": true,
"records": SpecialCircumstanceRecordType
}Fields
| Name | Description |
|---|---|
charges([SummarizedConsumptionType!]) | Summarized standing charges. |
error(StandingChargesWindowErrorUnion) | Potential internal error types. |
Example
{
"charges": [SummarizedConsumptionType],
"error": DuplicateNTCForStandingChargeErrorType
}StartCustomerVerification
Start the customer verification using the provided verification method.
The possible errors that can be raised are:
- KT-CT-1701: Brand does not exist.
- KT-CT-4194: Verification type not supported yet.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
verificationProcess(VerificationProcess) | The newly created verification process. |
Example
{
"possibleErrors": [PossibleErrorType],
"verificationProcess": VerificationProcess
}StatementBillingDocumentConnectionTypeConnection
A statement is a billing document that contains all entries on a ledger during a period of time. A customer can understand how their ledger's balance has changed by looking at each statement in series.
Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([StatementBillingDocumentConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": StatementBillingDocumentConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}StatementBillingDocumentConnectionTypeEdge
A Relay edge containing a StatementBillingDocumentConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(StatementBillingDocumentType) | The item at the end of the edge |
Example
{
"node": StatementBillingDocumentType,
"cursor": "abc123"
}StatementBillingDocumentType
A statement is a billing document that contains all entries on a ledger during a period of time. A customer can understand how their ledger's balance has changed by looking at each statement in series.
Fields
| Name | Description |
|---|---|
annulledBy(AnnulmentBillingDocumentType) | Billing document that annuls this statement. |
documentDebtPosition(BillingDocumentPositionType) | Position of the billing document in the delinquent debt tracking system. |
earliestChargeAt(DateTime) | The earliest charge date of the statement. |
endAt(DateTime!) | The end of the statement's period. |
firstIssuedAt(DateTime) | The date and time the statement was sent to the customer. |
id(Int) | ID for the statement billing document. |
identifier(String) | The unique reference of the statement that can be used for identifying the statement externally. |
latestChargeAt(DateTime) | The latest charge date of the statement. |
paymentDueDate(Date) | The date due for payment for the statement. |
pdfUrl(String) | URL to the PDF of the statement. |
startAt(DateTime!) | The start of the statement's period. |
totalCharges(StatementTotalType) | The total amounts for all charges on the statement. |
totalCredits(StatementTotalType) | The total amounts for all credits on the statement. |
transactions(BillTransactionConnectionTypeConnection) | Transactions on the statement Arguments
The order in which to return the transactions. |
Example
{
"id": 1,
"identifier": "abc123",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z",
"firstIssuedAt": "2020-01-01T00:00:00.000Z",
"earliestChargeAt": "2020-01-01T00:00:00.000Z",
"latestChargeAt": "2020-01-01T00:00:00.000Z",
"paymentDueDate": "2020-01-01",
"pdfUrl": "abc123",
"annulledBy": AnnulmentBillingDocumentType,
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"transactions": BillTransactionConnectionTypeConnection,
"documentDebtPosition": BillingDocumentPositionType
}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. |
Example
{
"isHeld": true,
"reasons": ["abc123"]
}Fields
| Name | Description |
|---|---|
grossTotal(Int) | The gross total amount for the statement (in minor currency units). |
netTotal(Int) | The net total amount for the statement (in minor currency units). |
taxTotal(Int) | The total amount of tax on the statement (in minor currency units). |
Example
{
"netTotal": 1,
"taxTotal": 1,
"grossTotal": 1
}Fields
| Name | Description |
|---|---|
attachments(BillingAttachmentConnectionTypeConnection) | |
averageDailyUsage(Float) | This field returns the average daily usage during the time period of a statement. Arguments
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. |
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. |
toAddress(String) | Email recipient address. |
toDate(Date) | The date of the constituent bill covered to. |
totalCharges(StatementTotalType) | The total amounts for all charges on the statement. |
totalCredits(StatementTotalType) | The total amounts for all credits on the statement. |
transactions(TransactionConnectionTypeConnection) | Transactions on the bill. |
userId(Int) | Email recipient user ID. |
Example
{
"id": "abc123",
"billType": "STATEMENT",
"fromDate": "2020-01-01",
"toDate": "2020-01-01",
"temporaryUrl": "abc123",
"issuedDate": "2020-01-01",
"attachments": BillingAttachmentConnectionTypeConnection,
"reversalsAfterClose": "ALL",
"closingBalance": 1,
"openingBalance": 1,
"isExternalBill": true,
"transactions": TransactionConnectionTypeConnection,
"userId": 1,
"toAddress": "abc123",
"paymentDueDate": "2020-01-01",
"consumptionStartDate": "2020-01-01",
"consumptionEndDate": "2020-01-01",
"status": "OPEN",
"heldStatus": HeldStatus,
"totalCharges": StatementTotalType,
"totalCredits": StatementTotalType,
"averageDailyUsage": 1.0,
"isFinal": true
}Fields
| Name | Description |
|---|---|
costExclTax(EstimatedMoneyType) | Monetary cost of the statistic (excluding tax), if applicable. |
costInclTax(EstimatedMoneyType) | Monetary cost of the statistic (including tax), if applicable. |
description(String) | Description of the statistic for the parent node. |
label(String) | Display label of the statistic for the parent node. |
type(ReadingStatisticTypeEnum) | The type of statistic being measured for the parent node. |
value(Decimal) | Consumption / generation value of the statistic, if applicable. |
Example
{
"type": "STANDING_CHARGE_COST",
"label": "abc123",
"description": "abc123",
"costExclTax": EstimatedMoneyType,
"costInclTax": EstimatedMoneyType,
"value": "1.0"
}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. |
Example
{
"id": "abc123",
"name": "abc123",
"status": "SKIPPED"
}StoreDirectDebitPaymentMethodDetails
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3940: Invalid data.
- KT-CT-3956: Temporary error occurred.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
storedPaymentMethodDetailsReference(String) |
Example
{
"possibleErrors": [PossibleErrorType],
"storedPaymentMethodDetailsReference": "abc123"
}StorePaymentInstruction
Store a new payment instruction created through the embedded process.
The possible errors that can be raised are:
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-4177: Unauthorized.
- KT-CT-3822: Unauthorized.
- KT-CT-3979: Invalid ledger.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
paymentInstruction(PaymentInstructionType) | The stored payment instruction. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"paymentInstruction": PaymentInstructionType
}Fields
| Name | Description |
|---|---|
characteristic(CharacteristicType) | The product characteristic. |
stringValue(String!) | The string value of the characteristic. |
value(String) | A string representation of a characteristic value, for convenience. |
Example
{
"value": "abc123",
"characteristic": CharacteristicType,
"stringValue": "abc123"
}StringType
Graphene type object to represent string values
Fields
| Name | Description |
|---|---|
stringValue(String!) | Value of this field. |
Example
{
"stringValue": "abc123"
}SubmitCustomerFeedback
The possible errors that can be raised are:
- KT-CT-5514: Unable to submit feedback.
- KT-CT-5511: The feedback_id should be provided for feedback source.
- KT-CT-5512: The feedback doesn't match the account.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
customerFeedback(CustomerFeedbackType) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"customerFeedback": CustomerFeedbackType
}SubmitMeterReadings
Submit meter readings for one or more meters.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-6422: Reading will be held.
- KT-CT-6425: Unable to create the meter reading.
- KT-CT-6434: Meter reading could not be updated. Input not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
readings([ReadingType]) | The submitted readings. |
Example
{
"possibleErrors": [PossibleErrorType],
"readings": [ReadingType]
}SubmitRepaymentRequest
Mutation for executing the repayment request use case.
The possible errors that can be raised are:
- KT-CT-1132: Unauthorized.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3823: Unauthorized.
- KT-CT-3926: Unauthorized.
- KT-CT-3927: Invalid Amount.
- KT-CT-3928: Idempotency key used for another repayment request.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
repaymentRequest(RequestRepaymentOutputType) | The newly created repayment request. |
Example
{
"possibleErrors": [PossibleErrorType],
"repaymentRequest": RequestRepaymentOutputType
}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 |
endAt(DateTime!) | |
startAt(DateTime!) |
Example
{
"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. |
ledgerType(String) | |
name(String) | The display name of the ledger. |
number(String) | The canonical name of the ledger. |
paymentAdequacy(PaymentAdequacyDetailsType) |
Example
{
"id": "abc123",
"name": "abc123",
"ledgerType": "abc123",
"number": "abc123",
"currentBalance": 1,
"paymentAdequacy": PaymentAdequacyDetailsType
}Fields
| Name | Description |
|---|---|
agreedCapacity(String) | The agreed capacity for this supply. |
connectionUnits(String) | The connection units for this supply. |
Example
{
"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 |
period(Period!) | The period that was charged. |
Example
{
"period": Period,
"agreements": AgreementConnection
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([SupplyPointConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": SupplyPointConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}SupplyPointConnectionTypeEdge
A Relay edge containing a SupplyPointConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(SupplyPointType) | The item at the end of the edge |
Example
{
"node": SupplyPointType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
externalIdentifier(String) | Supply point external identifier. |
marketName(String) | Supply point market name. |
requestedSupplyStartDate(Date) | Requested supply start date. |
selectedProduct(SelectedProductType) | The selected product information for this supply point or None if no product is selected. |
Example
{
"externalIdentifier": "abc123",
"marketName": "abc123",
"requestedSupplyStartDate": "2020-01-01",
"selectedProduct": SelectedProductType
}SupplyPointType
Represents a SupplyPoint.
Fields
| Name | Description |
|---|---|
devices(DevicesConnection) | Get list of devices under a supply point. |
externalIdentifier(String) | The external identifier of the supply point. |
id(ID!) | The ID of the supply point. |
marketName(String!) | The market this supply point belongs to. |
property(PropertyType) | The supply point's property. |
readings(Readings) | Get readings from a readable device e.g., a supply point, device, or register. Arguments
The exclusive end of the time period as an isoformatted string.
Get readings of only this type.
The inclusive start of the time period as an isoformatted string.
Time buckets to group readings into.
The timezone in which to return readings.
Optional filter to return readings only for specific list of units or unit (e.g., KILOWATTHOURS, METERSCUBED, LITER, etc.). |
Example
{
"id": "abc123",
"marketName": "abc123",
"externalIdentifier": "abc123",
"readings": Readings,
"property": PropertyType,
"devices": DevicesConnection
}SupplyProductTagType
A product tag.
Example
{
"code": "abc123",
"displayName": "abc123"
}SupplyProductType
GraphQL type for a supply product.
Fields
| Name | Description |
|---|---|
availabilityStatus(ProductAvailability) | The product availability status. |
availableFrom(DateTime) | The date and time the product is available from. |
availableTo(DateTime) | The date and time the product is available to. |
brandCode(String) | The brand code of the product. |
code(String) | The product code. |
description(String) | The product description. |
displayName(String) | The product description. |
endsAt(DateTime) | The date the product ends. |
fullName(String) | The product title. |
id(ID!) | |
isHidden(Boolean) | Whether the product is hidden. |
marketName(String) | The name of the market the product belongs to. |
notes(String) | The product notes. |
params(JSONString) | The product parameters. |
tags([SupplyProductTagType!]!) | Tags associated with the product. |
term(Int) | The product term in months. |
termsAndConditionsTypes([TermsAndConditionsType!]!) | Active terms and conditions for a market supply product. |
termsContractType(String) | The product contract type. |
Example
{
"id": "abc123",
"code": "abc123",
"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",
"brandCode": "abc123",
"marketName": "abc123",
"availabilityStatus": "EVERYONE",
"termsContractType": "abc123",
"termsAndConditionsTypes": TermsAndConditionsType,
"params": {"key": "value"},
"tags": SupplyProductTagType
}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 |
Example
{
"cursor": "abc123"
}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) |
Example
{
"eventType": "ACCOUNT_CREATED",
"account": AccountType,
"accountUser": AccountUserType,
"syncBatchId": "abc123",
"message": "abc123"
}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. |
Example
{
"startDate": "abc123",
"endDate": "abc123",
"timeOfUse": [TimeOfUseType],
"demandThreshold": "1.0"
}Fields
| Name | Description |
|---|---|
error(String) | The error message if the task failed. |
result(JSONString) | The result of the task. |
status(TaskStatusEnum) | The status of the task. |
Example
{
"status": "STARTED",
"result": {"key": "value"},
"error": "abc123"
}TemporarySpecialCircumstanceRecordType
Any special circumstances that the user has notified us about, which may entitle them to some specialist services. These circumstances have an end date, after which they will not longer apply. Having young children is an example of this in the UK.
Fields
| Name | Description |
|---|---|
createdAt(DateTime) | The date and time the special circumstance record was created. |
expiryDate(Date) | |
id(ID) | |
internalCode(String) | |
summary(String) |
Example
{
"id": "abc123",
"summary": "abc123",
"internalCode": "abc123",
"createdAt": "2020-01-01T00:00:00.000Z",
"expiryDate": "2020-01-01"
}TerminateCreditTransferPermission
Mutation to terminate a credit transfer permission.
The possible errors that can be raised are:
- KT-CT-3822: Unauthorized.
- KT-CT-3825: Credit transfer permission not found.
- KT-CT-3827: The ledger is not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
validTo(DateTime) | Datetime when the credit transfer permission ends. |
Example
{
"possibleErrors": [PossibleErrorType],
"validTo": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"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. |
Example
{
"pageInfo": PageInfo,
"edges": TermsAndConditionsConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}TermsAndConditionsConnectionTypeEdge
A Relay edge containing a TermsAndConditionsConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(TermsAndConditionsType) | The item at the end of the edge |
Example
{
"node": TermsAndConditionsType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
name(String) | The display name of the terms and conditions. |
s3Url(String) | The S3 URL to the terms and conditions file. |
Example
{
"name": "abc123",
"s3Url": "abc123"
}Fields
| Name | Description |
|---|---|
brandCode(String) | |
effectiveFrom(DateTime) | |
html(String) | The html of the terms and conditions document rendered as a JSON string. |
markdown(String) | The markdown text of the terms and conditions. |
name(String) | |
pdfUrl(String) | |
version(String) |
Example
{
"name": "abc123",
"pdfUrl": "abc123",
"brandCode": "abc123",
"markdown": "abc123",
"html": "abc123",
"version": "abc123",
"effectiveFrom": "2020-01-01T00:00:00.000Z"
}TextType
A block of text.
Fields
| Name | Description |
|---|---|
id(ID) | Unique identifier of the object. |
textAlignment(Alignment) | The text alignment. |
textStyle(TextStyleV1) | The text style, i.e. header, body. |
typename(String) | The name of the object's type. |
value(String!) | The text content. |
Example
{
"value": "abc123",
"textStyle": "TITLE1",
"textAlignment": "START",
"id": "abc123",
"typename": "abc123"
}Fields
| Name | Description |
|---|---|
days([Weekday]) | The days that the rate applies to. |
endTime(DateTime) | End time on the first day of the period this year. |
startTime(DateTime) | Start time on the first day of the period this year. |
Example
{
"days": "MON",
"startTime": "2020-01-01T00:00:00.000Z",
"endTime": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
gross(Int) | The gross amount (in minor currency units). |
net(Int) | The net amount (in minor currency units). |
tax(Int) | The amount of tax (in minor currency units). |
Example
{
"net": 1,
"tax": 1,
"gross": 1
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([TransactionConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": TransactionConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}TransactionConnectionTypeEdge
A Relay edge containing a TransactionConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(TransactionType) | The item at the end of the edge |
Example
{
"node": TransactionType,
"cursor": "abc123"
}TransferLoyaltyPointsBetweenUsers
Transfer Loyalty Points between users.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-9205: Insufficient Loyalty Points.
- KT-CT-9204: Negative or zero points set.
- KT-CT-9208: Invalid posted at datetime.
- KT-CT-9209: Negative Loyalty Points balance.
- KT-CT-9210: Unhandled Loyalty Points exception.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
pointsTransferred(Int) | The number of loyalty points that were transferred. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"pointsTransferred": 1
}TriggerElectricityHouseMoveOut
This mutation will trigger the electricity house move out processing asynchronously.
It won't return the occupier account immediately, instead, it will create a workflow instance linking to a few step instances. The steps will be executed as tasks and clients can use the workflow id in the response to track the progress.
The possible errors that can be raised are:
- KT-CT-6623: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
error(TriggerElectricityHouseMoveErrorUnion) | The error encountered when trying to trigger the electricity house move out process, if any. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
workflow(WorkflowType) | The workflow information which can be used to track the async processing progress. |
Example
{
"possibleErrors": [PossibleErrorType],
"workflow": WorkflowType,
"error": UnableToDeterminePhoneContactDetailsErrorType
}TriggerGasHouseMoveOut
This mutation will trigger the gas house move out processing asynchronously.
It won't return the occupier account immediately, instead, it will create a workflow instance linking to a few step instances. The steps will be executed as tasks and clients can use the workflow id in the response to track the progress.
Fields
| Name | Description |
|---|---|
error(TriggerGasHouseMoveErrorUnion) | |
workflow(WorkflowType) | The workflow information which can be used to track the async processing progress. |
Example
{
"workflow": WorkflowType,
"error": CouldNotStartWorkflowErrorType
}Fields
| Name | Description |
|---|---|
message(String!) |
Example
{
"message": "abc123"
}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!) |
Example
{
"message": "abc123",
"maxDate": "2020-01-01",
"maxDays": 1
}UpdateAccountAddressMutation
Update address in legacy format for specified accounts for user
Fields
| Name | Description |
|---|---|
viewer(AccountUserType) | The currently authenticated user. This field requires the |
Example
{
"viewer": AccountUserType
}UpdateAccountBillingAddress
The possible errors that can be raised are:
- KT-CT-4145: Invalid address.
- KT-CT-7123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
account(AccountType) | The updated account. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountType
}UpdateAccountBillingEmail
Update the billing email for the input account number to the received email value.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4122: Invalid email.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
account(AccountInterface) | Account that was changed. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}UpdateAccountConsents
Update the consents for an account using consent management system
The possible errors that can be raised are:
- KT-CT-9014: Duplicate consent.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-9018: Account not found.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
consents([ConsentType!]!) | Consents linked to this account. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"consents": ConsentType
}Fields
| Name | Description |
|---|---|
account(AccountType) | |
error(ElectricityProductSwitchingErrorUnion) |
Example
{
"account": AccountType,
"error": UnsupportedBrandErrorType
}Fields
| Name | Description |
|---|---|
account(AccountType) | |
error(GasProductSwitchingErrorUnion) |
Example
{
"account": AccountType,
"error": UnsupportedBrandErrorType
}UpdateAccountReference
Update a reference for a particular account and namespace.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-8310: Invalid data.
- KT-CT-8311: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
accountReference(AccountReferenceType) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountReference": AccountReferenceType
}UpdateAccountRichAddressMutation
Update address for specified accounts for user
The possible errors that can be raised are:
- KT-CT-4412: The supplied address is not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
viewer(AccountUserType) | The currently authenticated user. This field requires the |
Example
{
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}UpdateAccountUserCommsPreferencesMutationPayload
Update the account user comms preferences.
Fields
| Name | Description |
|---|---|
clientMutationId(String) | |
commsPreferences(AccountUserCommsPreferences) | |
emailFormat(String) | |
errors([ErrorType]) | |
fontSizeMultiplier(Float) | |
isOptedInMeterReadingConfirmations(Boolean) | |
isOptedInToClientMessages(Boolean) | |
isOptedInToOfferMessages(Boolean) | |
isOptedInToRecommendedMessages(Boolean) | |
isOptedInToSmsMessages(Boolean) | |
isOptedInToThirdPartyMessages(Boolean) | |
isOptedInToUpdateMessages(Boolean) | |
isUsingInvertedEmailColours(Boolean) | |
preferredHoldMusic(String) |
Example
{
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 1.0,
"emailFormat": "abc123",
"preferredHoldMusic": "abc123",
"errors": [ErrorType],
"commsPreferences": AccountUserCommsPreferences,
"clientMutationId": "abc123"
}UpdateAccountUserConsents
Update the consents from an account user using consent management system
The possible errors that can be raised are:
- KT-CT-9014: Duplicate consent.
- KT-CT-9016: Consent management not enabled.
- KT-CT-9017: Consent type not found.
- KT-CT-1111: Unauthorized.
- KT-CT-5421: Account user not found.
- KT-CT-5422: Invalid data.
- KT-CT-1605: Invalid input.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
accountUserConsents(AccountUserConsents) | All the consents for an account user. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"accountUserConsents": AccountUserConsents
}Fields
| Name | Description |
|---|---|
clientMutationId(String) | |
dateOfBirth(Date) | |
email(String) | |
errors([ErrorType]) | |
familyName(String) | |
givenName(String) | |
landline(String) | |
mobile(String) | |
pronouns(String) |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"pronouns": "abc123",
"mobile": "abc123",
"email": "abc123",
"dateOfBirth": "2020-01-01",
"landline": "abc123",
"errors": [ErrorType],
"clientMutationId": "abc123"
}UpdateActivePurchase
The possible errors that can be raised are:
- KT-CT-8225: Received an invalid purchaseId.
- KT-CT-8226: The provided purchase is not active.
- KT-CT-8206: Invalid data.
- KT-CT-8227: Available grants could not be applied.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
goodsPurchase(GoodsPurchase) | Goods purchase updated. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"goodsPurchase": GoodsPurchase
}UpdateAutoTopUpAmount
The possible errors that can be raised are:
- KT-CT-3815: No active payment schedule found for this account.
- KT-CT-3941: Invalid data.
- KT-CT-3942: An unexpected error occurred.
- KT-CT-3947: An unexpected error occurred.
- KT-CT-3953: The payment schedule is not a balance triggered schedule.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3822: Unauthorized.
- KT-CT-4123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
schedule(PaymentScheduleType) | The new schedule created. |
Example
{
"possibleErrors": [PossibleErrorType],
"schedule": PaymentScheduleType
}UpdateCommsDeliveryPreference
Update the comms delivery preference for the input account number to the received commsDeliveryPreference value.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-4136: Cannot set comms preference to email when account has no email.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
account(AccountInterface) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountInterface
}Fields
| Name | Description |
|---|---|
concession(ConcessionType) |
Example
{
"concession": ConcessionType
}UpdateDocumentAccessibilityPreference
Update the document accessibility preference for the input account number to the received documentAccessibilityPreference value.
The possible errors that can be raised are:
- KT-CT-4123: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
account(AccountType) | Account that was changed. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"account": AccountType
}UpdateElecMeterPointAccessDetails
Requires either/both accessDetails or hazard inputs. This mutation overrides existing access details.
The possible errors that can be raised are:
- KT-CT-6420: Unauthorized.
- KT-CT-4011: No meter points found with the given ID.
- KT-AU-7810: Missing mutation inputs.
- KT-AU-5610: Max number of meter point hazards exceeded.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
meterPoint(MeterPointType) | The target meter point. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"meterPoint": MeterPointType
}UpdateExportPaymentMethod
Update solar export payment method for an account. Allows customers to add or change their payment method for receiving solar export repayments.
The possible errors that can be raised are:
- KT-CT-3823: Unauthorized.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
exportRepaymentDetails(ExportRepaymentDetailsType) | Updated export repayment details. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"exportRepaymentDetails": ExportRepaymentDetailsType
}UpdateHardshipAgreement
The possible errors that can be raised are:
- KT-CT-11611: Hardship agreement not found.
- KT-CT-11612: Overlapping hardship agreement exists.
- KT-CT-10950: Invalid date range.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
updatedHardshipAgreement(HardshipAgreementType) | The updated hardship agreement. |
Example
{
"possibleErrors": [PossibleErrorType],
"updatedHardshipAgreement": HardshipAgreementType
}UpdateMetadata
Update existing metadata on an object.
The possible errors that can be raised are:
- KT-CT-4323: Unauthorized.
- KT-CT-8413: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
metadata(Metadata) | |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"metadata": Metadata
}UpdatePassword
Update user's password.
Note this is different from the ResetPassword mutation, which is used to reset a password when the user has forgotten it. This mutation is used to update the password when the user is already authenticated and wants to change their password.
Ideally, this mutation would simply receive a "new_password" and use the current password update usecase, but, until we're ready for a breaking change, we'll need to use the Django form to also validate the old password and two new passwords.
The possible errors that can be raised are:
- KT-CT-5460: Old password is invalid.
- KT-CT-5450: Password is invalid.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
viewer(AccountUserType) | The currently authenticated user. This field requires the |
Example
{
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}Fields
| Name | Description |
|---|---|
error(UpdatePaymentScheduleErrorUnion) | Handled errors related to payment schedule updates. |
schedule(PaymentScheduleType) | Updated payment schedule. |
Example
{
"schedule": PaymentScheduleType,
"error": DoesNotExistErrorType
}Fields
| Name | Description |
|---|---|
error(UpdatePrimaryResidenceErrorUnion) | The error type and message. |
primaryResidence(PrimaryResidenceType) | The updated primary residence. |
Example
{
"primaryResidence": PrimaryResidenceType,
"error": AccountUserCanNotFoundErrorType
}Fields
| Name | Description |
|---|---|
account(AccountType) | |
error(UpdateProcessedHouseMoveDateErrorUnion) |
Example
{
"account": AccountType,
"error": DoesNotExistErrorType
}UpdateUserAddressMutation
Update address in legacy format for all accounts for user
Fields
| Name | Description |
|---|---|
viewer(AccountUserType) | The currently authenticated user. This field requires the |
Example
{
"viewer": AccountUserType
}UpdateUserMutation
The possible errors that can be raised are:
- KT-CT-5413: Invalid data.
- KT-CT-5414: Invalid data.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
viewer(AccountUserType) |
Example
{
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}UpdateUserRichAddressMutation
Update address for all accounts for user
The possible errors that can be raised are:
- KT-CT-4412: The supplied address is not valid.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
viewer(AccountUserType) | The currently authenticated user. This field requires the |
Example
{
"possibleErrors": [PossibleErrorType],
"viewer": AccountUserType
}UpsertPropertyHazardByExternalIdentifier
Create or update a property hazard by its external identifier.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-12609: Property Hazard Type not found.
- KT-CT-12612: Property not found.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
propertyHazard(UpsertPropertyHazardByExternalIdentifierOutputType) | The upserted property hazard. |
Example
{
"possibleErrors": [PossibleErrorType]
}UpsertPropertyHazardByExternalIdentifierAndNmi
Create or update a property hazard by its external identifier.
This API exists for backwards compatibility, but shouldn't be used in favour of UpsertPropertyHazardByExternalIdentifier.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-12608: Supply point not found.
- KT-CT-12609: Property Hazard Type not found.
- KT-CT-12610: Supply point has no associated property.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
propertyHazard(UpsertPropertyHazardByExternalIdentifierOutputType) | The upserted property hazard. |
Example
{
"possibleErrors": [PossibleErrorType]
}UpsertPropertyHazardTypeByExternalIdentifier
Create or update a property hazard type by its external identifier.
The possible errors that can be raised are:
- KT-CT-1111: Unauthorized.
- KT-CT-12611: Property Hazard Type code already exists.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
propertyHazardType(PropertyHazardTypeOutputType) | The upserted property hazard type. |
Example
{
"possibleErrors": [PossibleErrorType]
}Fields
| Name | Description |
|---|---|
accountType(UsageReferenceAccountType!) | |
pricingZone(UsageReferencePricingZone!) | |
state(UsageReferenceState!) | |
totalUsage(Int!) | The reference supply usage in MJ |
Example
{
"pricingZone": "AGLNSW",
"state": "ACT",
"accountType": "DOMESTIC",
"totalUsage": 1
}UserManagedPayment
Represents the preference of the user to pay himself, instead of get charged.
Fields
| Name | Description |
|---|---|
forPaymentsAfter(String) | The start time of the payment preference. |
Example
{
"forPaymentsAfter": "abc123"
}Fields
| Name | Description |
|---|---|
concession(ConcessionType) |
Example
{
"concession": ConcessionType
}ValidateMfaDevice
Validate multi-factor authentication (MFA) devices for user.
The possible errors that can be raised are:
- KT-CT-1150: MFA device not found.
- KT-CT-1151: MFA device not found.
- KT-CT-1152: Invalid MFA token.
- KT-CT-1155: Enabled backup device is needed.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
deviceIsValid(Boolean) | Flag to indicate if the device has been verified, so it can be used for MFA. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
Example
{
"possibleErrors": [PossibleErrorType],
"deviceIsValid": true
}Example
{
"inputPath": ["abc123"],
"message": "abc123"
}ValidationErrorType
Error type for resolving input validation errors.
Fields
| Name | Description |
|---|---|
fieldErrors([ValidationErrorFieldType]) |
Example
{
"fieldErrors": [ValidationErrorFieldType]
}VariantProfile
Object representing a variant profile.
Fields
| Name | Description |
|---|---|
characteristicValues(JSONString!) | The characteristic values for the variant. |
schemeLabels(JSONString) | The scheme labels for the variant. |
Example
{
"characteristicValues": {"key": "value"},
"schemeLabels": {"key": "value"}
}Fields
| Name | Description |
|---|---|
status(String) | Verification process status. |
type(String) | Verification type. |
userNumber(String) | Customer with pending verification. |
Example
{
"userNumber": "abc123",
"status": "abc123",
"type": "abc123"
}VerifyCustomer
Verify a customer using the provided code and verification type.
The possible errors that can be raised are:
- KT-CT-4191: Error while verifying the customer.
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-1111: Unauthorized.
- KT-CT-1112: 'Authorization' header not provided.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
user(AccountUserType) | The currently authenticated user. |
Example
{
"possibleErrors": [PossibleErrorType],
"user": AccountUserType
}VerifyIdentity
The possible errors that can be raised are:
- KT-CT-1145: Account/user details do not match.
- KT-CT-1113: Disabled GraphQL field requested.
Fields
| Name | Description |
|---|---|
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
token(String!) | An expiring token that can be used to request to update the user's email address. |
Example
{
"possibleErrors": [PossibleErrorType],
"token": "abc123"
}VoiceCampaignConnectionTypeEdge
A Relay edge containing a VoiceCampaignConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(VoiceCampaignType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}VoiceCampaignItemConnectionTypeEdge
A Relay edge containing a VoiceCampaignItemConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(VoiceCampaignItemType) | The item at the end of the edge |
Example
{
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
edgeCount(Int!) | Number of nodes in the edge. |
edges([VoucherPurchaseConnectionTypeEdge]!) | Contains the nodes in this connection. |
pageInfo(PageInfo!) | Pagination data for this connection. |
totalCount(Int!) | Total number of nodes. |
Example
{
"pageInfo": PageInfo,
"edges": VoucherPurchaseConnectionTypeEdge,
"totalCount": 1,
"edgeCount": 1
}VoucherPurchaseConnectionTypeEdge
A Relay edge containing a VoucherPurchaseConnectionType and its cursor.
Fields
| Name | Description |
|---|---|
cursor(String!) | A cursor for use in pagination |
node(VoucherPurchaseType) | The item at the end of the edge |
Example
{
"node": VoucherPurchaseType,
"cursor": "abc123"
}Fields
| Name | Description |
|---|---|
availableFrom(Date) | When the voucher becomes available to be redeemed. |
balance(Int) | The current balance left in the voucher. |
charge(AccountChargeType) | The amount charged for the voucher. |
chargeBalanceTransfer(AccountBalanceTransferType) | A balance transfer for the voucher charge, if any. |
clientParams(JSONString) | Additional metadata from client sources stored against the voucher. This data is not structural and won't be relied on by Kraken internally. |
displayName(String) | Display name for the voucher purchase. |
id(ID) | The purchase ID. |
payment(AccountPaymentType) | The payment associated with the voucher purchase, if any. |
purchasedAt(DateTime) | When the purchase was performed. |
redemptions([VoucherRedemptionType]) | Fetch the redemptions for this voucher. |
voucherValue(Int) | The value of the voucher in cents. |
Example
{
"id": "abc123",
"charge": AccountChargeType,
"payment": AccountPaymentType,
"displayName": "abc123",
"clientParams": {"key": "value"},
"purchasedAt": "2020-01-01T00:00:00.000Z",
"voucherValue": 1,
"availableFrom": "2020-01-01",
"balance": 1,
"redemptions": [VoucherRedemptionType]
}Fields
| Name | Description |
|---|---|
claimedAt(DateTime) | When the redemption was claimed. |
credit(AccountCreditType) | The amount credited for the voucher redemption. |
id(ID) | The redemption ID. |
Example
{
"id": "abc123",
"credit": AccountCreditType,
"claimedAt": "2020-01-01T00:00:00.000Z"
}Fields
| Name | Description |
|---|---|
redeemableInFuture(Int) | The balance from vouchers that will be redeemable in future. |
redeemableToday(Int) | The balance from vouchers that can be redeemable today. |
Example
{
"redeemableToday": 1,
"redeemableInFuture": 1
}Fields
| Name | Description |
|---|---|
deviceId(String) | Serial number. |
marketSupplyPointId(String) | Meter point reference. |
readingFrequencyType(ReadingFrequencyType) | The frequency of the reading. |
Example
{
"marketSupplyPointId": "abc123",
"deviceId": "abc123",
"readingFrequencyType": "RAW_INTERVAL"
}Fields
| Name | Description |
|---|---|
capabilityType(WaterMeterCapabilityType!) | |
category(WaterMeterCategory!) | |
id(ID!) | |
isSmart(Boolean!) | Whether the meter is a smart meter. |
make(String!) | |
meterPointReference(String) | Meter point reference. |
model(String!) | |
numberOfDigits(Int!) | Number of digits / dials that the meter has or can show. |
possibleErrors([PossibleErrorType]) | Field with the possible errors of the query/mutation. Deprecated The 'possibleErrors' field is deprecated. |
serialNumber(String!) | |
status(WaterMeterStatus) |
Example
{
"id": "abc123",
"category": "NORMAL",
"capabilityType": "AMR",
"make": "abc123",
"model": "abc123",
"serialNumber": "abc123",
"status": "NOT_IN_USE",
"numberOfDigits": 1,
"possibleErrors": [PossibleErrorType],
"isSmart": true,
"meterPointReference": "abc123"
}Fields
| Name | Description |
|---|---|
body(String!) | Whatsapp text message body. |
Example
{
"body": "abc123"
}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. |
Example
{
"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. |
Example
{
"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 |
Example
{
"node": WorkflowType,
"cursor": "abc123"
}