Fields

accountType : AccountTypeChoices

The type of account.
activeHardshipAgreements : [HardshipAgreementType]

List of active hardship agreements for the user when is_in_hardship is True.
activeReferralSchemes : ReferralSchemeTypes

The referral schemes currently active for this account.
address : RichAddressType

The billing address of this account, stored in the new libaddressinput-based format.

Note that name and organization are very unlikely to be supplied here; the billing_name field on the account itself is generally used for that purpose instead.
annualStatements : AnnualStatementConnectionTypeConnection

Fetch annual statements for the account.
Arguments
after : String
before : String
first : Int
last : Int
applications : AccountApplicationConnectionTypeConnection

Applications by this account to become our customer. More recent applications will be listed first.
Arguments
after : String
before : String
first : Int
last : Int
status : AccountApplicationStatus

The account application status.
assistanceAgreements : [AssistanceAgreementType]

Assistance agreements for account.
balance : Int! required

The current account balance.
Arguments
includeAllLedgers : Boolean

If this variable is set to true, the balance will be calculated based on the sum of balances on all ledgers configured to contribute to this account's balance. Otherwise, only the main ledger's balance will be fetched (legacy behaviour). If you are unsure, set this value to true.
bill : BillInterface

Fetch a specific issued bill (invoice/statement) for the account.
Arguments
billType : BillTypeEnum
id : ID

The unique identifier of the bill.
identifier : String

The unique identifier of the bill. A pending billing document will not have an identifier yet. And not all finalized billing documents will have an identifier. Prefer using the id field unless advised by Kraken.
ledgerNumber : String

The number of the ledger for the bill. When provided, only the period- or item-based documentfor this account that is linked to that ledger is returned; pre-kraken, collective bills, and legacy bills are excluded.
billingAddress : String

The billing address of the account.
billingAddressLine1 : String
billingAddressLine2 : String
billingAddressLine3 : String
billingAddressLine4 : String
billingAddressLine5 : String
billingAddressPostcode : String
billingCountryCode : String
billingDeliveryPointIdentifier : String
billingEmail : String

The billing email of the account.
billingName : String

The billing name of the account.
billingOptions : BillingOptionsType

Information about the account's billing cycle.
billingPostcode : String

The postcode of the billing address.
billingSubName : String

The billing sub name of the account.
billingTriggerConfiguration : BillingTriggerConfiguration

The active billing trigger configuration for the account.
bills : BillConnectionTypeConnection

Fetch issued bills (invoices/statements) for the account.
Arguments
after : String
before : String
first : Int
fromDate : Date

Optional date representing the beginning of the search results. This date value is inclusive.
includeBillsWithoutPDF : Boolean

Include bills without PDFs.
includeHeldStatements : Boolean

Include held statements within the results.
includeHistoricStatements : Boolean default: True

Include pre-Kraken / historical statements within the results.
includeInvoices : Boolean default: True

Include item-based billing documents (invoices) within the results.
includeOpenStatements : Boolean

Include open statements. This flag needs to be used along with includeBillsWithoutPDF=false otherwise results will prove unexpected.
issuedFromDate : Date

Optional date representing the beginning of the search results based on issued date. This date value is inclusive.
issuedToDate : Date

Optional date representing the end of the search results based on issued date. This date value is exclusive.
last : Int
ledgerNumber : String

The number of a ledger for the bill. When provided, only period- or item-based documents for this account that are linked to that ledger are returned; collective bills and legacy bills are excluded. Historic/pre-Kraken bills are unaffected by this filter and are included or excluded solely by includeHistoricStatements.
offset : Int
onlyCurrentEmail : Boolean

Only include bills emailed to the current user's email.
orderBy : BillsOrderBy default: FROM_DATE_DESC

The order in which to return the bills.
toDate : Date

Optional date representing the end of the search results. This date value is exclusive.
brand : String

The brand of the account.
business : BusinessType

Business info related to a business account.
businessType : BusinessTypeOptions

The company type of a business account.
Deprecation
The 'businessType' field is deprecated.

Use `business.businessType` instead

