code (String)

Code name of the sensor.

displayName (String)

User determined name for a sensor.

enabled (Boolean)

Whether or not a sensor is enabled.

type (SensorType)

Sensor type (NTC).

cursor (String!)

A cursor for use in pagination

node (APIBrownout)

The item at the end of the edge

cursor (String!)

A cursor for use in pagination

node (APIExceptionType)

The item at the end of the edge

goodsPurchase (GoodsPurchase)

Goods purchase created.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

acceptedVersion (String)

Version of terms and conditions that were accepted.

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.

cursor (String!)

A cursor for use in pagination

node (AccountApplicationType)

The item at the end of the edge

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.

salesChannel (String!)

salesSubchannel (String)

The sales subchannel used when signing up. This could for example be a price comparison site.

status (AccountApplicationStatus!)

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.

data (JSONString)

A JSON object containing unstructured data about the account charge.

updatedAt (DateTime)

The date and time the metadata was last updated.

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)

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.

data (JSONString!)

updatedAt (DateTime!)

grossAmount (BigInt!)

id (ID!)

metadata (AccountCreditMetadataType)

netAmount (BigInt!)

note (String!)

reason (String!)

salesTaxAmount (BigInt!)

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.

cursor (String!)

A cursor for use in pagination

node (AccountEvent)

The item at the end of the edge

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)

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.

cursor (String!)

A cursor for use in pagination

node (AccountFileAttachment)

The item at the end of the edge

isEligibleForIo (Boolean)

Whether account is eligible to register devices with Intelligent Octopus or not.

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.

cursor (String!)

A cursor for use in pagination

node (AccountPaymentType)

The item at the end of the edge

amount (BigInt!)

Amount of payment in pence

id (ID!)

paymentDate (Date!)

The date this payment is scheduled to be debited

paymentInstruction (PaymentInstructionType)

The payment instruction that was used to make this payment.

reference (String!)

status (AccountPaymentStatusOptions)

The current status of the payment.

surchargeAmount (Int)

Surcharge amount generated by this payment.

transactionType (AccountPaymentTransactionTypeChoices)

The transaction type of the payment.

account (AccountType!)

createdAt (DateTime!)

namespace (String!)

updatedAt (DateTime!)

value (String!)

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.

cursor (String!)

A cursor for use in pagination

node (AccountRepaymentType)

The item at the end of the edge

amount (BigInt!)

Amount of payment in pence

id (ID!)

paymentDate (Date!)

The date this payment is scheduled to be debited

status (AccountRepaymentStatusOptions)

The current status of the repayment.

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

applications (AccountApplicationConnectionTypeConnection)

Applications by this account to become our customer. More recent applications will be listed first.

assistanceAgreements ([AssistanceAgreementType])

Assistance agreements for account.

balance (Int!)

The current account balance.

bill (BillInterface)

Fetch a specific issued bill (invoice/statement) for the account.

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.

bills (BillConnectionTypeConnection)

Fetch issued bills (invoices/statements) for the account.

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.

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.

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)

consents ([ConsentType!]!)

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.

debtCollectionProceedings ([DebtCollectionProceedingType])

Debt collection proceedings for account.

directDebitInstructions (DirectDebitInstructionConnectionTypeConnection)

The direct debit instructions of the account

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

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.

fileAttachments ([AccountFileAttachment])

Files attached to this account.

gasAgreements ([GasAgreementType])

The gas agreements belonging to the account

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

isEligibleForElectricityReadingIncentive (Boolean)

Whether or not an account is eligible for an electricity reading incentive.

isEligibleForGasReadingIncentive (Boolean)

Whether or not an account is eligible for a gas reading incentive.

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.

maximumRefund (MaximumRefundType)

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

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.

paginatedPaymentForecast (PaymentForecastConnectionTypeConnection)

Paginated payment forecasts for an account. Starts from today's date (inclusive). The interface supports last but does not guarantee 'lastness'.

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

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.

payments (AccountPaymentConnectionTypeConnection)

The payments made into an account from a payment instruction.

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.

provisionalTransactions (ProvisionalTransactionConnectionTypeConnection)

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.

referralsCreated (Int)

Number of referrals created by this account.

repayments (AccountRepaymentConnectionTypeConnection)

The repayments that have been requested for this account.

requestRefundEligibility (RequestRefundEligibilityType)

Details about the eligibility status for requesting a refund.

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.

urn (String)

Unique reference number from a 3rd party enrolment.

users ([AccountUserType!]!)

warmHomeDiscount (WarmHomeDiscount)

Get details about warm home discount applications and records.

url (String)

A url pertaining to a specific account.

urlIdentifier (String)

A description of the url's effect.

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.

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.

consents ([ConsentType!]!)

Consents linked to this user.

namespace (String)

The namespace for the property.

value (String)

The property value.

account (AccountType!)

id (ID!)

role (RoleString)

The account role.

user (AccountUserType!)

accountUserRoles ([AccountUserRoleType])

List of roles a user has for each account they're linked to.

accounts ([AccountInterface])

