About Enums
Enums represent possible sets of values for a field. They are useful for defining a specific set of allowed values for a field.
AccountBillingOptionsPeriodLength
An enumeration.
Values
MONTHLY
Monthly
QUARTERLY
Quarterly
Example
"MONTHLY"AccountEventType
An enumeration.
Values
EMAIL_RECEIVED
The email messages that were received by the account.
EMAIL_SENT
The email messages that were sent by the account.
MARKETING_EMAIL_SENT
The marketing email messages that were sent by the account.
PRINT_CANCELLED
The print messages that were cancelled.
PRINT_FAILED
The print messages that failed to be delivered.
PRINT_RETURNED
The print messages that were returned to sender.
PRINT_SENT
The print messages that were sent to the print partner by the account.
PRINT_SUCCEEDED
The print messages that were sent by the print partner.
PUSH_NOTIFICATION_SENT
The push notification messages that were sent by the account.
SMS_RECEIVED
The SMS messages that were received by the account.
SMS_SENT
The SMS messages that were sent by the account.
Example
"EMAIL_SENT"AccountPaymentStatusOptions
The current status of the payment. Note: REQUESTED payments are excluded by default.
Values
CLEARED
The payment has been approved by the merchant and added to your Kraken account.
DELETED
This payment was deleted. From this point it cannot be altered.
FAILED
The payment failed permanently.
FULFILLED
The payment has been made successfully and applied to the Kraken balance.
HISTORIC
Payments made in a previous system and then imported into Kraken.
PENDING
The payment has been submitted. From this point it cannot be altered.
PROMISED
A payment promise has been created, but it has not left the customers bank account.
PROMISE_BROKEN
The payment promise has been broken.
REQUESTED
The initial state of a payment in Kraken. It should be scheduled with a payment vendor in the future.
SCHEDULED
The payment has been scheduled for collection and the customer has been notified. While a payment is scheduled, it can still be deleted.
THIRD_PARTY
Third Party payments are those recorded for financial purposes in a different system but should be added to statements.
Example
"SCHEDULED"AccountPaymentTransactionTypeChoices
An enumeration.
Values
AGENCY
ALLPAY_CARD
ALLPAY_CASH
ALLPAY_CHEQUE
AUSTRALIA_POST
BACS_DEPOSIT
BPAY
BPOINT
BRISTOL_POUND
BTRE
CASH
CENTREPAY
CHEQUE
CREDIT_CARD
DCA_COLLECTION
DD_FINAL_COLLECTION
DD_FIRST_COLLECTION
DD_REGULAR_COLLECTION
DD_RE_PRESENTATION
DEBIT_CARD
DESKTOP_DEPOSIT
DWP
EAPA_VOUCHER
EBOX
EFT
ERRONEOUS_PAYMENT
FAILED_REPAYMENT_REVERSAL
FUEL_DIRECT
HEEAS
IDEAL
IVR
KONBINI
MONEYGRAM
PAGOPA_NOTICE
PAYMENT_FEE
PAYPAL
PAYPOINT_CARD
PAYPOINT_CASH
PAYPOINT_CHEQUE
PAYZONE
POST_OFFICE_CARD
POST_OFFICE_CASH
POST_OFFICE_CHEQUE
POST_OFFICE_SAVINGS_STAMPS
PREPAID_CARD
PREPAY_CARD
PREPAY_KEY
PREPAY_SMART
PREPAY_TOKEN
SERVICE_TICKET
SOCIAL_WELFARE_PAYMENT
TELPAY
TRANSFER_FROM_SAP
UNKNOWN
URGS
WALMART_CASH
Example
"DD_FIRST_COLLECTION"AccountRepaymentStatusOptions
An enumeration.
Values
APPROVED
The repayment has been approved but not made yet.
FAILED
The repayment failed permanently. This could be because of technical issues, or if the merchant rejects the payment for some reason. The payment will need to be retried by ops.
HISTORIC
Payments made in a previous system and then imported into Kraken.
PAID
The repayment has been made to the merchant to be sent to the customer. This is a terminal state, we don't get any further confirmation.
REQUESTED
The request for a repayment has been received but not actioned yet.
SUBMITTED
The payment has been submitted to the merchant. It is still possible for this repayment to fail.
THIRD_PARTY
Third Party payments are those recorded for financial purposes in a different system but should be added to statements.
Example
"REQUESTED"Values
ACTIVE
Supply could have started, be ongoing or ended.
DORMANT
Dormant. Users should not be able to log into dormant accounts.
ENROLMENT_ERROR
An error occurred when we tried to enroll a meter point. This may be deprecated in future in favour of exposing this through enrollment property of a meter point.
ENROLMENT_REJECTED
Meter point enrollment was rejected. This may be deprecated in future in favour of exposing this through enrollment property of a meter point.
INCOMPLETE
Account requires processes to be completed before supply can be set up
PENDING
A pending account is one that has been created but no registrations have started.
VOID
Void. Account created in error.
WITHDRAWN
Withdrawn before supply started
Example
"PENDING"AccountTypeChoices
An enumeration.
Values
BUSINESS
An account designed to supply/bill business premises.
BUSINESS_OCCUPIER
An account created when we supply a business premises but do not have details for the occupants.
BUSINESS_THIRD_PARTY_BILLED
An account designed to supply/bill business premises where the bill is sent to a third party.
BUSINESS_VACANT
An account created when we supply a business premises and know there are definitely no occupants.
DOMESTIC
An account designed to supply/bill domestic premises.
DOMESTIC_THIRD_PARTY_BILLED
An account designed to supply/bill domestic premises where the bill is sent to a third party.
MANAGED
An account created when we supply domestic premises that are managed by a business, i.e., a B2B2C model.
OCCUPIER
An account created when we supply a domestic premises but do not have details for the occupants.
PORTFOLIO_LEAD
An account which is responsible for all other accounts in the portfolio, i.e. pays the bills for them.
SUPPLY_POINT
An account that represents the relationship between a supply point and a supplier.
VACANT
An account created when we supply a domestic premises and know there are definitely no occupants.
Example
"BUSINESS"BillingTriggerFrequency
Billing frequency for billing triggers.
Values
ANNUALLY
DAILY
MONTHLY
Example
"DAILY"BillingTriggerOperationType
Billing trigger operation types.
Values
CHARGE_TARGET
CHARGE_TARGET_AND_ISSUE_INVOICE
CHARGE_TARGET_AND_ISSUE_STATEMENT
ISSUE_INVOICE_FOR_TARGET
ISSUE_STATEMENT_FOR_TARGET
Example
"CHARGE_TARGET"BillingTriggerTargetType
Billing trigger target types.
Values
ACCOUNT
CHARGING_LEDGER
PORTFOLIO
Example
"CHARGING_LEDGER"BusinessTypeOptions
Available business account type options (e.g., sole trader, limited company, partnership, charity).
Values
CHARITY
A business account where the company type is charity.
CHURCH
A business account for a church or other religious organisation.
GOVERNMENT
A business account for a government institution.
HOMEOWNER_ASSOCIATION
A business account for a homeowner association or similar community group.
LIMITED
A business account where the company type is limited.
LIMITED_LIABILITY_PARTNERSHIP
A business account where the company type is limited liability partnership.
NON_PROFIT
A business account for a non-profit organisation.
PARTNERSHIP
A business account where the company type is partnership.
PROPRIETARY_LIMITED_COMPANY
A business account where the company type is proprietary limited.
PUBLIC_LIMITED_COMPANY
A business account where the company type is public limited.
SOLE_TRADER
A business account where the company type is sole trader.
TO_BE_DETERMINED
A business account where the company type is to be determined.
TRADING_AS
A business account where the company has a trading name to carry out its business activities.
TRUST
A business account where the company type is a trust.
Example
"SOLE_TRADER"CommsDeliveryPreference
The method the account has specified they prefer we contact them
Values
POSTAL_MAIL
Example
"EMAIL"ConnectionStatus
Connection status of the device, provided as part of the telemetry data.
Values
OFFLINE
ONLINE
Example
"ONLINE"DataFrequency
The frequency of the cost of charge data to be shown in the consumer app.
We are generating this data daily, weekly, monthly or annually, with the following aggregations: daily -> half-hourly aggregation weekly & monthly -> daily aggregations annually -> monthly aggregations
Values
ANNUALLY
DAILY
MONTHLY
WEEKLY
Example
"DAILY"DebtCollectionProceedingStopReason
An enumeration.
Values
ARREARS_TO_CLIENT
Arrears to client
BANKRUPT
Bankrupt
CONFIRMED_EMPTY
Confirmed empty
COS
COS
COT_COS
COT / COS
COT_NO_PROOF
COT no proof
COT_PROOF_SEEN
COT proof seen
DECEASED
Deceased
DEMOLISHED
Demolished
ENROLLED_IN_ERROR
Enrolled in Error
EXP
Expired
GONE_AWAY
Gone away
HIGH_LEVEL_COMPLAINT
High level complaint
INSOLVENCIES_DEALING
Insolvencies dealing
IN_PRISON
In prison
LIVE_TO_FINAL
Live to final
LOW_BALANCE
Low balance
NEGATIVE_TRACE
Negative trace
PAID_IN_FULL
Paid in full
PARTIAL_SETTLEMENT
Partial settlement
PART_PAYMENT
Part payment
PAYMENT_ARRANGEMENT
Payment arrangement
PAYMENT_PLAN_AGREED
Payment plan agreed
PPM_ARRANGEMENT
PPM arrangement
PPM_FITTED
PPM fitted
PPM_REQUESTED
PPM requested
PROCESS_EXHAUSTED
Process exhausted
PROCESS_EXHAUSTED_CONTACT
Process exhausted - contact
PROCESS_EXHAUSTED_NO_CONTACT
Process exhausted - no contact
QUERY
Query
REDUCED_SETTLEMENT
Reduced settlement
REFUSED_TO_DEAL
Refused to deal
UNABLE_TO_LOCATE_PROPERTY
Unable to locate property
UNABLE_TO_TRACE
Unable to trace
VULNERABLE
Vulnerable
WITHDRAWN
Withdrawn
WRITE_OFF
Write off
Example
"BANKRUPT"DirectDebitInstructionStatus
An enumeration.
Values
ACTIVE
The instruction is active and can be used to take payments.
FAILED
The instruction could not be set up with the vendor.
PROVISIONAL
The instruction has not yet been set up.
Example
"ACTIVE"DocumentAccessibilityChoices
Enum representing document accessibility preferences for an account.
Values
AUDIO
BRAILLE
LARGE_PRINT
Example
"LARGE_PRINT"EnodeVendors
Available vendors supported by Enode.
Values
AUDI
BMW
CHEVROLET
CITROEN
CUPRA
DS
FIAT
FORD
HYUNDAI
JAGUAR
KIA
MERCEDES
MINI
NISSAN
OPEL
PEUGEOT
PORSCHE
RENAULT
SEAT
SKODA
TOYOTA
VAUXHALL
VOLKSWAGEN
VOLVO
Example
"AUDI"FlexGridExportStatus
The status of the device's grid export capability.
Values
DISABLED
ENABLED
NOT_APPLICABLE
Example
"ENABLED"FlexIsChargingDurationCapped
The status of the device's charging duration cap.
Values
DISABLED
ENABLED
NOT_APPLICABLE
Example
"ENABLED"FulfilmentSourceType
The type of the fulfilment source.
Values
CHARGE
CREDIT
PAYMENT
UNKNOWN
Example
"UNKNOWN"HardshipAgreementExitReason
An enumeration.
Values
ACCOUNT_FINALISED
Account finalised
CREDIT_OR_NIL_BALANCE
Credit or nil balance
CUSTOMER_REQUEST
Customer request
FURTHER_PAYMENT_PLAN_NOT_ESTABLISHED
Further payment plan not established
INITIAL_PAYMENT_PLAN_NOT_ESTABLISHED
Initial payment plan not established
NO_ENGAGEMENT
No Engagement
OTHER
Other
PAYMENT_PLAN_BROKEN_FOR_NON_PAYMENT
Payment plan broken for non-payment
PAYMENT_PLAN_COMPLETED_SUCCESSFULLY
Payment plan completed successfully
RAISED_IN_ERROR
Raised in Error
Example
"INITIAL_PAYMENT_PLAN_NOT_ESTABLISHED"HardshipAgreementHardshipEntryReason
An enumeration.
Values
EXTERNAL_REFERENCE
Financial counsellor or external agent referral
RETAILER_REFERRAL
Retailer referral
SELF_IDENTIFIED
Customer self-identified as being in hardship
Example
"SELF_IDENTIFIED"HardshipAgreementHardshipType
An enumeration.
Values
DEATH_IN_FAMILY
Death in the family
FAMILY_VIOLENCE
Family violence
HOUSEHOLD_ILLNESS
Household illness
OTHER
Other
REDUCED_INCOME
Reduced income
UNEMPLOYMENT
Unemployment
Example
"DEATH_IN_FAMILY"HeatPumpActivity
All possible heat pump activities.
Values
PENDING
PRE_COOLING
PRE_HEATING
SCHEDULED_COOLING
SCHEDULED_HEATING
Example
"PRE_HEATING"Values
GENERALLY_AVAILABLE
Generally Available - The device is available.
INTERNAL_TESTING
NOT_AVAILABLE
Not Available - The device is not available.
TESTING
Testing - The device is in testing status.
Example
"INTERNAL_TESTING"KrakenFlexDeviceTypes
The device types that can be controlled by KrakenFlex.
Values
BATTERIES
ELECTRICITY_METERS
ELECTRIC_VEHICLES
HEAT_PUMPS
INVERTERS
STORAGE_HEATERS
THERMOSTATS
Example
"BATTERIES"MaximumRefundReasonChoices
An enumeration.
Values
MAX_ALLOWED_TO_REQUEST_VIA_DASHBOARD
Maximum refund is equal to the maximum refund amount allowed to be requested via the dashboard.
MAX_AVAILABLE_AMOUNT
Maximum refund is equal to the current balance minus the account recommended balance.
TOTAL_AMOUNT_PAID_VIA_ACTIVE_DDI
Maximum refund is equal to the total amount the customer has paid using the current account Direct Debit instruction.
Example
"MAX_AVAILABLE_AMOUNT"Values
BEFORE_END_OF_MONTH
The payment day is calculated backwards from the last day of the month.
OF_MONTH
The payment day is calculated forward.
Example
"OF_MONTH"PaymentInstructionStatus
An enumeration.
Values
ACTIVE
The instruction is active and can be used to take payments.
FAILED
The instruction could not be set up with the vendor.
PROVISIONAL
The instruction has not yet been set up.
Example
"ACTIVE"Values
BALANCE_THRESHOLD_CROSSED
BILL_ISSUED
PAYMENT_PLAN
REGULAR_SCHEDULE
Example
"BALANCE_THRESHOLD_CROSSED"PaymentScheduleReasonOptions
An enumeration.
Values
DEBT_REPAYMENT_PLAN
A payment schedule created to take payments to pay back a debt. These schedules typically expire once the debt has been re-payed.
FINAL_PAYMENT
A payment schedule created to take the final payment when an account is closed.
GENERAL_ACCOUNT_PAYMENT
The default value for usual account payments.
SSD_PAYMENT
A payment schedule created to take a payment around the supply start date of a meterpoint to help prevent accounts accruing debt.
Example
"GENERAL_ACCOUNT_PAYMENT"PreferencesTargetType
The target type for a user's preferences.
Values
ABSOLUTE_STATE_OF_CHARGE
ABSOLUTE_TEMPERATURE
RELATIVE_STATE_OF_CHARGE
Example
"ABSOLUTE_STATE_OF_CHARGE"PreferencesUnitChoices
The unit for a user's preferences (e.g. min and max).
The PERCENTAGE_ABSOLUTE and PERCENTAGE_RELATIVE values are deprecated and should not be
used - PERCENTAGE should be used instead.
Values
CELSIUS
PERCENTAGE
PERCENTAGE_ABSOLUTE
PERCENTAGE_RELATIVE
Example
"CELSIUS"ProviderChoices
This refers to the provider that is used to authenticate when registering a device.
Values
BYD
DAIKIN
DAIKIN_LCM
ECOBEE
ECOBEE_V2
ENERGIZER
ENODE
ENPHASE
FORD
GIVENERGY
HUAWEI
HUAWEI_V2
HYPERVOLT
INDRA
JEDLIX
JEDLIX_V2
MERCEDES
MYENERGI
MYENERGI_V2
NATURE
NISSAN
OCPP
OCPP_WALLBOX
OCTOPUS_ENERGY
OHME
OHME_V2
SENSI
SENSI_V2
SMARTCAR
SMARTFLEX_CONNECT
SMART_PEAR
SOLAREDGE
TESLA
TESLA_V2
VOLKSWAGEN
VP_AMAZON
VP_HONEYWELL_CC
VP_HONEYWELL_RES
VP_NEST
Example
"BYD"ReadingDirectionType
An enumeration.
Values
CONSUMPTION
Reading is based on the customer's usage of the utility.
GENERATION
Reading is based on the utility generated by the customer.
For example: This will return solar readings if a customer has solar panels installed at their location.
Example
"CONSUMPTION"ReadingFrequencyType
An enumeration.
Values
DAILY
Readings taken on a day to day basis.
DAY_INTERVAL
FIFTEEN_MIN_INTERVAL
Readings taken in every 15 minute intervals.
FIVE_MIN_INTERVAL
Readings taken in every 5 minute intervals.
HOUR_INTERVAL
Readings taken in every 1 hour intervals.
INTERVALIZED
Readings taken at a point in time and intervalized.
MONTH_INTERVAL
Readings taken in every 1 month intervals.
POINT_IN_TIME
Readings taken at a point in time.
QUARTER_INTERVAL
Readings taken in every 3 months intervals.
RAW_INTERVAL
Interval Readings as provided, may be variable in length.
THIRTY_MIN_INTERVAL
Readings taken in every 30 minute intervals.
WEEK_INTERVAL
Readings taken in every 1 week intervals.
Example
"RAW_INTERVAL"ReadingStatisticTypeEnum
The type of statistic for the reading interval.
Values
CAPACITY_CHARGE_COST
The calculated cost of capacity charges for the interval.
CARBON_COST
The estimated carbon cost of the interval.
CO2_EMISSION_STATISTIC
The calculated co2 emission for the interval.
CONSUMPTION_BREAKDOWN
The breakdown of consumption into time of use buckets.
CONSUMPTION_COST
The calculated cost of consumption for the interval.
GAS_READING_INFORMATION
Information related to a gas reading eg. conversion_factor, volume etc.
GENERATION_VALUE
The calculated monetary value of generation for the interval
POWER_FACTOR_STATISTIC
The calculated power factor for the interval.
STANDING_CHARGE_COST
The calculated cost of standing charges for the interval.
TOU_BUCKET_COST
The apportion cost of a time of use bucket for the interval.
Example
"STANDING_CHARGE_COST"ReadingTypes
Available reading types.
Values
ACCUMULATION
Readings indicating total utility consumption since the meter was installed or reset.
INTERVAL
Readings indicating total consumption or generation of a utility between two points in time.
PEAK
Readings indicating the maximum rate of utility transfer.
Example
"INTERVAL"ReferralSchemeTypeChoices
Referral scheme type choices.
Values
LEGACY_REFERRAL
Legacy Referral.
PARTNER_REWARD
Partner Reward.
PROMO_REWARD
Promo Reward.
REFERRAL_REWARD
Referral Reward.
SIGNUP_REWARD
Signup Reward.
Example
"REFERRAL_REWARD"ReferralStatusChoices
Referral status choices.
Values
Cancelled
Cancelled.
Paid
Paid.
Pending
Pending.
Example
"Pending"RepaymentMethod
Methods by which repayments can be sent to the customer.
Values
BANK_TRANSFER
CARD
CHEQUE
Example
"BANK_TRANSFER"RepaymentRequestStatus
Possible status' for a repayment (or refund) request
Values
ACCEPTED
CANCELLED
REJECTED
REQUESTED
Example
"REQUESTED"ScheduleType
An enumeration.
Values
BACS_TRANSFER
CARD_PAYMENT
DIRECT_DEBIT
PAYMENT_SLIP
Example
"BACS_TRANSFER"SelectIntegrationChoices
For when both the EV and charge point have an integration available.
Values
CHARGE_POINT
ELECTRIC_VEHICLE
Example
"ELECTRIC_VEHICLE"SmartControlAction
The smart control action choices, i.e. suspend or unsuspend.
Values
SUSPEND
UNSUSPEND
Example
"SUSPEND"Values
COMMUNICATION_ERROR
Unable to communicate with device - Dispatches were created but no telemetry readings available during the charge session.
CUSTOMER_ACTION_REQUIRED
Action required - Customer needs to take action to re-enable our control (i.e attemptto re-onboard).
FAILURE_CAUSE_ERROR
Unable to determine cause of failure - If the charge session was not achieved, butwe are unable to determine the cause of failure.
FULL_CHARGE
Device fully charged - Device conducting a relative charge session indicated it hadreached 100% SoC or an internal SoC limit. Applied regardless of whether or not wewere able to add the energy requested.
NO_CHARGING
No charging - No charging (import of energy) was observed during the session.
NO_SCHEDULED_CHARGE
No scheduled charge within session - There were no schedules for the given charge session period.
POST_CHARGE_BATTERY_DRAIN
Post-charge battery drain - Target was hit but session ended below target due tobattery drain (caused e.g. by cell balancing).
POWER_DISCREPANCY
Observed power discrepancy - Power during the session was observed to be significantly different from the value of the max. import in static data.
POWER_TAPERING
Observed power tapering - Power decreased at state of charge levels or towards the end of the session.
SOC_LIMIT_REACHED
State of charge limit reached - Charging prevented due to a device specific charging limit setting (current state of charge is equal to or above the set limit).
THIRD_PARTY_CHARGING_INTERFERENCE
Third-party charging interference - Telemetry for an at-home charging event was found outside of Dispatch Schedules.
UNKNOWN_CHARGING_ERROR_CAUSE
Unknown failure cause
Example
"SOC_LIMIT_REACHED"SmartFlexChargingTruncationCause
The possible causes for a charging session ending prematurely.
Values
BOOST_CHARGING
CHARGING_OPTIMISATION_CREATED
DEVICE_DEAUTH_SUCCESS
DISCONNECTED
SUSPENDED
UNKNOWN_TRUNCATION_CAUSE
Example
"DISCONNECTED"SmartFlexDeviceLifecycleStatus
The current lifecycle status of a KrakenFlex device on the smarter tariff API.
Values
FAILED_ONBOARDING_TEST
LIVE
ONBOARDING
ONBOARDING_TEST_IN_PROGRESS
PENDING_LIVE
RETIRED
Example
"ONBOARDING"Values
AUTHENTICATION_COMPLETE
Authentication Complete - ready to start test (if needed) or pending live where auth or telemetry is delayed.
AUTHENTICATION_FAILED
Authentication Failed - failed to connect and ready to restart authentication and authorization.
AUTHENTICATION_PENDING
Authentication Pending - ready to start authentication and authorization, or auth is in progress.
BOOSTING
Manual Boosting (e.g. bump charging) - user has overridden the schedule to immediately boost (e.g. bump charge now).
LOST_CONNECTION
Lost Connection - lost connection to the device, ready to re-auth (if not temporary / automatic fix).
RETIRED
Retired - deleted / de-authed (re-auth not possible, re-register device to onboard again).
SETUP_COMPLETE
Setup Complete - test is complete (if needed) and device is live, but not ready for smart control.
SMART_CONTROL_CAPABLE
Smart Control Capable - live and ready for smart control (e.g. at home and plugged in) but none is scheduled.
SMART_CONTROL_IN_PROGRESS
Smart Control in Progress - smart control (e.g. smart charging) is scheduled or is currently occurring.
SMART_CONTROL_NOT_AVAILABLE
Smart Control Not Available - not currently capable of smart control (e.g. away from home or unplugged).
SMART_CONTROL_OFF
Smart Control Off (suspended) - smart control has been (temporarily) disabled (e.g. by the user with holiday mode).
TEST_CHARGE_FAILED
Test Charge Failed - connection or smart control test has failed or could not start, ready to retry test.
TEST_CHARGE_IN_PROGRESS
Test Charge in Progress - connection and smart control test has successfully started and is occurring.
TEST_CHARGE_NOT_AVAILABLE
Test Charge Not Available - not currently capable of smart control test (e.g. away from home or unplugged).
Example
"AUTHENTICATION_PENDING"StatementReversalsAfterClose
Tracking of charge reversals after statement closure (ALL, SOME, NONE, or NOT_CLOSED).
Values
ALL
All charges have been reversed after the statement was closed.
NONE
No reversals after the statement was closed.
NOT_CLOSED
The statement has not been closed yet.
SOME
Some charges have been reversed after the statement was closed.
Example
"ALL"TestChargeErrorType
The type of test charge error.
Values
UNABLE_TO_COMPLETE_TEST_CHARGE
An error occurred during a test charge attempt.
UNABLE_TO_INITIATE_TEST_CHARGE
An error occurred when attempting to initiate a test charge.
Example
"UNABLE_TO_INITIATE_TEST_CHARGE"TestChargeRefusalReason
All possible reasons for refusing a test charge.
Values
DEVICE_ALREADY_CHARGING
DEVICE_AWAY_FROM_HOME
DEVICE_DISCONNECTED
DEVICE_LIVE
DEVICE_LOCATION_MISSING
DEVICE_LOCATION_UNABLE_TO_IDENTIFY
DEVICE_NO_LOCATION_CONFIGURED
DEVICE_ONBOARDING_IN_PROGRESS
DEVICE_RETIRED
DEVICE_SUSPENDED
Example
"DEVICE_LIVE"TestDispatchAssessmentFailureReason
The reason (if any) that we believe a test dispatch (test charge) did not succeed.
Values
ASSESSMENTS_FAILED
DEVICE_DISCONNECTED
ERROR
NONE
NOT_AT_HOME
SOC_LIMIT_REACHED
UNABLE_TO_COMMUNICATE
UNKNOWN
Example
"NONE"TestDispatchStatus
All possible test dispatch statuses.
Values
COMPLETE
FAILED
TRIGGERED
Example
"TRIGGERED"TextStyleV1
The style is the typographical hierarchy. These are Typescale Categories from the Mobile Design System (Figma).
Values
BODY1
BODY2
BUTTON_TEXT
CALLOUT1
CALLOUT2
CALLOUT3
INPUT_TITLE
SMALL1
SMALL2
SMALL3
TABULAR
TITLE1
TITLE2
TITLE3
TITLE4
TITLE5
TITLE6
Example
"TITLE1"Values
AUTO
The thermostat is in automatic mode.
COOLING
The thermostat is in cool-only mode.
HEATING
The thermostat is in heat-only mode.
OFF
The thermostat is off.
Example
"HEATING"TimeGranularities
Time buckets into which readings are grouped.
Values
DAY
FIFTEEN_MIN
FIVE_MIN
HOUR
MONTH
QUARTER
THIRTY_MIN
WEEK
YEAR
Example
"FIVE_MIN"TransactionTypeFilter
Filter options for transaction types (e.g., energy charges, water charges, imported payments).
Values
ENERGY_CHARGES
For filtering/excluding energy charge transactions: Gas or Electricity.
IMPORTED_CHARGES
For filtering/excluding imported charge transactions.
IMPORTED_CREDITS
For filtering/excluding imported credit transactions.
IMPORTED_PAYMENTS
For filtering/excluding imported payment transactions.
IMPORTED_REPAYMENTS
For filtering/excluding imported repayment transactions.
UNISSUED_TRANSACTIONS
For filtering/excluding unissued transactions.
WATER_CHARGES
For filtering/excluding water charge transactions.
Example
"UNISSUED_TRANSACTIONS"Units
Available units relevant to electricity, gas, and water.
Values
AMPERE
DECALITERS
FEET_CUBED
KILOAMPERE
KILOLITERS
KILOVOLT
KILOVOLT_AMPERE
KILOVOLT_AMPERE_HOURS
KILOVOLT_AMPERE_REACTIVE
KILOVOLT_AMPERE_REACTIVE_HOURS
KILOWATT
KILOWATT_HOURS
LITER
METERS_CUBED
POWER_FACTOR
US_GALLONS
VOLT
VOLT_AMPERE
VOLT_AMPERE_HOURS
VOLT_AMPERE_REACTIVE
VOLT_AMPERE_REACTIVE_HOURS
WATT
WATT_HOURS
Example
"WATT"