- Marked as deprecated on 2022-03-09.
- Scheduled for removal on or after 2024-01-01.
campaigns : [AccountCampaignType]

The campaigns associated with an account.
canBeWithdrawn : Boolean

Whether an account can be withdrawn.
canChangePayments : Boolean

Whether an account can change their payment schedule.
canInputMeterReadingsViaIvr : Boolean

Whether on not the meter readings can be input via IVR.
canModifyPayments : CanModifyPaymentsType

Data about whether or not an account can modify their payments.
canRenewTariff : Boolean

Whether the account is eligible for tariff renewal.
canRequestRefund : Boolean

Whether the account can request a credit refund.
commsDeliveryPreference : CommsDeliveryPreference

The method the account has specified they prefer we contact them.
communicationDeliveryPreference : String
Deprecation
The 'communicationDeliveryPreference' field is deprecated.

Use `commsDeliveryPreference` instead

- Marked as deprecated on 2022-05-27.
- Scheduled for removal on or after 2024-01-01.
complaints : ComplaintConnectionTypeConnection

The complaints associated with an account.
Arguments
after : String
before : String
first : Int
last : Int
consents : [ConsentType!]! required

Consents linked to this account.
contributionAgreements : [ContributionAgreementType]

Contribution agreements for account.
cotReadingWindowDays : Int

The number of days around a move out a final meter reading can be given for.
createdAt : DateTime

The datetime that the account was originally created.
currentEstimatedSsd : Date

The current estimated supply start day on an account.
customerAssets : [CustomerAssetType]

Get customer assets for an account.
debtCollectionProceedings : [DebtCollectionProceedingType]

Debt collection proceedings for account.
directDebitInstructions : DirectDebitInstructionConnectionTypeConnection

The direct debit instructions of the account
Arguments
after : String
before : String
first : Int
last : Int
statuses : [DirectDebitInstructionStatus]

Filter the direct debit instructions by status
documentAccessibility : DocumentAccessibilityChoices

The document accessibility preference of the account.
earliestPossibleSsd : Date

The earliest possible supply start day on an account.
electricityAgreements : [ElectricityAgreementType]

The electricity agreements belonging to the account.
Arguments
active : Boolean

Whether to return active agreements only. Will otherwise include all active and future agreements that have not been revoked.
eligibilityForWarmHomeDiscount : WarmHomeDiscountEligibility

Whether the account is eligible to apply for Warm Home Discount as part of the Scottish Broader Group.
events : AccountEventConnectionTypeConnection

The account events that were recorded for the account.
Arguments
after : String
before : String
eventTypes : [AccountEventType]

Filter the account events by their type.
first : Int
last : Int
fileAttachments : [AccountFileAttachment]

Files attached to this account.
gasAgreements : [GasAgreementType]

The gas agreements belonging to the account.
Arguments
active : Boolean

Whether to return active agreements only. Will otherwise include all active and future agreements that have not been revoked.
greenAccomplishments : GreenAccomplishmentsType

The green benefits achieved over the lifetime of an account.
hasActiveCollectionsProceedings : Boolean

Whether or not the account has active collections proceedings.
hasActiveDunningProcess : Boolean

Whether or not the account has an active Dunning process.
id : ID! required
isEligibleForElectricityReadingIncentive : Boolean

Whether or not an account is eligible for an electricity reading incentive.
Deprecation
The 'isEligibleForElectricityReadingIncentive' field is deprecated.

Please see wheelOfFortuneSpins query instead.

- Marked as deprecated on 2025-06-24.
- Scheduled for removal on or after 2025-07-24.
isEligibleForGasReadingIncentive : Boolean

Whether or not an account is eligible for a gas reading incentive.
Deprecation
The 'isEligibleForGasReadingIncentive' field is deprecated.

Please see wheelOfFortuneSpins query instead.

- Marked as deprecated on 2025-06-24.
- Scheduled for removal on or after 2025-07-24.
isInBlockingMigration : Boolean

Whether or not the account is a part of a migration for which we want to switch supplier without customer actions.
isInHardship : Boolean

True if there is an active Hardship Agreement for this account. False otherwise.
latestPossibleSsd : Date