List of accounts that the user is linked to either via portfolio role or account role.

alternativePhoneNumbers ([String])

List of alternative phone numbers for the account user.

consents ([ConsentType!]!)

Consents linked to this user.

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.

email (String!)

familyName (String!)

firstName (String)

We recommend you use preferredName or fullName instead of this field.

fullName (String)

The user's full name.

givenName (String!)

hasFamilyIssues (Boolean)

Whether there are family issues.

holdMusicChoices ([TrackOptionType])

List of hold music options.

id (ID!)

isDeceased (Boolean!)

Designates whether this user is deceased.

isInHardship (Boolean)

True if user is linked to an account with an active hardship agreement.

isOptedInToWof (Boolean)

landline (String!)

landlinePhoneNumber (String)

The user's landline phone number.

lastName (String)

We recommend you use preferredName or fullName instead of this field.

liveSecretKey (String)

The user's secret key to access the Developer API.

mobile (String!)

portfolioId (ID)

We recommend you use portfolioIds instead of this field.

portfolioIds ([ID])

List of portfolio ids that the user is linked to via their portfolio roles.

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.

preferences (AccountUserCommsPreferences)

preferredName (String)

The user's preferred name.

pronouns (String)

The user's pronouns e.g. 'she/her', 'he/him', 'they/them'.

specialCircumstances (SpecialCircumstancesType)

title (String)

agent (SiteworksAppointmentAgent)

agentReference (String)

appointmentDate (Date!)

cancellationCategory (CancellationCategory)

The reason the appointment was cancelled (category).

cancellationSubCategory (String)

The reason the appointment was cancelled (sub-category).

createdAt (DateTime!)

date (Date)

id (UUID!)

isTradToSmartExchange (Boolean)

Is the appointment switching from a traditional (not SMETS1) meter to a smart meter?

requestId (String)

status (SiteworksAppointmentStatus)

The current status of the Siteworks application.

timeSlotEnd (Time)

timeSlotStart (Time)

workCategory (WorkCategory)

The category of work the appointment has been booked for.

timestamp (DateTime)

The time the data was reported.

value (HeatPumpActivity)

The latest reported activity of the heat pump.

campaignAdded (Boolean)

Whether the campaign was successfully added.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

amount (Int!)

Top-up amount in pence to add to smart meter.

mpan (String)

profileClass (String)

mprn (String)

edgeCount (Int!)

Number of nodes in the edge.

