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

ID of the accepted quote.

billingInformation (BillingInformationInputType!)

The billing fields.

customerDetails (CustomerDetailsInputType!)

The personal information fields.

existingAccountNumber (String)

The existing account number, if the customer is already registered.

paymentInformation (PaymentInformationInputType)

The payment information.

quoteCode (UUID!)

The identifier of the quote we're accepting.

requiresPostalComms (Boolean)

Requires postal communications.

salesInformation (SalesInformationInputType)

The sales information.

supplyPoints ([SupplyPointInputType]!)

The list of supply points.

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.

ledgerNumber (String)

The ledger number 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.

portfolioNumber (String)

The portfolio number eg. P-A123B456.

statements (String)

Statements.

urn (String)

URN Number.

user (String)

The Account User ID (not account number).

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.

billingAddressCity (String!)

The customer's billing address city name.

billingAddressNumStreet (String!)

The customer's billing address (number + street).

billingAddressPostcode (String!)

The customer's billing address postal code.

bypassWithdrawalPeriod (Boolean!)

If true the customer can have a supply date at D+1 minimum. If false the withdrawal period will be active so the customer can have a supply date at D+14 minimum.

dateOfBirth (Date!)

The customer's date of birth.

email (String!)

The customer's email for account user creation.

familyName (String!)

The customer's family name.

givenName (String!)

The customer's given name.

iban (String)

The customer's iban.

mobile (String!)

The customer's mobile phone number.

note (String)

Additional information for ops users (client have additional questions, etc...).

paymentDay (Int!)

The preferred day of the month the customer wants to be charged.

productCode (String!)

The identifier of chosen product.

pronouns (String)

The customer's applicable pronouns if any.

quoteCode (UUID!)

The identifier of the quote we're accepting.

requestedSupplyStartDate (Date)

The date from which the client wants to switch provider. Minimum D+1 with a bypass of the withdrawal period, D+14 without a bypass of the withdrawal period.

subscriptionType (SubscriptionType!)

Subscription type the supply point is eligible for (resulting from previous eligibility check).

supplyPointId (String!)

The customer's supply point id.

switchReadings (ReadingInputType)

Readings supplied by the customer in case of non communicating supply_point.

switchReadingsDate (Date)

The date of the reading.

title (String!)

The title of civility of the customer ('M.' or 'Mme').

enedisClientConsent (Boolean!)

True if the client consented to allow Enedis to collect meter point data.

subscriptionType (RequestedSubscriptionType!)

Subscription type to request to Enedis.

supplyPointId (String!)

The customer's supply point id.

annualConsumption (AnnualConsumptionType!)

The forecast consumption for a year.

heatingType (HeatingType)

Type of heating.

providerCalendarId (ProviderCalendarIdType)

The provider calendar id to use for this quote (if not provided by Enedis).

residenceType (ResidenceType)

Type of residence.

supplyPointId (String!)

The customer's supply point id.

allDay (Int!)

All-day energy consumption (in kWh) accumulated over a year.

allDay (Int!)

The all day part of the reading (in kWh).

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.

BASE (Int)

The BASE part of the forecast consumption (in kWh).

HC (Int)

The HC part of the forecast consumption (in kWh).

HP (Int)

The HP part of the forecast consumption (in kWh).

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)

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.

billingAddressCountryCode (String!)

The customer's billing address country code.

billingAddressLine1 (String!)

The customer's billing address number and street.

billingAddressLine2 (String)

The customer's billing address line 2.

billingAddressLine3 (String)

The customer's billing address line 3.

billingAddressLine4 (String!)

TThe customer's billing address city.

billingAddressLine5 (String)

TThe customer's billing address line 5.

billingAddressPostcode (String!)

The customer's billing address postal code.

billingFrequency (BillingFrequency)

The billing frequency.

billingName (String)

The customer's billing name.

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.

clientConsent (Boolean)

True if the client consented to allow the DSO to collect meter point data.

isClientAuthorizedToRequestData (Boolean)

Is the client is authorized to request consumption data from the meter point?

meterPoints ([MeterPointInputType]!)

The list of meter points.

acceptedTAndC (Boolean!)