The latest possible supply start day on an account.
ledgers : [LedgerType]

Ledgers provide the foundation of bookkeeping functionality. Similar to a bank account, they allow us to keep track of financial activity on a particular customer account.
Arguments
includeDebtLedgers : Boolean default: True

If this variable is set to false, debt ledgerswill be filtered out of the ledgers list.
ledgerId : ID

The ledger to return.
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerNumber : String

The ledger to return by its number.
marketSupplyAgreements : AgreementConnection

Retrieve all market supply agreements under this account. Note that when active is set to false it actually means 'return both active and inactive agreements'.
Arguments
active : Boolean

Whether to return active agreements only.
after : String
before : String
first : Int
id : ID

Filter the list to the agreement with this id.
last : Int
supplyPointExternalIdentifier : String

Filter the list to agreements for the supply point with this external identifier.
maximumRefund : MaximumRefundType

The maximum amount a customer is allowed to request as a refund and the reason why that's the maximum amount.
Arguments
ledgerNumber : String

The ledger number to calculate maximum refund for.
metadata : [Metadata]

Metadata associated with the account.
notes : [AccountNoteType]

Notes for the account.
number : String

A code that uniquely identifies the account.
operationsTeam : OperationsTeamType

The operations team that the account belongs to.
overdueBalance : Int

The current account overdue balance.
paginatedFileAttachments : AccountFileAttachmentConnectionTypeConnection

Files attached to this account.
Arguments
after : String
before : String
category : String

File attachment category.
first : Int
id : Int

File attachment id.
last : Int
paginatedPaymentForecast : PaymentForecastConnectionTypeConnection

Paginated payment forecasts for an account. Starts from today's date (inclusive). The interface supports last but does not guarantee 'lastness'.
Arguments
after : String
before : String
dateTo : Date

The end date to retrieve forecasts for. This end date is inclusive.
first : Int
last : Int
ledgerId : Int

The ledger to return payment forecasts from. Defaults to the main ledger when no ID is passed.
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerNumber : String

The number of the ledger to return payment forecasts from. Defaults to the main ledger when no number is passed.
paymentAdequacy : PaymentAdequacyType

Results of the latest review of the account's payments.
paymentForecast : [PaymentForecastType]

A list displaying the payment forecast for an account. The list starts from today's date (inclusive).
Deprecation
The 'paymentForecast' field is deprecated.

Please use 'paginatedPaymentForecast' instead.

- Marked as deprecated on 2024-01-03.
- Scheduled for removal on or after 2025-01-01.
Arguments
dateTo : Date! required

The end date to retrieve forecasts for. This end date is inclusive.
ledgerId : Int

The ledger to return payment forecasts from. Defaults to the main ledger when no ID is passed.
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerNumber : String

The number of the ledger to return payment forecasts from. Defaults to the main ledger when no number is passed.
paymentMethods : PaymentInstructionConnectionTypeConnection

The payment instructions of the account.
Arguments
after : String
before : String
first : Int
last : Int
statuses : [PaymentInstructionStatus]

Filter the payment instructions by status.
paymentPlans : PaymentPlanConnectionTypeConnection

The payment plans that have been created for this account.
Arguments
after : String
before : String
first : Int
last : Int
payments : AccountPaymentConnectionTypeConnection

The payments made into an account from a payment instruction.
Arguments
after : String
before : String
first : Int
includePromises : Boolean default: True

Whether to include payment promises (of any kind: made, broken or fulfilled) or not. The default is to include them.
last : Int
ledgerId : String

The id of the ledger to return payments from.
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerNumber : String

WARNING: Will be mandatory in future versions

The number of the ledger to return payments from.
reason : PaymentReasonOptions

Filter for payments that were taken for a particular reason.
paymentSchedules : PaymentScheduleConnectionTypeConnection

The schedules that describe how we would expect to take payments for an account on a given month.
Arguments
active : Boolean
activeOnDate : Date
after : String
before : String
canCreatePayment : Boolean
Deprecation
The 'canCreatePayment' field is deprecated.

Please use 'includeDormant' instead.

- Marked as deprecated on 2023-12-06.
- Scheduled for removal on or after 2024-12-06.
first : Int
includeDormant : Boolean default: True

