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 |
|---|---|
| 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. |
| Bills (Shortcut). |
| Account or Billing name. |
| Business name. |
| Business identifier or number. |
| Location (Supply or Billing, full or partial, address or post code). |
| Meter Serial Number. |
| The portfolio number eg. P-A123B456. |
| Statements (Alias for bills). |
| URN Number. |
| The Account User ID (not account number). |
Example
{
"accountNumber": "abc123",
"portfolioNumber": "abc123",
"urn": "abc123",
"user": "abc123",
"account": "abc123",
"bill": "abc123",
"statements": "abc123",
"meterSerialNumber": "abc123",
"location": "abc123",
"billingName": "abc123",
"businessName": "abc123",
"businessNumber": "abc123",
"accountReferences": "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 |
|---|---|
| The ID of the SmartFlex onboarding wizard to cancel. |
Example
{
"wizardId": "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 entire continuation URI returned by the vendor. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"continuationUri": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number that the device is registered to. |
| External reference in the third-party system to identify the device. |
| Postcode of the property (linked to the account) that the device is registered to. |
Example
{
"accountNumber": "abc123",
"postalCode": "abc123",
"externalDeviceIdentifier": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123"
}CreateFlexShellAccountInput
Input for creating a ResiFlex shell account.
Input fields
| Name | Description |
|---|---|
| Current property address for device onboarding. |
| The brand code representing the client. |
| Email address of the account holder. |
| Last/family name of the account holder. |
| First/given name of the account holder. |
Example
{
"brandCode": "abc123",
"email": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"address": RichAddressInput
}Input fields
| Name | Description |
|---|---|
| List of post events to create. |
Example
{
"events": PostEventInput
}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. |
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 |
|---|---|
| Namespace of the detail. |
| Value of the detail. |
Example
{
"namespace": "abc123",
"value": "abc123"
}Input fields
| Name | Description |
|---|---|
| Auxiliary device variant id. |
| Unique device variant id. |
Example
{
"deviceVariantId": "abc123",
"auxDeviceVariantId": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The authentication details required given the chosen provider. |
| The device type specific details required for registering a device. |
| The device type to be registered - batteries, electric vehicles, heat pumps or thermostats. |
| The ID of the property the device belongs to. |
| The provider used to authenticate the device. |
Example
{
"accountNumber": "abc123",
"propertyId": 1,
"deviceType": "BATTERIES",
"provider": "BYD",
"deviceDetails": DeviceDetailsInput,
"authentication": AuthenticationInput
}ElectricityFiltersInput
Filter measurements by electricity parameters.
Input fields
| Name | Description |
|---|---|
| The identifier of the specific device associated to this reading. |
| The identifier of the market supply point associated to this reading. |
| Reading direction is based on the utility generated or consumed by the customer. |
| The frequency of the reading. |
| |
| The identifier of the register associated to this reading. |
Example
{
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123",
"readingDirection": "CONSUMPTION",
"registerId": "abc123",
"readingQuality": "ACTUAL"
}Input fields
| Name | Description |
|---|---|
| Payment instruction ID. |
Example
{
"paymentInstructionId": 1
}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
}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).
The currently supported inputs are: - account user email/password combination - account user API key - organization live secret key - pre-signed key - refresh token
Input fields
| Name | Description |
|---|---|
| API key of the account user. Use standalone, don't provide a second input field. |
| The response from the CAPTCHA challenge. Use with 'email' and 'password' fields. |
| Email address of the account user. Use with 'password' field. Deprecated The 'email' field is deprecated. |
| 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. Deprecated The 'password' field is deprecated. |
| 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
{
"APIKey": "abc123",
"organizationSecretKey": "abc123",
"preSignedKey": "abc123",
"refreshToken": "abc123",
"email": "abc123",
"password": "abc123",
"captchaResponse": "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 |
|---|---|
| Account number of the account to update. |
| The language preference to set for the account, from the available options. |
Example
{
"accountNumber": "abc123",
"optionsLanguagePreference": "ENGLISH"
}Input fields
| Name | Description |
|---|---|
| Explanation or context for the event. |
| Unique identifier for this event from the external vendor, if provided. Used for deduplication so that requests can be safely retried without creating duplicate events. |
| Type of post event (ie. 'delivered', 'returned', 'failed'). |
| Unique ID of the message (ie. letter or document) that this post event relates to. |
| The date/time that the post event occurred, if provided. |
Example
{
"messageId": "abc123",
"eventType": "abc123",
"description": "abc123",
"timestamp": "2020-01-01T00:00:00.000Z",
"eventId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The day of the week. |
| The maximum value. |
| The minimum value. |
| Time of day this change should apply. Format: HH:MM. |
Example
{
"dayOfWeek": "MONDAY",
"time": "00:00:00.000Z",
"min": "1.0",
"max": "1.0"
}RequestPasswordResetInput
Input type for the RequestPasswordReset mutation.
Input fields
| Name | Description |
|---|---|
| The URL from which the reset was requested. If supported, it is used as the base URL to generate the reset link in the email sent to the user. |
| The email requesting a password reset email. Provide either this or the userNumber. |
| The number of the user requesting a password reset email. Provide either this or the email. |
Example
{
"email": "abc123",
"userNumber": "abc123",
"baseUrl": "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, NZ region, 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, NZ suburb and city/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
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}SelectVehicleOrChargePointInput
Options for selecting the user's vehicle or charge point.
Input fields
| Name | Description |
|---|---|
| User selected integration option. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedIntegration": "ELECTRIC_VEHICLE"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The smart control action, i.e. suspend or unsuspend. |
| The ID of the device. |
Example
{
"deviceId": "abc123",
"action": "SUSPEND"
}Input fields
| Name | Description |
|---|---|
| The ID of the device. |
| The mode of the schedule. |
| The schedule with the preference details. |
| The unit of the min and max values in the preferences schedule. |
Example
{
"deviceId": "abc123",
"mode": "CHARGE",
"unit": "CELSIUS",
"schedules": PreferencesScheduleInput
}Input fields
| Name | Description |
|---|---|
| The account number associated with the device. |
| The ID of the device to re-authenticate. |
| The property where the device is located/charged. |
Example
{
"accountNumber": "abc123",
"propertyId": 1,
"deviceId": "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 |
|---|---|
| The boost action. |
| Device ID. |
Example
{
"deviceId": "abc123",
"action": "BOOST"
}Input fields
| Name | Description |
|---|---|
| Device ID. |
| Whether or not the device grid export is enabled. |
Example
{
"deviceId": "abc123",
"enabled": true
}Input fields
| Name | Description |
|---|---|
| The ID of the device to update. |
| Whether to enable charging duration capping. |
Example
{
"deviceId": "abc123",
"enabled": true
}Input fields
| Name | Description |
|---|---|
| |
| User details. |
| |
| |
| |
| A free text field to help identifying the customer (e.g. for a job title). |
| 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",
"label": "abc123",
"details": DetailsInputType
}Input fields
| Name | Description |
|---|---|
| The key of the user input, matching the key of the requested input. |
| The value provided by the user for this input. |
Example
{
"key": "abc123",
"value": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the SmartFlex onboarding step to complete. |
| A list of user input key-value pairs where each key should match the key of the requested input. |
| A json object of user input key-value pairs where the key should match the key of the requested input. Deprecated The 'completeUserInputRequiredForSmartFlexOnboarding.userInputs' field is deprecated. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"userInput": UserInput,
"userInputs": {"key": "value"}
}UtilityFiltersInput
Filter measurements by the given utility parameters.
Input fields
| Name | Description |
|---|---|
| Filter measurements by electricity parameters. |
Example
{
"electricityFilters": ElectricityFiltersInput
}Input fields
| Name | Description |
|---|---|
| Account number. |
| |
| |
| |
| |
|
Example
{
"accountNumber": "abc123",
"weekdayTargetTime": "abc123",
"weekdayTargetSoc": 1,
"weekendTargetTime": "abc123",
"weekendTargetSoc": 1,
"targetType": "abc123"
}