accountNumber (ID)

The account number to filter for.

category (APIExceptionCategories)

The category to filter for.

channel (String)

The channel to filter for.

customerContact (String)

The customer contact to filter for.

externalIdentifier (String)

The external identifier to filter for.

priority (APIExceptionPriority)

The priority to filter for.

resolutionStatus (APIExceptionResolutionStatus)

The resolution status to filter for.

resolutionType (APIExceptionResolutionType)

The resolution type to filter for.

supplyPointIdentifier (ID)

The supply point identifier to filter for.

tags ([APIExceptionTags])

Tags to filter for.

userId (ID)

The user ID to filter for.

accountNumber (String!)

The account number.

clientParams (JSONString)

A JSON object containing client parameters to store on the quote.

marketParams (JSONString)

A JSON object containing market parameters to store on the purchase.

quoteId (Int!)

ID of the accepted quote.

accountNumber (String!)

The account number.

enrolmentId (ID!)

The ID of the Enrolment.

termsVersion (TermsVersionInput!)

The version of accepted terms and conditions.

accountNumber (String)

The account number of the account to update.

billingAddress (BillingAddressDetailsInput)

Billing address details.

accountNumber (ID!)

The account number.

ledgerId (ID!)

The ledger id for the account.

accountNumber (String!)

Account number.

accountNumber (String!)

The account number.

namespace (String!)

The namespace for the reference.

value (String!)

The reference value.

account (String)

Internal account id (not account number).

accountNumber (String)

The account number eg. A-FF15AE70.

accountReferences (String)

Account Reference.

billingName (String)

Account or Billing name.

businessName (String)

Business name.

businessNumber (String)

Business identifier or number.

location (String)

Location (Supply or Billing, full or partial, address or post code).

meterSerialNumber (String)

Meter Serial Number.

mpan (String)

MPAN of property.

mprn (String)

MPRN of property.

portfolioNumber (String)

The portfolio number eg. P-A123B456.

statements (String)

Statements.

telephoneNumber (String)

Telephone.

urn (String)

URN Number.

user (String)

The Account User ID (not account number).

creditScoreData (CreditScoreData)

creditScoreFetchedAt (DateTime)

dateOfBirth (Date)

email (String!)

familyName (String!)

givenName (String!)

mobile (String!)

optedInForMarketing (Boolean!)

psrData (UpdateSpecialCircumstancesInput)

roles ([String])

Role codes of the roles to be assigned to the user.

accountNumber (String!)

The account number.

campaign (String!)

The slug of the campaign we want to assign.

expiryDate (Date)

The date in which the link between the campaing and the account is meant to expire. If null, no specific expiring date will be set.

startDate (Date)

The date in which the link between the campaing and the account is meant to start. If null, no specific start date will be set.

externalAccountId (String!)

Identifier of an account in the external system.

tokenValue (String!)

Token identifier.

validFrom (DateTime!)

The start time of token's validity.

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.

addressLine1 (String)

addressLine2 (String)

addressLine3 (String)

addressLine4 (String)

addressLine5 (String)

postcode (String!)

Postcode of the property where the appointment took place.

addressLine1 (String!)

addressLine2 (String!)

addressLine3 (String!)

county (String!)

postcode (String!)

town (String!)

agreementId (ID!)

The Kraken ID of the agreement to be renewed. The agreement must be currently active.

productCode (String!)

The code of the product the agreement will be renewed to.

accountNumber (String!)

The account number.

amount (Int!)

The new amount for the amended payment.

paymentDate (Date!)

The new date to collect the payment.

paymentId (Int!)

The ID of the payment to amend.

reason (String)

Reason for amending the payment.

readingDatetime (DateTime!)

The new datetime of reading.

readingId (Int!)

The ID of the reading that will be amended.

readingValue (Int!)

The new value of reading.

accountNumber (ID!)

The account number for the requested repayment.

repaymentId (ID!)

The id of the account repayment to be approved.

bucketName (String!)

The name of the bucket to assign the conversation to.

clientMutationId (String)

conversationRelayId (ID!)