If false, we remove the currently valid schedule if it has already fulfilled its purpose and will have no further impact on customer payments, along with any schedules which are not valid from today.
last : Int
ledgerId : ID

The ledger id to return the payment schedules from.
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerNumber : String

The ledger number to return the payment schedules from.
ledgerType : Int

The ledger to return transactions from.
portfolio : PortfolioType

The portfolio this account is linked to.
preferredLanguageForComms : String

The language that the account preferred for communications.
projectedBalance : Int

Expected balance in a year's time.
properties : [PropertyType]

Properties linked to the account now and in the future.
Arguments
activeFrom : DateTime

Returns properties that have an effective period that ends at or after the given activeFrom datetime.
provisionalTransactions : ProvisionalTransactionConnectionTypeConnection
Arguments
after : String
before : String
first : Int
last : Int
recommendedBalanceAdjustment : Int

Top up payment amount in pence that we recommend for an account.
references : [AccountReferenceType]

Account references linked to this account.
referrals : ReferralConnectionTypeConnection

The referrals created by this account.
Arguments
after : String
before : String
first : Int
last : Int
status : ReferralStatus

Only return referrals with the specified status. Return all referrals by default.
referralsCreated : Int

Number of referrals created by this account.
refundApproval : RefundApprovalType

Refund approval data from the Bulk Refund Allocation Query (BRAQ) API. Provides maximum refund amount and any issues. Raises errors if functionality is not configured or data unavailable.
reminders : AccountReminderConnectionTypeConnection

The reminders associated with an account.
Arguments
after : String
before : String
first : Int
last : Int
repayments : AccountRepaymentConnectionTypeConnection

The repayments that have been requested for this account.
Arguments
after : String
before : String
first : Int
last : Int
statuses : [AccountRepaymentStatusOptions]

Only return repayments whose status matches one of these statuses.
requestRefundEligibility : RequestRefundEligibilityType

Details about the eligibility status for requesting a refund.
Arguments
ledgerNumber : String

The ledger number to check refund eligibility.
rewards : [RewardType]

The rewards applied to this account.
shouldReviewPayments : Boolean

Whether the account's payment should be adjusted.
smets2Interest : SmartMeterInterestChoices

The interest of an account in procuring smart meters.
smets2RefusalReason : SMETS2InterestReason

The reason why the account holder is not interested in having a smart meter installed.
splitBillingAddress : [String]

List of billing address lines.
status : AccountStatus

The current status of the account.
trackerTariffDailyPricing : TrackerTariffDailyPricing

Only relevant for Kraken instances that support daily tracker tariffs. Returns null if not applicable.

transactions : TransactionConnectionTypeConnection

Fetch transactions that have taken place on the account.
Arguments
after : String
before : String
first : Int
fromDate : Date

Optional date representing the beginning of the postedDate range filter. This date value is inclusive.
includeAllLedgers : Boolean

In a multi-ledger scenario, include all ledgers' transactions if true. Analogously, if false and no ledgerId or ledger_number argument is present, the list of transactions defaults to the main ledger (legacy behaviour).
last : Int
ledgerId : Int

The ledger to return transactions from.
Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerNumber : String

The number of the ledger to return transactions from.
offset : Int
orderBy : TransactionsOrderBy default: POSTED_DATE_DESC

The order in which to return the transactions.
toDate : Date

Optional date representing the end of the postedDate range filter. This date value is exclusive.
transactionTypes : [TransactionTypeFilter]

Include only these specific transaction types in the result.
transactionTypesExcluded : [TransactionTypeFilter]

Exclude these specific transaction types from the result.
urn : String

Unique reference number from a 3rd party enrolment.
users : [AccountUserType!]! required
warmHomeDiscount : WarmHomeDiscount

