Inputs
Inputs¶
AccountReferenceInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| namespace | String! | ||
| value | String! | ||
AccountCreatedByAffiliateInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| emailAddress | String! | ||
AccountCheckoutInformationInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| esiId | String! | ||
| productId | String! | ||
AccountUserInput¶
| Field | Type | Description | |
|---|---|---|---|
| givenName | String! | ||
| familyName | String! | ||
| String! | |||
| mobile | String | ||
| landline | String | ||
| communicationPreference | communication_preference | ||
| LanguagePreferenceInput | LanguagePreferenceChoices | ||
| dateOfBirth | Date! | ||
AddPropertyToShellAccountInputType¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| esiId | String! | ||
| effectiveFrom | DateTime | ||
| addressLine1 | String! | ||
| addressLine2 | String! | ||
| addressLine3 | String | ||
| city | String! | ||
| state | String! | ||
| postcode | String! | ||
| enrollmentType | ShellAccountEnrollmentTypeEnum! | ||
| hasCriticalCare | Boolean | ||
| productId | String! | ||
| autoTopUpPaymentAmount | Int | ||
AddressTdspMappingInputType¶
| Field | Type | Description | |
|---|---|---|---|
| houseNumber | String | ||
| address | String! | ||
| city | String! | ||
| postCode | String! | ||
| state | String | ||
ApplyRewardInputType¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| reference | String! | ||
BillingAddressInput¶
| Field | Type | Description | |
|---|---|---|---|
| address1 | String! | ||
| address2 | String | ||
| city | String! | ||
| state | String! | ||
| zipCode | String! | ||
CollectAdHocACHPaymentInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| amount | Int! | ||
| paymentDate | Date! | ||
| description | String! | ||
| idempotencyKey | String! | ||
CollectAdHocPaymentForInstructionInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| amount | Int! | ||
| reference | String! | ||
| description | String! | ||
| paymentDate | Date! | ||
| idempotencyKey | String! | ||
CollectDepositInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| depositKey | String! | ||
| idempotencyKey | String! | ||
ConciseRatesBaseInput¶
| Field | Type | Description | |
|---|---|---|---|
| esiId | String | ||
| serviceProvider | ServiceProvider | ||
| loadZone | LoadZone | ||
ConciseRatesInput¶
| Field | Type | Description | |
|---|---|---|---|
| esiId | String | ||
| serviceProvider | ServiceProvider | ||
| loadZone | LoadZone | ||
| kwhUsage | Decimal | ||
CreateAccountChargeInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| netAmount | Int! | ||
| grossAmount | Int! | ||
| salesTaxAmount | Int! | ||
| cclAmount | Int | ||
| metadata | JSONString | ||
| note | String | ||
| reason | AccountChargeReasonType! | ||
CreateAccountCreditInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| netAmount | Int! | ||
| grossAmount | Int! | ||
| salesTaxAmount | Int! | ||
| metadata | JSONString | ||
| note | String | ||
| reason | AccountCreditReasonType! | ||
CreateAccountFileAttachmentInput¶
| Field | Type | Description | |
|---|---|---|---|
| filename | String! | ||
| accountNumber | String! | ||
| category | Category! | ||
| clientMutationId | String | ||
CreateAccountInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountUser | AccountUserInput! | ||
| billingAddress | BillingAddressInput! | ||
| salesInformation | SalesInfoInput! | ||
| ssn | String | ||
CreateAffiliateLinkInputType¶
| Field | Type | Description | |
|---|---|---|---|
| organisationId | ID! | ||
| subdomain | String! | ||
| contactName | String! | ||
| contactEmail | String! | ||
CreateAffiliateSessionInputType¶
| Field | Type | Description | |
|---|---|---|---|
| linkId | ID! | ||
| ipAddress | String! | ||
| userAgent | String! | ||
| queryParams | CreateAffiliateSessionParams! | ||
| quoteShareId | ID! | ||
CreateAffiliateSessionParams¶
| Field | Type | Description | |
|---|---|---|---|
| additionalQueryParams | JSONString! | ||
| event | String! | ||
| eventCreated | String! | ||
| eventInformation | JSONString! | ||
| route | String! | ||
| sessionId | ID! | ||
| successfulConversion | Boolean! | ||
CustomerCreateQuoteInput¶
| Field | Type | Description | ||
|---|---|---|---|---|
| esiId | String! | The meter point's unique identification number. | ||
| accountNumber | String! | Account number. | ||
CustomerAcceptQuoteInput¶
| Field | Type | Description | ||
|---|---|---|---|---|
| accountNumber | String! | The account number. | ||
| code | String! | The quoted product's code. | ||
| productId | String! | The selected product's id. | ||
| effectiveFrom | DateTime! | Datetime at which the new agreement should be effective from. If not given, it defaults to the current local time (CST) midnight aligned. | ||
CreateQuoteInput¶
| Field | Type | Description | ||
|---|---|---|---|---|
| affiliateSessionId | String! | Optional affiliate session id for associating a quote with an affiliate. | ||
| postCode | String! | A post code that should be used to generate a quote for. | ||
| paymentMethod | PaymentMethods! | A post code that should be used to generate a quote for. | ||
| extraCriteria | QuoteExtraCriteria! | A meta data field. | ||
CustomerRevokeFutureAgreementsInput¶
| Field | Type | Description | ||
|---|---|---|---|---|
| accountNumber | String! | Account number. | ||
CreateDepositAgreementInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| depositKey | String! | ||
| reason | String! | ||
CreatePaymentIntentInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| amount | Int! | ||
| date | Date! | ||
CreateShellAccountInput¶
| Field | 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 | ||
| clientMutationId | String | ||
CustomerFeedbackInputType¶
| Field | Type | Description | |
|---|---|---|---|
| answer | String | ||
| issueResolved | Boolean! | ||
| formId | Int! | ||
| feedbackId | Int! | ||
| accountNumber | String! | ||
DailyReadingInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| esiId | String! | ||
| fromDatetime | DateTime! | ||
| toDatetime | DateTime! | ||
DeletePushNotificationBindingInput¶
| Field | Type | Description | |
|---|---|---|---|
| token | String! | ||
DepositAgreementInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| depositKey | String! | ||
EnrollmentAccountResetPasswordInputType¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| emailAddress | String! | ||
| password | String! | ||
ErcotDeleteInputType¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| esiId | String! | ||
| zoneName | LoadZoneName | ||
| productId | String | ||
| duns | String | ||
ErcotInputType¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| esiId | String! | ||
| zoneName | LoadZoneName | ||
| productId | String | ||
| duns | String | ||
FormSubmissionInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| formType | FormType | ||
| content | JSONString! | ||
FraudAlerts¶
| Field | Type | Description | |
|---|---|---|---|
| code | String! | ||
| description | String! | ||
GetEmbeddedSecretForAdHocPaymentInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| amount | Int! | ||
| description | String! | ||
GetEmbeddedSecretForNewPaymentInstructionInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| instructionType | PaymentType! | ||
IntervalReadingInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| esiId | String! | ||
| fromDatetime | DateTime! | ||
| toDatetime | DateTime! | ||
InvalidatePreSignedTokenInput¶
| Field | Type | Description | |
|---|---|---|---|
| token | String! | ||
InvalidatePreSignedTokensForUserInput¶
| Field | Type | Description | |
|---|---|---|---|
| String! | |||
| scope | PreSignedTokenScope | ||
InvalidateRefreshTokenInput¶
| Field | Type | Description | |
|---|---|---|---|
| refreshToken | String! | ||
InvalidateRefreshTokensForUserInput¶
| Field | Type | Description | |
|---|---|---|---|
| String! | |||
LanguagePreferenceInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| languagePreference | LanguagePreferenceChoices! | ||
MeasurementConnectionInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String | Exclusive with `propertyId`. | |
| propertyId | ID | Exclusive with `accountNumber`. | |
| startAt | Datetime | Earliest datetime to return measurements from. Used with `endAt`. | |
| endAt | Datetime | Latest datetime to return measurements from. Used with `startAt`. Exclusive range. | |
| startOn | Datetime | Earliest datetime to return measurements from. Used with `endOn`. | |
| endOn | Datetime | Latest datetime to return measurements from. Used with `startOn`. Inclusive range. | |
| timezone | String | Timezone to use for grouping. This should likely be the local timezone. | |
| typedOnly | MeasurementTypedOnlyInput | The main mechanism used to filter results. | |
MeasurementTypedSourceInput¶
| Field | Type | Description | |
|---|---|---|---|
| utility | UtilityType | All OEUS accounts are on `Electricity` contracts. | |
| readingFrequencyType | ReadingFrequencyType | The level of aggregation the API should return. | |
| readingDirection | ReadingDirectionType | Kilowatts consumed or kilowatts generated. | |
| source | String | The string reading source as it exists in Kraken's database. This field is seldom used. If not provided, it is derived from the other inputs. | |
| readingQuality | ReadingQualityType | The OEUS Kraken only supports `Actual` readings. | |
MetadataInput¶
| Field | Type | Description | |
|---|---|---|---|
| identifier | String! | ||
| linkedObjectType | LinkedObjectType! | ||
| key | String! | ||
| value | JSONString! | ||
ObtainJSONWebTokenInput¶
| Field | Type | Description | |
|---|---|---|---|
| String | |||
| password | String | ||
| APIKey | String | ||
| organizationSecretKey | String | ||
| preSignedKey | String | ||
| refreshToken | String | ||
ObtainLongLivedRefreshTokenInput¶
| Field | Type | Description | |
|---|---|---|---|
| krakenToken | String! | ||
ProductInput¶
| Field | Type | Description | |
|---|---|---|---|
| id | ID | ||
| displayName | String | ||
| basedOnTimeOfUse | Boolean | ||
| availableAt | DateTime | ||
| prepay | Boolean | ||
QuoteExtraCriteria¶
| Field | Type | Description | ||
|---|---|---|---|---|
| kwhConsumption | Decimal! | Defaults to 1000 kWh if no value is given. | ||
| kwhUsagePeriod | EstimationInterval! | A usage period that should be used to estimate a quote request. Defaults to ANNUALLY if not given. | ||
RegisterPushNotificationBindingInput¶
| Field | Type | Description | |
|---|---|---|---|
| token | String! | ||
| bundleId | String! | ||
RequestResetPasswordMutationInput¶
| Field | Type | Description | |
|---|---|---|---|
| String! | |||
| isCreateMode | Boolean | ||
| clientMutationId | String | ||
ResetPasswordMutationInput¶
| Field | Type | Description | |
|---|---|---|---|
| password | String! | ||
| userId | String! | ||
| token | String! | ||
| clientMutationId | String | ||
SalesInfoInput¶
| Field | Type | Description | |
|---|---|---|---|
| salesSubchannel | SalesSubchannel | ||
| salesAffiliateSubdomain | String | uniqueReferenceNumber | String |
| optedInForMarketing | Boolean | ||
| optedInToRecommendedMessages | Boolean | ||
| optedInToUpdates | Boolean | ||
| optedInToAssociatedCompanies | Boolean | ||
| optedInToThirdParties | Boolean | ||
| optedInToSms | Boolean | ||
SmartGridCisDeleteInputType¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| sgAccountId | String! | ||
StoreAchDirectDebitInstructionInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| secretKey | String! | ||
StoreCardPaymentInstructionInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| validFrom | DateTime! | ||
| vendorReference | String! | ||
StoreCreditScoreInputType¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| fraudDetectionHash | String! | ||
| score | Int! | ||
| fraudAlerts | Fraud Alerts! | ||
| riskBracket | Risk Bracket! | ||
TypedSourceInputType¶
| Field | Type | Description | |
|---|---|---|---|
| utility | UtilityType! | ||
| readingFrequencyType | ReadingFrequencyType! | ||
| readingDirection | ReadingDirectionType! | ||
| sourceIdentifier | String! | ||
UpdateAccountUserCommsPreferencesMutationInput¶
| Field | Type | Description | |
|---|---|---|---|
| isOptedInToClientMessages | Boolean | ||
| isOptedInToOfferMessages | Boolean | ||
| isOptedInToRecommendedMessages | Boolean | ||
| isOptedInToUpdateMessages | Boolean | ||
| isOptedInToThirdPartyMessages | Boolean | ||
| isOptedInMeterReadingConfirmations | Boolean | ||
| isOptedInToSmsMessages | Boolean | ||
| isUsingInvertedEmailColours | Boolean | ||
| fontSizeMultiplier | Float | ||
| emailFormat | String | ||
| preferredHoldMusic | String | ||
| clientMutationId | String | ||
UpdateAccountUserMutationInput¶
| Field | Type | Description | |
|---|---|---|---|
| givenName | String | ||
| familyName | String | ||
| pronouns | String | ||
| mobile | String | ||
| String | |||
| dateOfBirth | Date | ||
| landline | String | ||
| clientMutationId | String | ||
UpdateAffiliateLinkInputType¶
| Field | Type | Description | |
|---|---|---|---|
| linkId | ID! | ||
| organisationId | ID | ||
| subdomain | String | ||
| contactName | String | ||
| contactEmail | String | ||
| isBusiness | Boolean | ||
| landingUrl | String | ||
| trainingStatus | String | ||
UpdateCommsDeliveryPreferenceInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| commsDeliveryPreference | CommsDeliveryPreference! | ||
UpdatePasswordInput¶
| Field | Type | Description | |
|---|---|---|---|
| oldPassword | String! | ||
| newPassword | String! | ||
| newPasswordConfirmed | String! | ||
UpdateShellAccountCommsPreferenceInputType¶
| Field | Type | Description | |
|---|---|---|---|
| optedInToSms | Boolean | ||
| emailAddress | String! | ||
| optedInToClientMessages | Boolean | ||
| optedInToOfferMessages | Boolean | ||
| optedInToRecommendedMessages | Boolean | ||
| optedInToThirdParties | Boolean | ||
| useInvertedEmailColours | Boolean | ||
| fontSizeMultiplier | Float | ||
UpdateUserInput¶
| Field | Type | Description | |
|---|---|---|---|
| givenName | String | ||
| familyName | String | ||
| pronouns | String | ||
| String | |||
| mobile | String | ||
| dateOfBirth | Date | ||
| landline | String | ||
| userId | String | ||
ValidateEmailInput¶
| Field | Type | Description | |
|---|---|---|---|
| String! | |||
VerifyACHPaymentInstructionInput¶
| Field | Type | Description | |
|---|---|---|---|
| accountNumber | String! | ||
| amounts | [Int]! | ||