The relay id of the conversation that will be assigned to the bucket.

accessToken (String)

SSO access token for the chosen provider authentication.

authorizationCode (String)

Provider code from user login used for SSO.

expiresIn (Int)

SSO token expiry for the provider's authentication (integer in seconds).

providerDeviceId (String)

ID of the device in the external provider system.

redirectUri (String)

Full redirect URI (including all query string parameters) from the result of an OAuth 2.0 flow.

refreshToken (String)

SSO refresh token for the chosen provider authentication.

state (String)

State from user login used for SSO.

eventId (ID!)

The ID of the action to perform.

params ([BackendScreenParamInputType])

List of key-value pairs (strings) to pass as parameters to the mutation.

key (String!)

value (String!)

balanceThreshold (Int!)

The ledger balance (in the minor currency unit) which when passed will trigger a payment to be taken.

targetBalance (Int)

The target balance (in the minor currency unit) for the ledger; used to calculate the payment amount. Defaults to zero.

accountHolder (String)

accountNumber (String)

accountType (String)

bankCode (String)

branchCode (String)

iban (String)

accountNumber (String!)

Account number.

minimumSocPercentage (Int!)

The minimum state of charge (soc) %.

rateType (NonBespokeElectricityRateTypeChoices!)

Rate type associated with the given unit rate.

unitRate (Decimal!)

Electricity bespoke unit rate to override the unit rate associated with the tariff.

paymentMethod (PaymentMethod!)

Payment method associated with the given unit rate.

standingCharge (Decimal)

Bespoke standing charge.

unitRate (Decimal)

Gas bespoke unit rate.

unitRates ([BespokeElectricityUnitRatesInput])

Electricity bespoke unit rates with their associated rate type.

standingCharge (Decimal)

Bespoke standing charge.

unitRate (Decimal)

Gas bespoke unit rate.

unitRates ([BespokeElectricityUnitRatesInput])

Electricity bespoke unit rates with their associated rate type.

accountNumber (String!)

The account number.

mpan (String!)

The mpan number.

targetBalance (Int)

The target balance (in the minor currency unit) for the ledger; used to calculate the payment amount. Defaults to zero.

frequencyMultiplier (Int)

The multiple of months at which payment are taken. Required when a payment day is chosen, ignored if payment day not set.

paymentDay (Int)

The day of the month at which to take payment (1-28). If not provided payment is taken whenever a bill is issued.

administrativeArea (String)

Administrative area.

country (String)

Billing country.

deliveryPointIdentifier (String)

Billing delivery point identifier.

dependentLocality (String)

Billing dependent locality.

locality (String)

Billing locality.

postalCode (String)

Billing postal code.

sortingCode (String)

Billing sorting code.

streetAddress (String)

Billing street address.

structuredStreetAddress (GenericScalar)

Billing structured street address.

accountNumber (String)

The account number of the item.

callWindowEnd (DateTime)

The end of the call window for the item.

callWindowStart (DateTime)

The start of the call window for the item.

metadata (JSONString)

The metadata of the item.

phoneNumber (String)

The phone number of the item.

leaveSupplierProcessId (ID!)

The ID of the LeaveSupplier process to cancel.

reason (String)

The reason for the cancellation.

accountNumber (ID!)

The account number.

paymentId (ID!)

The ID of the payment to cancel.

reason (String)

Reason for cancelling the payment.

requestId (String!)

The id of the request to be cancelled.

wizardId (ID!)

The ID of the SmartFlex onboarding wizard to cancel.

number (String!)

The export certificate number.

type (CertificateType!)

The export certificate type.

businessType (BusinessTypeEnum!)

Type of the business: LTD, Charity, SoleTrader or Partnership.

companyNumber (String)

Company registration number. Only needed for LTDs.

deviceId (String!)

The device id of the device (e.g. B0-11-2E-33-FF-45-C6-78).

accountNumber (String!)

Account number.

state (Boolean!)

The state that the climate control device should be set to. A value of true indicates that the device should be turned on, and a value of false indicates it should be switched off.

