Objects
Objects¶
APIKeyAuthentication¶
| Field | Argument | Type | Description |
|---|---|---|---|
| token | String | ||
| errors | [ErrorType] | ||
AccountApplicationConnectionTypeConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [AccountApplicationConnectionTypeEdge]! | ||
AccountApplicationConnectionTypeEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | AccountApplicationType | ||
| cursor | String! | ||
AccountApplicationType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| status | AccountApplicationStatus! | ||
| salesChannel | AccountApplicationSalesChannel | ||
| salesSubchannel | String | ||
| dateOfSale | Date | ||
| coolingOffEndDate | Date | ||
| isMigrated | Boolean | ||
| migrationSource | String | ||
AccountCheckoutInformationOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| productId | String! | ||
| isPrepayProduct | Boolean | ||
| depositRequiredForPrepayProduct | Boolean | Indicates account must make a deposit payment before checkout. | |
| prepayProductBalanceThreshold | Int | The minimum positive balance in cents required for prepay products. This is value is set by the account user and defaults to 2500. | |
| pricePerKwh | Decimal | ||
AccountCampaignType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String | ||
| expiryDate | Date | ||
AccountChargeMetadataType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| data | JSONString! | ||
| updatedAt | DateTime! | ||
AccountChargeType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| grossAmount | Int! | ||
| cclAmount | Int! | ||
| netAmount | Int | ||
| salesTaxAmount | Int | ||
| reason | AccountChargeReason | ||
| note | String! | ||
| metadata | AccountChargeMetadataType | ||
AccountCreatedAtOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| createdAt | DateTime | ||
AccountCreatedByAffiliateOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| accountNumber | String! | ||
| emailAddress | String! | ||
| meterPointStatus | |||
AccountCreditMetadataType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| data | JSONString! | ||
| updatedAt | DateTime! | ||
AccountCreditType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| grossAmount | Int! | ||
| netAmount | Int! | ||
| salesTaxAmount | Int! | ||
| note | String! | ||
| reason | AccountCreditReason! | ||
| metadata | AccountCreditMetadataType | ||
AccountEventConnectionTypeConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [AccountEventConnectionTypeEdge]! | ||
AccountEventConnectionTypeEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | AccountEvent | ||
| cursor | String! | ||
AccountFileAttachment¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| filename | String! | ||
| category | String! | ||
| isUploaded | Boolean | ||
| isReady | Boolean | ||
| fetchUrl | String | ||
| sizeInBytes | Int | ||
AccountPaymentConnectionTypeConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [AccountPaymentConnectionTypeEdge]! | ||
AccountPaymentConnectionTypeEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | AccountPaymentType | ||
| cursor | String! | ||
AccountPaymentType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| amount | Int! | ||
| paymentDate | Date! | ||
| reference | String! | ||
| transactionType | String! | ||
| status | AccountPaymentStatusOptions | ||
| surchargeAmount | Int | ||
AccountReferenceType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| account | AccountType! | ||
| namespace | String! | ||
| value | String! | ||
| createdAt | DateTime! | ||
| updatedAt | DateTime! | ||
AccountRepaymentConnectionTypeConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [AccountRepaymentConnectionTypeEdge]! | ||
AccountRepaymentConnectionTypeEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | AccountRepaymentType | ||
| cursor | String! | ||
AccountRepaymentType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| amount | Int! | ||
| paymentDate | Date! | ||
| status | AccountRepaymentStatusOptions | ||
AccountType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| number | String | ||
| status | AccountStatus | ||
| paymentSchedules | PaymentScheduleConnectionTypeConnection | ||
| activeOnDate | Date | ||
| active | Boolean | ||
| canCreatePayment | Boolean | ||
| ledgerType | Int | ||
| reason | PaymentScheduleReasonOptions | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| users | [AccountUserType!]! | ||
| balance | Int | ||
| urn | String | ||
| billingName | String | ||
| billingAddress | String | ||
| billingAddressLine1 | String | ||
| billingAddressLine2 | String | ||
| billingAddressLine3 | String | ||
| billingAddressLine4 | String | ||
| billingAddressLine5 | String | ||
| billingAddressPostcode | String | ||
| billingCountryCode | String | ||
| billingDeliveryPointIdentifier | String | ||
| splitBillingAddress | [String] | ||
| address | RichAddressType | ||
| ledgers | [LedgerType] | ||
| canRequestRefund | Boolean | ||
| payments | AccountPaymentConnectionTypeConnection | ||
| status | AccountPaymentStatusOptions | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| repayments | AccountRepaymentConnectionTypeConnection | ||
| statuses | [AccountRepaymentStatusOptions] | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| paymentForecast | [PaymentForecastType] | ||
| dateTo | Date! | ||
| ledgerId | Int | ||
| referrals | ReferralConnectionTypeConnection | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| activeReferralSchemes | ReferralSchemeTypes | ||
| transactions | TransactionConnectionTypeConnection | ||
| transactionTypes | [TransactionTypeFilter] | ||
| ledgerId | Int | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| provisionalTransactions | ProvisionalTransactionConnectionTypeConnection | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| annualStatements | AnnualStatementConnectionTypeConnection | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| bills | BillConnectionTypeConnection | ||
| includeBillsWithoutPDF | Boolean | ||
| includeOpenStatements | Boolean | ||
| onlyCurrentEmail | Boolean | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| billingOptions | BillingOptionsType | ||
| bill | BillInterface | ||
| id | ID | ||
| billType | BillTypeEnum | ||
| directDebitInstructions | DirectDebitInstructionConnectionTypeConnection | ||
| statuses | [DirectDebitInstructionStatus] | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| events | AccountEventConnectionTypeConnection | ||
| eventTypes | [AccountEventType] | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| applications | AccountApplicationConnectionTypeConnection | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| accountType | AccountTypeChoices | ||
| commsDeliveryPreference | CommsDeliveryPreference | ||
| communicationDeliveryPreference ⚠️ | String |
⚠️ DEPRECATED Use `commsDeliveryPreference` instead |
|
| references | [AccountReferenceType] | ||
| fileAttachments | [AccountFileAttachment] | ||
| maximumRefund | MaximumRefundType | ||
| campaigns | [AccountCampaignType] | ||
| properties | [PropertyType] | ||
| activeFrom | DateTime | ||
AccountUserCommsPreferences¶
| Field | Argument | Type | Description |
|---|---|---|---|
| isOptedInToClientMessages | Boolean | ||
| isOptedInToOfferMessages | Boolean | ||
| isOptedInToRecommendedMessages | Boolean | ||
| isOptedInToUpdateMessages | Boolean | ||
| isOptedInToThirdPartyMessages | Boolean | ||
| emailFormat | EmailFormats | ||
| isUsingInvertedEmailColours | Boolean | ||
| fontSizeMultiplier | Float | ||
| isOptedInMeterReadingConfirmations | Boolean | ||
| isOptedInToSmsMessages | Boolean | ||
| preferredHoldMusic | Songs | ||
AccountUserType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| accounts | [AccountInterface] | ||
| givenName | String! | ||
| familyName | String! | ||
| String! | |||
| mobile | String! | ||
| landline | String! | ||
| pronouns | String | ||
| displayName ⚠️ | String |
⚠️ DEPRECATED Please use fullName instead of this field. |
|
| firstName ⚠️ | String |
⚠️ DEPRECATED Use 'givenName' instead |
|
| lastName ⚠️ | String |
⚠️ DEPRECATED Use 'familyName' instead |
|
| fullName | String | ||
| preferredName | String | ||
| portfolioId | ID | ||
| specialCircumstances | SpecialCircumstancesType | ||
| preferences | AccountUserCommsPreferences | ||
| dateOfBirth | Date | ||
| landlinePhoneNumber ⚠️ | String |
⚠️ DEPRECATED Use 'landline' instead. |
|
| alternativePhoneNumbers | [String] | ||
| hasFamilyIssues | Boolean | ||
AcquireOauthTokens¶
| Field | Argument | Type | Description |
|---|---|---|---|
| tokensAcquired | boolean | ||
AcquireOauthTokensInput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| accountNumber | String | ||
| authCode | String | ||
| state | String | ||
AddPropertyToShellAccount¶
| Field | Argument | Type | Description |
|---|---|---|---|
| addPropertyToShellAccountData | AddPropertyToShellAccountOutputType | ||
AddPropertyToShellAccountOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| esiId | String | ||
AddressTdspMappingOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| esiId | String | ||
| houseNumber | String | ||
| address | String | ||
| address2 | String | ||
| city | String | ||
| postCode | String | ||
| state | String | ||
| serviceProvider | ServiceProvider | ||
| loadZone | LoadZone | ||
| isCustomer | OeCustomerOutput | ||
AffiliateLinkType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| organisation | AffiliateOrganisationType | ||
| subdomain | String! | ||
| trainingStatus | LinkTrainingStatus! | ||
| isBusiness | Boolean! | ||
| contactName | String! | ||
| contactEmail | String! | ||
| landingUrl | String! | ||
AffiliateSessionType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| ipAddress | String! | ||
| userAgent | String! | ||
| queryParams | Dict! | ||
| quoteShare | ID! | ||
AffiliateOrganisationType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String! | ||
| salesChannel | String! | ||
AgnosticRatesType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| standingRates | [StandingRatesType] | ||
| consumptionRates | [ConsumptionRatesType] | ||
AgreementType¶
| Field | Argument | Type | Description | |
|---|---|---|---|---|
| id | ID! | |||
| autoTopUpAmountSelectedByUser | Int! | Returns the auto top up amount selected by the user in cents. | ||
| validFrom | DateTime! | |||
| validTo | DateTime | |||
| agreedAt | DateTime | |||
| terminatedAt | DateTime | |||
| product | ProductType | |||
| efls | [EflType] | |||
| language | EFLLanguage | |||
| activeProductRates | RatesType | |||
| outageInformation | OutageMapOutputType | |||
| totalApplicableRate | Decimal | Returns the total applicable rate based on the given kwhUsage. If includeSubscriptionFees is given, it returns the rate that matches with the rate on the EFL. | ||
| kwhUsage, includeSubscriptionFees | Decimal, Boolean | |||
| includeFutureActiveAgreements | Boolean | Provide `True` if you need any future active agreements this meter point may have | ||
AnnualStatementConnectionTypeConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [AnnualStatementConnectionTypeEdge]! | ||
AnnualStatementConnectionTypeEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | AnnualStatementType | ||
| cursor | String! | ||
AnnualStatementType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| periodStartsAt | DateTime! | ||
| periodEndsAt | DateTime! | ||
| id | ID | ||
| pdfUrl | String | ||
ApplyReward¶
| Field | Argument | Type | Description |
|---|---|---|---|
| rewardOutput | ApplyRewardOutputType | ||
ApplyRewardOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| rewardApplied | Boolean | ||
| rewardDescription | String | ||
| rewardStatus | ReferralCodeApplicationStatusChoices | ||
AutoPayOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| isEnabled | Boolean | ||
BillConnectionTypeConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [BillConnectionTypeEdge]! | ||
BillConnectionTypeEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | BillInterface | ||
| cursor | String! | ||
BillingOptionsType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| periodStartDay | Int | ||
| periodLength | AccountBillingOptionsPeriodLength | ||
| isFixed | Boolean! | ||
| currentBillingPeriodStartDate | Date | ||
| currentBillingPeriodEndDate | Date | ||
| nextBillingDate | Date | ||
Charge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | ||
| postedDate | Date | ||
| amount | Int | ||
| balanceCarriedForward | Int | ||
| isCredit | Boolean | ||
| isAccountCharge | Boolean | ||
| isAccountPayment | Boolean | ||
| isHeld | Boolean | ||
| title | String | ||
| statementId | ID | ||
| isReversed | Boolean! | ||
| consumption | Consumption | ||
CollectAdHocACHPayment¶
| Field | Argument | Type | Description |
|---|---|---|---|
| payment | CollectAdHocACHPaymentOutput | ||
CollectAdHocACHPaymentOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| wasScheduled | Boolean | ||
CollectAdHocPaymentForInstruction¶
| Field | Argument | Type | Description |
|---|---|---|---|
| payment | CollectAdHocPaymentForInstructionOutput | ||
CollectAdHocPaymentForInstructionOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| wasScheduled | Boolean | ||
CollectDeposit¶
| Field | Argument | Type | Description |
|---|---|---|---|
| payment | CollectDepositOutput | ||
CollectDepositOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| status | CollectDepositStatusChoices | ||
| paymentDate | Date | ||
ConciseRatesOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| totalApplicableRate | Decimal | ||
| totalApplicableRateWithMonthlySubscriptionFees | Decimal | ||
| totalApplicableDayRateWithMonthlySubscriptionFees | Decimal | ||
| totalApplicableNightRateWithMonthlySubscriptionFees | Decimal | ||
| kwhUsage | Decimal | ||
| serviceProvider | ServiceProvider | ||
| serviceProviderConsumptionRate | Decimal | ||
| serviceProviderStandingRate | Decimal | ||
| loadZone | LoadZone | ||
| loadZoneConsumptionRate | Decimal | ||
| totalApplicableDayRate | Decimal | ||
| totalApplicableNightRate | Decimal | ||
| loadZoneDayTimeConsumptionRate | Decimal | ||
| loadZoneNightTimeConsumptionRate | Decimal | ||
| serviceProviderStandingRateUnitType | UnitType | ||
| serviceProviderConsumptionRateUnitType | UnitType | ||
| loadZoneDayTimeRateUnitType | UnitType | ||
| loadZoneNightTimeRateUnitType | UnitType | ||
| loadZoneConsumptionRateUnitType | UnitType | ||
Consumption¶
| Field | Argument | Type | Description |
|---|---|---|---|
| startDate | Date | ||
| endDate | Date | ||
| quantity | Decimal | ||
| unit | ConsumptionUnit | ||
| usageCost | Int | ||
| supplyCharge | Int | ||
ConsumptionRatesType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String | ||
| taxable | Boolean | ||
| taxCode | String | ||
| loadZone | LoadZone | ||
| description | String | ||
| serviceProvider | ServiceProvider | ||
| unitType | UnitType | ||
| currency | Currency | ||
| pricePerUnit | Decimal | ||
| efls | [EflType] | ||
| language | EFLLanguage | ||
| bandCategory | BandCategory | ||
| bandSubcategory | String | ||
| band | String | ||
| timeOfUse | TimeOfUse | ||
CoordinatesType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| latitude | Float | ||
| longitude | Float | ||
CostDetails¶
| Field | Argument | Type | Description |
|---|---|---|---|
| lowestCost | LowestCostDetail | ||
| highestCost | HighestCostDetail | ||
CreateAccount¶
| Field | Argument | Type | Description |
|---|---|---|---|
| account | CreateAccountOutput | ||
CreateAccountCharge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| accountCharge | AccountChargeType | ||
CreateAccountCredit¶
| Field | Argument | Type | Description |
|---|---|---|---|
| accountCredit | AccountCreditType | ||
CreateAccountFileAttachmentPayload¶
| Field | Argument | Type | Description |
|---|---|---|---|
| postRequest | UploadPostRequest | ||
| clientMutationId | String | ||
CreateAccountOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| number | String | ||
CreateAccountReference¶
| Field | Argument | Type | Description |
|---|---|---|---|
| accountReference | AccountReferenceType | ||
CreateAffiliateLink¶
| Field | Argument | Type | Description |
|---|---|---|---|
| affiliateLink | AffiliateLinkType | ||
CreateAffiliateSession¶
| Field | Argument | Type | Description |
|---|---|---|---|
| affiliateSession | AffiliateSessionType | ||
CreateDepositAgreement¶
| Field | Argument | Type | Description |
|---|---|---|---|
| depositAgreement | CreateDepositAgreementOutput | ||
CreateDepositAgreementOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| depositRequired | Boolean | ||
| depositAmount | Int | ||
CreateErcotData¶
| Field | Argument | Type | Description |
|---|---|---|---|
| ercotData | ErcotOutputType | ||
CreateMetadata¶
| Field | Argument | Type | Description |
|---|---|---|---|
| metadata | Metadata | ||
CreatePaymentIntent¶
| Field | Argument | Type | Description |
|---|---|---|---|
| paymentIntent | PaymentIntentType | ||
CreateShellAccountPayload¶
| Field | Argument | Type | Description |
|---|---|---|---|
| givenName | String! | ||
| familyName | String! | ||
| billingName | String | ||
| String! | |||
| mobile | String! | ||
| billingAddressLine1 | String! | ||
| billingAddressLine2 | String! | ||
| billingAddressLine3 | String | ||
| billingAddressLine4 | String | ||
| billingAddressLine5 | String | ||
| billingPostcode | String! | ||
| isBusinessAccount | Boolean | ||
| password | String | ||
| passwordUpdateToken | String | ||
| urn | String | ||
| errors | [ErrorType] | ||
| account | AccountInterface | ||
| clientMutationId | String | ||
CreateSmartDeviceToken¶
| Field | Argument | Type | Description |
|---|---|---|---|
| state | String | ||
CreateSmartDeviceTokenInput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| accountNumber | String | ||
| deviceType | String | ||
| deviceVendor | String | ||
CreateSmartGridCisData¶
| Field | Argument | Type | Description |
|---|---|---|---|
| smartgridcisData | SmartGridCisOutputType | ||
Credit¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | ||
| postedDate | Date | ||
| amount | Int | ||
| balanceCarriedForward | Int | ||
| isCredit | Boolean | ||
| isAccountCharge | Boolean | ||
| isAccountPayment | Boolean | ||
| isHeld | Boolean | ||
| title | String | ||
| statementId | ID | ||
| isReversed | Boolean! | ||
CreditCheckOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| status | CreditCheckStatus | ||
CustomerFeedbackType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| rawScore | Int | ||
| submittedAt | DateTime | ||
CustomerRevokeFutureAgreementsOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| successfulRevocation | Boolean | ||
DailyReadingOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| meterPointId | Int | ||
| readAt | String | ||
| meterReading | Decimal | ||
| dailyUsage | Decimal | ||
| source | String | ||
DateAmount¶
| Field | Argument | Type | Description |
|---|---|---|---|
| date | String | ||
| amount | Decimal | ||
DeleteThermostatToken¶
| Field | Argument | Type | Description |
|---|---|---|---|
| status | String | ||
DeleteThermostatTokenInput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String | ||
| accountNumber | String | ||
DepositAgreementOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| depositKey | String | ||
| depositAmount | Int | ||
| acceptedAt | DateTime | ||
| fulfilledAt | DateTime | ||
DirectDebitInstructionConnectionTypeConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [DirectDebitInstructionConnectionTypeEdge]! | ||
DirectDebitInstructionConnectionTypeEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | DirectDebitInstructionType | ||
| cursor | String! | ||
DirectDebitInstructionType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| status | String! | ||
| sortCode | String! | ||
| iban | String! | ||
| accountHolder | String! | ||
| instructionType | String | ||
| cardPaymentNetwork | String | ||
| cardExpiryMonth | Int | ||
| cardExpiryYear | Int | ||
| lastFourDigitsOfAccountNumber ⚠️ | String |
⚠️ DEPRECATED Use 'masked_account_identifier' for a masked reference to the instruction. This field is misleading, as it's only the last 3 digits that are stored. We'll remove this field on 14/03/2020. |
|
| maskedAccountIdentifier | String | ||
| maskedIban | String | ||
DisableToken¶
| Field | Argument | Type | Description |
|---|---|---|---|
| message | String | ||
EflType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| serviceProvider | EFLFileServiceProvider! | ||
| language | String! | ||
| version | String! | ||
| url | String | ||
| productDisplayName | String | ||
ElectricityMeterPointType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| esiId | String! | ||
| serviceProvider | ElectricityMeterPointServiceProvider! | ||
| loadZone | ElectricityMeterPointLoadZone! | ||
| loadProfile | String | ||
| status | ElectricityMeterPointStatus! | ||
| hasCriticalCare | Boolean! | ||
| meters | [ElectricityMeterType] | ||
| id | Int | ||
| includeInactive | Boolean | ||
| agreements | [AgreementType] | ||
ElectricityMeterType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| serialNumber | String! | ||
| activeFrom | DateTime! | ||
| activeTo | DateTime | ||
EmailAttachmentType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| filename | String! | ||
| temporaryUrl | String | ||
EmailAuthentication¶
| Field | Argument | Type | Description |
|---|---|---|---|
| token | String | ||
| errors | [ErrorType] | ||
EmailEventType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| eventType | String! | ||
| occurredAt | DateTime! | ||
| message | EmailType | ||
EmailType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| sentAt | DateTime | ||
| subject | String | ||
| attachments | [EmailAttachmentType] | ||
| textBody | String | ||
| htmlBody | String | ||
| sender | String | ||
| recipient | String | ||
EnrollmentAccountResetPasswordMutation¶
| Field | Argument | Type | Description |
|---|---|---|---|
| resetStatus | Boolean | ||
ErcotDeleteOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| accountNumber | String | ||
ErcotHolidaysOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| holidayList | List[Date] | ||
ErcotMarketData¶
| Field | Argument | Type | Description |
|---|---|---|---|
| SettlementPoint | SettlementPointOptions | ||
| LMP | Float | ||
| LMP5MinuteDifference | Float | ||
| RtorpaRtordpaLmp | Float | ||
| RtorpaRtordpaLmp5MinDifference | Float | ||
| lastUpdatedAt | CustomGrapheneDateTime | ||
ErcotOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| accountNumber | String! | ||
| esiId | String! | ||
| zoneName | LoadZoneName | ||
| productId | String | ||
| duns | String | ||
ErcotQueryType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| account | AccountType | ||
| esiId | String | ||
| duns | String | ||
ErrorType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| field | String! | ||
| messages | [String!]! | ||
FanClubDiscountOutput¶
| Field | Type | Description | |
|---|---|---|---|
| discountAmount | Decimal | The current discount status for the current hour as a decimal between 0 and 1.0. | |
FanClubWindPowerProjections¶
| Field | Type | Description | |
|---|---|---|---|
| windPowerProjections | [WindPowerProjection] | A list of future wind power projections up to 48 hours into the future. | |
FormSubmissionOuput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | Int | ||
| content | JSONString | ||
| errors | [SerializerFieldErrorsType] | ||
GeneratePreSignedToken¶
| Field | Argument | Type | Description |
|---|---|---|---|
| token | String | ||
| tokenExpiryDatetime | DateTime | ||
| scope | PreSignedTokenScope | ||
GenerationDetail¶
| Field | Argument | Type | Description |
|---|---|---|---|
| highestMonth | DateAmount | ||
| highestDay | DateAmount | ||
| highestHourStart | Int | ||
| highestHourEnd | Int | ||
GetAccountWithAccountNumberOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| result | String | ||
GetEmbeddedSecretForAdHocPayment¶
| Field | Argument | Type | Description |
|---|---|---|---|
| secretKey | String | ||
GetEmbeddedSecretForNewPaymentInstruction¶
| Field | Argument | Type | Description |
|---|---|---|---|
| secretKey | String | ||
GetThermostatDetailsType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String | ||
| name | String | ||
| hvacMode | String | ||
| enabled | Boolean | ||
HighestCostDetail¶
| Field | Argument | Type | Description |
|---|---|---|---|
| month | DateAmount | ||
| day | DateAmount | ||
HighestUsageDetail¶
| Field | Argument | Type | Description |
|---|---|---|---|
| month | DateAmount | ||
| day | DateAmount | ||
| hourStart | Int | ||
| hourEnd | Int | ||
IntervalReadingOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| meterPointId | Int | ||
| fromDatetime | DateTime | ||
| toDatetime | DateTime | ||
| consumption | Decimal | ||
| price | Decimal | The market price for an interval reading. This will be `null` for all meterpoints associated with fixed-rate products. | |
InvalidatePreSignedToken¶
| Field | Argument | Type | Description |
|---|---|---|---|
| token | PreSignedToken | ||
InvalidatePreSignedTokensForUser¶
| Field | Argument | Type | Description |
|---|---|---|---|
| tokens | [PreSignedToken] | ||
InvalidateRefreshToken¶
| Field | Argument | Type | Description |
|---|---|---|---|
| token | RefreshToken | ||
InvalidateRefreshTokensForUser¶
| Field | Argument | Type | Description |
|---|---|---|---|
| tokens | [RefreshToken] | ||
InvoiceType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | ||
| billType | BillTypeEnum | ||
| fromDate | Date | ||
| toDate | Date | ||
| temporaryUrl | String | ||
| issuedDate | Date | ||
LedgerType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | Int | ||
| name | String | ||
| ledgerType | String | ||
| balance | Int | ||
| affectsAccountBalance | Boolean | ||
LegalDocuments¶
| Field | Argument | Type | Description |
|---|---|---|---|
| prepaidDisclosureStatement | Link | ||
| termsOfService | Link | ||
| termsOfUse | Link | ||
| yourRightsAsACustomer | Link | ||
Link¶
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String | ||
| fullName | String | ||
| language | string | ||
| url | string | ||
LoadZoneRatesType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| consumptionRates | [ConsumptionRatesType] | ||
LowestCostDetail¶
| Field | Argument | Type | Description |
|---|---|---|---|
| month | DateAmount | ||
| day | DateAmount | ||
LowestUsageDetail¶
| Field | Argument | Type | Description |
|---|---|---|---|
| month | DateAmount | ||
| day | DateAmount | ||
| hourStart | Int | ||
| hourEnd | Int | ||
MasqueradeAuthentication¶
| Field | Argument | Type | Description |
|---|---|---|---|
| token | String | ||
| errors | [ErrorType] | ||
MaximumRefundType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| amount | Int | ||
| reasonToRecommendAmount | MaximumRefundReasonChoices | ||
| recommendedBalance | Int | ||
MeasurementEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | MeasurementInterface | ||
| cursor | String! | ||
MeasurementConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [MeasurementEdge]! | ||
MeasurementInterface¶
| Field | Argument | Type | Description |
|---|---|---|---|
| source | String | ||
| metaData | MeasurementsMetadataOutput | ||
| value | Decimal | ||
| unit | String | ||
| readAt | DateTime | ||
MeasurementTypedSourceOutput¶
| Field | Type | Description | |
|---|---|---|---|
| utility | UtilityType | ||
| readingFrequencyType | ReadingFrequencyType | ||
| readingDirection | ReadingDirectionType | ||
| source | String | ||
| readingQuality | ReadingQualityType | ||
MeasurementEstimatedMoneyType¶
| Field | Type | Description | |
|---|---|---|---|
| estimatedAmount | Decimal | Monetary cost of the statistic. This is the smallest unit of currency, e.g. cents for USD or yen for JPY. Because electricity is priced as a commodity, we must account for fractional cents and this field must be a Decimal. Values from this field should likely not be used for accounting purposes. | |
| costCurrency | [String] | Monetary currency of the statistic in ISO-4217 format. | |
MeasurementStatisticOutput¶
| Field | Type | Description | |
|---|---|---|---|
| ReadingStatisticTypeEnum | ReadingStatisticTypeEnum | The type of statistic being measured for the parent node. | |
| label | String | Display label of the statistic for the parent node. | |
| description | String | Description of the statistic for the parent node. | |
| costExclTax | MeasurementsEstimatedMoneyType | Monetary cost of the statistic (excluding tax), if applicable. | |
| costInclTax | MeasurementsEstimatedMoneyType | Monetary cost of the statistic (including tax), if applicable. | |
| value | Decimal | Consumption / generation value of the statistic, if applicable. | |
MeasurementMetadataOutput¶
| Field | Type | Description | |
|---|---|---|---|
| typedSource | MeasurementsTypedSourceOutput | ||
| statistics | [MeasurementsStatisticOutput] | Statistics relating to the parent measurement node. | |
Metadata¶
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | ||
| value | JSONString | ||
NotifiableApplicationType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| name | String! | ||
| bundleId | String! | ||
| service | NotifiableApplicationService! | ||
| externalProvider | NotifiableApplicationExternalProvider! | ||
| externalProjectId | String! | ||
| description | String! | ||
| pushNotificationBindings | [PushNotificationBindingType!]! | ||
ObtainJSONWebToken¶
| Field | Argument | Type | Description |
|---|---|---|---|
| payload | GenericScalar! | ||
| refreshExpiresIn | Int! | ||
| token | String! | ||
| refreshToken | String! | ||
ObtainKrakenJSONWebToken¶
| Field | Argument | Type | Description |
|---|---|---|---|
| token | String! | ||
| payload | GenericScalar! | ||
| refreshToken | String | ||
| refreshExpiresIn | Int | ||
ObtainLongLivedRefreshToken¶
| Field | Argument | Type | Description |
|---|---|---|---|
| refreshToken | String | ||
| refreshExpiresIn | Int! | ||
OccupancyPeriodType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| effectiveFrom | DateTime | ||
| effectiveTo | DateTime | ||
OeCustomerOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| isOeCustomer | Boolean | ||
OutageMapOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| serviceProvider | ServiceProvider | ||
| link | String | ||
| outageReportNumber | String | ||
| serviceRequestNumber | String | ||
PageInfo¶
| Field | Argument | Type | Description |
|---|---|---|---|
| hasNextPage | Boolean! | ||
| hasPreviousPage | Boolean! | ||
| startCursor | String | ||
| endCursor | String | ||
Payment¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | ||
| postedDate | Date | ||
| amount | Int | ||
| balanceCarriedForward | Int | ||
| isCredit | Boolean | ||
| isAccountCharge | Boolean | ||
| isAccountPayment | Boolean | ||
| isHeld | Boolean | ||
| title | String | ||
| statementId | ID | ||
| isReversed | Boolean! | ||
PaymentForecastType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| paymentNumber | Int | ||
| date | Date | ||
| amount | Int | ||
PaymentInstructionType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| status | String! | ||
| sortCode | String! | ||
| iban | String! | ||
| accountHolder | String! | ||
| instructionType | String | ||
| cardPaymentNetwork | String | ||
| cardExpiryMonth | Int | ||
| cardExpiryYear | Int | ||
| validFrom | DateTime! | ||
| vendor | String! | ||
| cardNumber | String! | ||
| cardType | String | ||
| maskedAccountIdentifier | String | ||
PaymentIntentType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| reference | String! | ||
| accountNumber | String | ||
| amount | Int | ||
| date | Date | ||
PaymentScheduleConnectionTypeConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [PaymentScheduleConnectionTypeEdge]! | ||
PaymentScheduleConnectionTypeEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | PaymentScheduleType | ||
| cursor | String! | ||
PaymentScheduleType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| supplementaryLedger | SupplementaryLedgerType | ||
| validFrom | Date! | ||
| validTo | Date | ||
| reason | PaymentScheduleReasonOptions | ||
| paymentHolidayReason | String! | ||
| paymentDay | Int! | ||
| paymentFrequency | PaymentFrequencyOptions | ||
| paymentFrequencyMultiplier | Int! | ||
| paymentAmount | Int! | ||
| paymentAdequacyAdjustment | Int | ||
| paymentAdequacyAdjustmentExpiryDate | Date | ||
| isVariablePaymentAmount | Boolean! | ||
| scheduleType | PaymentScheduleScheduleType! | ||
| totalDebtAmount | Int | ||
| isPaymentHoliday | Boolean | ||
PhoneNumberOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| isValidPhoneNumber | Boolean | ||
PostcodeZoneMapping¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| postcode | String! | ||
| serviceProvider | PostcodeZoneMappingServiceProvider | ||
| loadZone | PostcodeZoneMappingLoadZone | ||
PreKrakenBillType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | ||
| billType | BillTypeEnum | ||
| fromDate | Date | ||
| toDate | Date | ||
| temporaryUrl | String | ||
| issuedDate | Date | ||
PreSignedToken¶
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | ||
| scope | ExpiringTokenScope! | ||
| isValid | Boolean | ||
ProductType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| marketName | String! | ||
| code | String! | ||
| notes | String! | ||
| fullName | String! | ||
| displayName | String! | ||
| description | String! | ||
| availableFrom | DateTime! | ||
| availableTo | DateTime | ||
| term | Int | ||
| endsAt | DateTime | ||
| availabilityStatus | ProductAvailabilityStatus! | ||
| termsContractType | String! | ||
| isWholesale | Boolean | ||
| generationCredit | Boolean | ||
| basedOnTimeOfUse | Boolean | ||
| autoTopUpMinimumAmount | Int | ||
| autoTopUpDefaultAmount | Int | ||
| prepay | Boolean | ||
| rates | RatesType | ||
| postcode | String | ||
| address | AddressTdspMappingInputType | ||
| esiId | String | ||
| serviceProvider | ServiceProvider | ||
| loadZone | LoadZone | ||
ProductWithRatesOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | ||
| fullName | String | ||
| displayName | String | ||
| description | String | ||
| rates | [ConciseRatesOutput] | ||
| filterRatesBy | ConciseRatesInput | ||
| prepay | Boolean | ||
PropertyType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String | ||
| addressLine1 | String! | ||
| addressLine2 | String! | ||
| addressLine3 | String! | ||
| addressLine4 | String! | ||
| addressLine5 | String! | ||
| postcode | String! | ||
| address | String | ||
| splitAddress | [String] | ||
| occupancyPeriods | [OccupancyPeriodType] | ||
| coordinates | CoordinatesType | ||
| meterPoints | [ElectricityMeterPointType] | ||
ProvisionalTransactionConnectionTypeConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [ProvisionalTransactionConnectionTypeEdge]! | ||
ProvisionalTransactionConnectionTypeEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | ProvisionalTransactionType | ||
| cursor | String! | ||
ProvisionalTransactionType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| title | String | ||
| amount | Int | ||
| date | Date | ||
PushNotificationBindingType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID! | ||
| messages | [EmailType!]! | ||
| user | AccountUserType! | ||
| token | String! | ||
| application | NotifiableApplicationType! | ||
| registeredAt | DateTime! | ||
| expiresAt | DateTime! | ||
QuizOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| question | String | ||
| answer | String | ||
| invalidAnswer1 | String | ||
| invalidAnswer2 | String | ||
| invalidAnswer3 | String | ||
RatesType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| tdspRates | TdspRatesType | ||
| loadZoneRates | LoadZoneRatesType | ||
| agnosticRates | AgnosticRatesType | ||
RecordDepositAgreementAccepted¶
| Field | Argument | Type | Description |
|---|---|---|---|
| isRecorded | Boolean | ||
ReferralCodeStatusType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| isValid | Boolean | ||
| description | String | ||
| maxRecurrence | String | ||
| codeType | CodeType | ||
ReferralConnectionTypeConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [ReferralConnectionTypeEdge]! | ||
ReferralConnectionTypeEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | ReferralType | ||
| cursor | String! | ||
ReferralSchemeType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| referralUrl | String | ||
| referralDisplayUrl | String | ||
| referrerRewardAmount | Int | ||
| referredRewardAmount | Int | ||
| combinedRewardAmount | Int | ||
| canBeReferred | Boolean | ||
| code | String | ||
| referrerGivenName | String | ||
| referrerFamilyName | String | ||
ReferralSchemeTypes¶
| Field | Argument | Type | Description |
|---|---|---|---|
| domestic | ReferralSchemeType | ||
| business | ReferralSchemeType | ||
| friendsAndFamily ⚠️ | ReferralSchemeType |
⚠️ DEPRECATED Please use domestic instead. |
|
ReferralType¶
| Field | Argument | Type | Description | |
|---|---|---|---|---|
| id | ID! | |||
| referredUserName | String | |||
| paymentStatus | String | |||
| paymentDate | Date | |||
| referredUserJoinDate | DateTime | code | String | |
| referredUserPaymentAmount | Int! | Payment given to the referred user in cents. | ||
| referringUserPaymentAmount | Int! | Payment given to the referring user in cents. | ||
| combinedPaymentAmount | Int! | The payment amount received by the referrer and the referee combined. | ||
Refresh¶
| Field | Argument | Type | Description |
|---|---|---|---|
| payload | GenericScalar! | ||
| refreshExpiresIn | Int! | ||
| token | String! | ||
| refreshToken | String! | ||
RefreshToken¶
| Field | Argument | Type | Description |
|---|---|---|---|
| key | String! | ||
| expiryDt | DateTime! | ||
| isValid | Boolean | ||
Refund¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | ||
| postedDate | Date | ||
| amount | Int | ||
| balanceCarriedForward | Int | ||
| isCredit | Boolean | ||
| isAccountCharge | Boolean | ||
| isAccountPayment | Boolean | ||
| isHeld | Boolean | ||
| title | String | ||
| statementId | ID | ||
| isReversed | Boolean! | ||
RegisterPushNotificationBinding¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pushNotificationBinding | PushNotificationBindingType | ||
RequestResetPasswordMutationPayload¶
| Field | Argument | Type | Description |
|---|---|---|---|
| String! | |||
| isCreateMode | Boolean | ||
| errors | [ErrorType] | ||
| clientMutationId | String | ||
ResetPasswordMutationPayload¶
| Field | Argument | Type | Description |
|---|---|---|---|
| errors | [SerializerFieldErrorsType] | ||
| clientMutationId | String | ||
RichAddressType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String | ||
| organization | String | ||
| streetAddress | String | ||
| structuredStreetAddress | GenericScalar | ||
| dependentLocality | String | ||
| locality | String | ||
| administrativeArea | String | ||
| postalCode | String | ||
| sortingCode | String | ||
| country | String | ||
| deliveryPointIdentifier | String | ||
SerializerErrorType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| message | String | ||
| code | String | ||
SerializerFieldErrorsType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| field | String | ||
| errors | [ErrorTypeUnion!] | ||
SmartGridCisDeleteOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| accountNumber | String | ||
SmartGridCisOutputType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| accountNumber | String! | ||
| sgAccountNumber | String! | ||
| sgAccountId | String | ||
| phoneNumber | String | ||
| productId | Int | ||
SpecialCircumstanceRecordType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | ||
| summary | String | ||
| internalCode | String | ||
SpecialCircumstancesType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| isSharingConsentGiven | Boolean | ||
| records | [SpecialCircumstanceRecordUnion] | ||
StandingRatesType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String | ||
| taxable | Boolean | ||
| taxCode | String | ||
| loadZone | LoadZone | ||
| description | String | ||
| serviceProvider | ServiceProvider | ||
| unitType | UnitType | ||
| currency | Currency | ||
| pricePerUnit | Decimal | ||
| efls | [EflType] | ||
| language | EFLLanguage | ||
| bandCategory | BandCategory | ||
| bandSubcategory | String | ||
| band | String | ||
StatementType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | ||
| billType | BillTypeEnum | ||
| fromDate | Date | ||
| toDate | Date | ||
| temporaryUrl | String | ||
| issuedDate | Date | ||
| closingBalance | Int | ||
| isExternalBill | Boolean | ||
| transactions | TransactionConnectionTypeConnection | ||
| before | String | ||
| after | String | ||
| first | Int | ||
| last | Int | ||
| userId | Int | ||
| toAddress | String | ||
| paymentDueDate | Date | ||
| consumptionStartDate | Date | ||
| consumptionEndDate | Date | ||
| reversalsAfterClose | StatementReversalsAfterClose! | ||
StoreAchDirectDebitInstruction¶
| Field | Argument | Type | Description |
|---|---|---|---|
| paymentInstruction | PaymentInstructionType | ||
StoreCardPaymentInstruction¶
| Field | Argument | Type | Description |
|---|---|---|---|
| paymentInstruction | PaymentInstructionType | ||
StoreCreditScore¶
| Field | Argument | Type | Description |
|---|---|---|---|
| result | Boolean | ||
SubdomainOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| isValid | Boolean | ||
SubmitCustomerFeedback¶
| Field | Argument | Type | Description |
|---|---|---|---|
| customerFeedback | CustomerFeedbackType | ||
SupplementaryLedgerType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | ||
| name | String | ||
| ledgerType | String | ||
| currentBalance | Int | ||
TdspRatesType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| standingRates | [StandingRatesType] | ||
| consumptionRates | [ConsumptionRatesType] | ||
TemporarySpecialCircumstanceRecordType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | ID | ||
| summary | String | ||
| internalCode | String | ||
| expiryDate | Date | ||
TermsAndConditionsType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String | ||
| pdfUrl | String | ||
| brandCode | String | ||
| markdown | String | ||
| html | String | ||
| version | String | ||
| effectiveFrom | DateTime | ||
ThirdPartyOrganizationType¶
| Field | Argument | Type | Description |
|---|---|---|---|
| name | String! | ||
TotalSummary¶
| Field | Argument | Type | Description |
|---|---|---|---|
| start | String | ||
| end | String | ||
| costDetails | CostDetails | ||
| usageDetails | UsageDetails | ||
| quiz | [QuizOutput] | ||
ToggleThermostatControl¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String | ||
| accountNumber | String | ||
| hvacMode | String | ||
| setEnabled | String | ||
ToggleThermostatControlInput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| id | String | ||
| accountNumber | String | ||
| setEnabled | String | ||
TotalUsage¶
| Field | Argument | Type | Description |
|---|---|---|---|
| currYear | Int | ||
| currYearUsage | Decimal | ||
| lastYear | Int | ||
| lastYearUsage | Decimal | ||
| yearOverYearChange | Decimal | ||
TransactionConnectionTypeConnection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| pageInfo | PageInfo! | ||
| edges | [TransactionConnectionTypeEdge]! | ||
TransactionConnectionTypeEdge¶
| Field | Argument | Type | Description |
|---|---|---|---|
| node | TransactionType | ||
| cursor | String! | ||
TriggerPostUploadOperations¶
| Field | Argument | Type | Description |
|---|---|---|---|
| operationsTriggered | Boolean | ||
UpdateAccountReference¶
| Field | Argument | Type | Description |
|---|---|---|---|
| accountReference | AccountReferenceType | ||
UpdateAccountUserCommsPreferencesMutationPayload¶
| Field | Argument | Type | Description |
|---|---|---|---|
| isOptedInToClientMessages | Boolean | ||
| isOptedInToOfferMessages | Boolean | ||
| isOptedInToRecommendedMessages | Boolean | ||
| isOptedInToUpdateMessages | Boolean | ||
| isOptedInToThirdPartyMessages | Boolean | ||
| isOptedInMeterReadingConfirmations | Boolean | ||
| isOptedInToSmsMessages | Boolean | ||
| isUsingInvertedEmailColours | Boolean | ||
| fontSizeMultiplier | Float | ||
| emailFormat | String | ||
| preferredHoldMusic | String | ||
| errors | [ErrorType] | ||
| commsPreferences | AccountUserCommsPreferences | ||
| clientMutationId | String | ||
UpdateAccountUserMutationPayload¶
| Field | Argument | Type | Description |
|---|---|---|---|
| givenName | String | ||
| familyName | String | ||
| pronouns | String | ||
| mobile | String | ||
| String | |||
| dateOfBirth | Date | ||
| landline | String | ||
| errors | [ErrorType] | ||
| clientMutationId | String | ||
UpdateAffiliateLink¶
| Field | Argument | Type | Description |
|---|---|---|---|
| affiliateLink | AffiliateLinkType | ||
UpdateCommsDeliveryPreference¶
| Field | Argument | Type | Description |
|---|---|---|---|
| account | AccountInterface | ||
UpdateErcotData¶
| Field | Argument | Type | Description |
|---|---|---|---|
| ercotData | ErcotOutputType | ||
UpdateMetadata¶
| Field | Argument | Type | Description |
|---|---|---|---|
| metadata | Metadata | ||
UpdatePassword¶
| Field | Argument | Type | Description |
|---|---|---|---|
| viewer | AccountUserType | ||
UpdateShellAccountCommsPreference¶
| Field | Argument | Type | Description |
|---|---|---|---|
| isUpdated | Boolean | ||
UpdateSmartGridCisData¶
| Field | Argument | Type | Description |
|---|---|---|---|
| smartgridcisData | SmartGridCisOutputType | ||
UpdateUserMutation¶
| Field | Argument | Type | Description |
|---|---|---|---|
| viewer | AccountUserType | ||
UploadPostRequest¶
| Field | Argument | Type | Description |
|---|---|---|---|
| url | String! | ||
| fields | JSONString! | ||
| key | String! | ||
UsageDetails¶
| Field | Argument | Type | Description |
|---|---|---|---|
| lowestUsage | LowestUsageDetail | ||
| highestUsage | HighestUsageDetail | ||
| totalUsage | TotalUsage | ||
| generation | GenerationDetail | ||
ValidateEmail¶
| Field | Argument | Type | Description |
|---|---|---|---|
| isValid | Boolean | ||
Verify¶
| Field | Argument | Type | Description |
|---|---|---|---|
| payload | GenericScalar! | ||
VerifyACHPaymentInstruction¶
| Field | Argument | Type | Description |
|---|---|---|---|
| result | VerifyACHPaymentInstructionOutput | ||
VerifyACHPaymentInstructionOutput¶
| Field | Argument | Type | Description |
|---|---|---|---|
| bankAccountVerified | Boolean | ||
WindPowerProjection¶
| Field | Argument | Type | Description |
|---|---|---|---|
| deliveryDatetime | String | The datetime to which this prediction applies in ISO format. | |
| totalPowerProjection | Decimal | Projected total power grid-wide in megawatts. | |
| windPowerProjection | Decimal | Projected total wind power grid-wide in megawatts. | |
| projectedWindPowerPercentage | Decimal | The predicted proportion of wind power on the grid. Ranges from 0.0 to 1.0. | |