About Input Objects
Input objects can be described as "composable objects" because they include a set of input fields that define the object.
Input fields
| Name | Description |
|---|---|
| The account number to filter for. |
| The category to filter for. |
| The channel to filter for. |
| The customer contact to filter for. |
| The external identifier to filter for. |
| The priority to filter for. |
| The resolution status to filter for. |
| The resolution type to filter for. |
| The supply point identifier to filter for. |
| Tags to filter for. |
| The user ID to filter for. |
Example
{
"externalIdentifier": "abc123",
"resolutionStatus": "ASSIGNED",
"resolutionType": "AUTOMATIC",
"channel": "abc123",
"priority": "LOW",
"tags": "MOVE_IN",
"category": "ACCOUNT",
"accountNumber": "abc123",
"userId": "abc123",
"customerContact": "abc123",
"supplyPointIdentifier": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| A JSON object containing client parameters to store on the quote. |
| A JSON object containing market parameters to store on the purchase. |
| ID of the accepted quote. |
Example
{
"accountNumber": "abc123",
"quoteId": 1,
"clientParams": {"key": "value"},
"marketParams": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| The account number of the account to update. |
| Billing address details. |
Example
{
"accountNumber": "abc123",
"billingAddress": BillingAddressDetailsInput
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The ledger id for the account. |
Example
{
"accountNumber": "abc123",
"ledgerId": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
Example
{
"accountNumber": "abc123"
}AccountReferenceInput
The input type for the account reference.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The namespace for the reference. |
| The reference value. |
Example
{
"accountNumber": "abc123",
"namespace": "abc123",
"value": "abc123"
}Input fields
| Name | Description |
|---|---|
| Internal account id (not account number). |
| The account number eg. A-FF15AE70. |
| Account Reference. |
| Account or Billing name. |
| Business name. |
| Business identifier or number. |
| Location (Supply or Billing, full or partial, address or post code). |
| Meter Serial Number. |
| The portfolio number eg. P-A123B456. |
| Statements. |
| URN Number. |
| The Account User ID (not account number). |
Example
{
"accountNumber": "abc123",
"portfolioNumber": "abc123",
"urn": "abc123",
"user": "abc123",
"account": "abc123",
"statements": "abc123",
"meterSerialNumber": "abc123",
"location": "abc123",
"billingName": "abc123",
"businessName": "abc123",
"businessNumber": "abc123",
"accountReferences": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The slug of the campaign we want to assign. |
| 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. |
| 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. |
Example
{
"accountNumber": "abc123",
"campaign": "abc123",
"startDate": "2020-01-01",
"expiryDate": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| The customer's postcode. |
| The customer's street. |
| The customer's street number. |
| The customer's street number suffix. |
| The customer's town. |
Example
{
"street": "abc123",
"streetNumber": "abc123",
"streetNumberSuffix": "abc123",
"postcode": "abc123",
"town": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The new amount for the amended payment. |
| The new date to collect the payment. |
| The ID of the payment to amend. |
| Reason for amending the payment. |
Example
{
"accountNumber": "abc123",
"paymentId": 1,
"amount": 1,
"paymentDate": "2020-01-01",
"reason": "abc123"
}AnnulOrderInput
The input for annulling an order.
Input fields
| Name | Description |
|---|---|
| The account number. |
| Annulment reason. |
| The supply point id of the order. |
Example
{
"supplyPointId": 1,
"accountNumber": "abc123",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number for the requested repayment. |
| The id of the account repayment to be approved. |
Example
{
"accountNumber": "abc123",
"repaymentId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The name of the bucket to assign the conversation to. |
| |
| The relay id of the conversation that will be assigned to the bucket. |
Example
{
"conversationRelayId": "abc123",
"bucketName": "abc123",
"clientMutationId": "abc123"
}Input fields
| Name | Description |
|---|---|
| SSO access token for the chosen provider authentication. |
| Provider code from user login used for SSO. |
| SSO token expiry for the provider's authentication (integer in seconds). |
| ID of the device in the external provider system. |
| Full redirect URI (including all query string parameters) from the result of an OAuth 2.0 flow. |
| SSO refresh token for the chosen provider authentication. |
| State from user login used for SSO. |
Example
{
"accessToken": "abc123",
"authorizationCode": "abc123",
"refreshToken": "abc123",
"expiresIn": 1,
"state": "abc123",
"providerDeviceId": "abc123",
"redirectUri": "abc123"
}BackendScreenEventInput
Input for a backend action.
Input fields
| Name | Description |
|---|---|
| The ID of the action to perform. |
| List of key-value pairs (strings) to pass as parameters to the mutation. |
Example
{
"eventId": "abc123",
"params": BackendScreenParamInputType
}BackendScreenParamInputType
A key-value pair (both Strings) which is passed in parameters to a backend action.
Example
{
"key": "abc123",
"value": "abc123"
}BalanceTriggeredScheduleInput
A payment schedule which triggers a payment the balance of a ledger drops below a certain value.
Input fields
| Name | Description |
|---|---|
| The ledger balance (in the minor currency unit) which when passed will trigger a payment to be taken. |
| The target balance (in the minor currency unit) for the ledger; used to calculate the payment amount. Defaults to zero. |
Example
{
"balanceThreshold": 1,
"targetBalance": 1
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
|
Example
{
"accountHolder": "abc123",
"iban": "abc123",
"accountNumber": "abc123",
"bankCode": "abc123",
"branchCode": "abc123",
"accountType": "abc123"
}BillTriggeredScheduleInput
A payment schedule which triggers a payment when a bill is issued.
Optionally a payment day frequency multiplier can be specified in which case the payment is taken on the first occurrence of the payment day after a bill has been issued.
Input fields
| Name | Description |
|---|---|
| The multiple of months at which payment are taken. Required when a payment day is chosen, ignored if payment day not set. |
| The day of the month at which to take payment (1-28). If not provided payment is taken whenever a bill is issued. |
Example
{
"paymentDay": 1,
"frequencyMultiplier": 1
}Input fields
| Name | Description |
|---|---|
| Administrative area. |
| Billing country. |
| Billing delivery point identifier. |
| Billing dependent locality. |
| Billing locality. |
| Billing postal code. |
| Billing sorting code. |
| Billing street address. |
| Billing structured street address. |
Example
{
"streetAddress": "abc123",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "abc123",
"locality": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"deliveryPointIdentifier": "abc123",
"administrativeArea": "abc123",
"country": "abc123"
}CancelContractInput
The input for cancelling the contract and receive a confirmation email.
Input fields
| Name | Description |
|---|---|
| The account number. |
| Last day of supply of the customer. Has to be at least 30 days in the future. Format should be: '%Y-%m-%d'. |
| Cancellation reason. |
| The supply point id of the contract. |
Example
{
"supplyPointId": 1,
"accountNumber": "abc123",
"lastDayOfSupply": "abc123",
"reason": "abc123"
}CancelLeaveSupplierInput
Input required to cancel a LeaveSupplier journey.
Input fields
| Name | Description |
|---|---|
| The ID of the LeaveSupplier process to cancel. |
| The reason for the cancellation. |
Example
{
"leaveSupplierProcessId": "abc123",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The ID of the payment to cancel. |
| Reason for cancelling the payment. |
Example
{
"accountNumber": "abc123",
"paymentId": "abc123",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| The id of the request to be cancelled. |
Example
{
"requestId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the SmartFlex onboarding wizard to cancel. |
Example
{
"wizardId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The payment amount (in cents). |
| The type of the payment instruction. |
| The reason a payment is being collected, for internal audit purposes. |
| |
| The ID of the ledger on which to collect the payment. |
| 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. |
Example
{
"accountNumber": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"description": "abc123",
"idempotencyKey": "abc123",
"collectionMethod": "BPAY",
"ledgerId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The entire continuation URI returned by the vendor. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"continuationUri": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number that the device is registered to. |
| External reference in the third-party system to identify the device. |
| Postcode of the property (linked to the account) that the device is registered to. |
Example
{
"accountNumber": "abc123",
"postalCode": "abc123",
"externalDeviceIdentifier": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the associated API exception, if any. |
| Any optional useful context involved in the API call. |
| The correlation id header from the HTTP request. |
| The input data provided to the API, if any. |
| The name of the operation associated with this call. |
| The response returned by the API. |
Example
{
"correlationId": "abc123",
"operationName": "abc123",
"inputData": {"key": "value"},
"response": {"key": "value"},
"context": {"key": "value"},
"apiExceptionId": 1
}Input fields
| Name | Description |
|---|---|
| The ID of the associated API exception, if any. |
| The event category. |
| Any optional useful context involved in the event. |
| Any useful event description. |
| The event type. |
Example
{
"eventType": "abc123",
"category": "abc123",
"description": "abc123",
"context": {"key": "value"},
"apiExceptionId": 1
}Input fields
| Name | Description |
|---|---|
| The account number associated with the exception, if available. |
| The ID of the user assigned to handle this exception.If no user is provided, no user will be assigned to the exception. |
| Category associated with this exception. Uses the default category if not provided. |
| The API client channel where the exception was triggered from. |
| Contextual information about the exception, if any. |
| The customer contact associated with the exception, if available. |
| External identifier mapping an entity on the client's database. |
| The key date associated with the exception, if available. |
| The ID of an operations team to handle this exception. If no team is provided, no team will be assigned to the exception. |
| The priority. Defaults to LOW if not provided. |
| The resolution status. Defaults to UNASSIGNED if not provided. |
| The resolution type. Defaults to UNASSIGNED if not provided. |
| The supply point identifier associated with the exception, if available. |
| Tags associated with this exception if any. |
| The user ID associated with the exception, if available. |
Example
{
"externalIdentifier": "abc123",
"resolutionStatus": "ASSIGNED",
"resolutionType": "AUTOMATIC",
"priority": "LOW",
"context": {"key": "value"},
"channel": "abc123",
"assignedUserId": 1,
"operationsTeamId": 1,
"tags": "MOVE_IN",
"category": "ACCOUNT",
"accountNumber": "abc123",
"userId": 1,
"customerContact": "abc123",
"supplyPointIdentifier": "abc123",
"keyDate": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| The ID of the associated API exception. |
| The body of the note. |
Example
{
"body": "abc123",
"apiExceptionId": "abc123"
}CreateAccountChargeInput
The input type for the account charge.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The climate change levy amount of the charge to be added. Deprecated The 'cclAmount' field is deprecated. |
| Optional short note about account charge for customer display. |
| The gross amount of the charge to be added. |
| Any extra data that will be associated with account charge. |
| The net amount of the charge to be added. Deprecated The 'netAmount' field is deprecated. |
| Optional short note about account charge for internal use. |
| The reason why the charge is added to the account. This should be a valid charge reason code. |
| The sales tax amount of the charge to be added. Deprecated The 'salesTaxAmount' field is deprecated. |
Example
{
"accountNumber": "abc123",
"netAmount": 1,
"grossAmount": 1,
"salesTaxAmount": 1,
"cclAmount": 1,
"metadata": {"key": "value"},
"note": "abc123",
"displayNote": "abc123",
"reason": "abc123"
}CreateAccountCreditInput
The input type for the account credit.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The gross amount of the credit to be created. |
| Any extra data that will be associated with account credit. |
| The net amount of the credit to be created. |
| Optional short note about account credit. |
| The reason why the credit is added to the account. |
| The sales tax amount of the credit to be created. |
Example
{
"accountNumber": "abc123",
"netAmount": 1,
"grossAmount": 1,
"salesTaxAmount": 1,
"metadata": {"key": "value"},
"note": "abc123",
"reason": "EXTERNAL_REFERRAL_CREDIT"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| Pin the note to account. |
| The note to add. |
Example
{
"accountNumber": "abc123",
"note": "abc123",
"isPinned": true
}CreateAccountPaymentScheduleInput
Input type for updating the payment schedule on a ledger. Requires an account_number, ledger_id and one of payment_day or payment_amount to be provided.
Input fields
| Name | Description |
|---|---|
| Number of the account for which to update the schedule. |
| Number of the ledger associated with the current payment schedule. |
| The new fixed payment amount. |
| The new day of the month at which to take payment; ranges from 1 to 28. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"paymentDay": 1,
"paymentAmount": 1
}Input fields
| Name | Description |
|---|---|
| The account number. |
| Reminder content. |
| When the reminder is due. |
| The reminder type. |
Example
{
"accountNumber": "abc123",
"reminderType": "AD_HOC",
"content": "abc123",
"dueAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| |
| |
| The organisation for whom to create the affiliate link for. |
| Will be validated as follows:
|
Example
{
"organisationId": "abc123",
"subdomain": "abc123",
"contactName": "abc123",
"contactEmail": "abc123"
}Input fields
| Name | Description |
|---|---|
| Is this partner allowed to specify payment methods other than Direct Debit in the import csv or API. |
| Are meter point registrations limited for profile classes 1 and 2 for registrations from csv or API. |
| Allow registration requests with customers without an email address. |
| Allow registration requests with exiting account user emails to add to the portfolio belonging to the account user. |
| Allow performing tariff renewals via API. |
| Allow this partner access to the IVR support API (modify their own IVR handling through third party 'IVR Flow Editor'). |
| Default Account Type. |
| Restrict to field-sales-only products? This is only allowed for the 'field-sales' and 'events' sales channels. |
| |
| Sales Channel. |
| Allow this partner to skip validation that ensures all meter points belong to the same address. |
Example
{
"name": "abc123",
"salesChannel": "DEFAULT_SUPPLY",
"defaultAccountType": "BUSINESS",
"canRegisterBusinessMeterPoints": true,
"canRegisterPortfolioAccounts": true,
"canRegisterCustomersWithoutEmailAddress": true,
"skipMeterPointAddressValidation": true,
"allowAlternativePaymentMethods": true,
"canRenewTariffs": true,
"canUseIvrSupportApi": true,
"isFieldSalesOnlyProduct": true
}Input fields
| Name | Description |
|---|---|
| The IP Address of the user. |
| The affiliate link for whom to create the session for. |
| Additional query parameters to attach to this session. |
| The quote share that led to this session. |
| The HTTP user agent. |
Example
{
"linkId": "abc123",
"ipAddress": "abc123",
"userAgent": "abc123",
"queryParams": {"key": "value"},
"quoteShareId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The start datetime of the agreement. |
| The end datetime of the agreement, if any. |
| The amount contributed per interval. Note, this is in the smallest domination that the currency supports. e.g. Pence, Cents, Yen, etc. |
| The frequency of contributions. |
| The code of the scheme to contribute to. |
Example
{
"accountNumber": "abc123",
"schemeCode": "abc123",
"interval": "MONTHLY",
"amount": 1,
"activeFrom": "2020-01-01T00:00:00.000Z",
"activeTo": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| |
| |
|
Example
{
"accountNumber": "abc123",
"supplyType": "abc123",
"directDebitInstruction": DirectDebitInstructionIBANInput
}Input fields
| Name | Description |
|---|---|
| The number of the account that the event should be created for. |
| The category of the event. |
| An array of content data associated with the event. |
| A human-readable description of the event. |
| The time the event occurred. |
| The subcategory of the event. |
Example
{
"accountNumber": "abc123",
"category": "COMMUNICATIONS",
"subcategory": "TELEPHONE",
"description": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"content": ExternalAccountEventContent
}Input fields
| Name | Description |
|---|---|
| The category of the event. |
| An array of content data associated with the event. |
| A human-readable description of the event. |
| The time the event occurred. |
| The subcategory of the event. |
| The user that the event should be created for. |
Example
{
"userId": "abc123",
"category": "COMMUNICATIONS",
"subcategory": "TELEPHONE",
"description": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"content": ExternalAccountEventContent
}Input fields
| Name | Description |
|---|---|
| The account number. |
| A JSON object containing client parameters to store on the quote. |
| A JSON object containing market parameters to store on the quote. |
| Products to get a quote for. |
Example
{
"accountNumber": "abc123",
"productsToQuote": ProductToQuoteInput,
"clientParams": {"key": "value"},
"marketParams": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| A JSON object containing client parameters to store on the quote. |
| Customer profile. |
| A JSON object containing market parameters to store on the quote. |
| Products to get a quote for. |
Example
{
"customerProfile": CustomerProfileInput,
"productsToQuote": ProductToQuoteInput,
"clientParams": {"key": "value"},
"marketParams": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| |
| |
| An optional parameter where we can pass the generic message headers if it has one Email channel tries to get the value |
| 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. |
| |
| When the message occurred in the system of origin. |
| 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. |
Example
{
"channel": "EMAIL",
"messageId": "abc123",
"newMessage": InkMessageInput,
"vendor": "abc123",
"messageHeaders": {"key": "value"},
"occurredAt": "2020-01-01T00:00:00.000Z",
"clientMutationId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The id of the account user. |
| The number of the loyalty card. |
| The scheme of the loyalty card. |
Example
{
"accountUserId": "abc123",
"scheme": "abc123",
"number": "abc123"
}Input fields
| Name | Description |
|---|---|
| The brand to associate with this portfolio, if not provided the default brand will be used. |
| Whether collective bills should be issued for the portfolio's accounts. The default value is False. |
| The ID of the operations team to associate with this portfolio.If no team is provided, no team will be assigned to the portfolio. |
Example
{
"brandCode": "abc123",
"operationsTeamId": "abc123",
"collectiveBilling": true
}Input fields
| Name | Description |
|---|---|
| The user to associate with the portfolio. |
| The portfolio to associate the user with. |
| The role to assign to the user. If not provided the default role will be used. |
Example
{
"portfolioId": "abc123",
"accountUserId": "abc123",
"role": RoleString
}Input fields
| Name | Description |
|---|---|
| The account number. |
| A JSON object containing client parameters to store on the purchase. |
| A JSON object containing client parameters to store on the purchase. |
| Products being purchased. |
Example
{
"accountNumber": "abc123",
"saleItems": ProductToPurchaseInput,
"clientParams": {"key": "value"},
"marketParams": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| The session id of the affiliate. |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
{
"gasNetworkOperatorNumber": "abc123",
"electricityNetworkOperatorNumber": "abc123",
"postcode": "abc123",
"gasAnnualConsumption": 1,
"electricityAnnualConsumption": 1,
"electricityAnnualNighttimeConsumption": 1,
"city": "abc123",
"qualifyingDate": "2020-01-01T00:00:00.000Z",
"elecProductCode": "abc123",
"gasProductCode": "abc123",
"affiliateSessionId": "abc123"
}CreateReferralInput
Required information for creating a referral
Input fields
| Name | Description |
|---|---|
| The account number for the referred account. |
| An email address, link or code, referencing the referring account. |
Example
{
"accountNumber": "abc123",
"reference": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| Day to fixed bill on if billingperiodlength set. |
| For fixed billing accounts only, the length of their billing period. Can be MONTHLY or QUARTERLY. |
| Month to start billing from if billingperiodlength set to QUARTERLY or the multiplier is > 1. |
| 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. |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
{
"portfolioNumber": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"billingName": "abc123",
"email": "abc123",
"mobile": "abc123",
"landline": "abc123",
"brand": "abc123",
"dateOfBirth": "2020-01-01",
"billingAddressLine1": "abc123",
"billingAddressLine2": "abc123",
"billingAddressLine3": "abc123",
"billingAddressLine4": "abc123",
"billingAddressLine5": "abc123",
"billingPostcode": "abc123",
"billingRichAddress": "abc123",
"billingPeriodLength": "abc123",
"billingPeriodMultiplier": 1,
"billingPeriodDay": 1,
"billingPeriodMonth": 1,
"isBusinessAccount": true,
"companyName": "abc123",
"companyNumber": "abc123",
"businessType": "abc123",
"password": "abc123",
"passwordUpdateToken": "abc123",
"urn": "abc123",
"clientMutationId": "abc123"
}CustomerDetailsInput
Details about the customer.
Input fields
| Name | Description |
|---|---|
| The customer's date of birth. |
| Account email. |
| Family name. |
| Given name. |
| Account landline number. |
| Account mobile phone number. |
| The customer's communication preferences. |
| The customer's pronouns. |
| The customer's title. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"title": "abc123",
"pronouns": "abc123",
"email": "abc123",
"mobile": "abc123",
"landline": "abc123",
"dateOfBirth": "2020-01-01",
"preferences": UpdateAccountUserCommsPreferencesInput
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
|
Example
{
"answer": "abc123",
"issueResolved": true,
"formId": 1,
"feedbackId": 1,
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| Line 1 of customer's address. |
| Line 2 of customer's address. |
| Line 3 of customer's address. |
| Line 4 of customer's address. |
| Line 5 of customer's address. |
| Customer's email. |
| Customer's family name. |
| Customer's given name. |
| Customer's phone number. |
| Customer's postcode. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"postcode": "abc123",
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "abc123",
"addressLine4": "abc123",
"addressLine5": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The most recently registered device of this type will be de-authenticated. |
Example
{
"accountNumber": "abc123",
"deviceType": "BATTERIES"
}Input fields
| Name | Description |
|---|---|
| The account number associated with the removed AccountReference. |
| The namespace associated with the removed AccountReference. |
Example
{
"accountNumber": "abc123",
"namespace": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
Example
{
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| Device push notification token. |
Example
{
"token": "abc123"
}Input fields
| Name | Description |
|---|---|
| Namespace of the detail. |
| Value of the detail. |
Example
{
"namespace": "abc123",
"value": "abc123"
}Input fields
| Name | Description |
|---|---|
| Auxiliary device variant id. |
| Unique device variant id. |
Example
{
"deviceVariantId": "abc123",
"auxDeviceVariantId": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The authentication details required given the chosen provider. |
| The device type specific details required for registering a device. |
| The device type to be registered - batteries, electric vehicles, heat pumps or thermostats. |
| The ID of the property the device belongs to. |
| The provider used to authenticate the device. |
Example
{
"accountNumber": "abc123",
"propertyId": 1,
"deviceType": "BATTERIES",
"provider": "DAIKIN",
"deviceDetails": DeviceDetailsInput,
"authentication": AuthenticationInput
}Example
{
"accountHolder": "abc123",
"iban": "abc123"
}ElectricityFiltersInput
Filter measurements by electricity parameters.
Input fields
| Name | Description |
|---|---|
| |
| |
| Reading direction is based on the utility generated or consumed by the customer. |
| |
| |
|
Example
{
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123",
"readingDirection": "CONSUMPTION",
"registerId": "abc123",
"readingQuality": "ACTUAL"
}Input fields
| Name | Description |
|---|---|
| The ID of the Contribution Agreement to end. |
| The future end datetime of the agreement. If not given, terminate now. |
Example
{
"contributionAgreementId": "abc123",
"endAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The Kraken account number. |
| Bank details for setting up a payment instruction as part of the enrollment. |
| Details of an externally created payment instruction to be recorded in Kraken. |
| Details of the payment schedule(s) to be created as part of enrollment. |
| Sales info for this enrollment. |
Example
{
"accountNumber": "abc123",
"bankDetails": BankDetailsInput,
"instructionDetails": InstructionDetailsInput,
"paymentSchedule": PaymentScheduleDetailsInput,
"salesInfo": SalesInformationInput
}ExternalAccountEventContent
A piece of content associated with an external account event.
Input fields
| Name | Description |
|---|---|
| The content type of the content. |
| A human-readable description of the content. |
| The value of the content. |
Example
{
"description": "abc123",
"contentType": "PLAINTEXT",
"value": "abc123"
}FanClubDiscountNotificationInput
The input type for sending Fan Club push notifications for discounts.
Input fields
| Name | Description |
|---|---|
| The list of valid catchment areas. |
| The end time of the likely Fan Club discount. |
| The start time of the likely Fan Club discount. |
Example
{
"catchments": "abc123",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The eligibility status of the customer. |
| Email address for the customer. |
Example
{
"email": "abc123",
"eligibility": "abc123"
}ForceReauthenticationInput
The input type for repudiating previously issued Kraken Tokens and refresh tokens.
Input fields
| Name | Description |
|---|---|
| Also force third-party applications you have authorized to use your account to reauthenticate. |
Example
{
"includeThirdParties": true
}Input fields
| Name | Description |
|---|---|
| |
| Form content. |
| Form type. |
Example
{
"accountNumber": "abc123",
"formType": "COVID_19_FINANCIAL_ENERGY_ASSESSMENT",
"content": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| The channel of the contact. |
| The name of the file. |
Example
{
"channel": "EMAIL",
"filename": "abc123"
}GetEmbeddedSecretForNewPaymentInstructionInput
The input for getting the client secret for an embedded new card payment method form.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The type of the new payment instruction. |
| WARNING: Will be mandatory in future versions The ledger ID. |
Example
{
"accountNumber": "abc123",
"instructionType": "BPAY",
"ledgerId": "abc123"
}GetHostedUrlForNewPaymentInstructionInput
The input needed for getting the external URL for setting up a payment instruction.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The type of the new payment instruction. |
| The ledger number. |
| The URL to redirect the user to after the action was cancelled. |
| The URL to redirect the user to after the action resulted in an error. |
| The URL to redirect the user to after the action resulted in a failure. |
| The URL to redirect the user to after the action was completed successfuly. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"instructionType": "BPAY",
"returnUrlSuccess": "abc123",
"returnUrlFailure": "abc123",
"returnUrlError": "abc123",
"returnUrlCancel": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The billing address. |
| Whether the billing address is the same as the delivery address. |
| The IBAN for the electricity agreement. |
| The electricity meter number. |
| The first day of supply for the new Property. |
| The IBAN for the gas agreement. |
| The gas meter number. |
| The last day of supply for the previous property. |
| The new supply address. |
Example
{
"accountNumber": "abc123",
"lastDayOfSupply": "2020-01-01",
"firstDayOfSupply": "2020-01-01",
"newSupplyAddress": AddressInputType,
"billingAddress": AddressInputType,
"billingAddressSameAsDeliveryAddress": true,
"electricityMeterNumber": "abc123",
"gasMeterNumber": "abc123",
"electricityIban": "abc123",
"gasIban": "abc123"
}InitiateHostedStandalonePaymentInput
Input fields for initiating a hosted standalone payment.
The amount should always be provided in the minor unit of currency (e.g., pence not pounds, cents not dollars, etc.).
A standalone payment can be made against a specific ledger (e.g., a debt ledger) by providing the ledger id. Accounts have a default ledger that will be used if not provided.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The amount to be collected in the minor unit of currency. |
| The method by which the payment is being collected. |
| A description of the purpose of the payment. |
| The id of the specific ledger against which this payment should be applied. Please provide either ledger number or ID. |
| The number of the specific ledger against which this payment should be applied. Please provide either ledger number or ID. |
| The URL to redirect the user to after the action was cancelled. |
| The URL to redirect the user to after the action resulted in an error. |
| The URL to redirect the user to if the url is not longer valid. |
| The URL to redirect the user to after the action resulted in a failure. |
| The URL to redirect the user to after the action was completed but the payment is still being processed. |
| The URL to redirect the user to after the action was completed successfuly. |
Example
{
"accountNumber": "abc123",
"amount": 1,
"description": "abc123",
"collectionMethod": "CARD",
"ledgerNumber": "abc123",
"ledgerId": "abc123",
"returnUrlSuccess": "abc123",
"returnUrlPending": "abc123",
"returnUrlFailure": "abc123",
"returnUrlError": "abc123",
"returnUrlCancel": "abc123",
"returnUrlExpired": "abc123"
}Input fields
| Name | Description |
|---|---|
| Identification of the account that requesting the product switch. |
| ID of the selected quoted product, obtain from quoting that supply point. |
| The date at which the product switch becomes effective. |
| The user for whom to perform the update. This is only needed when using an Organisation role. |
Example
{
"accountNumber": "abc123",
"quotedProductId": "abc123",
"switchDate": "2020-01-01",
"userId": "abc123"
}InitiateStandalonePaymentInput
Input fields for initiating a standalone payment.
The amount should always be provided in the minor unit of currency (e.g., pence not pounds, cents not dollars, etc.).
A standalone payment can be made against a specific ledger (e.g., a debt ledger) by providing the ledger id. Accounts have a default ledger that will be used if not provided.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The amount to be collected in the minor unit of currency. |
| The method by which the payment is being collected. |
| A description of the purpose of the payment. |
| The id of the specific ledger against which this payment should be applied. |
Example
{
"accountNumber": "abc123",
"amount": 1,
"description": "abc123",
"collectionMethod": "CARD",
"ledgerId": "abc123"
}InkEmailMessageInput
This type is used to create an inbound email.
Input fields
| Name | Description |
|---|---|
| Message attachments. |
| The carbon copy (cc) email addresses the message was sent to. |
| The email address the message was sent from. |
| The content of the message, as plain text. |
| The S3 bucket in which the original email is stored. |
| The S3 key of the original email. |
| The email subject/title. |
| The email addresses the message was sent to. |
Example
{
"plainTextContent": "abc123",
"attachments": InkGenericMessageAttachmentInput,
"subject": "abc123",
"fromAddress": Email,
"toAddresses": Email,
"ccAddresses": [Email],
"s3Bucket": "abc123",
"s3Key": "abc123"
}Input fields
| Name | Description |
|---|---|
| The S3 bucket of the attachment. |
| The S3 key of the attachment. |
Example
{
"s3Key": "abc123",
"s3Bucket": "abc123"
}InkGenericMessageInput
This type is used to create an generic message.
Input fields
| Name | Description |
|---|---|
| Message attachments. |
| The identity the message was sent from. |
| The content of the message, as plain text. |
| The identity the message was sent to. |
Example
{
"plainTextContent": "abc123",
"attachments": InkGenericMessageAttachmentInput,
"fromHandle": "abc123",
"toHandle": "abc123"
}InkMessageInput
An Ink message used as an input.
This is intended to be morally equivalent to a tagged union; exactly one of the properties provided here is expected to be provided.
At current, only the generic message type is provided, because only the generic message type is currently supported as an input type. This is intended to be a backwards-compatible extension point to allow other message input types to be added in the future.
Input fields
| Name | Description |
|---|---|
| |
| |
|
Example
{
"generic": InkGenericMessageInput,
"email": InkEmailMessageInput,
"post": InkPostMessageInput
}InkPostMessageInput
This type is used to create an inbound post.
Input fields
| Name | Description |
|---|---|
| The account number that the letter was sent from. |
| Message attachments. |
| Notes on the letter. |
| The content of the message, as plain text. |
Example
{
"plainTextContent": "abc123",
"attachments": InkGenericMessageAttachmentInput,
"accountNumber": "abc123",
"notes": "abc123"
}InstructionDetailsInput
Input type for instruction details that was created using the embedded process.
This means it was set up in the vendor system, and we only need to store a representation of the instruction in Kraken, but not make any calls to the vendor. This method of instruction creation must always be used for creating card instructions.
Input fields
| Name | Description |
|---|---|
| The type of the payment instruction. |
| The datetime from which the instruction is vaild. |
| The vendor's reference for this payment instruction. |
Example
{
"instructionType": "BPAY",
"validFrom": "2020-01-01T00:00:00.000Z",
"vendorReference": "abc123"
}InvalidatePaymentInstructionInput
Input for invalidating an arbitrary payment instruction.
Input fields
| Name | Description |
|---|---|
| |
| The id of the payment instruction to be invalidated. |
Example
{
"accountNumber": "abc123",
"id": "abc123"
}InvalidatePreSignedTokenInput
Input type for the InvalidatePreSignedToken mutation.
Input fields
| Name | Description |
|---|---|
|
Example
{
"token": "abc123"
}InvalidatePreSignedTokensForUserInput
Input type for the InvalidatePreSignedTokensForUser mutation.
Input fields
| Name | Description |
|---|---|
| The email address of the user whose tokens should be invalidated. |
| The scope of the token to invalidate. If this argument is not specified, all pre-signed tokens issued to the user are invalidated. |
Example
{
"email": "abc123",
"scope": "SUBMIT_METER_READINGS"
}InvalidateRefreshTokenInput
Input type for the InvalidateRefreshToken mutation.
Input fields
| Name | Description |
|---|---|
|
Example
{
"refreshToken": "abc123"
}InvalidateRefreshTokensForUserInput
Input type for the InvalidateRefreshTokensForUser mutation.
Input fields
| Name | Description |
|---|---|
| The email address of the user whose tokens should be invalidated. |
Example
{
"email": "abc123"
}JoinFanClubInput
The input type for signing an account up to Fan Club.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The list of catchments that have exceeded the member cap. |
| The list of valid catchment areas. |
| User's email address. |
Example
{
"accountNumber": "abc123",
"catchments": "abc123",
"cappedCatchments": ["abc123"],
"email": "abc123"
}Input fields
| Name | Description |
|---|---|
| The Kraken account number. |
| Future billing address. |
| |
| The requested last day of supply. |
Example
{
"accountNumber": "abc123",
"requestedSupplyEndDate": "2020-01-01",
"marketData": LeaveSupplierMarketInputType,
"futureBillingAddress": RichAddressInput
}Input fields
| Name | Description |
|---|---|
| A list of supply points for initiating a leave supplier journey. |
Example
{
"supplyPointData": _DefaultMarketTerminationInput
}Input fields
| Name | Description |
|---|---|
| Country code. |
| Line 1 of address. |
| Line 2 of address. |
| Line 3 of address. |
| Line 4 of address. |
| Line 5 of address. |
| Postal code. |
Example
{
"line1": "abc123",
"postalCode": "abc123",
"countryCode": "abc123",
"line2": "abc123",
"line3": "abc123",
"line4": "abc123",
"line5": "abc123"
}LinkUserToLineInput
Link an AccountUser to a LINE account.
Input fields
| Name | Description |
|---|---|
|
Example
{
"linkToken": "abc123"
}MetadataInput
The metadata input type for mutations.
Input fields
| Name | Description |
|---|---|
| An identifier for the associated object, e.g. account_number for the Account linked object type. |
| The key for the metadata. |
| The object that the metadata is associated with. |
| The metadata value which should be a valid JSON string. |
Example
{
"identifier": "abc123",
"linkedObjectType": "ACCOUNT",
"key": "abc123",
"value": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| Lead email. |
| To know if the lead is domestic or business. |
| The product the lead is interested in. |
| Lead name. |
| Lead phone. |
| The source where the lead comes from. |
Example
{
"source": "abc123",
"phone": "abc123",
"email": "abc123",
"name": "abc123",
"leadType": "abc123",
"marketName": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The OCPP authentication details. |
Example
{
"accountNumber": "abc123",
"details": "abc123"
}ObtainJSONWebTokenInput
The input type for obtaining a Kraken Token (JWT).
Input fields
| Name | Description |
|---|---|
| API key of the account user. Use standalone, don't provide a second input field. |
| Email address of the account user. Use with 'password' field. |
| Live secret key of an third-party organization. Use standalone, don't provide a second input field. |
| Password of the account user. Use with 'email' field. |
| Short-lived, temporary key (that's pre-signed). Use standalone, don't provide a second input field. |
| The refresh token that can be used to extend the expiry claim of a Kraken token. Use standalone, don't provide a second input field. |
Example
{
"email": "abc123",
"password": "abc123",
"APIKey": "abc123",
"organizationSecretKey": "abc123",
"preSignedKey": "abc123",
"refreshToken": "abc123"
}ObtainLongLivedRefreshTokenInput
The input type for obtaining a long-lived refresh token.
Input fields
| Name | Description |
|---|---|
| The Kraken Token that will be used to generate the long-lived refresh token. |
Example
{
"krakenToken": "abc123"
}PaymentScheduleDetailsInput
Input type for payment schedule details.
This enables us to collect information to create 4 different types of schedules during enrollment: - Payment on receipt of bill - Payment at a fixed day of the month once a receipt of bill has been issued - Payment when a ledger balance drops below a certain value - Payment at regular intervals for a fixed amount
This is intended to be morally equivalent to a "union" input type.
Input fields
| Name | Description |
|---|---|
| |
| |
|
Example
{
"regularTriggered": RegularTriggeredScheduleInput,
"billTriggered": BillTriggeredScheduleInput,
"balanceTriggered": BalanceTriggeredScheduleInput
}Input fields
| Name | Description |
|---|---|
| The account number. |
| Optional short note about the credit, to be displayed to the user. |
| The ID of the ledger where the credit will be posted. |
| The net amount of the credit to be posted. Amount should be posted in the smallest unit of currency. |
| Optional short note about the credit, to be displayed to internal systems. |
| The reason why the credit is posted. This should be a valid credit reason code. |
| The tax amount of the credit to be posted. Amount should be posted in the smallest unit of currency. |
Example
{
"accountNumber": "abc123",
"netAmount": 1,
"taxAmount": 1,
"displayNote": "abc123",
"note": "abc123",
"reason": "abc123",
"ledgerId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The day of the week. |
| The maximum value. |
| The minimum value. |
| Time of day this change should apply. Format: HH:MM. |
Example
{
"dayOfWeek": "MONDAY",
"time": "00:00:00.000Z",
"min": 1.0,
"max": 1.0
}Input fields
| Name | Description |
|---|---|
| The type of account to create. |
| The billing address. |
| The billing name. |
| The brand of the created account. |
| The chosen payment day. |
| The customer's details. |
| The date of sale, defaults to today if not provided. |
| The preferred supply start date. |
| Sales information. |
Example
{
"accountType": "BUSINESS",
"brandCode": "abc123",
"billingName": "abc123",
"billingAddress": LifecycleAddressInput,
"customerDetails": CustomerDetailsInput,
"salesInfo": SalesInformationInput,
"preferredSsd": "2020-01-01",
"dateOfSale": "2020-01-01",
"chosenPaymentDay": 1
}ProductSwitchInput
The input for confirming a product switch.
Input fields
| Name | Description |
|---|---|
| ID of the quoted product to be switched to. |
Example
{
"quotedProductId": 1
}Input fields
| Name | Description |
|---|---|
| Number of units. |
| Products code to purchase. |
Example
{
"productCode": "abc123",
"numberOfUnits": 1
}ProductToQuoteInput
Represents a product and the quantity to quote for a customer.
Input fields
| Name | Description |
|---|---|
| Currency. |
| Number of units. |
| Price per unit in smallest sub-unit of the currency. |
| ID of the product to quote. |
Example
{
"productId": 1,
"numberOfUnits": 1,
"pricePerUnit": 1,
"currency": "abc123"
}Input fields
| Name | Description |
|---|---|
| The params of the trigger type, as a JSON string. These are defined in the Params class for a trigger type. |
| The code of the trigger type to be published. |
Example
{
"triggerTypeCode": "abc123",
"params": {"key": "value"}
}QueryComplexityInputType
Information about the complexity of the query.
Input fields
| Name | Description |
|---|---|
| The operation name of the query to calculate complexity for if more than one is provided. |
| The query to calculate complexity for. |
| Any variables to include for the query. Pagination variables should be included as they will affect the overall weight of the query. |
Example
{
"query": "abc123",
"variables": {"key": "value"},
"operationName": "abc123"
}Input fields
| Name | Description |
|---|---|
| Quote code. |
| Recipient information. |
Example
{
"recipient": Recipient,
"quoteCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The number of the account for which readings are submitted. |
| The ID of the meter for which readings are submitted. |
| The date of the reading. |
| A list of readings for the meter. |
Example
{
"accountNumber": "abc123",
"readingDate": "2020-01-01",
"readings": RegisterReadingInput,
"meterId": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The authentication details required for the currently authenticated device. |
| The most recently registered device of this type will be re-authenticated. |
Example
{
"accountNumber": "abc123",
"authentication": AuthenticationInput,
"deviceType": "BATTERIES"
}Input fields
| Name | Description |
|---|---|
| Email address of the recipient. |
| Family name of the recipient. |
| Given name of the recipient. |
| Mobile number of the recipient. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"mobile": "abc123"
}RedeemLoyaltyPointsInput
The input type for redeeming Loyalty Points.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The number of Loyalty Points to redeem. |
Example
{
"accountNumber": "abc123",
"points": 1
}RedeemReferralClaimCodeInput
Required payload to redeem the benefit for partner reward referral scheme
Input fields
| Name | Description |
|---|---|
| The account number for the referred account. |
| Referral scheme claim code value. |
Example
{
"accountNumber": "abc123",
"code": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The amount to be repaid. |
| Unique constraint to prevent duplicate requests. |
| The ID of the payment to refund. |
| Reason for refunding the payment. |
Example
{
"accountNumber": "abc123",
"paymentId": "abc123",
"amountInMinorUnit": 1,
"idempotencyKey": "abc123",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| Register a push notification binding. A push notification binding connects an account user to a specific application running on a specific device through a 'registration token' (Android) or 'device token' (iOS). Using this binding we can send push notifications to the account user's devices. |
| Device push notification token. |
Example
{
"token": "abc123",
"bundleId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The OBIS code of the register. |
| The value of the reading. |
Example
{
"value": 1.0,
"registerObisCode": "abc123"
}RegularTriggeredScheduleInput
A payment schedule which triggers a payment at regular intervals.
Input fields
| Name | Description |
|---|---|
| The based unit of frequency at which payments are to be taken. |
| The multiple of the frequency at which payment are taken; should be between 1 and 11. |
| The day of the month/week at which to take payment; ranges from 1 to 28 for 'Monthly'. |
Example
{
"paymentDay": 1,
"frequency": "WEEKLY",
"frequencyMultiplier": 1
}RepaymentInput
Input fields for Repayment Intervention.
Input fields
| Name | Description |
|---|---|
| The Repayment Intervention reason. |
| The repayment ID. |
Example
{
"repaymentId": "abc123",
"reason": "abc123"
}RequestPasswordResetInput
Input type for the RequestPasswordReset mutation.
Input fields
| Name | Description |
|---|---|
| The email requesting a password reset email. |
Example
{
"email": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number for the requested ledger's account. |
| The amount to be repaid. |
| Unique constraint to prevent duplicate requests. |
| The ledger id from which the repayment will be requested. |
| The method by which the money will be transferred to the customer. |
| The reason for the repayment. |
Example
{
"accountNumber": "abc123",
"ledgerId": "abc123",
"amountInMinorUnit": 1,
"method": "BANK_TRANSFER",
"idempotencyKey": "abc123",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
|
Example
{
"password": "abc123",
"userId": "abc123",
"token": "abc123",
"clientMutationId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The new password. |
| The token from the presigned url. |
| A base64 bytestring representing the user's unique id. |
Example
{
"newPassword": "abc123",
"userId": "abc123",
"token": "abc123"
}RetentionQuoteInput
The arguments required for getting the offered market quote(s) for an account
Input fields
| Name | Description |
|---|---|
| The account number. |
| The supply type either: 'ELECTRICITY' or 'GAS' |
Example
{
"accountNumber": "abc123",
"supplyType": "ELECTRICITY"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The ID of the agreement to be revoked. |
| The reason for revoking the agreement. |
Example
{
"accountNumber": "abc123",
"agreementId": "abc123",
"reason": "abc123"
}RevokeContractInput
The input for revoking a contract.
Input fields
| Name | Description |
|---|---|
| The account number. |
| Cancellation reason. |
| The supply point id of the contract. |
Example
{
"supplyPointId": 1,
"accountNumber": "abc123",
"reason": "abc123"
}RichAddressInput
A postal address.
This data model is based on the structure used by Google's libaddressinput library—so you can use it, or other libraries that use its data model and reference data, to accept input.
All fields can be blank, except for country which must
always be supplied.
This type is the input equivalent of RichAddressType; all
the fields here are semantically equivalent to fields
there, except where documented.
Input fields
| Name | Description |
|---|---|
| Top-level administrative subdivision, e.g. US state, AU state/territory, IT region, JP prefecture. |
| ISO 3166-1 alpha-2 code of the country this address belongs
to, e.g. |
| Identifier used by the local postal service for this address, e.g. AU DPID, GB postcode + Delivery Point Suffix, US Zip-9 + Delivery Point. This is the value that gets encoded in the barcode printed on the envelope by large-volume bulk mail providers. |
| UK dependent localities, or neighbourhoods or boroughs in some other locations. |
| City or town portion of an address, e.g. US city, AU suburb/town, IT comune, UK post town. |
| A personal name. |
| The name of a business or organisation. |
| Postal code (ZIP code in the US). |
| Sorting code, e.g. FR CEDEX code. This field is not used in many countries. |
| At most one of this field and This is a divergence from |
| At most one of this field and
|
Example
{
"name": "abc123",
"organization": "abc123",
"streetAddress": "abc123",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "abc123",
"locality": "abc123",
"administrativeArea": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"country": "abc123",
"deliveryPointIdentifier": "abc123"
}SalesInformationInput
Information about the sale to associate with the account.
Input fields
| Name | Description |
|---|---|
| Affiliate params. |
| Affiliate subdomain. |
| The referral code used by the customer when signing up. |
| Sales channel. |
| Sales subchannel. |
| Unique reference number. |
Example
{
"salesChannel": "abc123",
"salesSubchannel": "abc123",
"urn": "abc123",
"affiliateSubdomain": "abc123",
"affiliateParams": "abc123",
"referralCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| Quote code. |
| IDs of the quoted products to be selected. |
Example
{
"quoteCode": "abc123",
"selectedQuotedProductIds": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}SetLoyaltyPointsUserInput
The input type for setting the Loyalty Points user.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The account user receiving the points. |
Example
{
"accountNumber": "abc123",
"newLoyaltyPointsUserId": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
|
Example
{
"accountNumber": "abc123",
"ledgerId": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"bankDetails": BankDetailsInput
}Input fields
| Name | Description |
|---|---|
| The email to share the quote with. |
| The quote to share. |
Example
{
"quoteCode": "abc123",
"email": "abc123"
}Input fields
| Name | Description |
|---|---|
| The smart control action, i.e. suspend or unsuspend. |
| The ID of the device. |
Example
{
"deviceId": "abc123",
"action": "SUSPEND"
}Input fields
| Name | Description |
|---|---|
| The ID of the device. |
| The mode of the schedule. |
| The schedule with the preference details. |
| The unit of the min and max values in the preferences schedule. |
Example
{
"deviceId": "abc123",
"mode": "CHARGE",
"unit": "CELSIUS",
"schedules": PreferencesScheduleInput
}SpecialCancelContractInput
The input for special cancellation of a contract.
Input fields
| Name | Description |
|---|---|
| The account number. |
| Requested last day of supply of the customer. |
| The special cancellation reason. |
| The supply point id of the contract. |
Example
{
"supplyPointId": 1,
"accountNumber": "abc123",
"lastDayOfSupply": "2020-01-01",
"reason": "PRICE_CHANGE"
}Input fields
| Name | Description |
|---|---|
| The account to which the device should be registered. |
| The property where the device is located/charged. |
Example
{
"accountNumber": "abc123",
"propertyId": 1
}StorePaymentInstructionInput
The input for storing a new payment instruction created through the embedded process.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The type of the new payment instruction. |
| WARNING: Will be mandatory in future versions The ledger ID to which the instructions will be linked. |
| The datetime from which the instruction is vaild. |
| The vendor's reference for this payment method. |
Example
{
"accountNumber": "abc123",
"instructionType": "BPAY",
"validFrom": "2020-01-01T00:00:00.000Z",
"vendorReference": "abc123",
"ledgerId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The amount ( in lowest unit ) to transfer. If the amount is negative,the effect is reversed (the source ledger's balance increases and the destination ledger's balance decreases). |
| Optional short note about transfer reason. |
| Account's ledger from which the requested amount is debited. |
| Account's ledger to which the requested amount is credited. |
Example
{
"sourceAccountLedger": AccountLedgerInput,
"targetAccountLedger": AccountLedgerInput,
"amount": 1,
"note": "abc123"
}TransferLoyaltyPointsBetweenUsersInput
The input type for transferring Loyalty Points.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The number of Loyalty Points to transfer. |
| The account user receiving the points. |
Example
{
"accountNumber": "abc123",
"receivingUserId": "abc123",
"points": 1
}Input fields
| Name | Description |
|---|---|
| The ID of the user assigned to handle this exception.If no user is provided, no user will be assigned to the exception. |
| The new category. If none is provided, the field won't be updated. |
| The new context. If none is provided, the field won't be updated. This will completely replace the existing context by the new one. |
| The ID of the API Exception that will be updated. |
| The new key date. If none is provided, the field won't be updated. |
| The ID of an operations team to handle this exception. If no team is provided, no team will be assigned to the exception. |
| The new priority. If none is provided, the field won't be updated. |
| The new resolution status. If none is provided, the field won't be updated. |
| The new resolution type. If none is provided, the field won't be updated. |
| The updated list of tags. If none is provided, the field won't be updated. |
Example
{
"id": 1,
"resolutionStatus": "ASSIGNED",
"resolutionType": "AUTOMATIC",
"priority": "LOW",
"context": {"key": "value"},
"category": "ACCOUNT",
"tags": "MOVE_IN",
"keyDate": "2020-01-01",
"assignedUserId": 1,
"operationsTeamId": 1
}Input fields
| Name | Description |
|---|---|
| The ID of the API Exception note being updated. |
| The body of the note. |
Example
{
"body": "abc123",
"apiExceptionNoteId": "abc123"
}UpdateAccountBillingEmailInput
Input fields for updating billing email for an account.
Input fields
| Name | Description |
|---|---|
| Account number for account. |
| The billingemail which can be up to 512 characters. Use null to unset billingemail. |
Example
{
"accountNumber": "abc123",
"billingEmail": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
{
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"emailFormat": "TEXT",
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 1.0,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"preferredHoldMusic": "NO_SONG_PREFERRED"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
{
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 1.0,
"emailFormat": "abc123",
"preferredHoldMusic": "abc123",
"clientMutationId": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
|
Example
{
"givenName": "abc123",
"familyName": "abc123",
"pronouns": "abc123",
"mobile": "abc123",
"email": "abc123",
"dateOfBirth": "2020-01-01",
"landline": "abc123",
"clientMutationId": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| The id of the affiliate link that is going to be edited. |
| The organisation for whom to update the affiliate link for. |
| Will be validated as follows:
|
|
Example
{
"linkId": "abc123",
"organisationId": "abc123",
"subdomain": "abc123",
"contactName": "abc123",
"contactEmail": "abc123",
"isBusiness": true,
"landingUrl": "abc123",
"trainingStatus": "abc123"
}Input fields
| Name | Description |
|---|---|
| Is this partner allowed to specify payment methods other than Direct Debit in the import csv or API. |
| Are meter point registrations limited for profile classes 1 and 2 for registrations from csv or API. |
| Allow registration requests with customers without an email address. |
| Allow registration requests with exiting account user emails to add to the portfolio belonging to the account user. |
| Allow performing tariff renewals via API. |
| Allow this partner access to the IVR support API (modify their own IVR handling through third party 'IVR Flow Editor'). |
| Default Account Type. |
| Restrict to field-sales-only products? This is only allowed for the 'field-sales' and 'events' sales channels. |
| |
| The organisation that is going to be edited. |
| Sales Channel. |
| Allow this partner to skip validation that ensures all meter points belong to the same address. |
Example
{
"organisationId": "abc123",
"name": "abc123",
"salesChannel": "DEFAULT_SUPPLY",
"defaultAccountType": "BUSINESS",
"canRegisterBusinessMeterPoints": true,
"canRegisterPortfolioAccounts": true,
"canRegisterCustomersWithoutEmailAddress": true,
"skipMeterPointAddressValidation": true,
"allowAlternativePaymentMethods": true,
"canRenewTariffs": true,
"canUseIvrSupportApi": true,
"isFieldSalesOnlyProduct": true
}Input fields
| Name | Description |
|---|---|
| A code that uniquely identifies the account. |
| A code that uniquely identifies the agreement. |
| The reason for the change. |
| The start date of the agreement. |
| The end date of the agreement (exclusive). The agreement will end on midnight of this date, such that the previous day is the last day covered by this agreement. |
Example
{
"agreementId": "abc123",
"accountNumber": "abc123",
"validFrom": "2020-01-01",
"validTo": "2020-01-01",
"reason": "abc123"
}UpdateAutoTopUpAmountInput
Input type for updating the schedule auto top up amount for for an account. Requires an account_number, ledger_id and payment_amount to be provided.
Input fields
| Name | Description |
|---|---|
| Account number to update the schedule auto top up amount for. |
| Specifies the ledger ID associated with the current schedule for updates. |
| The new auto-top-up amount for the payment schedule. |
Example
{
"accountNumber": "abc123",
"ledgerId": 1,
"paymentAmount": 1
}UpdateCommsDeliveryPreferenceInput
Input fields for updating comms delivery preferences for an account
Input fields
| Name | Description |
|---|---|
| |
|
Example
{
"accountNumber": "abc123",
"commsDeliveryPreference": "EMAIL"
}Input fields
| Name | Description |
|---|---|
| |
| The message to set the tags on. |
| The tag names to set on the message. |
| The tag code to set on the message. |
| The tag version to set on the message. |
Example
{
"messageRelayId": "abc123",
"tagNames": "abc123",
"taggerCode": "abc123",
"taggerVersion": "abc123",
"clientMutationId": "abc123"
}Input fields
| Name | Description |
|---|---|
| New password. |
| Confirm new password. |
| Old password. |
Example
{
"oldPassword": "abc123",
"newPassword": "abc123",
"newPasswordConfirmed": "abc123"
}Example
{
"accountNumber": "abc123",
"paymentAmount": 1,
"supplyType": "abc123"
}Example
{
"accountNumber": "abc123",
"paymentDay": 1,
"supplyType": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| A JSON object containing client parameters to store on the purchase. |
| A JSON object containing market parameters to store on the purchase. |
| The purchase ID. |
| Products being purchased. |
Example
{
"accountNumber": "abc123",
"purchaseId": "abc123",
"saleItems": ProductToPurchaseInput,
"marketParams": {"key": "value"},
"clientParams": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| |
| User details. |
| |
| |
| |
| Because this field is clearable, null and the empty string are treated differently; passing null or omitting the field leaves the value as-is, but explicitly passing an empty string clears this value. |
| Because this field is clearable, null and the empty string are treated differently; passing null or omitting the field leaves the value as-is, but explicitly passing an empty string clears this value. |
| How the user would like us to address them (e.g. 'she/her', 'they/them'). Because this field is clearable, null and the empty string are treated differently; passing null or omitting the field leaves the value as-is, but explicitly passing an empty string clears this value. |
| The user's title. |
| The user for whom to perform the update. This is only needed when using an Organisation role. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"pronouns": "abc123",
"email": "abc123",
"mobile": "abc123",
"dateOfBirth": "2020-01-01",
"landline": "abc123",
"userId": "abc123",
"title": "abc123",
"details": DetailsInputType
}UtilityFiltersInput
Filter measurements by the given utility parameters.
Input fields
| Name | Description |
|---|---|
|
Example
{
"electricityFilters": ElectricityFiltersInput
}ValidateEmailInput
Input required to validate email address via Kickbox
Input fields
| Name | Description |
|---|---|
| Check if an email is already in use. |
| The user's email address. |
Example
{
"email": "abc123",
"checkUniqueness": true
}Input fields
| Name | Description |
|---|---|
| The user's phone number. |
Example
{
"phoneNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| |
| |
| |
| |
|
Example
{
"accountNumber": "abc123",
"weekdayTargetTime": "abc123",
"weekdayTargetSoc": 1,
"weekendTargetTime": "abc123",
"weekendTargetSoc": 1,
"targetType": "abc123"
}Input fields
| Name | Description |
|---|---|
| The number of the account belonging to the user (e.g. A-12345678). |
| The first line of the user's address (this could be the energy supply property address or the billing address on the account). |
| The user's full name. |
| The user's postcode (this could be the postcode of the energy supply property address or of the billing address on the account). |
Example
{
"accountNumber": "abc123",
"fullName": "abc123",
"firstLineOfAddress": "abc123",
"postcode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The number of the account for which readings are submitted. |
| The supply type that the spin should be registered for. |
| Indication whether the user has accepted the WoF terms and conditions. |
Example
{
"accountNumber": "abc123",
"supplyType": "ELECTRICITY",
"termsAccepted": true
}_DefaultMarketTerminationInput
Default input required to initiate a LeaveSupplier journey for a given market. This type should only be used when there are no configured markets while building the LeaveSupplierMarketInputType.
Input fields
| Name | Description |
|---|---|
| The market supply point identification number. |
Example
{
"supplyPointIdentifier": "abc123"
}