accountNumber (String!)

The account number.

agency (String!)

The DCA agency owning the proceeding.

campaign (String)

The campaign for the proceeding.

notifyDca (Boolean)

Whether to send a notification to the DCA.

stopReason (String!)

The reason for stopping.

stoppedDate (String!)

The date where dca proceeding stopped.

accountNumber (String!)

The account number.

amount (Int!)

The payment amount (in pence).

collectionMethod (PaymentType)

The type of the payment instruction.

description (String!)

The reason a payment is being collected, for internal audit purposes.

idempotencyKey (String!)

ledgerId (ID!)

The ID of the ledger on which to collect the payment.

paymentDate (Date!)

The date to attempt to take the payment. Cannot be a date in the past. Payment will be collected on the requested date or as soon as possible after that date.

accountNumber (String!)

The account number.

agency (String!)

The agency.

amount (Int)

Amount of debt.

campaign (String!)

The campaign.

dateStarted (String!)

The date where commencement started.

isWhiteLabel (Boolean!)

If the commencement is white label.

notes (String)

Notes for the commencement.

affiliateLinkSubdomain (String)

The subdomain of the affiliate link used to track the commission.

fixedTpiFee (Int)

The fixed comission fee, in pence, which is paid to the third-party intermediary.

organizationName (String!)

The third-party intermediary who sold this renewal to the customer.

standingChargeUplift (Decimal)

The amount to add to the standing charge when billing, in pence/day, which is paid to the third-party intermediary.

unitRateUplift (Decimal!)

The amount to add to the unit rate when billing, in pence/kWh, which is paid to the third-party intermediary.

chfDeviceId (String!)

Device ID of the CHF (Communications Hub Function).

installationCode (String!)

Code provided by manufacturer as part of ASN data, and included as part of device pre-notification, which is required to authorise device commissioning.

meterDeviceId (String!)

Device ID (ESME or GSME) of the device being commissioned.

meterType (MeterTypeChoices!)

Type of meter being commissioned

mpxn (String)

serialNumber (String)

Serial number for ESME or GSME devices.

continuationUri (String!)

The entire continuation URI returned by the vendor.

stepId (ID!)

The ID of the SmartFlex onboarding step to complete.

wizardId (ID!)

The ID of the SmartFlex onboarding wizard.

accountNumber (String!)

Account number that the device is registered to.

externalDeviceIdentifier (String!)

External reference in the third-party system to identify the device.

postalCode (String!)

Postcode of the property (linked to the account) that the device is registered to.

stepId (ID!)

The ID of the SmartFlex onboarding step to complete.

wizardId (ID!)

The ID of the SmartFlex onboarding wizard.

code (String!)

The code of the consent type.

value (ConsentValue!)

The value to update the consent to.

consentTypeCode (String!)

The code of the consent type.

value (ConsentValue)

consentToMbna (Boolean)

Consent to MBNA.

email (String!)

Email.

firstName (String!)

First name.

lastName (String!)

Last name.

phone (String!)

Phone.

apiExceptionId (Int)

The ID of the associated API exception, if any.

context (JSONString)

Any optional useful context involved in the API call.

correlationId (String!)

The correlation id header from the HTTP request.

inputData (JSONString)

The input data provided to the API, if any.

operationName (String!)

The name of the operation associated with this call.

response (JSONString!)

The response returned by the API.

apiExceptionId (Int)

The ID of the associated API exception, if any.

category (String!)

The event category.

context (JSONString)

Any optional useful context involved in the event.

description (String!)

Any useful event description.

eventType (String!)

The event type.

accountNumber (ID)

The account number associated with the exception, if available.

assignedUserId (Int)

The ID of the user assigned to handle this exception.If no user is provided, no user will be assigned to the exception.

category (APIExceptionCategories)

Category associated with this exception. Uses the default category if not provided.

channel (String!)

The API client channel where the exception was triggered from.

context (JSONString)

Contextual information about the exception, if any.

customerContact (String)

The customer contact associated with the exception, if available.

externalIdentifier (String!)