Get details about warm home discount applications and records.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "accountType": "BUSINESS", "activeHardshipAgreements": [HardshipAgreementType], "activeReferralSchemes": ReferralSchemeTypes, "address": RichAddressType, "annualStatements": AnnualStatementConnectionTypeConnection, "applications": AccountApplicationConnectionTypeConnection, "assistanceAgreements": [AssistanceAgreementType], "balance": 29, "bill": BillInterface, "billingAddress": "none-trade-continue-in-road", "billingAddressLine1": "anyone-between-nation-entire-blood", "billingAddressLine2": "energy-place-money-bad-authority", "billingAddressLine3": "sure-poor-community-technology-against", "billingAddressLine4": "happy-summer-report-exist-through", "billingAddressLine5": "our-tend-throughout-international-put", "billingAddressPostcode": "name-war-sometimes-rise-sport", "billingCountryCode": "your-either-cut-section-show", "billingDeliveryPointIdentifier": "79026002", "billingEmail": "then-baby-past-member-official", "billingName": "international-goal-write-according-whether", "billingOptions": BillingOptionsType, "billingPostcode": "receive-politics-must-state-mention", "billingSubName": "yes-firm-since-population-year", "billingTriggerConfiguration": BillingTriggerConfiguration, "bills": BillConnectionTypeConnection, "brand": "executive-in-vote-unit-military", "business": BusinessType, "campaigns": [AccountCampaignType], "canBeWithdrawn": true, "canChangePayments": true, "canInputMeterReadingsViaIvr": true, "canModifyPayments": CanModifyPaymentsType, "canRenewTariff": true, "canRequestRefund": true, "commsDeliveryPreference": "EMAIL", "complaints": ComplaintConnectionTypeConnection, "consents": [ConsentType], "contributionAgreements": [ContributionAgreementType], "cotReadingWindowDays": 78, "createdAt": "2005-08-24T03:09:16.127010+00:00", "currentEstimatedSsd": "1987-06-01", "customerAssets": [CustomerAssetType], "debtCollectionProceedings": [DebtCollectionProceedingType], "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection, "documentAccessibility": "LARGE_PRINT", "earliestPossibleSsd": "1987-01-31", "electricityAgreements": [ElectricityAgreementType], "eligibilityForWarmHomeDiscount": WarmHomeDiscountEligibility, "events": AccountEventConnectionTypeConnection, "fileAttachments": [AccountFileAttachment], "gasAgreements": [GasAgreementType], "greenAccomplishments": GreenAccomplishmentsType, "hasActiveCollectionsProceedings": true, "hasActiveDunningProcess": true, "id": "77956764", "isInBlockingMigration": true, "isInHardship": true, "latestPossibleSsd": "1995-02-18", "ledgers": [LedgerType], "marketSupplyAgreements": AgreementConnection, "maximumRefund": MaximumRefundType, "metadata": [Metadata], "notes": [AccountNoteType], "number": "cell-significant-window-education-act", "operationsTeam": OperationsTeamType, "overdueBalance": 55, "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection, "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection, "paymentAdequacy": PaymentAdequacyType, "paymentMethods": PaymentInstructionConnectionTypeConnection, "paymentPlans": PaymentPlanConnectionTypeConnection, "payments": AccountPaymentConnectionTypeConnection, "paymentSchedules": PaymentScheduleConnectionTypeConnection, "portfolio": PortfolioType, "preferredLanguageForComms": "save-not-happy-I-view", "projectedBalance": 97, "properties": [PropertyType], "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection, "recommendedBalanceAdjustment": 86, "references": [AccountReferenceType], "referrals": ReferralConnectionTypeConnection, "referralsCreated": 3, "refundApproval": RefundApprovalType, "reminders": AccountReminderConnectionTypeConnection, "repayments": AccountRepaymentConnectionTypeConnection, "requestRefundEligibility": RequestRefundEligibilityType, "rewards": [RewardType], "shouldReviewPayments": true, "smets2Interest": "PRIORITY", "smets2RefusalReason": "SMETS2_INTEREST_REASON_DO_NOT_OWN_HOME", "splitBillingAddress": "together-understand-suffer-himself-less", "status": "PENDING", "trackerTariffDailyPricing": TrackerTariffDailyPricing, "transactions": TransactionConnectionTypeConnection, "urn": "somebody-head-see-loss-from", "users": [AccountUserType], "warmHomeDiscount": WarmHomeDiscount }