True if the customer has accepted the terms and conditions.

accountUserMetadata ([MetadataInput])

Account user metadata.

billingFrequency (BillingFrequency)

The billing frequency.

billingName (String)

The customer's billing name (only required for direct debit).

consentData (FraConsentDataInput)

Consents for Distribution Network Operators.

consentDataPerSupplyPointId ([IndustryConsentDataPerSupplyPointInput!])

Consents per supply point for Distribution Network Operators.

iban (String)

The IBAN number.

paymentDay (Int)

The preferred day of the month the customer wants the payment to occur (only required for direct debit).

preferences (UpdateAccountUserCommsPreferencesInput!)

Comms preferences.

quoteCode (UUID!)

The code for the quote to be checked out.

requiresPostalComms (Boolean)

Requires postal communications.

scheduleType (ScheduleType)

The payment method for the schedule.

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

The date where dca proceeding stopped.

accountNumber (String!)

The account number.

amount (Int!)

The payment amount (in cents).

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.

ledgerNumber (String)

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

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)

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

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.

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.

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.

sourceLedgerNumber (String!)

Source ledger number.

targetLedgerNumber (String!)

Target ledger number.

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.

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.

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.

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.

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)

accountNumber (String!)

Account number of the request.

paymentReason (PaymentReason)

Payment reason of the request. Preferably left empty to let Kraken choose one.

requestedAmount (Int!)

Amount of the request (in cents).

sourceLedgerId (ID!)

Id of the source ledger concerned (ex: pot ledger).

targetLedgerId (ID!)

Id of the target ledger concerned (ex: charging ledger).

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.

dateOfBirth (Date!)

The customer's date of birth.

email (String!)

The customer's email for account retrieval.

familyName (String!)

The customer's family name.

givenName (String!)

The customer's given name.

mobile (String!)

The customer's mobile phone number.

title (String!)

The title of civility of the customer ('M.' or 'Mme').

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.

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.

allDay (AllDayAnnualConsumptionInput)

All-day energy consumption accumulated over a year.

peakOffPeak (PeakOffPeakAnnualConsumptionInput)

Energy consumption during peak/off-peak hours accumulated over a year.

deviceId (String)

marketSupplyPointId (String)

readingDirection (ReadingDirectionType)

Reading direction is based on the utility generated or consumed by the customer.

readingFrequencyType (ReadingFrequencyType)

The frequency of the reading.

readingQuality (ReadingQualityType)

registerId (String)

agreementId (Int)

ID of the agreement for which the quote is requested.

providedAnnualConsumption (ElectricityAnnualConsumptionInput)

The annual consumption to base the quote upon.

providerCalendar (ElectricityProviderCalendarType)

The provider calendar to use for this quote (if not provided by the DSO).

subscribedMaxPower (Int)

Request a specific subscribed max power during subscription.

supplyPointId (ID!)

The customer's supply point id.

contributionAgreementId (ID!)

The ID of the Contribution Agreement to end.

endAt (DateTime)

The future end datetime of the agreement. If not given, terminate now.

accountNumber (String!)

The Kraken account number.

bankDetails (BankDetailsInput)

Bank details for setting up a payment instruction as part of the enrollment.

instructionDetails (InstructionDetailsInput)

Details of an externally created payment instruction to be recorded in Kraken.

paymentSchedule (PaymentScheduleDetailsInput)

Details of the payment schedule(s) to be created as part of enrollment.

salesInfo (SalesInformationInput)

Sales info for this enrollment.

contentType (ExternalAccountEventContentType!)

The content type of the content.

description (String!)

A human-readable description of the content.

value (String!)

The value of the content.

catchments ([String]!)

The list of valid catchment areas.

endAt (DateTime!)

The end time of the likely Fan Club discount.

startAt (DateTime!)

The start time of the likely Fan Club discount.

eligibility (String!)

The eligibility status of the customer.

email (String!)

Email address for the customer.

includeThirdParties (Boolean!)

Also force third-party applications you have authorized to use your account to reauthenticate.

accountNumber (String!)

content (JSONString!)

Form content.

formType (FormType)

Form type.

enedisCurves (Boolean)