External identifier mapping an entity on the client's database.

keyDate (Date)

The key date associated with the exception, if available.

operationsTeamId (Int)

The ID of an operations team to handle this exception. If no team is provided, no team will be assigned to the exception.

priority (APIExceptionPriority)

The priority. Defaults to LOW if not provided.

resolutionStatus (APIExceptionResolutionStatus)

The resolution status. Defaults to UNASSIGNED if not provided.

resolutionType (APIExceptionResolutionType)

The resolution type. Defaults to UNASSIGNED if not provided.

supplyPointIdentifier (String)

The supply point identifier associated with the exception, if available.

tags ([APIExceptionTags])

Tags associated with this exception if any.

userId (Int)

The user ID associated with the exception, if available.

apiExceptionId (ID!)

The ID of the associated API exception.

body (String!)

The body of the note.

accountNumber (String!)

The account number.

cclAmount (Int)

The climate change levy amount of the charge to be added.

displayNote (String)

Optional short note about account charge for customer display.

grossAmount (Int!)

The gross amount of the charge to be added.

metadata (JSONString)

Any extra data that will be associated with account charge.

netAmount (Int)

The net amount of the charge to be added.

note (String)

Optional short note about account charge for internal use.

reason (String!)

The reason why the charge is added to the account. This should be a valid charge reason code.

salesTaxAmount (Int)

The sales tax amount of the charge to be added.

accountNumber (String!)

The account number.

grossAmount (Int!)

The gross amount of the credit to be created.

metadata (JSONString)

Any extra data that will be associated with account credit.

netAmount (Int!)

The net amount of the credit to be created.

note (String)

Optional short note about account credit.

reason (AccountCreditReasonType!)

The reason why the credit is added to the account.

salesTaxAmount (Int!)

The sales tax amount of the credit to be created.

accountNumber (String!)

category (Category!)

clientMutationId (String)

filename (String!)

accountNumber (String!)

The account number.

isPinned (Boolean!)

Pin the note to account.

note (String!)

The note to add.

accountNumber (String!)

Number of the account for which to update the schedule.

ledgerNumber (String!)

Number of the ledger associated with the current payment schedule.

paymentAmount (Int)

The new fixed payment amount.

paymentDay (Int)

The new day of the month at which to take payment; ranges from 1 to 28.

accountNumber (String!)

The account number.

content (String!)

Reminder content.

dueAt (DateTime!)

When the reminder is due.

reminderType (AccountReminderTypes!)

The reminder type.

electricityMeterPoints ([ElectricityMeterPointConsumptionInput])

The electricity meter points to create a quote request for.

gasMeterPoints ([GasMeterPointConsumptionInput])

The gas meter points to create a quote request for.

paymentMethod (PaymentMethodChoices)

Optional parameter for the payment method to quote for. Defaults to Direct Debit.

postcode (String!)

The postcode of the meter points being quoted.

productCodes ([String]!)

The product codes of products to quote for.

contactEmail (String!)

contactName (String!)

organisationId (ID!)

The organisation for whom to create the affiliate link for.

subdomain (String!)

Will be validated as follows:

• should be at least two characters
• should only contain (letters, numbers, and Hyphen)
• should not contain bad words
• should not contain any of the reserved words including: affiliates, api, business, click, consul, developer, friends, kraken, mail, sendgrid, tech, webhooks, www, www2

allowAlternativePaymentMethods (Boolean)

Is this partner allowed to specify payment methods other than Direct Debit in the import csv or API.

canRegisterBusinessMeterPoints (Boolean)

Are meter point registrations limited for profile classes 1 and 2 for registrations from csv or API.

canRegisterCustomersWithoutEmailAddress (Boolean)

Allow registration requests with customers without an email address.

canRegisterPortfolioAccounts (Boolean)

Allow registration requests with exiting account user emails to add to the portfolio belonging to the account user.

canRenewTariffs (Boolean)

Allow performing tariff renewals via API.

canUseIvrSupportApi (Boolean)

Allow this partner access to the IVR support API (modify their own IVR handling through third party 'IVR Flow Editor').