edges ([AddressConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (AddressType)

The item at the end of the edge

addressLine1 (String!)

First address line.

addressLine2 (String)

Second address line.

addressLine3 (String)

Third address line.

addressLine4 (String)

Fourth address line.

addressLine5 (String)

Fifth address line.

postcode (String!)

Postcode.

uprn (String)

Unique Property Reference Number.

electricityMeterPoints ([ElectricMeterTechnicalDetails])

List of electricity meter points associated with the address.

gasMeterPoints ([GasMeterTechnicalDetails])

List of gas meter points associated with the address.

addressKey (String!)

A unique ID per address using part of the address with spaces removed.

addressType (AddressTypeEnum)

The type of address (domestic, business or unknown).

display (String!)

The complete and human-legible address in a single string.

electricityMeterPoints ([AddressAPIElectricityMeterPointType])

gasMeterPoints ([AddressAPIGasMeterPointType])

gspGroupId (String!)

The ID of the Grid Supply Point Group that the address belongs to.

hasPrepaidMeters (Boolean!)

houseNumber (String)

The identifier for a property. The house number consists of the part of line 1 of the address that is not the street name. This includes sub-building names, building names, deliver point aliases and building numbers. For example, the house number for the property 'Flat 12 100 Example St' would be 'Flat 12 100'.

line1 (String!)

Line 1 of the address. This is generally the house number and street name.

line2 (String!)

Line 2 of the address. This is generally the area or village.

line3 (String!)

Line 3 of the address. This is generally the area or village.

line4 (String!)

Line 4 of the address. This is generally the city.

line5 (String!)

Line 5 of the address. This is generally the county.

postcode (String!)

streetName (String)

The street name for a property. The street name consists of the part of line 1 of the address that is not the house number. For example, the house number for the property 'Flat 12 100 Example St' would be 'Example St'.

edgeCount (Int!)

Number of nodes in the edge.

edges ([AddressUPRNTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (UniqueRELAddressType)

The item at the end of the edge

gspCoefficient (Float)

The price multiplier/coefficient used to calculate the unit rate.

peakOffset (Float)

The peak offset for the unit rate.

priceCap (Float)

The maximum value/cap for the unit rate.

type (LineLinkErrorType!)

The type of error that occurred.

payment (AccountPaymentType)

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

readingAmended (Boolean)

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.

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.

cursor (String!)

A cursor for use in pagination

node (AnnualStatementType)

The item at the end of the edge

id (ID)

pdfUrl (String)

periodEndsAt (DateTime!)

periodStartsAt (DateTime!)

annulledBillingDocumentId (Int!)

ID of the billing document annulled by this annulment.

firstIssued (DateTime)

First time the annulment was issued.

id (Int!)

pdfUrl (String)

URL to the PDF of the annulment.

validFrom (DateTime)

validTo (DateTime)

value (Decimal)

edgeCount (Int!)

Number of nodes in the edge.

edges ([ApplicableRateConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total number of nodes.

cursor (String!)

A cursor for use in pagination

node (ApplicableRate)

The item at the end of the edge

discountCode (String)

The assigned discount code.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

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.

authorizationUri (String)

The URL to redirect the user to for authorization.

id (ID)

A unique identifier for this onboarding step.

redirectUri (String)

The URI where the auth flow is going to redirect back to at the end.

edges ([AutoTopupConfigConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

cursor (String!)

A cursor for use in pagination

node (AutoTopupConfigType)

The item at the end of the edge

accountNumber (String!)

The account number, e.g.: 'A-A1B2C3D4'.

deviceId (String!)

Alphanumber code identifying the device, e.g.: 'A1-BC-D2-00-01-23-EF-4G'.

effectiveFrom (DateTime!)

The date and time when the config became effective.

effectiveTo (DateTime)

The date and time when the config stopped being effective.

id (ID!)

topupAmount (Int!)

Auto top-up amount in the lowest currency unit. i.e. USA cents / GBP pence / etc.

edges ([AutoTopupTriggerConnectionTypeEdge]!)

Contains the nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

cursor (String!)

A cursor for use in pagination

node (AutoTopupTriggerType)

The item at the end of the edge

autoTopupConfigId (ID!)

Integer ID of the related AutoTopupConfig, e.g. '123'.

createdAt (DateTime!)

DateTime when the trigger event was created, e.g. '2024-01-01T00:00:00+00:00'.

failureReason (SmartDeviceAutoTopupTriggerFailureReasons)

Reason auto top-up trigger event failed, if any.

id (ID!)

source (SmartDeviceAutoTopupTriggerSources!)

Source of the auto top-up trigger event.

status (SmartDeviceAutoTopupTriggerStatus!)

Status of the auto top-up trigger event.

triggeredAt (DateTime!)

DateTime when auto topup was triggered, e.g. '2024-01-01T00:00:00+00:00'.

updatedAt (DateTime!)

DateTime when the trigger event was last updated, e.g. '2024-01-01T00:00:00+00:00'.

electricity (SupplyTypeSpecificSpinsType)

Spin information for an electricity agreement.

gas (SupplyTypeSpecificSpinsType)

Spin information for a gas agreement.

action (ActionType)

An action to perform.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

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.

key (String!)

value (String!)

isAvailable (Boolean)

Whether the balance forecast is available for the given account.

maximumSocPercentage (Int)

The maximum state of charge (soc) %.

minimumSocPercentage (Int)

The minimum state of charge (soc) %.

chargingPreferences (BatteryChargingPreferencesType)

The charging preferences of the battery (e.g. min / max state of charge %).

deviceStatus (DeviceStatusType)

The current status of the battery (e.g. connected, state of charge, power).

deviceType (KrakenFlexDeviceTypes)

Batteries.

krakenflexDeviceId (ID)

ID of the device in KrakenFlex.

params (BatteryParamsType)

Device specific parameters.

provider (ProviderChoices)

Battery integration provider (make).

variantId (ID)

ID of the battery variant.

connectionStatus (ConnectionStatus)

Whether the battery is currently connected (online/offline).

powerInKw (Decimal)

The current power of the battery in kW.

stateOfCharge (Decimal)

The current state of charge (SoC) of the battery (percentage).

batteryCapacityInKwh (Decimal)

Usable capacity in kWh.

couplingType (BatteryCouplingType)

Coupling type (AC/DC).

isDeprecated (Boolean)

Whether a variant is deprecated.

isIntegrationLive (Boolean)

Whether an integration/make is live, i.e. available.

maxPowerInKw (Decimal)

Max import/export power in kW.

model (String)

Model name of the battery.

variantId (ID)

ID of the battery variant.

make (String)

Make of the home battery.

models ([BatteryVariantModelsType])

List of home battery models per make.

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.

cursor (String!)

A cursor for use in pagination

node (BillInterface)

The item at the end of the edge

billedToDate (Date)

The date that has been billed up to.

currentBalance (Decimal)

The balance after attempting to bill.

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.

cursor (String!)

A cursor for use in pagination

node (BillingAttachmentType)

The item at the end of the edge

filename (String)

The name of the file.

temporaryUrl (String)

The TemporaryURL type represents a temporary URL at which the file is available.It is intended for redirection purposes, NOT persistence in any form. (e.g. inclusion in emails or the body of a web page).

temporaryUrlExpiresAt (DateTime)

The expiry datetime field of the temporary URL.

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.

possibleErrors ([PossibleErrorType])

Field with the possible errors of the query/mutation.

transactionIds ([SensorUpdateTransactionId])

A mapping of transaction ids for each sensor.

businessType (BusinessTypeOptions)

The company type of a business account.

linkedAccountNumber (ID!)

Account number linked to this business.