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. |
| The ID of the Enrolment. |
| The version of accepted terms and conditions. |
Example
{
"accountNumber": "abc123",
"enrolmentId": "abc123",
"termsVersion": TermsVersionInput
}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. |
| MPAN of property. |
| MPRN of property. |
| The portfolio number eg. P-A123B456. |
| Statements. |
| Telephone. |
| 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",
"mpan": "abc123",
"mprn": "abc123",
"telephoneNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| Role codes of the roles to be assigned to the user. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"mobile": "abc123",
"optedInForMarketing": true,
"creditScoreData": CreditScoreData,
"creditScoreFetchedAt": "2020-01-01T00:00:00.000Z",
"dateOfBirth": "2020-01-01",
"psrData": UpdateSpecialCircumstancesInput,
"roles": ["abc123"]
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The slug of the campaign we want to assign. |
Example
{
"accountNumber": "abc123",
"campaign": "abc123"
}AddEvPublicChargingTokenInput
The input type for adding an EV Public Charging token.
Input fields
| Name | Description |
|---|---|
| Identifier of an account in the external system. |
| Token identifier. |
| The start time of token's validity. |
Example
{
"externalAccountId": "abc123",
"tokenValue": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| First address line. |
| Second address line. |
| Third address line. |
| Fourth address line. |
| Fifth address line. |
| Postcode. |
| Unique Property Reference Number. |
Example
{
"uprn": "abc123",
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "abc123",
"addressLine4": "abc123",
"addressLine5": "abc123",
"postcode": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| Postcode of the property where the appointment took place. |
Example
{
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "abc123",
"addressLine4": "abc123",
"addressLine5": "abc123",
"postcode": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
|
Example
{
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "abc123",
"town": "abc123",
"county": "abc123",
"postcode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The Kraken ID of the agreement to be renewed. The agreement must be currently active. |
| The code of the product the agreement will be renewed to. |
Example
{
"agreementId": "abc123",
"productCode": "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"
}Input fields
| Name | Description |
|---|---|
| The new datetime of reading. |
| The ID of the reading that will be amended. |
| The new value of reading. |
Example
{
"readingId": 1,
"readingValue": 1,
"readingDatetime": "2020-01-01T00:00:00.000Z"
}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"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
|
Example
{
"accountHolder": "abc123",
"iban": "abc123",
"accountNumber": "abc123",
"bankCode": "abc123",
"branchCode": "abc123",
"accountType": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The minimum state of charge (soc) %. |
Example
{
"accountNumber": "abc123",
"minimumSocPercentage": 1
}Input fields
| Name | Description |
|---|---|
| Rate type associated with the given unit rate. |
| Electricity bespoke unit rate to override the unit rate associated with the tariff. |
Example
{
"unitRate": 1.0,
"rateType": "STANDARD"
}Input fields
| Name | Description |
|---|---|
| Payment method associated with the given unit rate. |
| Bespoke standing charge. |
| Gas bespoke unit rate. |
| Electricity bespoke unit rates with their associated rate type. |
Example
{
"standingCharge": 1.0,
"unitRate": 1.0,
"unitRates": BespokeElectricityUnitRatesInput,
"paymentMethod": "DIRECT_DEBIT"
}Input fields
| Name | Description |
|---|---|
| Bespoke standing charge. |
| Gas bespoke unit rate. |
| Electricity bespoke unit rates with their associated rate type. |
Example
{
"standingCharge": 1.0,
"unitRate": 1.0,
"unitRates": BespokeElectricityUnitRatesInput
}Example
{
"accountNumber": "abc123",
"mpan": "abc123"
}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"
}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 export certificate number. |
| The export certificate type. |
Example
{
"number": "abc123",
"type": "MCS"
}Input fields
| Name | Description |
|---|---|
| The unique charge point id. |
| The charge point make. Deprecated The 'make' field is deprecated. |
| The charge point model. Deprecated The 'model' field is deprecated. |
| The charge point power (kW). Deprecated The 'power' field is deprecated. |
Example
{
"make": "abc123",
"model": "abc123",
"power": 1.0,
"chargePointId": "abc123"
}Input fields
| Name | Description |
|---|---|
| Type of the business: LTD, Charity, SoleTrader or Partnership. |
| Company registration number. Only needed for LTDs. |
Example
{
"businessType": "LTD",
"companyNumber": "abc123"
}CheckDeviceConnectionInput
Specify the device id of a smart device to check the connection.
Input fields
| Name | Description |
|---|---|
| The device id of the device (e.g. B0-11-2E-33-FF-45-C6-78). |
Example
{
"deviceId": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The state that the climate control device should be set to. A value of true indicates that the device should be turned on, and a value of false indicates it should be switched off. |
Example
{
"accountNumber": "abc123",
"state": true
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The payment amount (in pence). |
| 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 subdomain of the affiliate link used to track the commission. |
| The fixed comission fee, in pence, which is paid to the third-party intermediary. |
| The third-party intermediary who sold this renewal to the customer. |
| The amount to add to the unit rate when billing, in pence/kWh, which is paid to the third-party intermediary. |
Example
{
"organizationName": "abc123",
"unitRateUplift": 1.0,
"fixedTpiFee": 1,
"affiliateLinkSubdomain": "abc123"
}Input fields
| Name | Description |
|---|---|
| Device ID of the CHF (Communications Hub Function). |
| Code provided by manufacturer as part of ASN data, and included as part of device pre-notification, which is required to authorise device commissioning. |
| Device ID (ESME or GSME) of the device being commissioned. |
| Type of meter being commissioned |
| |
| Serial number for ESME or GSME devices. |
Example
{
"mpxn": "abc123",
"chfDeviceId": "abc123",
"meterDeviceId": "abc123",
"installationCode": "abc123",
"meterType": "ELECTRICITY_METER",
"serialNumber": "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 |
|---|---|
| Consent to MBNA. |
| Email. |
| First name. |
| Last name. |
| Phone. |
Example
{
"firstName": "abc123",
"lastName": "abc123",
"email": "abc123",
"phone": "abc123",
"consentToMbna": true
}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 |
|---|---|
| |
| |
| |
|
Example
{
"filename": "abc123",
"accountNumber": "abc123",
"category": "FILE_ATTACHMENT_MCS_CERT",
"clientMutationId": "abc123"
}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 electricity meter points to create a quote request for. |
| The gas meter points to create a quote request for. |
| Optional parameter for the payment method to quote for. Defaults to Direct Debit. |
| The postcode of the meter points being quoted. |
| The product codes of products to quote for. |
Example
{
"electricityMeterPoints": ElectricityMeterPointConsumptionInput,
"gasMeterPoints": GasMeterPointConsumptionInput,
"postcode": "abc123",
"productCodes": "abc123",
"paymentMethod": "DIRECT_DEBIT"
}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": "DIRECT",
"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"
}CreateAutoTopupConfigInput
The input type for creating an auto top-up config.
Input fields
| Name | Description |
|---|---|
| The account number, e.g.: 'A-A1B2C3D4'. |
| Alphanumber code identifying the device, e.g.: 'A1-BC-D2-00-01-23-EF-4G'. |
| The amount to top-up. The amount should always be provided in the minor unit of currency, i.e. USA cents / GBP pence / etc. Minimum allowed amount is 1. |
Example
{
"accountNumber": "abc123",
"deviceId": "abc123",
"topupAmount": 1
}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",
"directDebitInstruction": DirectDebitInstructionLocalBankDetailsInput
}CreateElectricJuiceAgreementInput
The input type for creating an Electric Juice agreement.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The time from which the new agreement is valid (default: now). |
Example
{
"accountNumber": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z"
}CreateElectricJuiceChargeCardInput
The input type for creating a new Electric Juice charge card.
Input fields
| Name | Description |
|---|---|
| The account number of the account this charge card should be associated with. |
| The UID on the charge card. |
| The name printed on the charge card. |
Example
{
"chargeCardUid": "abc123",
"nameOnCard": "abc123",
"accountNumber": "abc123"
}CreateElectricJuiceChargeInput
The input type for adding a charge for Electric Juice.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The price of additional (non-consumption) fees on this charge. |
| The UID of the Electric Juice charge card to associate with this charge. |
| The provider that originated this charge. |
| The currency of the charge. Deprecated The 'currency' field is deprecated. |
| The amount of energy consumed in kWh. |
| The amount to be charged (excl. tax). |
| The end time of the charge period. |
| The start time of the charge period. |
| The location of the charging point this charge is associated with. |
| The price per kWh. |
Example
{
"accountNumber": "abc123",
"chargeCardUid": "abc123",
"periodStartAt": "2020-01-01T00:00:00.000Z",
"periodEndAt": "2020-01-01T00:00:00.000Z",
"netAmount": 1,
"currency": "UK_PENCE",
"chargeProvider": "abc123",
"postcode": "abc123",
"kwhUsed": 1.0,
"pricePerKwh": 1.0,
"additionalFees": 1
}CreateElectricJuiceCreditInput
The input type for an Electric Juice ledger credit.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The gross amount of the credit to be created. |
| 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 tax amount of the credit to be created. |
Example
{
"accountNumber": "abc123",
"netAmount": 1,
"grossAmount": 1,
"taxAmount": 1,
"note": "abc123",
"reason": "EXTERNAL_REFERRAL_CREDIT"
}CreateEvPublicChargingAgreementInput
The input type for creating an EV Public Charging agreement.
Input fields
| Name | Description |
|---|---|
| The account number. |
| Identifier of an account in the external system. |
| The start time of the agreement. |
Example
{
"accountNumber": "abc123",
"externalAccountId": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z"
}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 subcategory of the event. |
Example
{
"accountNumber": "abc123",
"category": "COMMUNICATIONS",
"subcategory": "TELEPHONE",
"description": "abc123",
"content": ExternalAccountEventContent
}Input fields
| Name | Description |
|---|---|
| The account number. |
| A JSON object containing client parameters to store on the quote. |
| Products to get a quote for. |
Example
{
"accountNumber": "abc123",
"productsToQuote": ProductToQuoteInput,
"clientParams": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}Input fields
| Name | Description |
|---|---|
| A JSON object containing client parameters to store on the quote. |
| Customer profile. |
| Products to get a quote for. |
Example
{
"customerProfile": CustomerProfileInput,
"productsToQuote": ProductToQuoteInput,
"clientParams": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}Input fields
| Name | Description |
|---|---|
| Account to associate quote to. |
| Details of the address. |
| Details to pass to hubspot. |
| ID of the product to quote. |
| Details of the property, used for eligiblity checks. |
Example
{
"accountNumber": "abc123",
"productId": 1,
"addressDetails": AddressDetailsInput,
"contactDetails": ContactDetailsInput,
"propertyDetails": PropertyDetailsInput
}Input fields
| Name | Description |
|---|---|
| The account related to the message, if there is one. If provided, we will directly route the message to the account's conversation. |
| |
| 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. |
Example
{
"messageId": "abc123",
"newMessage": InkMessageInput,
"messageHeaders": {"key": "value"},
"occurredAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"clientMutationId": "abc123"
}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": "TRACED"
}Input fields
| Name | Description |
|---|---|
| The product rate(s) to be created. |
Example
{
"productRates": ProductRateInputType
}Input fields
| Name | Description |
|---|---|
| The account number. |
| A JSON object containing client parameters to store on the quote. |
| 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 |
|---|---|
| Optional address information about the customer |
| The affiliate organisation ID. Used with restricttoaffiliate_products. |
| |
| |
| |
| |
| |
| Whether the user has consented to their energy consumption estimates being retrieved from the industry vendors. This currently applies to business accounts only. |
| |
| Optional parameter to select the payment method for the quote, default is direct debit. |
| Used to verify the position that field sales agents generate quotes from |
| |
| Whether to restrict the products (tariffs) to quote from to only show affiliate products. Requires affiliateorganisationid. |
Example
{
"postcode": "abc123",
"electricityMeterPoints": ElectricityMeterPointConsumptionInput,
"gasMeterPoints": GasMeterPointConsumptionInput,
"position": PositionInput,
"gspGroupId": "abc123",
"affiliateSessionId": "abc123",
"affiliateOrganisationId": "abc123",
"restrictToAffiliateProducts": true,
"brandCode": "abc123",
"address": QuoteAddressInput,
"isBusiness": true,
"hasConsentedToIndustryDataSearch": true,
"paymentMethod": "DIRECTDEBIT"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| Optional parameter to override the payment method on the current agreement. |
| If the customer is currently on a flat rate tariff, create a flat rate quote. |
| The product codes of products to quote for. |
| The property id to create a quote request for. |
| The date at which the agreements would be renewed. |
Example
{
"accountNumber": "abc123",
"propertyId": 1,
"productCodes": "abc123",
"renewalAt": "2020-01-01T00:00:00.000Z",
"persistFlatRate": true,
"paymentMethod": "DIRECT_DEBIT"
}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 |
|---|---|
| The account number. |
| The property id to create a quote request for. |
| The date at which the agreements would be renewed. |
Example
{
"accountNumber": "abc123",
"propertyId": 1,
"renewalAt": "2020-01-01T00:00:00.000Z"
}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"
}Example
{
"riskBracket": "abc123",
"score": 1
}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 |
|---|---|
| Device ID for the device being decommissioned. |
Example
{
"deviceId": "abc123"
}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 |
|---|---|
| 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
{
"accountNumber": "abc123",
"accountHolder": "abc123",
"sortCode": "abc123"
}Example
{
"accountNumber": "abc123",
"paymentDay": 1
}DisableAutoTopupInput
The input type for disabling auto top-up.
Input fields
| Name | Description |
|---|---|
| The account number, e.g.: 'A-A1B2C3D4'. |
| Alphanumber code identifying the device, e.g.: 'A1-BC-D2-00-01-23-EF-4G'. |
Example
{
"accountNumber": "abc123",
"deviceId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The amount (excl. tax) in smallest units of currency. |
| The rate band of this line item. |
| JSON containing any additional metadata. |
| The end of the public charging session. |
| The start of the public charging session. |
Example
{
"amount": 1,
"periodStartAt": "2020-01-01T00:00:00.000Z",
"periodEndAt": "2020-01-01T00:00:00.000Z",
"band": "CONSUMPTION",
"metadata": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| The amount in smallest units of currency. |
| The amount (excl. tax) that this tax was calculated from, in smallest units of currency. |
| JSON containing any additional metadata. |
| The rate at which tax was applied. |
| The type of tax (e.g. 'VAT'). |
| The unit of the tax rate. |
Example
{
"amount": 1,
"amountTaxed": 1,
"rate": 1.0,
"unitType": "PROPORTION",
"taxType": "abc123",
"metadata": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| Daily bespoke rate for electricity. |
| Nightly bespoke rate for electricity. |
| Off peak rate for electricity. |
| Standard bespoke rate for electricity. |
| Standing charge for electricity. |
Example
{
"standard": 1.0,
"day": 1.0,
"night": 1.0,
"offPeak": 1.0,
"standingCharge": 1.0
}Input fields
| Name | Description |
|---|---|
| Daily electricity consumption. |
| If the consumption values are estimated, set this to 'True'. |
| Nightly electricity consumption. |
| Off peak hours electricity consumption. |
| Amount of electricity consumed. |
Example
{
"standard": 1,
"day": 1,
"night": 1,
"offPeak": 1,
"isEstimate": true
}ElectricityFiltersInput
Filter measurements by electricity parameters.
Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
|
Example
{
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123",
"readingDirection": "CONSUMPTION",
"registerId": "abc123",
"readingQuality": "ACTUAL"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
|
Example
{
"profileClass": 1,
"mpan": "abc123",
"isEstimate": true,
"annualConsumptionStandard": 1,
"annualConsumptionDay": 1,
"annualConsumptionNight": 1
}Input fields
| Name | Description |
|---|---|
| Annual consumption values for this meter point. Must be provided if no MPAN is provided. |
| Should the meter point be quoted on a flat rate. |
| The grid supply point ID of this meter point. |
| The meter type on this meter point. Must be provided if no MPAN is provided. |
| Must be provided if no custom consumption input is provided. |
Example
{
"mpan": "abc123",
"consumption": ElectricityConsumptionInput,
"meterType": "STANDARD",
"gspId": "abc123",
"flatRate": true
}Input fields
| Name | Description |
|---|---|
| Annual consumption values for this meter point. Must be provided if no MPAN is provided. |
| Should the meter point be quoted on a flat rate. |
| The grid supply point ID of this meter point. |
| The meter type on this meter point. Must be provided if no MPAN is provided. |
| Must be provided if no custom consumption input is provided. |
| A list of products and optional product parameters to quote for. |
Example
{
"mpan": "abc123",
"consumption": ElectricityConsumptionInput,
"meterType": "STANDARD",
"gspId": "abc123",
"flatRate": true,
"productsInput": ElectricityProductInput
}Input fields
| Name | Description |
|---|---|
| Bespoke rates to override default electricity unit rates. |
| Code specifying the product to quote for. |
| Optional payment method to quote for. |
Example
{
"code": "abc123",
"paymentMethod": "DIRECT_DEBIT",
"bespokeRates": ElectricityBespokeRates
}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"
}ExpireEvPublicChargingTokenInput
The input type for expiring an EV Public Charging token.
Input fields
| Name | Description |
|---|---|
| Identifier of an account in the external system. |
| Token identifier. |
| The end time of token's validity. |
Example
{
"externalAccountId": "abc123",
"tokenValue": "abc123",
"validTo": "2020-01-01T00:00:00.000Z"
}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"
}Input fields
| Name | Description |
|---|---|
| The account number associated with this schedule. |
| The ID of the schedule to accept. |
Example
{
"scheduleId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
|
Example
{
"fitId": "abc123",
"meters": FitMeterInput
}Input fields
| Name | Description |
|---|---|
| |
|
Example
{
"id": 1,
"reading": FitReadingInput
}Input fields
| Name | Description |
|---|---|
|
Example
{
"installations": FitInstallationInput
}Example
{
"value": 1.0,
"readAt": "2020-01-01T00:00:00.000Z",
"isBiennial": true
}Input fields
| Name | Description |
|---|---|
| Flow temperature if weather compensation is off. |
| Whether weather compensation should be enabled or not. |
| The min and max temperatures for when weather compensation is enabled. |
Example
{
"useWeatherCompensation": true,
"weatherCompensationValues": TemperatureRangeInput,
"flowTemperature": TemperatureInput
}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 |
|---|---|
| Standing charge for gas. |
| Standard bespoke rate for gas. |
Example
{
"value": 1.0,
"standingCharge": 1.0
}Input fields
| Name | Description |
|---|---|
| If the consumption values are estimated, set this to 'True'. |
| Amount of gas consumed. |
Example
{
"value": 1,
"isEstimate": true
}GasFiltersInput
Filter measurements by gas parameters.
Input fields
| Name | Description |
|---|---|
| |
| |
| |
|
Example
{
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123",
"registerId": "abc123"
}Example
{
"mprn": "abc123",
"isEstimate": true,
"annualConsumption": 1
}Input fields
| Name | Description |
|---|---|
| Annual consumption values for this meter point. |
| The grid supply point ID of this meter point. |
| Must be provided if no custom consumption input is provided. |
Example
{
"mprn": "abc123",
"consumption": GasConsumptionInput,
"gspId": "abc123"
}Input fields
| Name | Description |
|---|---|
| Annual consumption values for this meter point. |
| The grid supply point ID of this meter point. |
| Must be provided if no custom consumption input is provided. |
| A list of products and optional product parameters to quote for. |
Example
{
"mprn": "abc123",
"consumption": GasConsumptionInput,
"gspId": "abc123",
"productsInput": GasProductInput
}Input fields
| Name | Description |
|---|---|
| Bespoke rates to override default gas unit rates. |
| Code specifying the product to quote for. |
| Optional payment method to quote for. |
Example
{
"code": "abc123",
"paymentMethod": "DIRECT_DEBIT",
"bespokeRates": GasBespokeRates
}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 heat pump variant ID. |
Example
{
"heatPumpId": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The state that the hot water device should be set to. A value of true indicates that the device should be turned on, and a value of false indicates it should be switched off. |
Example
{
"accountNumber": "abc123",
"state": true
}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. |
Example
{
"accountNumber": "abc123",
"quotedProductId": "abc123",
"switchDate": "2020-01-01"
}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"
}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"
}Input fields
| Name | Description |
|---|---|
| Device ID of the CHF (Communications Hub Function). |
| Device ID (IHD, PPMID, CAD or Alt HAN) of the device being added to the CHF. |
| The device type being joined to the CHF. |
| The fuel type of the device, electricity, gas or dual fuel |
| Code provided by manufacturer as part of ASN data, and included as part of device pre-notification, which can be required to authorise the joined device. |
Example
{
"fuelType": "ELECTRICITY",
"chfDeviceId": "abc123",
"consumerDeviceId": "abc123",
"installationCode": "abc123",
"consumerDeviceType": "PPMID"
}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"
}JoinSavingSessionsCampaignInput
The input type for signing an account up to Saving Sessions.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The MPAN to be signed up. |
Example
{
"accountNumber": "abc123",
"mpan": "abc123"
}JoinSavingSessionsEventInput
The input type for opting an account in to a Saving Sessions event.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The code of the event the user is trying to sign up to. |
Example
{
"accountNumber": "abc123",
"eventCode": "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 |
|---|---|
| The type of meter. This field is not required but should be supplied whenever possible. |
| Serial number of the meter involved in the appointments |
| Whether the meter details refer to a meter that is currently installed at the site or one that has been removed or replaced. |
Example
{
"serialNumber": "abc123",
"status": "REMOVED",
"meterType": "abc123"
}Input fields
| Name | Description |
|---|---|
| The date the product switch should take effect. Defaults to the current agreement end date, or tomorrow if the agreement is open-ended. |
| Information on the commission that's associated with this agreement. |
| Should the meter point be on a flat rate. |
| The MPxN of the meter point. |
| The ID of the selected quoted product. |
Example
{
"mpxn": "abc123",
"quotedProductId": "abc123",
"changeOn": "2020-01-01",
"commission": CommissionInput,
"flatRate": true
}Input fields
| Name | Description |
|---|---|
| Street address of the new property. Should not contain the postcode. |
| Date of moving into the new property. |
| If True, this will trigger the move in flow at the new property for the account. |
| MPANs of the electricity meter points at the new property. |
| MPRNs of the gas meter points at the new property. |
| Postcode of new property. |
| The product to use when creating agreements for the new property. If not provided, the current product for each meter point is used if available, or else the default SVT product. If provided, quote_code must also be provided. |
| A quote that contains the product provided in productcode. Should be provided only if productcode is also provided. |
Example
{
"address": "abc123",
"postcode": "abc123",
"moveInDate": "abc123",
"mpans": ["abc123"],
"mprns": ["abc123"],
"productCode": "abc123",
"quoteCode": "abc123",
"moveInNewProperty": true
}Input fields
| Name | Description |
|---|---|
| |
| |
| The property to perform a move in for. |
| The details of the next occupant of the property. |
|
Example
{
"accountNumber": "abc123",
"propertyId": "abc123",
"moveOutDate": "2020-01-01",
"newProperty": MoveInNewProperty,
"newTenant": MoveOutNewTenant
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
|
Example
{
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"mobile": "abc123",
"role": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account type to quote for (e.g. Business or Domestic). |
| Optional ID of the affiliate session active when creating this quote. |
| Company brand to quote for. |
| Optional parameter for the payment method to quote for. Defaults to Direct Debit. |
Example
{
"accountType": "BUSINESS",
"brandCode": "abc123",
"paymentMethod": "DIRECT_DEBIT",
"affiliateSessionId": "abc123"
}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"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| The day of the month that payments should be taken from the account. Should be between 1 and 28. |
| |
| |
| |
|
Example
{
"accountNumber": "abc123",
"propertyId": "abc123",
"quoteCode": "abc123",
"productCode": "abc123",
"paymentDay": 1,
"directDebitInstruction": DirectDebitInstructionLocalBankDetailsInput,
"users": AccountUserInput,
"moveInDate": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| Input a customer account number. |
| Payment amount must be inputted as pence. |
| Input a direct debit payment day. |
Example
{
"accountNumber": "abc123",
"paymentAmount": 1,
"paymentDay": 1
}Example
{
"latitude": 1.0,
"longitude": 1.0
}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"
}PostEVPublicChargingChargeInput
The input type for post an EV Public Charging charge.
Input fields
| Name | Description |
|---|---|
| The line items for the new charge. |
| The tax items for the new charge. |
| The value of the token used for this session. |
Example
{
"tokenValue": "abc123",
"lineItems": EVPCLineItem,
"taxItems": EVPCTaxItem
}Input fields
| Name | Description |
|---|---|
| Optional short note about the credit, to be displayed to the user. |
| The external account identifier. |
| The net amount of the credit to be added. Amount should be posted in the smallest unit of currency. |
| The reason why the credit is added. |
| The tax amount of the credit to be added. Amount should be posted in the smallest unit of currency. |
Example
{
"externalAccountId": "abc123",
"netAmount": 1,
"taxAmount": 1,
"reason": "EXTERNAL_REFERRAL_CREDIT",
"displayNote": "abc123"
}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
}ProductRateInputType
Input type for creating a single product rate.
Input fields
| Name | Description |
|---|---|
| The band category of the product rate. |
| The band subcategory of the product rate. For gas products, pass 'null'. For electricity products, select a subcategory. |
| The GSP group id of the product rate. |
| The payment method of the product rate, if applicable. |
| The value of the product rate. |
| Date and time the product rate is effective from. |
| Date and time the product rate is effective to. |
Example
{
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"bandCategory": "STANDING_CHARGE",
"bandSubcategory": "STANDARD",
"pricePerUnit": 1.0,
"gsp": "_A",
"paymentMethod": "DIRECT_DEBIT"
}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 |
|---|---|
| Whether the property has indoor space for a cylinder. |
| Whether the property has outdoor space for a heat pump. |
| Heat type. |
| Whether the property is undergoing a home renovation. |
| Property type. |
Example
{
"propertyType": "END_OF_TERRACE",
"heatType": "MAINS_GAS_BOILER",
"hasOutdoorSpaceForHeatPump": true,
"hasIndoorSpaceForCylinder": true,
"isHomeRenovation": true
}Input fields
| Name | Description |
|---|---|
| The EUID of the device we are trying to provision. |
| The SHA256 hash of the EUID and timestamp. |
| The signature of the nonce generated by the device's private key. |
| A string representing the number of whole milliseconds since the epoch. |
Example
{
"euid": "abc123",
"timestamp": "abc123",
"nonce": "abc123",
"signature": "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 |
|---|---|
| Account number to create this quote for. |
| Date at which the product switch takes effect. Defaults to today if not provided. |
| A list of electricity meterpoints to create this quote for. |
| A list of gas meterpoints to create this quote for. |
Example
{
"electricityMeterPointsInput": ElectricityMeterPointProductsInput,
"gasMeterPointsInput": GasMeterPointProductsInput,
"accountNumber": "abc123",
"at": "2020-01-01T00:00:00.000Z"
}Example
{
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| Slug of campaign to quote on. |
| Property to quote on. |
Example
{
"accountNumber": "abc123",
"propertyId": 1,
"campaignSlug": "abc123"
}Input fields
| Name | Description |
|---|---|
| A list of electricity meterpoints to create this quote for. |
| A list of gas meterpoints to create this quote for. |
| Additional context about the future account which is required to create the quote. |
| Only quote on products with these tags. If not provided, quote against all available products. |
Example
{
"electricityMeterPointsInput": ElectricityMeterPointInput,
"gasMeterPointsInput": GasMeterPointInput,
"newAccountInput": NewAccountInput,
"productTags": ["abc123"]
}Input fields
| Name | Description |
|---|---|
| A list of electricity meterpoints to create this quote for. |
| A list of gas meterpoints to create this quote for. |
| Data for creating a new account. |
Example
{
"electricityMeterPointsInput": ElectricityMeterPointProductsInput,
"gasMeterPointsInput": GasMeterPointProductsInput,
"newAccountInput": NewAccountInput
}Input fields
| Name | Description |
|---|---|
| |
| Deprecated The 'register' field is deprecated. |
|
Example
{
"registerId": "abc123",
"register": "abc123",
"reading": 1
}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"
}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
}RedeemOctoPointsInput
The input type for redeeming OctoPoints.
Input fields
| Name | Description |
|---|---|
| The account number. |
Example
{
"accountNumber": "abc123"
}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"
}RefundRequestInput
The input type for the refund request.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The requested refund amount. |
Example
{
"accountNumber": "abc123",
"requestedAmount": 1
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The authentication details required given the chosen provider. |
| The charger details. |
| The ID of the property the electric vehicle belongs to. |
| The provider used to authenticate the device. |
| The unique vehicle ID of the electric vehicle. |
Example
{
"accountNumber": "abc123",
"vehicle": VehicleInput,
"chargePoint": ChargePointInput,
"supportedProvider": "DAIKIN",
"authentication": AuthenticationInput,
"propertyId": 1
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The authentication details required given the chosen provider. |
| The make, model and power of the heat pump. |
| The ID of the property the heat pump belongs to. |
| The provider used to authenticate the device. |
Example
{
"accountNumber": "abc123",
"propertyId": 1,
"heatPump": HeatPumpInput,
"provider": "DAIKIN",
"authentication": AuthenticationInput
}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"
}RegisterSmartDeviceInput
This type is used by agent services to notify Kraken of a new device.
Input fields
| Name | Description |
|---|---|
| The ID of the device to register. |
| The 4-letter manufacturer code for the device. |
| Model of the device. |
| Type of the device, e.g. ESME or GSME. |
| ESME variant for an ESME device. |
| Firmware version number. |
| Installation code of the device. |
| MPID of the Meter Asset Provider for the device. Used with ESME or GSME devices. |
| Serial number for ESME or GSME devices. |
| SMETS CHTS version number. |
| Supplier associated with the device. |
Example
{
"deviceId": "abc123",
"mapMpid": "abc123",
"supplierMpid": "abc123",
"deviceManufacturer": "abc123",
"deviceModel": "abc123",
"deviceType": "abc123",
"smetsChtsVersion": "abc123",
"installCode": "abc123",
"esmeVariant": "abc123",
"serialNumber": "abc123",
"firmwareVersion": "abc123"
}Input fields
| Name | Description |
|---|---|
| Device ID of the CAD being removed from the CHF/HAN. |
| The device type being joined, currently limited to CAD only. |
Example
{
"consumerDeviceId": "abc123",
"consumerDeviceType": "CAD"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
|
Example
{
"serialNumber": "abc123",
"meterType": "K",
"registers": RemovedElectricityMeterRegisterInput,
"readAt": "2020-01-01T00:00:00.000Z",
"prepayData": RemovedMeterPrepayDataInput
}Input fields
| Name | Description |
|---|---|
| |
|
Example
{
"mpan": "abc123",
"meters": RemovedElectricityMeterInput
}Input fields
| Name | Description |
|---|---|
| |
| Identifier string/label for the register. |
Example
{
"id": "abc123",
"finalReading": 1.0
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
|
Example
{
"serialNumber": "abc123",
"meterType": "PP",
"finalReading": 1.0,
"readAt": "2020-01-01T00:00:00.000Z",
"prepayData": RemovedMeterPrepayDataInput
}Input fields
| Name | Description |
|---|---|
| |
|
Example
{
"mprn": "abc123",
"meters": RemovedGasMeterInput
}Input fields
| Name | Description |
|---|---|
| The credit balance of the meter in millipence. |
| The total of all debt left on the removed meter in millipence. |
| Amount of emergency credit remaining on the meter in millipence. |
Example
{
"balance": 1,
"cumulativeDebtBalance": 1,
"emergencyCreditBalance": 1
}Input fields
| Name | Description |
|---|---|
| The date the agreement was agreed from (inclusive, if different to valid_from). |
| Bespoke rates overriding those of the associated tariff, with payment method. |
| Bespoke rates overriding those of the associated tariff. |
| Information on the commission that's associated with this agreement. |
| MPxN to renew the agreement for. |
| Tariff code for the new agreement. |
| The start date of the new agreement (inclusive). |
| The end date of the new agreement (exclusive). |
Example
{
"mpxn": "abc123",
"tariffCode": "abc123",
"validFromDate": "2020-01-01",
"validToDate": "2020-01-01",
"agreedFromDate": "2020-01-01",
"bespokeTariffRates": BespokeTariffRatesInput,
"bespokePpsTariffRates": BespokePPSTariffRatesInput,
"commission": CommissionInput
}Input fields
| Name | Description |
|---|---|
| Account number |
| The date the new agreement takes effect. This can be no more than 90 days in the future. |
| A list of electricity agreements and the code of the product they will be renewed to. |
| A list of gas agreements and the code of the product they will be renewed to. |
Example
{
"accountNumber": "abc123",
"electricityAgreements": AgreementRenewalProductInput,
"gasAgreements": AgreementRenewalProductInput,
"changeOn": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The date the new agreement takes effect. This can be no more than 90 days in the future. |
| Where the account's current payment schedule has a debt repayment element, we let the user choose whether to continue making catch-up payments, or to repay the full debt in addition to their next payment. |
| If the customer is currently on a flat rate tariff, persist this into the new agreement. |
| The ID of the property that agreements should be renewed for. |
| The ID if the quoted product we wish to use to create new agreements. Part of the tariff renewal journey involves re-quoting to ensure this is available. |
Example
{
"accountNumber": "abc123",
"quotedProductId": "abc123",
"propertyId": "abc123",
"makeFullDebtRepayment": true,
"persistFlatRate": true,
"changeOn": "2020-01-01"
}RepaymentInput
Input fields for Repayment Intervention.
Input fields
| Name | Description |
|---|---|
| The Repayment Intervention reason. |
| The repayment ID. |
Example
{
"repaymentId": "abc123",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| MPxN of the related meter point to the agreement. |
| Product code to replace with. |
| Date to replace on, must be in future. |
Example
{
"accountNumber": "abc123",
"mpxn": "abc123",
"replaceOnDate": "2020-01-01",
"newProductCode": "abc123"
}ReplaceCommsHubInput
Specify a new SMETS2 Communications Hub to replace an existing Communications Hub.
Input fields
| Name | Description |
|---|---|
| The device id of the new Communications Hub. |
| The device id of the old Communications Hub. |
Example
{
"oldCommsHubDeviceId": "abc123",
"newCommsHubDeviceId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The installer/agents own booking reference for the appointment to remove these meters. |
| |
|
Example
{
"appointmentId": "abc123",
"electricityMeterPoint": RemovedElectricityMeterPointInput,
"gasMeterPoint": RemovedGasMeterPointInput
}Input fields
| Name | Description |
|---|---|
| Device ID for the meter. |
| The last half hourly end time (inclusive) to retrieve. |
| The first half hourly period start (inclusive) to retrieve. |
Example
{
"deviceId": "abc123",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z"
}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 |
|---|---|
| |
| |
| Optional parameter to select the payment method for the quote, default is direct debit. |
| |
| |
|
Example
{
"accountNumber": "abc123",
"propertyId": "abc123",
"productAvailableAt": "2020-01-01T00:00:00.000Z",
"includeHiddenProducts": true,
"persistFlatRate": true,
"paymentMethod": "DIRECTDEBIT"
}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"
}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"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The temperature the room should be set to. The valid temperature range is between 12 and 30 degrees in increments of 0.5 degrees. |
Example
{
"accountNumber": "abc123",
"temperature": 1.0
}SalesInformationInput
Information about the sale to associate with the account.
Input fields
| Name | Description |
|---|---|
| Unique reference number. |
| Unique reference number. |
| Sales channel. |
| Sales subchannel. |
| Unique reference number. |
Example
{
"salesChannel": "abc123",
"salesSubchannel": "abc123",
"urn": "abc123",
"affiliateSubdomain": "abc123",
"affiliateParams": "abc123"
}Input fields
| Name | Description |
|---|---|
| The MPAN of the meter point to enrol with Saving Sessions. If not provided, a random eligible meter point for the account will be selected |
| Whether or not the account should enrol in Saving Sessions. |
Example
{
"shouldEnrol": true,
"nominatedMpan": "abc123"
}Input fields
| Name | Description |
|---|---|
| Whether this setting turns the zone on or off, or changes its temperature. |
| Desired zone temperature (for zones which support setpoints). |
| Time for when settings should be active, in |
Example
{
"time": "00:00:00.000Z",
"action": "abc123",
"setpointInCelsius": 20.6
}SensorDisplayNameUpdate
A mapping of sensor codes to the display names we would like those sensors to have.
Input fields
| Name | Description |
|---|---|
| The new display name to set for this sensor. |
| The code of the sensor you want to update. |
Example
{
"sensorCode": "abc123",
"newDisplayName": "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 |
|---|---|
| Time at which boost should end. |
| The zone mode, i.e. ON, OFF, AUTO or BOOST. |
| Target temperature for a zone in celsius. |
| The heat pump controller zone, i.e. WATER, ZONE1, ZONE2 or AUXILIARY. |
Example
{
"zone": "WATER",
"mode": "ON",
"setpointInCelsius": 20.6,
"endAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The code for the sensor we want to make primary, such as 'SENSOR01'. |
| The heat pump controller zone. |
Example
{
"zone": "WATER",
"sensorCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The schedule(s) to be set for a specific zone. |
| The heat pump controller zone, i.e. WATER, ZONE1, ZONE2 or AUXILIARY. |
Example
{
"zone": "WATER",
"schedules": ZoneSchedule
}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"
}SmartMeterDeviceInput
Identifies a SMETS2 meter (or a SMETS1 E&A'd meter).
Input fields
| Name | Description |
|---|---|
| Account number of customer. |
| Electricity or gas meter device ID. |
Example
{
"accountNumber": "abc123",
"deviceId": "abc123"
}SmartPrepayMeterAmountInput
This type is used by clients to top-up a smart prepay meter
Input fields
| Name | Description |
|---|---|
| Account number of customer. |
| Amount of credit to add to the meter, in pence. |
| Electricity or gas meter device ID. |
| Apply as temporary credit. |
| The top-up will wait for this payment to clear before proceeding. |
| Reason for top-up. |
Example
{
"accountNumber": "abc123",
"deviceId": "abc123",
"amount": 1,
"paymentIntentId": "abc123",
"isTemporaryCredit": true,
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| Version of the terms and conditions that have been accepted. |
| Account number. |
| The export certificate object. |
| The DNO status. |
| The export MPAN. |
| The FiT ID. |
| The FiT ownership status. |
| The import MPAN. |
| Whether to take over the FiT generation payments. |
| The MCS certificate number. Deprecated The 'mcsCertNumber' field is deprecated. |
| The export product code. |
| The export technology type. |
| Have the terms and conditions for this product been accepted? To be deprecated. |
Example
{
"accountNumber": "abc123",
"importMpan": "abc123",
"exportMpan": "abc123",
"productCode": "abc123",
"technologyType": "HYDRO",
"fitStatus": "OWNER",
"includeFitGeneration": true,
"fitId": "abc123",
"mcsCertNumber": "abc123",
"certificate": Certificate,
"dnoStatus": "NOTIFIED",
"termsAndConditionsAccepted": true,
"acceptedTermsAndConditionsVersion": "abc123"
}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
}Input fields
| Name | Description |
|---|---|
| Account number. |
| |
| The MPAN to switch. |
| The MPRN to switch. |
| The product code to switch to. |
| A target start date for the new agreement. Must be today or later. Will be ignored if date is in the past at time of creating the new agreement. |
|
Example
{
"accountNumber": "abc123",
"mpan": "abc123",
"mprn": "abc123",
"productCode": "abc123",
"isNewAccount": true,
"termsAndConditions": TermsAndConditions,
"targetAgreementChangeDate": "2020-01-01"
}StoreElectricJuicePaymentInstructionInput
The input for storing a new card instruction from an embedded form.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The datetime from which the instruction is vaild. |
| The vendor's reference for this payment method. |
Example
{
"accountNumber": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"vendorReference": "abc123"
}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 |
|---|---|
| Account number. |
| The information required to switch each meter point onto the specified product. |
| Runs payment adequacy and checks if the amount - the customer is paying each month - should be updated. |
Example
{
"accountNumber": "abc123",
"meterPointSwitchContexts": MeterPointSwitchContext,
"updatePaymentAmount": true
}TemperatureInput
Describes the temperature of something that is relevant to the heating system.
Input fields
| Name | Description |
|---|---|
| The units in which the temperature is being measured. |
| The temperature measured. |
Example
{
"value": 1.0,
"unit": "DEGREES_CELSIUS"
}TemperatureRangeInput
An input type to represent a finite temperature range.
Input fields
| Name | Description |
|---|---|
| The maximum allowable temperature in range. |
| The minimum allowable temperature in range. |
Example
{
"minimum": TemperatureInput,
"maximum": TemperatureInput
}Input fields
| Name | Description |
|---|---|
| |
| The version of the terms and conditions the user was presented with. |
Example
{
"version": "abc123",
"accepted": true
}Input fields
| Name | Description |
|---|---|
| The major version of terms and conditions that were accepted. |
| The minor version of terms and conditions that were accepted. |
Example
{
"versionMajor": 1,
"versionMinor": 1
}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
}TypedSourceInputType
Provide a typed source to filter measurements. If a typed_source and a raw source is given, preference is given to the raw source. To get better results, make sure none of the input fields are empty.
Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
|
Example
{
"utility": "ELECTRICITY",
"readingFrequencyType": "RAW_INTERVAL",
"readingDirection": "CONSUMPTION",
"sourceIdentifier": "abc123",
"readingQuality": "ACTUAL"
}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 |
|---|---|
| |
| Input field for setting smart meter interest. |
| The source category of the smart meter interest update. |
| Input field for setting the reason for why a customer is not interested in a smart meter. |
Example
{
"accountNumber": "abc123",
"smets2Interest": "INTERESTED",
"smets2InterestSource": "WEBSITE",
"smets2RefusalReason": "SMETS2_INTEREST_REASON_DO_NOT_OWN_HOME"
}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": "DIRECT",
"defaultAccountType": "BUSINESS",
"canRegisterBusinessMeterPoints": true,
"canRegisterPortfolioAccounts": true,
"canRegisterCustomersWithoutEmailAddress": true,
"skipMeterPointAddressValidation": true,
"allowAlternativePaymentMethods": true,
"canRenewTariffs": true,
"canUseIvrSupportApi": true,
"isFieldSalesOnlyProduct": true
}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 |
|---|---|
| How the CHF was installed and connected to the rest of the Smart Metering System. |
| Device ID of the CHF (Communications Hub Function). |
| Is it a new or replacement CHF? |
| Location of the CHF. |
| The engineer's description of the fault. |
| Whether a fault was identified before or after the installation. |
| Was an external aerial installed? |
| In the case of NOSMWAN, was the issue a thick stone wall obstruction (as defined in CHSM)? |
| In the case of NOSMWAN, was the issue a local metal obstruction (as defined in CHSM)? |
| In the case of NOSMWAN, was the CHF in a shared/communal area (as defined in CHSM)? |
| MPAN of the meter point linked to the CHF. Deprecated The 'mpan' field is deprecated. |
| MPxN of a meter point linked to the CHF. |
| In the case of NOFAULTRETURN, the reason for the meter not being installed. |
| Type of the premise in which the CHF is located. |
| The type of status update to be sent. |
Example
{
"chfDeviceId": "abc123",
"updateType": "SUCCESS",
"mpxn": "abc123",
"mpan": "abc123",
"chfInstallType": "NEW",
"hasAerialInstalled": true,
"chfLocation": "OUTSIDE",
"premiseType": "DETACHED_OR_SEMI",
"hasMetalObstruction": true,
"hasConnectivityObstruction": true,
"hasSharedObstruction": true,
"faultReason": "DAMAGED_CASE",
"faultReturnType": "PRIOR_TO_INSTALLATION",
"chfConnectionMethod": "HOT_SHOE",
"noFaultReturnType": "GENERAL"
}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",
"amount": 1
}Example
{
"accountNumber": "abc123",
"paymentDay": 1
}Input fields
| Name | Description |
|---|---|
| |
| The consent that smart meter readings can be used for further analysis |
| The desired reading frequency for the smart meter. |
Example
{
"accountNumber": "abc123",
"readingFrequency": "DAILY",
"allowReadingsAnalysis": true
}Input fields
| Name | Description |
|---|---|
| Additional presence preferred |
| Blind |
| Careline/telecare system |
| Chronic/serious illness |
| Dementia |
| Developmental condition |
| Pensionable age |
| |
| |
| |
| |
| Heart, lung & ventilator |
| Dialysis, feeding pump and automated medication |
| Preferred language |
| MDE electric showering |
| Medicine refrigeration |
| Mental health |
| Nebuliser and apnoea monitor |
| Oxygen concentrator |
| Oxygen Use |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| Use a unique password to identify our staff and partners |
| Consent required to allow priority service request information to be shared. You will only need to provide this once |
|
Example
{
"additionalPresencePreferred": true,
"blind": true,
"carelineTelecareSystem": true,
"chronicSeriousIllness": true,
"dementia": true,
"developmentalCondition": true,
"elderly": true,
"hearingImpairment": true,
"heartLungMachine": true,
"kidneyDialysis": true,
"mdeElectricShowering": true,
"medicineRefrigeration": true,
"mentalHealth": true,
"nebuliser": true,
"oxygenConcentrator": true,
"oxygenUse": true,
"partialSighted": true,
"physicalImpairment": true,
"poorSenseOfSmell": true,
"restrictedHandMovement": true,
"restrictedMovement": true,
"speechImpairment": true,
"stairLift": true,
"waterDependent": true,
"familiesWithYoungChildren5OrUnder": true,
"familiesWithYoungChildren5OrUnderEndDate": "abc123",
"temporaryLifeChanges": true,
"temporaryLifeChangesEndDate": "abc123",
"temporaryPostHospitalRecovery": true,
"temporaryPostHospitalRecoveryEndDate": "abc123",
"temporaryYoungAdultHouseholder": true,
"temporaryYoungAdultHouseholderEndDate": "abc123",
"foreignLanguageSpeaker": true,
"language": "abc123",
"usePasswordToIdentify": true,
"partnerPassword": "abc123",
"userConsent": true
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The desired Supply Start Date (SSD). |
Example
{
"accountNumber": "abc123",
"desiredSsd": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| 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"
}UtilityFiltersInput
Filter measurements by the given utility parameters.
Input fields
| Name | Description |
|---|---|
| |
|
Example
{
"electricityFilters": ElectricityFiltersInput,
"gasFilters": GasFiltersInput
}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 |
|---|---|
| Registration number of a car. |
Example
{
"registrationNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| The unique electric vehicle id. |
Example
{
"vehicleId": 1
}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 |
|---|---|
| A set of criteria under which someone is eligible for the Warm Home Discount. The applicant must meet at least one of these criteria, as well as at least one qualifying component criteria. |
| A set of criteria under which someone is eligible for the Warm Home Discount. The applicant must meet at least one of these criteria, as well as at least one qualifying component criteria. |
Example
{
"qualifyingCriteria": "SAVINGS_ELEMENT_OF_PENSION_CREDIT",
"qualifyingComponent": "PERSONAL_INDEPENDENCE_PAYMENTS"
}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
}Input fields
| Name | Description |
|---|---|
| Days of the week a schedule should be active, Sunday through Saturday, in bitmask format,e.g. Sun, Tue, Wed => 1011000. |
| Settings in a schedule for the selected day(s). |
Example
{
"days": "abc123",
"settings": ScheduleSettings
}_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"
}