contactEmail (String)

The primary contact email for the organisation.

defaultAccountType (AccountTypeChoices!)

Default Account Type.

isFieldSalesOnlyProduct (Boolean)

Restrict to field-sales-only products? This is only allowed for the 'field-sales' and 'events' sales channels.

name (String!)

salesChannel (SalesChannelChoices!)

Sales Channel.

skipMeterPointAddressValidation (Boolean)

Allow this partner to skip validation that ensures all meter points belong to the same address.

ipAddress (String)

The IP Address of the user.

linkId (ID!)

The affiliate link for whom to create the session for.

queryParams (JSONString)

Additional query parameters to attach to this session.

quoteShareId (ID)

The quote share that led to this session.

userAgent (String)

The HTTP user agent.

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

topupAmount (Int!)

The amount to top-up. The amount should always be provided in the minor unit of currency, i.e. USA cents / GBP pence / etc. Minimum allowed amount is 1.

campaignId (String!)

The campaign ID.

campaignItems ([CampaignItemInput]!)

The items to add.

accountNumber (String!)

The account number.

activeFrom (DateTime!)

The start datetime of the agreement.

activeTo (DateTime)

The end datetime of the agreement, if any.

amount (Int!)

The amount contributed per interval. Note, this is in the smallest domination that the currency supports. e.g. Pence, Cents, Yen, etc.

interval (Interval!)

The frequency of contributions.

schemeCode (String!)

The code of the scheme to contribute to.

accountNumber (String!)

directDebitInstruction (DirectDebitInstructionLocalBankDetailsInput!)

accountNumber (String!)

The account number.

validFrom (DateTime)

The time from which the new agreement is valid (default: now).

accountNumber (String!)

The account number of the account this charge card should be associated with.

chargeCardUid (String!)

The UID on the charge card.

nameOnCard (String!)

The name printed on the charge card.

accountNumber (String!)

The account number.

additionalFees (Int!)

The price of additional (non-consumption) fees on this charge.

chargeCardUid (String)

The UID of the Electric Juice charge card to associate with this charge.

chargeProvider (String!)

The provider that originated this charge.

currency (CurrencyOptions)

The currency of the charge.

kwhUsed (Decimal!)

The amount of energy consumed in kWh.

netAmount (Int!)

The amount to be charged (excl. tax).

periodEndAt (DateTime!)

The end time of the charge period.

periodStartAt (DateTime!)

The start time of the charge period.

postcode (String!)

The location of the charging point this charge is associated with.

pricePerKwh (Decimal!)

The price per kWh.

accountNumber (String!)

The account number.

grossAmount (Int!)

The gross amount of the credit to be created.

netAmount (Int!)

The net amount of the credit to be created.

note (String)

Optional short note about account credit.

reason (AccountCreditReasonType!)

The reason why the credit is added to the account.

taxAmount (Int!)

The tax amount of the credit to be created.

accountNumber (String!)

The account number.

externalAccountId (String!)

Identifier of an account in the external system.

validFrom (DateTime!)

The start time of the agreement.

accountNumber (String!)

The number of the account that the event should be created for.

category (ExternalAccountEventCategory!)

The category of the event.

content ([ExternalAccountEventContent]!)

An array of content data associated with the event.

description (String)

A human-readable description of the event.

occurredAt (DateTime)

The time the event occurred.

subcategory (ExternalAccountEventSubCategory)

The subcategory of the event.

category (ExternalAccountEventCategory!)

The category of the event.

content ([ExternalAccountEventContent]!)

An array of content data associated with the event.

description (String)

A human-readable description of the event.

occurredAt (DateTime)

The time the event occurred.

subcategory (ExternalAccountEventSubCategory)

The subcategory of the event.

userId (String!)

The user that the event should be created for.

accountNumber (String!)

The account number.

clientParams (JSONString)

A JSON object containing client parameters to store on the quote.

marketParams (JSONString)

A JSON object containing market parameters to store on the quote.

productsToQuote ([ProductToQuoteInput]!)

Products to get a quote for.