Update the consent to fetch enedis curves.

enedisIndex (Boolean)

Update the consent to fetch enedis index.

allDay (AllDayAnnualConsumptionInput!)

All-day energy consumption accumulated over a year.

deviceId (String)

marketSupplyPointId (String)

readingFrequencyType (ReadingFrequencyType)

The frequency of the reading.

registerId (String)

providedAnnualConsumption (GasAnnualConsumptionInput)

The annual consumption to base the quote upon.

supplyPointId (ID!)

The customer's supply point id.

channel (InkCommunicationChannel!)

The channel of the contact.

filename (String!)

The name of the file.

accountNumber (String!)

The account number.

instructionType (PaymentType!)

The type of the new payment instruction.

ledgerId (String)

The ledger ID.

ledgerNumber (String)

WARNING: Will be mandatory in future versions

The number of the ledger.

instructionType (PaymentType!)

The type of the new payment instruction.

accountNumber (String!)

The account number.

instructionType (PaymentType!)

The type of the new payment instruction.

ledgerNumber (String!)

The ledger number.

returnUrlCancel (String)

The URL to redirect the user to after the action was cancelled.

returnUrlError (String)

The URL to redirect the user to after the action resulted in an error.

returnUrlFailure (String)

The URL to redirect the user to after the action resulted in a failure.

returnUrlSuccess (String)

The URL to redirect the user to after the action was completed successfuly.

leadId (ID)

The identifier the lead.

collectDailyConsumptionData (Boolean)

Consent to collect daily consumption data from the industry.

collectHalfHourlyConsumptionData (Boolean)

Consent to collect half-hourly consumption data from the industry.

consentData (IndustryConsentDataInput!)

New consent data.

supplyPointId (ID!)

Supply point id to be updated.

accountNumber (String!)

The account number.

amount (Int!)

The amount to be collected in the minor unit of currency.

collectionMethod (CollectionMethod!)

The method by which the payment is being collected.

description (String!)

A description of the purpose of the payment.

ledgerId (ID)

The id of the specific ledger against which this payment should be applied.

ledgerNumber (String)

The number of the specific ledger against which this payment should be applied.

returnUrlCancel (String)

The URL to redirect the user to after the action was cancelled.

returnUrlError (String)

The URL to redirect the user to after the action resulted in an error.

returnUrlExpired (String)

The URL to redirect the user to if the url is not longer valid.

returnUrlFailure (String)

The URL to redirect the user to after the action resulted in a failure.

returnUrlPending (String)

The URL to redirect the user to after the action was completed but the payment is still being processed.

returnUrlSuccess (String)

The URL to redirect the user to after the action was completed successfuly.

accountNumber (String!)

Identification of the account that requesting the product switch.

quotedProductId (ID!)

ID of the selected quoted product, obtain from quoting that supply point.

suppressCommunications (Boolean)

Suppress Product Switch communications.

switchDate (Date!)

The date at which the product switch becomes effective.

userId (ID)

The user for whom to perform the update. This is only needed when using an Organisation role.

accountNumber (String!)

The account number.

amount (Int!)

The amount to be collected in the minor unit of currency.

collectionMethod (CollectionMethod)

The method by which the payment is being collected.

description (String!)

A description of the purpose of the payment.

ledgerId (ID)

The id of the specific ledger against which this payment should be applied.

ledgerNumber (String)

The number of the specific ledger against which this payment should be applied.

attachments ([InkGenericMessageAttachmentInput!])

Message attachments.

ccAddresses ([Email!])

The carbon copy (cc) email addresses the message was sent to.

fromAddress (Email!)

The email address the message was sent from.

plainTextContent (String!)

The content of the message, as plain text.

s3Bucket (String)

The S3 bucket in which the original email is stored.

s3Key (String)

The S3 key of the original email.

subject (String!)

The email subject/title.

toAddresses ([Email!]!)

The email addresses the message was sent to.

s3Bucket (String!)

The S3 bucket of the attachment.

s3Key (String!)

The S3 key of the attachment.

attachments ([InkGenericMessageAttachmentInput!])

Message attachments.

fromHandle (String!)

The identity the message was sent from.