clientParams (JSONString)

A JSON object containing client parameters to store on the quote.

customerProfile (CustomerProfileInput!)

Customer profile.

marketParams (JSONString)

A JSON object containing market parameters to store on the quote.

productsToQuote ([ProductToQuoteInput]!)

Products to get a quote for.

accountNumber (String)

Account to associate quote to.

addressDetails (AddressDetailsInput!)

Details of the address.

contactDetails (ContactDetailsInput!)

Details to pass to hubspot.

productId (Int!)

ID of the product to quote.

propertyDetails (PropertyDetailsInput!)

Details of the property, used for eligiblity checks.

accountNumber (String!)

The account related to the message, if there is one.

If provided, we will directly route the message to the account's conversation.

clientMutationId (String)

messageHeaders (JSONString)

An optional parameter where we can pass the generic message headers if it has one

Email channel tries to get the value conversation-relay-id from this parameter

messageId (String!)

An arbitrary, unique ID for this message.

This must be unique for each message that is supplied using the same organisation; collisions between messages provided by different organisations are tolerated.

Stored as vendor_id.

newMessage (InkMessageInput!)

occurredAt (DateTime)

When the message occurred in the system of origin.

channel (InkCommunicationChannel!)

clientMutationId (String)

messageHeaders (JSONString)

An optional parameter where we can pass the generic message headers if it has one

Email channel tries to get the value conversation-relay-id from this parameter

messageId (String!)

An arbitrary, unique ID for this message.

This must be unique for each message that is supplied using the same organisation; collisions between messages provided by different organisations are tolerated.

Stored as vendor_id.

newMessage (InkMessageInput!)

occurredAt (DateTime)

When the message occurred in the system of origin.

vendor (String)

An optional vendor value to denote which system it originated from.

If no vendor is passed, we will get the default generic vendor from the setting called INKDEFAULTGENERICMESSAGEAPI_VENDOR.

accountUserId (String)

The id of the account user.

number (String)

The number of the loyalty card.

scheme (String)

The scheme of the loyalty card.

brandCode (String)

The brand to associate with this portfolio, if not provided the default brand will be used.

collectiveBilling (Boolean)

Whether collective bills should be issued for the portfolio's accounts. The default value is False.

operationsTeamId (ID)

The ID of the operations team to associate with this portfolio.If no team is provided, no team will be assigned to the portfolio.

accountUserId (ID!)

The user to associate with the portfolio.

portfolioId (ID!)

The portfolio to associate the user with.

role (RoleString)

The role to assign to the user. If not provided the default role will be used.

productRates ([ProductRateInputType]!)

The product rate(s) to be created.

accountNumber (String!)

The account number.

clientParams (JSONString)

A JSON object containing client parameters to store on the purchase.

marketParams (JSONString)

A JSON object containing client parameters to store on the purchase.

saleItems ([ProductToPurchaseInput]!)

Products being purchased.

address (QuoteAddressInput)

Optional address information about the customer.

affiliateOrganisationId (String)

The affiliate organisation ID. Used with restricttoaffiliate_products.

affiliateSessionId (String)

brandCode (String!)

electricityMeterPoints ([ElectricityMeterPointConsumptionInput])

gasMeterPoints ([GasMeterPointConsumptionInput])

gspGroupId (String)

hasConsentedToIndustryDataSearch (Boolean)

Whether the user has consented to their energy consumption estimates being retrieved from the industry vendors. This currently applies to business accounts only.

isBusiness (Boolean)

paymentMethod (QuotePaymentMethodChoices)

Optional parameter to select the payment method for the quote, default is direct debit.

position (PositionInput)

Used to verify the position that field sales agents generate quotes from.

postcode (String!)

restrictToAffiliateProducts (Boolean)

Whether to restrict the products (tariffs) to quote from to only show affiliate products. Requires affiliateorganisationid.

accountNumber (String!)

The account number.

paymentMethod (PaymentMethodChoices)

Optional parameter to override the payment method on the current agreement.

persistFlatRate (Boolean)

If the customer is currently on a flat rate tariff, create a flat rate quote.

productCodes ([String]!)

The product codes of products to quote for.

propertyId (Int!)

The property id to create a quote request for.

renewalAt (DateTime!)

The date at which the agreements would be renewed.

accountNumber (String!)

The account number for the referred account.

reference (String!)

An email address, link or code, referencing the referring account.

accountNumber (String!)

The account number.

content (String!)

Reminder content.

dueAt (DateTime!)

When the reminder is due.

reminderTypeName (String!)

The reminder type name.

accountNumber (String!)

The account number.

propertyId (Int!)

The property id to create a quote request for.

renewalAt (DateTime!)

The date at which the agreements would be renewed.

billingAddressLine1 (String)

billingAddressLine2 (String)

billingAddressLine3 (String)

billingAddressLine4 (String)

billingAddressLine5 (String)

billingName (String)

billingPeriodDay (Int)

Day to fixed bill on if billingperiodlength set.

billingPeriodLength (String)

For fixed billing accounts only, the length of their billing period. Can be MONTHLY or QUARTERLY.

billingPeriodMonth (Int)

Month to start billing from if billingperiodlength set to QUARTERLY or the multiplier is > 1.

billingPeriodMultiplier (Int)

For fixed billing accounts only, the number the period length is to be multiplied by to get the total period length, i.e. for billing every second month, select 2 combined with a billing period length MONTHLY. Can't be > 1 for quarterly billing.

billingPostcode (String)

billingRichAddress (String)

brand (String)

businessType (String)

clientMutationId (String)

companyName (String)

companyNumber (String)

dateOfBirth (Date)

email (String!)

familyName (String!)

givenName (String!)

isBusinessAccount (Boolean)

landline (String)

mobile (String)

password (String)

passwordUpdateToken (String)

portfolioNumber (String)

urn (String)

riskBracket (String!)

score (Int!)

dateOfBirth (Date)

The customer's date of birth.

email (String)

Account email.

familyName (String!)

Family name.

givenName (String!)

Given name.

landline (String)

Account landline number.

mobile (String)

Account mobile phone number.

preferences (UpdateAccountUserCommsPreferencesInput)

The customer's communication preferences.

pronouns (String)

The customer's pronouns.

title (String)

The customer's title.

accountNumber (String!)

answer (String)

feedbackId (Int!)

formId (Int!)

issueResolved (Boolean!)

addressLine1 (String!)

Line 1 of customer's address.

addressLine2 (String)

Line 2 of customer's address.

addressLine3 (String)

Line 3 of customer's address.

addressLine4 (String)

Line 4 of customer's address.

addressLine5 (String)

Line 5 of customer's address.

email (String!)

Customer's email.

familyName (String!)

Customer's family name.

givenName (String!)

Customer's given name.

phoneNumber (String!)

Customer's phone number.

postcode (String!)

Customer's postcode.

accountNumber (String!)

Account number.

deviceType (KrakenFlexDeviceTypes)

The most recently registered device of this type will be de-authenticated.

deviceId (String!)

Device ID for the device being decommissioned.

accountNumber (String!)

The account number associated with the removed AccountReference.

namespace (String!)

The namespace associated with the removed AccountReference.

accountNumber (String!)

Account number.

token (String!)

Device push notification token.

namespace (String!)

Namespace of the detail.

value (String)

Value of the detail.

auxDeviceVariantId (ID)

Auxiliary device variant id.

deviceVariantId (ID)

Unique device variant id.

accountNumber (String!)

Account number.

authentication (AuthenticationInput)

The authentication details required given the chosen provider.

deviceDetails (DeviceDetailsInput)

The device type specific details required for registering a device.

deviceType (KrakenFlexDeviceTypes!)

The device type to be registered - batteries, electric vehicles, heat pumps or thermostats.

propertyId (Int!)

The ID of the property the device belongs to.

provider (ProviderChoices!)

The provider used to authenticate the device.

accountHolder (String!)

accountNumber (String!)

sortCode (String!)

accountNumber (String!)

paymentDay (Int!)

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