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.
APIBrownoutStatus
Possible API Brownout statuses.
Values
ABORTED
CANCELLED
COMPLETED
IN_PROGRESS
SCHEDULED
Example
"SCHEDULED"APIExceptionResolutionStatus
An enumeration.
Values
ASSIGNED
CANCELLED
IN_PROGRESS
RESOLVED
UNASSIGNED
UNSUCCESSFUL
WAITING_ON_THIRD_PARTY
Example
"ASSIGNED"AccountApplicationStatus
An enumeration.
Values
CURRENT
Current
FAILED
Failed
HISTORIC
Historic
WITHDRAWN
Withdrawn
Example
"CURRENT"AccountBillingOptionsPeriodLength
An enumeration.
Values
MONTHLY
Monthly
QUARTERLY
Quarterly
Example
"MONTHLY"AccountCreditReasonType
Please note: these labels are exposed in the API documentation.
Values
EXTERNAL_REFERRAL_CREDIT
External referral credit
Example
"EXTERNAL_REFERRAL_CREDIT"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.
Example
"EMAIL_SENT"AccountPaymentStatusOptions
An enumeration.
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
DWP
EAPA_VOUCHER
EFT
ERRONEOUS_PAYMENT
FAILED_REPAYMENT_REVERSAL
FUEL_DIRECT
HEEAS
IDEAL
IVR
KONBINI
PAGOPA_NOTICE
PAYMENT_FEE
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
TELPAY
TRANSFER_FROM_SAP
UNKNOWN
URGS
Example
"DD_FIRST_COLLECTION"AccountReminderTypes
Contains reminder type choices for all territories.
Values
ACCOUNT_COOL_OFF
ACCOUNT_MIGRATION_SYNC_XOSERVE_METER_MISMATCH
ACTIVATE_PAYMENT_CANCELLATION_STOPPED
AD_HOC
AGREEMENT_REVOKED
AMPERAGE_CHANGE
ASSIGNED_TO_CREDIT_TEAM
AUS_CENTREPAY_EXCESSIVE_CREDIT
AUS_EMBEDDED_ACQUISITION_MATRIX_ERROR
AUS_EMBEDDED_CHILD_NMIS
AUS_EMBEDDED_WATER_ESTIMATION_REQUIRED_FOR_SKIPPED_READING
AUS_EMBEDDED_WATER_READING_FAILURE
AUS_GET_CORRECT_PHONE_NUMBER
AUS_INDUSTRY_CUSTOMER_OWN_READING_NOT_SENT
AUS_VIC_SHAREDFUSE_NOTIFICATION
AUTOMATED_BILLING_DISABLED
BILLING
BILLING_AMENDED_INTERVAL_DATA_RECEIVED_CAUSING_OVERCHARGE
BILLING_AMENDED_METER_READ_BASIC
BILLING_AMENDED_METER_READ_CES_ELEC_BASIC
BILLING_AMENDED_METER_READ_CES_ELEC_INTERVAL
BILLING_AMENDED_METER_READ_GAS
BILLING_AMENDED_METER_READ_INTERVAL
BILLING_AMENDED_METER_READ_INTERVAL_LEGACY
BILLING_AMENDED_METER_READ_PRE_MIGRATION
BILLING_BACKDATED_CONCESSION_RECEIVED
BILLING_BACKDATED_UMS_RECORD_RECEIVED
BILLING_CUSTOMER_SELF_READ_RECEIVED
BILLING_MISSING_READ
BILLING_QUOTED_NTC_DOES_NOT_ALIGN
BILLING_REGISTER_REPLACED_OR_REMOVED
CANCEL_MOVE_OUT_UNABLE_TO_REINSTATE_FUTURE_AGREEMENTS
CHURN_PREVENTION
COMMERCIAL_ENERGISATION_INTERVENTION_REQUIRED
COMMS_TO_BE_PRINTED
CONTRACT_COMMS_NOT_DELIVERED
COS_GAIN
COS_GAIN_MIGRATION_ECOES_METER_MISMATCH
COS_GAIN_REL_RETRIEVAL_FAILURE
COS_LOSS
CUSTOMER_DETAILS_CHANGE
CUSTOMER_REPORTED_SMART_METER_ISSUES
D0010_CREATION_FAILURE
D0052_CREATION_FAILURE
D0205_CREATION_FAILURE
DEU_INBOUND_APERAK
DEU_MASTER_DATA_SYNCHRONISATION
DEU_MASTER_DATA_UPDATE
DEU_METER_READINGS
DEU_SWICHTING_PROCESS_FAILED
DISCONNECTION_MANDATORY_NOTICE_EMAIL_FAILURE
DISCONNECTION_MANDATORY_NOTICE_SMS_FAILURE
DUNNING_BEST_ENDEAVOURS_CALL
DUNNING_DISCONNECTION_DE_ENERGISATION_ASSESSMENT
DUNNING_DISCONNECTION_MANDATORY_NOTICE_EMAIL_FAILURE
DUNNING_DISCONNECTION_OUTBOUND_REMINDER_CALL
DUNNING_MANDATORY_NOTICE_EMAIL_FAILURE
DUNNING_OUTBOUND_REMINDER_CALL
DUNNING_REMINDER
DUNNING_REMINDER_CALL
DUNNING_REMINDER_DISCONNECTION_APPLICATION
DUNNING_REMINDER_FUTURE_PAYMENT
DUNNING_REMINDER_PAYMENT_MADE
DUNNING_VACANT_CONSUMPTION_DE_ENERGISATION_ASSESSMENT
DUPLICATE_CARD_FINGERPRINTs
EMBEDDED_NETWORK_ALL_CHILD_LIFE_SUPPORT_RECORDS_ARE_DEREGISTERED
EMBEDDED_NETWORK_EXCEPTION_DISTRIBUTOR_OWNED_PARENT_LIFE_SUPPORT_RECORD
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_LOST_OR_LOSING
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_RECEIVED_DANGEROUS_LIFE_SUPPORT_NOTIFICATION
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_RECEIVED_LIFE_SUPPORT_NOTIFICATION
FAMILY_ISSUES_ADDED
FIELDWORKS_ACCOUNT_CREATED_WITH_NO_EMAIL_ADDRESS
FIELDWORKS_ALLOCATE_NMI_MARKET_PARTICIPANTS_NOT_SET
FIELDWORKS_APPOINTMENTS_UNAVAILABLE
FIELDWORKS_BULK_DEPLOYMENT_JOURNEY_AUTO_CANCELLED
FIELDWORKS_CHANGE_REQUEST_STEP_ERRORED
FIELDWORKS_CHANGE_REQUEST_STEP_FAILED
FIELDWORKS_CONTACT_SO_RECIPIENT_TO_UPDATE_THE_SO_DETAILS
FIELDWORKS_EXPECTED_METER_POINT_NOT_CREATED
FIELDWORKS_EXPECTED_METER_READ_NOT_RECEIVED
FIELDWORKS_EXPECTED_NTCS_NOT_RECEIVED
FIELDWORKS_INVESTIGATE_WHETHER_JOURNEY_NEEDS_CONTINUATION
FIELDWORKS_JOURNEY_ATTACHMENTS
FIELDWORKS_JOURNEY_CANCELLED_DUE_TO_LIFE_SUPPORT_REGISTRATION
FIELDWORKS_MAINTAIN_REGISTER_BILLABLE_OVERRIDE_FOR_UNSOLICITED_METER_CHANGES
FIELDWORKS_MANUALLY_COMPLETE_CUSTOMER_MOVE_IN
FIELDWORKS_METERPOINT_IS_NOT_ACTIVE
FIELDWORKS_METER_FAULT_JOURNEY_AUTO_CANCELLED
FIELDWORKS_METER_FAULT_NCOM_COMMS_FAILED
FIELDWORKS_METER_FAULT_RECEIVED
FIELDWORKS_MIRN_DISCOVERY_FAILED
FIELDWORKS_MOVE_OUT_CANCELLED_WHILE_SUPPLY_ABOLISHMENT_IN_PROGRESS
FIELDWORKS_MULTIPLE_OPEN_JOURNEYS_FOR_METER_POINT
FIELDWORKS_NEW_CONNECTION_COMPLETION_REVIEW
FIELDWORKS_NEW_CONNECTION_DATA_NOT_VALID
FIELDWORKS_OBTAIN_CUSTOMER_APPROVAL_BEFORE_PROGRESSING
FIELDWORKS_OBTAIN_SUPPLY_ABOLISHMENT_APPROVAL
FIELDWORKS_PAYER_CONTACT_FAILED_VALIDATION
FIELDWORKS_SERVICE_ORDER_ATTACHMENTS
FIELDWORKS_SERVICE_ORDER_COMPLETED
FIELDWORKS_SERVICE_ORDER_FAILED
FIELDWORKS_SERVICE_ORDER_PARTIALLY_COMPLETED
FIELDWORKS_SERVICE_ORDER_STATUS_UPDATED
FIELDWORKS_SERVICE_ORDER_STEP_ERRORED
FIELDWORKS_SERVICE_ORDER_STEP_FAILED
FIELDWORKS_SERVICE_ORDER_UNABLE_TO_ACCESS_WITH_CUSTOMER_CONSULTATION
FIELDWORKS_SUPPLY_PERIOD_DOES_NOT_EXIST_FOR_METERPOINT
FIELDWORKS_UPLOAD_ATTACHMENT_TO_JEMENA_PORTAL
FINAL_BILLING_UNABLE_TO_BILL
FLOW_FILE_ERROR
FOLLOW_UP_PAYMENT_PROMISE
FRA_ACTIVATION_PROCESS_AWAITING_SWITCH_IN_CONFIRMATION
FRA_ACTIVATION_PROCESS_AWAITING_SWITCH_READINGS
FRA_ACTIVATION_PROCESS_COMMANDER_SOUSCRIPTION
FRA_ACTIVATION_PROCESS_GAS_PROVIDER_CHANGE_REQUEST
FRA_ACTIVATION_PROCESS_INCEPTION_CHECKS
FRA_ACTIVATION_PROCESS_PRM_ELIGIBILITY
FRA_ACTIVATION_PROCESS_SCHEDULE_SITEWORKS
FRA_ELEC_ACTIVATION_PROCESS_WRONG_SWITCH_READINGS_FOR_PROVIDER_CALENDAR_TEMPORAL_CLASSES
FRA_ENERGY_CHEQUE_UNKNOWN
FRA_FSL
FRA_TERMINATION_PROCESS_NEEDS_INTERVENTION
FRA_TERMINATION_REQUEST_ERRORED
GAS_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_FAILED
GAS_EXCEPTION_CUSTOMER_TRANSFER_CANCELLED
GAS_EXCEPTION_CUSTOMER_TRANSFER_REJECTED
GAS_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_FAILED
GAS_EXCEPTION_METER_DATA_VERIFY_REQUEST_FAILED
GAS_EXCEPTION_METER_DATA_VERIFY_RESPONSE_NO_CHANGE_WITH_EXPLANATION
GAS_EXCEPTION_METER_DATA_VERIFY_RESPONSE_OVERDUE
GAS_EXCEPTION_METER_DATA_VERIFY_RESPONSE_WITHOUT_REVISED_READ
GAS_EXCEPTION_SITE_ACCESS_DETAILS_NOTIFICATION_FAILED
GAS_EXCEPTION_SITE_ACCESS_DETAILS_RECEIVED_FOR_NON_EXISTENT_METER
GAS_EXCEPTION_SITE_ADDRESS_DETAILS_NOTIFICATION_FAILED
GAS_MANUAL_SERVICE_ORDER_REQUIRED_FOR_ENROLMENT
GAS_NOTIFICATION_CHANGE_OF_SITE_ADDRESS
GAS_READING_REMOVED_INSTALLED_RECEIVED
GAS_UNKNOWN_CUSTOMER_CLASSIFICATION_CODE_RECEIVED
GBR_ADD_PHOTO_TO_METER_READING
GBR_GET_PHOTO_OF_METER_AND_CALL_SUPPLIER
GBR_RAISE_DISPUTE
GBR_VERIFY_MHHS_MESSAGE
HARDSHIP_GRADUATION_ASSESSMENT
HARDSHIP_NO_PAYMENT_PLAN
HARDSHIP_REMOVAL_ASSESSMENT
HELD_BILLING_DOCUMENT
HELD_STATEMENT
INDUSTRY_CHANGE_OF_SUPPLIER_DOUBLE_GAIN
INDUSTRY_CUSTOMER_TRANSFER_DELAYED
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_CANCELLED
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_CONFLICTING_PERIOD
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_GAIN_COMPLETION_OVERDUE
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_OBJECTED
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_REJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_CANCELLATION_FAILED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_CANCELLED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_COMPLETED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTION_MISSING_ACK
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTION_REJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTION_WITHDRAWAL_REJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_REJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_WITHDRAWAL_REJECTED
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_INVALID_BILLING_ADDRESS
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_MISSING_MANDATORY_FIELDS
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_REJECTED
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_REQUEST_SPECIAL_REASON
INDUSTRY_EXCEPTION_FAILED_TO_CANCEL_DEENERGISATION_SERVICE_ORDER
INDUSTRY_EXCEPTION_HOUSE_MOVE_ENROLMENT_CANNOT_CALCULATE_MOVE_IN_READING
INDUSTRY_EXCEPTION_HOUSE_MOVE_ENROLMENT_SERVICE_ORDER_ALREADY_IN_PROGRESS
INDUSTRY_EXCEPTION_HOUSE_MOVE_ENROLMENT_UNABLE_TO_COPY_LAST_METER_READING
INDUSTRY_EXCEPTION_HOUSE_MOVE_OUT_CANNOT_CALCULATE_MOVE_OUT_READING
INDUSTRY_EXCEPTION_LIFE_SUPPORT_CONTACT_USER_REMOVED_FROM_ACCOUNT
INDUSTRY_EXCEPTION_LIFE_SUPPORT_MULTIPLE_ACCOUNTS_MATCHES
INDUSTRY_EXCEPTION_LIFE_SUPPORT_MULTIPLE_LIFE_SUPPORT_CONTACT_MATCHES
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_CONTAINS_UNEXPECTED_DATA
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_FAILED_TO_SEND
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_INVALID_CONTACT_METHOD
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_INVALID_PHONE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_RECEIVED_FROM_NON_REGISTRATION_OWNER
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_REJECTED
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_UNKNOWN_CONTACT
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_MISSING_LIFE_SUPPORT_NOTIFICATION
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_REJECTED
INDUSTRY_EXCEPTION_METER_POINT_ENROLMENT_INCOMPLETE_COULD_NOT_SEND_SERVICE_ORDER
INDUSTRY_EXCEPTION_NEXT_SCHEDULED_READ_DATE_TOO_FAR_IN_FUTURE
INDUSTRY_EXCEPTION_RELINKING_OCCURRED_DURING_SDR_SYNC
INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_NOTIFICATION_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_NOTIFICATION_REJECTED
INDUSTRY_EXCEPTION_STANDING_DATA_PROPERTIES_ADDRESS_FAILED_TO_UPDATE
INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_INCOMPLETE_COULD_NOT_SEND_CHANGE_REQUEST
INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_INVALID_NMI_METER_STATUS
INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_NEXT_SCHEDULED_READ_DATE_PAST
INDUSTRY_EXCEPTION_UNABLE_TO_PROCESS_ROLR
INDUSTRY_LIFE_SUPPORT_CANCEL_DEREGISTRATION_FAILED
INDUSTRY_LIFE_SUPPORT_MANUAL_BEST_ENDEAVOUR_REQUIRED
INDUSTRY_LIFE_SUPPORT_REGISTRATION_FOLLOW_UP_REQUIRED
INDUSTRY_LIFE_SUPPORT_REVIEW_AFTER_CANCELLED_MOVE_OUT_FOR_NEXT_ACCOUNT
INDUSTRY_LIFE_SUPPORT_REVIEW_ATTEMPTED_CANCELLED_MOVE_OUT_FOR_NEXT_ACCOUNT
INDUSTRY_LIFE_SUPPORT_REVIEW_DEREGISTRATION
INDUSTRY_LIFE_SUPPORT_REVIEW_POST_DEREGISTRATION
INDUSTRY_LIFE_SUPPORT_REVIEW_POST_DEREGISTRATION_COMMS
INDUSTRY_MANUAL_ACTION_REQUIRED
INDUSTRY_MANUAL_CUSTOMER_DETAILS_NOTIFICATION_REQUIRED
INDUSTRY_MANUAL_LIFE_SUPPORT_NOTIFICATION_REQUIRED
INDUSTRY_METER_POINT_MISSING_CUSTOMER_CLASSIFICATION
INDUSTRY_READINGS_NOT_SENT
INDUSTRY_SEND_LIFE_SUPPORT_DE_REGISTRATION_FORM
INDUSTRY_UNABLE_TO_CREATE_RECORD
INDUSTRY_VIC_DRO_MANUAL_LIFE_SUPPORT_EXTENSION_REQUEST
INDUSTRY_WARNING_MESSAGE_RECEIVED
ITA_ACCOUNT_WITHDRAWN_WITHOUT_NOTIFICATION
ITA_PROCESS_WELCOME_PACK_STEP
JPN_BILLING_FIX_INVALID_CHARGE_DATA
JPN_BILLING_PATTERN_CHANGED_DUE_TO_READING_DATE_CHANGE
JPN_CALL_FOR_DUNNING_CAMPAIGN
JPN_CONFIRMATION_OF_RELOCATION
JPN_CONFIRM_PAYMENT_FOR_DUNNING_CAMPAIGN
JPN_FAILED_TO_SEND_SMS_FOR_BILLING_INFO
JPN_FAILED_TO_SEND_SMS_FOR_CONVENIENCE_STORE_PAYMENT
JPN_FINAL_READING_OUTSIDE_AGREEMENT
JPN_MULTIPLE_VALID_REFERRALS
JPN_READINGS_NOT_RECEIVED
JPN_SHORT_TERM_MOVE_IN_REJECTION
JPN_SUPPLY_DETAILS_UPDATE_CONFIRMATION
JPN_SUPPLY_POINT_FAILS_CAN_SUPPLY_CHECK
JPN_SWITCH_IN_SCHEDULE_OVERLAP
KMT
MAIL_FAILED
MAIL_RETURNED
MANDATORY_COMMS_NOT_DELIVERED
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_CREATE
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_REVERSE_TERMINATION
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_TERMINATE
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_UPDATE
MARKET_SUPPLY_EXCEPTION_MISSING_ACCOUNT_QUOTED_PRODUCT
METER_EXCHANGE_ONE_WAY_NOTIFICATION
METER_FAULT_AND_ISSUE_ONE_WAY_NOTIFICATION_ACCEPTED
METER_FAULT_AND_ISSUE_ONE_WAY_NOTIFICATION_REJECTED
MIGRATION_TYPE
MOVE_IN
MOVE_IN_CES_LIFE_SUPPORT_REQUIRED
MOVE_IN_COMMS_NOT_DELIVERED
MOVE_IN_DEFAULT_PAYMENT_SCHEDULE_FAILED
MOVE_IN_MOVE_OUT_MANUAL_PROCESS
MOVE_OUT
NETWORK_TARIFF_ONE_WAY_NOTIFICATION
NEW_PSR_ADDED_TO_PREPAY_ACCOUNT
NON_ENERGY_PAYMENT_CALL_REMINDER
NOTICE_OF_METERING_WORKS_ONE_WAY_NOTIFICATION
NZ_BILLING_QUERY
NZ_DUNNING
NZ_METERING_QUERY
NZ_SOLAR_METER_CHANGE
NZ_SWITCHING_WITHDRAWAL
NZ_VACANT_PROPERTY
OBSOLETE_BILLING_AMENDED_STANDING_DATA_REGISTER_CHANGED
OBSOLETE_BILLING_AMENDED_STANDING_DATA_REGISTER_DELETED
PAYMENTS_FAILED_REPAYMENT
PAYMENT_INSTRUCTION_FAILED
PAYMENT_PLAN
PAYMENT_PLAN_HARDSHIP_COMPLETION
PAYMENT_PLAN_HARDSHIP_COMPLETION_WORKFLOW_CANCELLED
PAYMENT_PLAN_MISSED_INSTALMENT
PAYMENT_SCHEDULE_FAILED_TO_CREATE
PLANNED_INTERRUPTION
PLANNED_INTERRUPTION_MEDICAL_DEPENDENCY
PLANNED_INTERRUPTION_NOTIFICATION_SENT_TO_LIFE_SUPPORT_CUSTOMER
PLANNED_INTERRUPTION_ONE_WAY_NOTIFICATION
PLANNED_INTERRUPTION_ONE_WAY_NOTIFICATION_REJECTED
POST_HARDSHIP_CANCELLATION
PROPERTY_ADDRESS_NEEDS_UPDATE
PSR_IMPORT_COULD_NOT_IDENTIFY_ACCOUNT_USER
SA_CONCESSION_STATEMENT_CLOSED
SCHEDULED_BILLING_ADDRESS_UPDATE
SCHEDULED_OCCUPIER_PACK_SEND
SERVICE_ORDER_ACKNOWLEDGEMENT_OVERDUE
SERVICE_ORDER_CANCELLATION_FAILED
SERVICE_ORDER_CANCELLATION_REQUEST_REJECTED
SERVICE_ORDER_FAILED
SERVICE_ORDER_INITIAL_RESPONSE_OVERDUE
SERVICE_ORDER_NOT_COMPLETED
SERVICE_ORDER_OTHER_JOB_ENQUIRY_CODE
SERVICE_ORDER_PARTIALLY_COMPLETED
SERVICE_ORDER_REQUEST_REJECTED
SERVICE_ORDER_UNABLE_TO_CHARGE
SERVICE_ORDER_UNSOLICITED_RECEIVED
SERVICE_ORDER_UNSOLICITED_RECEIVED_DEENERGISED_METER_POINT
SMARTFLEX_DEVICE_INTEGRATION_POSTPONED
SMART_CHANGE_OF_TENANCY_IN_PROGRESS
SMART_CHANGE_OF_TENANCY_REQUEST_FAILED
SMART_METER_MODE_CHANGE_UNSUPPORTED
SMART_PREPAY_ADD_DEBT_FAILURE
SMART_PREPAY_NEED_TO_ADJUST_DEBT
SMART_PREPAY_TOP_UP_FAILURE
SMART_PREPAY_TOP_UP_MULTIPLE_ACTIVE_PROCESSES
SMART_PREPAY_TOP_UP_UTRN
SMETS2_DATA_REQUEST_FOLLOWUP
SMETS2_HEALTH_CHECK
SMETS2_IHD_HEALTH_CHECK
SOLAR_EXPORT_CREDITS_EXCESS
SPECIAL_READ_CANCELLATION_FAILED
SPECIAL_READ_FAILED
SPECIAL_READ_OUTSTANDING
SPECIAL_READ_WITH_ESTIMATE_READ_RECEIVED
UNSUPPORTED_FEATURE
UNSUPPORTED_PAYMENT_DAY
WATER_ACCOUNT_REVERSION
WATER_METER_READING_ISSUE
WITHDRAWAL_RECEIVED
WORKFLOW_CANCELLATION_FAILED
WORKFLOW_STEP_ERRORED
WORKFLOW_STEP_FAILED
Example
"AD_HOC"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"AccountStatusChoices
An enumeration.
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.
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_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.
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.
VACANT
An account created when we supply a domestic premises and know there are definitely no occupants.
Example
"BUSINESS"AchievedRegionalCarbonIndexChoices
An enumeration.
Values
HIGH
LOW
MODERATE
VERY_HIGH
VERY_LOW
Example
"VERY_LOW"AgentContractStatusType
An enumeration.
Values
ACCEPTED
The contracts that have been accepted by the agent.
REJECTED
The contracts that have been rejected by the agent.
REQUESTED
The contracts that have been requested by the supplier.
TERMINATED
The contracts that have been terminated.
TERMINATION_REQUESTED
The contracts for which termination has been requested by the supplier.
Example
"ACCEPTED"AllBandSubCategories
Combined list of subcategories for both consumption and standing charges
Values
ECO7_DAY
ECO7_NIGHT
ECONOMY7
STANDARD
THREE_RATE
THREE_RATE_OFF_PEAK
THREE_RATE_PEAK
THREE_RATE_SHOULDER
Example
"STANDARD"AppSessionOutcome
An enumeration.
Values
BUSY
Busy
CALLBACK
Callback
CALLBACK_COURTESY_CALL
Callback - courtesy call
CALLBACK_PITCHED
Callback - pitched
CONSUMER_APP_DOWNLOAD
Consumer app download
COS
COS
COT_NO_PROOF
COT no proof
COT_PROVEN
COT proven
DECEASED
Deceased
DEMOLISHED
Demolished
DONT_CALL_AGAIN
Don’t call again
EBSS_VOUCHER_CHECK_IN
EBSS voucher check in
ELECTRIC_JUICE_NOT_INTERESTED
Electric juice not interested
ELECTRIC_JUICE_SWITCH
Electric juice switch
ELECTRIC_JUICE_SWITCH_LITE
Electric juice lite switch
EMPTY
Empty
ENERGY_HELP_VISIT_COMPLETED
Energy help visit - completed
ENERGY_HELP_VISIT_LEAFLET
Energy help visit - leaflet left
EXHAUSTED_CONTACT
Exhausted - contact
EXHAUSTED_NO_CONTACT
Exhausted - no contact
EXISTING_CUSTOMER
Already an existing customer
INSOLVENCY
Insolvency
INTERESTED
Interested
LEAD_GENERATION
Lead generation
LEAD_GENERATION_BUSINESS
Business lead generation
LEAD_GENERATION_EJ
Electric juice switch & lead generation
LEAD_GENERATION_EJ_LITE
Electric juice lite switch & lead generation
LEAD_GENERATION_EV
Electric vehicle lead generation
LEAD_GENERATION_HEAT_PUMP
Heat pump lead generation
LEAD_GENERATION_SOLAR
Solar lead generation
METER_READING
Meter reading
METER_READING_NO_ANSWER
Meter reading - no answer
METER_READING_UNABLE_TO_TAKE_READING
Meter reading - unable to take reading
MULTIPLE_PROPERTIES
Multiple properties owned
NOT_BILL_PAYER
Not bill payer
NOT_DECISION_MAKER
Not decision maker
NO_ANSWER
No answer
NO_COLD_CALLING
No cold calling
NO_FIXED_ADDRESS
No fixed address
NO_PITCH
No pitch
NO_PITCH_NOT_INTERESTED
No pitch - not interested
NO_PITCH_NO_D2D
No pitch - no d2d
NO_PITCH_SWITCHED_RECENTLY
No pitch - switched recently
NO_PITCH_TPI_THIRD_PARTY
No pitch - TPI/third party
NO_PITCH_VULNERABLE
No pitch - vulnerable
OCCUPIER_NOT_BILL_PAYER
Occupier - not bill payer
OCCUPIER_NO_ANSWER
Occupier - no answer
OCCUPIER_REFUSED_TO_DISCUSS
Occupier - refused to discuss
OCCUPIER_SUSPECTED_EMPTY_PROPERTY
Occupier - suspected empty property
OCCUPY_ACCOUNT
Occupy account
OTHER
Other
PAID_IN_FULL
Paid in full
PAID_PARTIAL
Paid partial
PAID_REDUCED_SETTLEMENT
Paid reduced settlement
PAYMENT_PLAN
Payment plan
PITCH_NO_QUOTE
Pitch - no quote
PITCH_NO_QUOTE_ADVANCED_PAYMENT
Pitch no quote - advanced payment
PITCH_NO_QUOTE_IN_CONTRACT
Pitch no quote - in contract
PITCH_NO_QUOTE_NOT_INTERESTED
Pitch no quote - not interested
PITCH_NO_QUOTE_NO_EMAIL
Pitch no quote - no email
PITCH_NO_QUOTE_PRICE
Pitch no quote - price
PITCH_NO_QUOTE_SWITCHED_RECENTLY
Pitch no quote - switched recently
PPM_REQUESTED
PPM requested
PREPAYMENT_METER
Prepayment meter
PRISON
Prison
PROPERTY_INELIGIBLE
Property ineligible
PSR_REGISTERED
PSR registered
QUERY
Query
QUOTED_CALLBACK
Quoted - callback
QUOTED_NO_SALE
Quoted - no sale
QUOTED_NO_SALE_ADVANCED_PAYMENT
Quoted - no sale advanced payment
QUOTED_NO_SALE_AUTOPAY
Quoted - no sale objected to autopay
QUOTED_NO_SALE_CREDIT_CHECK_ISSUE
Quoted - no sale credit check issue
QUOTED_NO_SALE_DEPOSIT
Quoted - no sale objected to deposit
QUOTED_NO_SALE_EXIT_FEES
Quoted - no sale exit fees
QUOTED_NO_SALE_ISSUE_BANK_DETAILS
Quoted - no sale issue bank details
QUOTED_NO_SALE_MONTHLY_DD
Quoted - no sale monthly dd
QUOTED_NO_SALE_NO_EMAIL
Quoted - no sale no email
QUOTED_NO_SALE_OTHER
Quoted - no sale other
QUOTED_NO_SALE_PAPER_BILLS
Quoted - no sale paper bills
QUOTED_NO_SALE_PREPAY
Quoted - no sale prepay too high
QUOTED_NO_SALE_PRICE
Quoted - no sale price
QUOTED_NO_SALE_QUOTE_EMAILED
Quoted - no sale - quote emailed
QUOTED_NO_SALE_STANDING_CHARGE
Quoted - no sale standing charge
QUOTED_NO_SALE_UNSURE_OF_CURRENT_CONTRACT
Quoted - no sale unsure of current contract
QUOTED_NO_SALE_WAIVER_WANTED
Quoted - no sale waiver wanted
QUOTED_NO_SWITCH
Quoted - no switch
SHELTERED_HOUSING
Sheltered housing
SMART_METER_REGISTERED
Smart meter registered
SUCCESS
Success
SWITCHED
Switched
SWITCHED_BUSINESS
Switched Business
SWITCHED_CALLBACK
Switched (Callback)
SWITCHED_CREDIT_CHECK_WAIVER
Switched (Credit Check Waiver)
SWITCHED_FIRST_CONTACT
Switched (First Contact)
SWITCHED_SMART_PRODUCT
Switched (Smart Product)
TRANSFERRED
The customer was transferred to another team/agent
UNABLE_TO_LOCATE
Unable to locate
UNABLE_TO_TRACE
Unable to trace
UNSUCCESSFUL
Unsuccessful
VULNERABILITY_PROJECT
Vulnerability project
VULNERABLE
Vulnerable
WITHDRAWN
Withdrawn
WRONG_ADDRESS_SELECTED
Wrong address selected
Example
"SWITCHED"AppSessionOutcomeCategory
An enumeration.
Values
BUSY
Busy
CALLBACK
Callback
CALLBACK_COURTESY_CALL
Callback Courtesy Call
CALLBACK_PITCHED
Callback Pitched
CONSUMER_APP_DOWNLOAD
Consumer App Download
COS
Cos
COT_NO_PROOF
Cot No Proof
COT_PROVEN
Cot Proven
DECEASED
Deceased
DEMOLISHED
Demolished
DONT_CALL_AGAIN
Dont Call Again
EBSS_VOUCHER_CHECK_IN
Ebss Voucher Check In
ELECTRIC_JUICE_NOT_INTERESTED
Electric Juice Not Interested
ELECTRIC_JUICE_SWITCH
Electric Juice Switch
ELECTRIC_JUICE_SWITCH_LITE
Electric Juice Switch Lite
EMPTY
Empty
ENERGY_HELP_VISIT_COMPLETED
Energy Help Visit Completed
ENERGY_HELP_VISIT_LEAFLET
Energy Help Visit Leaflet
EXHAUSTED_CONTACT
Exhausted Contact
EXHAUSTED_NO_CONTACT
Exhausted No Contact
EXISTING_CUSTOMER
Existing Customer
INSOLVENCY
Insolvency
INTERESTED
Interested
LEAD_GENERATION
Lead Generation
LEAD_GENERATION_BUSINESS
Lead Generation Business
LEAD_GENERATION_EJ
Lead Generation Ej
LEAD_GENERATION_EJ_LITE
Lead Generation Ej Lite
LEAD_GENERATION_EV
Lead Generation Ev
LEAD_GENERATION_HEAT_PUMP
Lead Generation Heat Pump
LEAD_GENERATION_SOLAR
Lead Generation Solar
METER_READING
Meter Reading
METER_READING_NO_ANSWER
Meter Reading No Answer
METER_READING_UNABLE_TO_TAKE_READING
Meter Reading Unable To Take Reading
MULTIPLE_PROPERTIES
Multiple Properties
NOT_BILL_PAYER
Not Bill Payer
NOT_DECISION_MAKER
Not Decision Maker
NO_ANSWER
No Answer
NO_COLD_CALLING
No Cold Calling
NO_FIXED_ADDRESS
No Fixed Address
NO_PITCH
No Pitch
NO_PITCH_NOT_INTERESTED
No Pitch Not Interested
NO_PITCH_NO_D2D
No Pitch No D2D
NO_PITCH_SWITCHED_RECENTLY
No Pitch Switched Recently
NO_PITCH_TPI_THIRD_PARTY
No Pitch Tpi Third Party
NO_PITCH_VULNERABLE
No Pitch Vulnerable
OCCUPIER_NOT_BILL_PAYER
Occupier Not Bill Payer
OCCUPIER_NO_ANSWER
Occupier No Answer
OCCUPIER_REFUSED_TO_DISCUSS
Occupier Refused To Discuss
OCCUPIER_SUSPECTED_EMPTY_PROPERTY
Occupier Suspected Empty Property
OCCUPY_ACCOUNT
Occupy Account
OTHER
Other
PAID_IN_FULL
Paid In Full
PAID_PARTIAL
Paid Partial
PAID_REDUCED_SETTLEMENT
Paid Reduced Settlement
PAYMENT_PLAN
Payment Plan
PITCH_NO_QUOTE
Pitch No Quote
PITCH_NO_QUOTE_ADVANCED_PAYMENT
Pitch No Quote Advanced Payment
PITCH_NO_QUOTE_IN_CONTRACT
Pitch No Quote In Contract
PITCH_NO_QUOTE_NOT_INTERESTED
Pitch No Quote Not Interested
PITCH_NO_QUOTE_NO_EMAIL
Pitch No Quote No Email
PITCH_NO_QUOTE_PRICE
Pitch No Quote Price
PITCH_NO_QUOTE_SWITCHED_RECENTLY
Pitch No Quote Switched Recently
PPM_REQUESTED
Ppm Requested
PREPAYMENT_METER
Prepayment Meter
PRISON
Prison
PROPERTY_INELIGIBLE
Property Ineligible
PSR_REGISTERED
Psr Registered
QUERY
Query
QUOTED_CALLBACK
Quoted Callback
QUOTED_NO_SALE
Quoted No Sale
QUOTED_NO_SALE_ADVANCED_PAYMENT
Quoted No Sale Advanced Payment
QUOTED_NO_SALE_AUTOPAY
Quoted No Sale Autopay
QUOTED_NO_SALE_CREDIT_CHECK_ISSUE
Quoted No Sale Credit Check Issue
QUOTED_NO_SALE_DEPOSIT
Quoted No Sale Deposit
QUOTED_NO_SALE_EXIT_FEES
Quoted No Sale Exit Fees
QUOTED_NO_SALE_ISSUE_BANK_DETAILS
Quoted No Sale Issue Bank Details
QUOTED_NO_SALE_MONTHLY_DD
Quoted No Sale Monthly Dd
QUOTED_NO_SALE_NO_EMAIL
Quoted No Sale No Email
QUOTED_NO_SALE_OTHER
Quoted No Sale Other
QUOTED_NO_SALE_PAPER_BILLS
Quoted No Sale Paper Bills
QUOTED_NO_SALE_PREPAY
Quoted No Sale Prepay
QUOTED_NO_SALE_PRICE
Quoted No Sale Price
QUOTED_NO_SALE_QUOTE_EMAILED
Quoted No Sale Quote Emailed
QUOTED_NO_SALE_STANDING_CHARGE
Quoted No Sale Standing Charge
QUOTED_NO_SALE_UNSURE_OF_CURRENT_CONTRACT
Quoted No Sale Unsure Of Current Contract
QUOTED_NO_SALE_WAIVER_WANTED
Quoted No Sale Waiver Wanted
QUOTED_NO_SWITCH
Quoted No Switch
SHELTERED_HOUSING
Sheltered Housing
SMART_METER_REGISTERED
Smart Meter Registered
SUCCESS
Success
SWITCHED
Switched
SWITCHED_BUSINESS
Switched Business
SWITCHED_CALLBACK
Switched Callback
SWITCHED_CREDIT_CHECK_WAIVER
Switched Credit Check Waiver
SWITCHED_FIRST_CONTACT
Switched First Contact
SWITCHED_SMART_PRODUCT
Switched Smart Product
TRANSFERRED
Transferred
UNABLE_TO_LOCATE
Unable To Locate
UNABLE_TO_TRACE
Unable To Trace
UNKNOWN
Unknown
UNSUCCESSFUL
Unsuccessful
VULNERABILITY_PROJECT
Vulnerability Project
VULNERABLE
Vulnerable
WITHDRAWN
Withdrawn
WRONG_ADDRESS_SELECTED
Wrong Address Selected
Example
"SUCCESS"AppSessionOutcomeType
An enumeration.
Values
BUSINESS_LEAD
Business Lead
BUSINESS_SALE
Business Sale
CREDIT
Credit
ELECTRIC_UNIVERSE
Electric Universe
ELECTROVERSE
Electroverse
ELECTROVERSE_LEAD
Electroverse Lead
ENERGY_HELP
Energy Help
ENERGY_SUPPORT
Energy Support
EV_CHARGER
Ev Charger
EV_LEAD
Ev Lead
HEAT_PUMP_LEAD
Heat Pump Lead
INTELLIGENT_OCTOPUS_SIGNUP
Intelligent Octopus Signup
LEAD
Lead
METER_READING
Meter Reading
OCCUPIER
Occupier
SALE
Sale
SOLAR_LEAD
Solar Lead
UNKNOWN
Unknown
Example
"SALE"AppointmentStatus
An enumeration.
Values
ABORTED
The appointment was aborted. Choose this option for partially completed work (e.g. on a dual fuel meter exchange where one meter was exchanged successfully but the other exchange could not be completed.
BOOKED
The appointment has been booked.
CANCELLED
The appointment was cancelled either by the customer or the agent.
COMPLETED
The appointment has been completed successfully.
Example
"BOOKED"BrandChoices
An enumeration.
Values
AFFECT_ENERGY
Affect Energy.
BULB
Bulb.
COOP_ENERGY
Coop Energy.
EBICO_LIVING
Ebico Living.
LONDON_POWER
London Power.
OCTOPUS_ENERGY
Octopus Energy.
Example
"OCTOPUS_ENERGY"BroaderGroupRejectionReason
An enumeration.
Values
ALREADY_RECEIVED_DISCOUNT
APPLICATIONS_NOT_OPEN
BUSINESS_ACCOUNT
DUPLICATE
HAS_CORE_GROUP_DISCOUNT
HAS_OPEN_APPLICATION
INSUFFICIENT_EVIDENCE_PROVIDED
NON_DOMESTIC_METER_POINT
NOT_IN_SCOTLAND
NO_LONGER_ON_SUPPLY
Example
"APPLICATIONS_NOT_OPEN"BusinessTypeOptions
An enumeration.
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.
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.
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"CHFConnectionMethod
How the CHF was installed and connected to the rest of the Smart Metering System.
Values
CRADLE
Cradle.
ESME
Esme.
HOT_SHOE
Hot Shoe.
Example
"HOT_SHOE"CHFFaultReason
The user's description of the fault, if the meter was not installed due to a technical problem.
Values
AERIAL_FAULT
Fault with aerial.
DAMAGED_CASE
Damaged Case.
DAMAGED_CONNECTOR
Damaged connector.
ENVIRONMENTAL_CONDITIONS_EXCEEDED
Environmental Conditions Exceeded.
ILLEGAL_INTERFERENCE_OR_MISSING_SEALS
Illegal Interference Or Missing Seals.
LED_FAULT
Fault with LED.
MANUFACTURING_DEFECT
Manufacturing Defect.
SM_HAN_FAULT
Fault with SM HAN interface.
SM_WAN_FAULT
Fault with SM WAN.
Example
"DAMAGED_CASE"CHFFaultReturnType
Whether the fault was identified before or after the installation.
Values
POST_INSTALLATION
Post Installation.
PRIOR_TO_INSTALLATION
Prior To Installation.
Example
"PRIOR_TO_INSTALLATION"CHFInstallType
Whether it is a new or replacement CHF.
Values
NEW
New.
REPLACEMENT
Replacement.
Example
"NEW"CHFLocation
Location of the CHF.
Values
BASEMENT_OR_CELLAR
In the basement/cellar.
DEEP_INDOORS
Indoors, NOT on an external wall.
INDOORS_ON_EXTERNAL_WALL
Indoors On External Wall.
OUTSIDE
Outside of the premises.
Example
"OUTSIDE"CHFNoFaultReturnType
The reason for the meter not being installed if there was no technical issue.
Values
DUAL_SUPPLIER_HAN_VARIANT_REPLACEMENT
Dual supplier HAN variant replacement.
GENERAL
General.
LOST_OR_STOLEN_HUB
Lost or stolen hub.
NON_DOMESTIC_OPT_OUT
Non-domestic opt-out.
SM_WAN_VARIANT_REPLACEMENT
SM WAN variant replacement requested by DCC.
Example
"GENERAL"CampaignItemStatus
The status of the campaign item.
Values
ASSIGNED
COMPLETE
IN_PROGRESS
REMOVED
UNASSIGNED
Example
"UNASSIGNED"CampaignStatus
The status of the campaign.
Indicates whether calls can be made for items in the campaign or not.
Values
ACTIVE
INACTIVE
Example
"ACTIVE"CancellationCategory
The category for the appointment cancellation.
Values
CANCELLED_BY_BUSINESS
CANCELLED_BY_CUSTOMER
CANCELLED_BY_PROVIDER
CANCELLED_BY_SUPPLIER
Example
"CANCELLED_BY_CUSTOMER"Values
INSUFFICIENT_POINTS
MAX_CLAIMS_PER_PERIOD_REACHED
OUT_OF_STOCK
Example
"OUT_OF_STOCK"Category
An enumeration.
Values
FILE_ATTACHMENT_DNO_LETTER
FILE_ATTACHMENT_FLEXI_ORB_CERT
FILE_ATTACHMENT_HEAT_PUMP_HANDOVER_DOCUMENT
FILE_ATTACHMENT_MCS_CERT
Example
"FILE_ATTACHMENT_MCS_CERT"Values
APPROVED
CANCELLED
CLEARED
FAILED
HELD_FOR_REVIEW
NONE
PENDING
REQUESTED
SCHEDULED
Example
"APPROVED"CollectionCampaignType
An enumeration.
Values
B2B_DISCONNECTION_PROCESS
B2B_SITE_VISIT
CONFIRMED_EMPTY
DEBT_COLLECTION_AGENCY
DECEASED
DIGITAL_ONLY
DOMESTIC_FINAL
DOMESTIC_LIVE
EARLY_STAGE
ENFORCEMENT
FINAL_B2B
FINAL_COLLECTIONS_NBF
FINAL_DEBT_COLLECTION
FINAL_DEBT_COLLECTION_2
HIGH_RISK
HOME_VISIT
INSOLVENT
LITIGATION
LIVE_B2B
LIVE_DEBT_COLLECTION
LIVE_DEBT_COLLECTION_2
LIVE_DEBT_COLLECTION_3
LOW_RISK
MEDIUM_RISK
OCCUPIER
OCCUPIER_VISIT
PERSISTENT_DEBT
POST_REMOTE_SWITCH
POST_WARRANT
PRE_LEGAL
QUERY
REMOTE_SWITCH_TO_SPAYG
REQUESTED_SWITCH_TO_SMART_PAYG
RE_ENGAGEMENT
SUPPLY_DISCONNECTED
SWITCH_TO_SMART_PAYG
THIRD_PARTY
TRACE
TRACE_AND_COLLECT
TRACE_FINAL
TRACE_LIVE
VULNERABILITY_VISIT
VULNERABLE_CUSTOMER
WIST_DROP_OUT
Example
"VULNERABLE_CUSTOMER"CollectionProcessRecordCompletionTypeChoices
Options for Collection Process Record Completion types. ENDED: endedWITHDRAWN: withdrawnCANCELLED: cancelledNEVER_ACTIONED: never_actioned
Values
CANCELLED
ENDED
NEVER_ACTIONED
WITHDRAWN
Example
"ENDED"CommsDeliveryPreference
The method the account has specified they prefer we contact them
Values
POSTAL_MAIL
Example
"EMAIL"CommsHubStatusUpdateType
The type of comms hub status update request to be sent.
Values
FAULT_RETURN
Returning CHF due to technical fault.
NO_FAULT_RETURN
Returning CHF for non-technical reason.
NO_SM_WAN
No SM Wide Area Network.
SUCCESS
Success.
Example
"SUCCESS"CommsStrategy
Determines which communications will be sent for the appointment.
Values
SEND_ALL
SEND_ONLY_JOB_COMPLETED
SUPPRESS_ALL
Example
"SEND_ALL"ComparisonGroup
An enumeration.
Values
AREACODE
BEDROOM_AREACODE
BEDROOM_OUTCODE
NO_MATCH
OUTCODE
PROPERTY_BEDROOM_AREACODE
PROPERTY_BEDROOM_OUTCODE
Example
"PROPERTY_BEDROOM_AREACODE"ConnectionStatus
Connection status of the device, provided as part of the telemetry data.
Values
OFFLINE
ONLINE
Example
"ONLINE"ConsumptionGroupings
An enumeration.
Values
DAY
HALF_HOUR
HOUR
MONTH
QUARTER
QUARTER_HOUR
WEEK
Example
"QUARTER_HOUR"CurrentQualifyingComponentOptions
All of the qualifying components currently permitted for broader group applications.
Values
ADULT_DISABILITY_PAYMENT
In receipt of Adult Disability Payment (ADP)
AGE_THRESHOLD
Are aged 62 and over (OR in receipt of any pensioner premium)
DEPENDENT_CHILD_OVER_FIVE
Have a dependent child aged 5 – 16 or under 18 if in full time education (dependent child who normally resides with the applicant)
DEPENDENT_CHILD_UNDER_FIVE
Have a dependent child under 5 (dependent child who normally resides with the applicant)
DISABILITY_BENEFITS
In receipt of Disability Living Allowance (DLA), any disability premium (all rates) or disabled child element of Universal Credit
HAS_DISABILITY
Have a medically dependant illness (disability or mobility issue)
INCOME_RELATED_BENEFITS
In receipt of any Income-related benefit which includes: Carer’s Premium and Carer’s Allowance (for someone within the household) OR Attendance Allowance (for applicant or their partner) OR Industrial Injuries Benefit
LIMITED_CAPABILITY_FOR_WORK
In receipt of the limited capability for work element of Universal Credit
MATERNITY_EXEMPTION_CERTIFICATE
Hold a Maternity Exemption Certificate (MATEX)
PERSONAL_INDEPENDENCE_PAYMENTS
In receipt of Personal Independence Payments (PIP)
Example
"PERSONAL_INDEPENDENCE_PAYMENTS"DNOStatus
The status of DNO being notified of this export request.
Values
NOTIFIED
Notified
NOT_NOTIFIED
Not Notified
UNKNOWN
Unknown
Example
"NOTIFIED"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"DeviceStatus
An enumeration.
Values
COMMISSIONED
Commissioned
DECOMMISSIONED
Decommissioned
INSTALLED_NOT_COMMISSIONED
Installed but not commissioned
NOT_APPLICABLE
Not Applicable
PENDING
Pending
RECOVERED
Recovered
RECOVERY
In recovery
SUSPENDED
Suspended
WHITELISTED
Whitelisted
WITHDRAWN
Withdrawn
Example
"PENDING"DeviceStatuses
An enumeration.
Values
COMMISSIONED
Device has been commissioned
DECOMMISSIONED
Device has been decommissioned
INSTALLED_NOT_COMMISSIONED
Installed but not commissioned
NOT_APPLICABLE
Not applicable
PENDING
Pending
RECOVERED
Device recovered
RECOVERY
Device is in recovery mode
SUSPENDED
Decice suspended
WHITELISTED
Device has been whitelisted
WITHDRAWN
Device has been withdrawn
Example
"PENDING"DeviceType
An enumeration.
Values
CAD
Consumer Access Device (CAD)
CHF
Communications Hub Function (CHF)
ESME
Electricity Smart Meter (ESME)
GPF
Gas Proxy Function (GPF)
GSME
Gas Smart Meter (GSME)
HCALCS
HAN Connected Auxiliary Load Control Switch (HCALCS)
IHD
In-House Display (IHD)
IHD_OR_CAD
IHD or CAD (a type 2 device)
PPMID
Prepayment Interface Device (PPMID)
Example
"ESME"DirectDebitInstructionStatus
An enumeration.
Values
ACCOUNT_CLOSED
The account for this instruction was closed.
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"DispatchNoticeTypeChoices
The various dispatch notice time types ecisting in the datalake for saving session events.
Values
DAY_AHEAD
WITHIN_DAY_1
WITHIN_DAY_2
Example
"DAY_AHEAD"DocumentAccessibilityChoices
An enumeration.
Values
AUDIO
Audio-accessible documents are requested for this account.
BRAILLE
Braille documents are requested for this account.
LARGE_PRINT
Large print documents are requested for this account.
Example
"LARGE_PRINT"ElectricityAgentContractContractType
An enumeration.
Values
ADS
Advanced Data Service
DA
Data Aggregator
DC
Data Collector
MOP
Meter Operator
MSA
Advanced Metering Service
MSS
Smart Metering Service
SDS
Smart Data Service
UMSDS
Unmetered Data Service
UMSO
Unmetered Supplies Operator
Example
"MOP"ElectricityMeterMeterType
An enumeration.
Values
A_2ADEF
Single Element with ALCS, Boost Function and APC that is compliant with SMETS2
A_2ADF
Single Element with ALCS and APC that is compliant with SMETS2
A_2AEF
Single Element with Boost Function and APC that is compliant with SMETS2
A_2AF
Single Element with APC that is compliant with SMETS2
A_2BDEF
Twin Element with ALCS, Boost Function and APC that is compliant with SMETS2
A_2BDF
Twin Element with ALCS and APC that is compliant with SMETS2
A_2BEF
Twin Element with Boost Function and APC that is compliant with SMETS2
A_2BF
Twin Element with APC that is compliant with SMETS2
A_2CDEF
Polyphase with ALCS, Boost Function and APC that is compliant with SMETS2
A_2CDF
Polyphase with ALCS and APC that is compliant with SMETS2
A_2CEF
Polyphase with Boost Function and APC that is compliant with SMETS2
A_2CF
Polyphase with APC that is compliant with SMETS2
CHECK
Check
H
Half Hourly
K
Key
LAG_
Lag
LEAD_
Lead
MAIN_
Main
N
Non-Half Hourly
NCAMR
Non-remotely Configurable Automated Meter Reading
NSS
A meter that meets the definition of an ADM but is not compliant with any version of SMETS
RCAMR
Remotely Configurable Automated Meter Reading without remote enable/disable capability
RCAMY
Remotely Configurable Automated Meter Reading with remote enable/disable capability
S
Smartcard Prepayment
S1
A meter that is compliant with the Smart Metering Equipment Technical Specifications 1 (SMETS1)
S2A
A single element meter that is compliant with SMETS2
S2AD
A single element meter with one or more ALCS that is compliant with SMETS2
S2ADE
Single element meter with one or more ALCS and Boost Function that is compliant with SMETS2
S2B
A twin element meter that is compliant with SMETS2
S2BD
A twin element meter with one or more ALCS that is compliant with SMETS2
S2BDE
A twin element meter with one or more ALCS and Boost Function that is compliant with SMETS2
S2C
A polyphase meter that is compliant with SMETS2
S2CD
A polyphase meter with one or more ALCS that is compliant with SMETS2
S2CDE
A polyphase meter with one or more ALCS and Boost Function that is compliant with SMETS2
SPECL
Special
T
Token
Example
"CHECK"ElectricitySupplyType
An enumeration.
Values
SINGLE_PHASE
Single phase meter point.
THREE_PHASE
Three phase meter point.
Example
"SINGLE_PHASE"Eligibility
An enumeration.
Values
BUSINESS_ACCOUNT
CAPPED_CATCHMENT
ELIGIBLE
HAS_SMART_TARIFF
INCORRECT_READ_PERMISSION
INVALID_BRAND
INVALID_CATCHMENT
NO_ACTIVE_AGREEMENTS
NO_RECENT_READING
NO_SMART_METER
ONBOARDING_TO_SMART_TARIFF
Example
"ELIGIBLE"EnergyProductFilters
An enumeration.
Values
BUSINESS
Display our business products.
DOMESTIC
Display our domestic products.
FIXED
Display our fixed-term products.
GREEN
Display our greenest products.
PREPAY
Display our prepayment products.
SMART
Display our smart (charged half-hourly) products.
VARIABLE
Display our variable-term products.
Example
"PREPAY"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"EnrolmentStatus
An enumeration.
Values
CANCELLED
Cancelled
COMPLETED
Completed
ERRORED
Errored
FAILED
Failed
IN_PROGRESS
In progress
NOT_STARTED
Not started
STALLED
Stalled
Example
"NOT_STARTED"EnrolmentStatusOptions
An enumeration.
Values
ACCEPTED
Enrolment has been accepted by the industry, which means that it has all the information needed to switch supplier and if that information is correct (to it's knowledge)
COMPLETED
Enrolment has been completed.
DISPUTED
Enrolment has been disputed. This could be that the meter point details that have been provided have been disputed.
OBJECTION_RECEIVED
The previous supplier objects to the switch. The have not has cancelled the switch yet, but in 99% cases, they will cancel the switch.
PRE_REGISTRATION
The meterpoint has been created but the enrolment process has not started yet.
REGISTRATION_OBJECTED
The previous supplier cancelled the switch. This is a terminal state, and we will have to reapply before this can start again.
REJECTED
The overseeing industry body has objected to the switch
REQUESTED
Enrolment has been requested. This is the default catch-all status, which is returned when no other defined process is happening.
WITHDRAWN
The request to bring the meter point on supply has been withdrawn.
Example
"OBJECTION_RECEIVED"EnrolmentStepStatus
An enumeration.
Values
CANCELLED
COMPLETED
ERRORED
FAILED
IN_PROGRESS
PENDING
SKIPPED
STALLED
Example
"SKIPPED"EventReasonChoices
An enumeration.
Values
AD_HOC_CREDIT
OCTO_ASSIST_FUND_DONATION
OCTO_POINTS_CONVERSION
SAVING_SESSIONS_REWARD
Example
"SAVING_SESSIONS_REWARD"ExpiringTokenScope
An enumeration.
Values
ACCEPT_TERMS_AND_CONDITIONS
Scope that enables account user to accept the terms and conditions for a product.
BOOK_SMART_METER_APPOINTMENTS
Scope that enables account user to book smart meter appointments.
CHECKOUT_QUOTE
Scope that enables account user to checkout a quote (validate terms & conds and provide a payment detail).
EDIT_CUSTOMER_MARKETING_PREFERENCE
Edit Customer Marketing Preference
JOIN_CAMPAIGNS
Scope that enables account user to join campaigns.
JOIN_CAMPAIGN_EVENTS
Scope that enables account user to join campaign events.
MANAGE_ACCOUNT_RENEWALS
Scope that enables account user to generate a renewal quote and renew agreements.
MANAGE_BUSINESS_SECURITY_DEPOSIT
Scope that enables account user to manage security deposit payments for business accounts.
MANAGE_GOODS_PURCHASES
Scope that enables account user to accept goods quotes and process goods purchases.
MANAGE_PRODUCT_SWITCH
Scope that enables account user to do a self-serve product switch through the Dashboard.
REDEEM_LOYALTY_POINTS
Scope that enables account user to redeem loyalty points
REPORT_MOVE_OUT
Scope that enables account user to report a property move-out.
SEND_LOSS_OBJECTION_FOR_CHANGE_OF_SUPPLIER
Scope that enables user to send a loss objection for a change of supplier process.
SET_GOODS_PURCHASE_SALE_ITEM_PRICES
Set Goods Purchase Sale Item Prices
SUBMIT_CUSTOMER_FEEDBACK
Scope that enables account user to submit customer feedback.
SUBMIT_METER_READINGS
Scope that enables account user to submit meter readings.
UPDATE_ACCOUNT_DETAILS
Scope that enables the user to update information about themselves and their account.
UPDATE_BLACKHOLE_EMAIL
Scope that enables account user to update their blackhole email address.
UPDATE_DIRECT_DEBIT
Scope that enables account user to update their direct debit details.
UPDATE_SENSITIVE_CUSTOMER_INFORMATION
Update Sensitive Customer Information
VIEW_CAMPAIGN_DASHBOARDS
Scope that enables account user to visit campaign dashboard.
VIEW_DETAILED_USAGE
Scope that enables account user to visit detailed property usage pages.
Example
"SUBMIT_METER_READINGS"ExportTechnologyType
The type of generator technology used for export.
Values
HYDRO
Hydro
SOLAR
Photovoltaic
SOLAR_AND_STORAGE
Photovoltaic and Storage
STORAGE
Storage
WIND
Wind
WIND_AND_STORAGE
Wind and Storage
Example
"HYDRO"ExternalAccountEventCategory
Enum of allowable event type categories for external account events.
Values
COMMUNICATIONS
DEBT
MESSAGING
MOBILE
WEB
Example
"COMMUNICATIONS"ExternalAccountEventContentType
Enum of allowable content types for external account events.
The content type field is used to determine how to display the content in the account event description.
Values
HTML
LINK
PLAINTEXT
S3
Example
"PLAINTEXT"ExternalAccountEventSubCategory
Enum of allowable event type subcategories for external account events.
Values
CLICK_TO_CALL
DUNNING
FEEDBACK
PUSH_NOTIFICATION
SMS
SOCIAL_MEDIA
TELEPHONE
THIRD_PARTY
Example
"TELEPHONE"FITStatus
The ownership status of FiT for this property.
Values
NONE
None
OWNER
Notified
PREVIOUS_OWNER
Previous owner
THIRD_PARTY_OWNED
Third party owned
UNKNOWN
Unknown
Example
"OWNER"FetchSiteworksAppointmentStatus
The status of the fetch siteworks appointment operation. If the status is PENDING, the timeslots calculation is still in progress.
Values
COMPLETE
ERROR
PENDING
Example
"PENDING"FormType
An enumeration.
Values
COVID_19_FINANCIAL_ENERGY_ASSESSMENT
Covid-19 Financial Energy Assessment
COVID_19_GAS_PRICES_FINANCIAL_ENERGY_ASSESSMENT
Covid-19 Gas Prices Financial Energy Assessment
Example
"COVID_19_FINANCIAL_ENERGY_ASSESSMENT"FuelTypeChoices
An enumeration.
Values
DUAL_FUEL
Dual Fuel.
ELECTRICITY
Electricity.
GAS
Gas.
Example
"ELECTRICITY"GasMeterMechanism
An enumeration.
Values
CM
Coin Meter
CR
Credit
ET
Electronic Token Meter
MT
Mechanical Token Meter
NS
Non Compliant SMETS Smart Meter
PP
Prepayment
S1
SMETS 1 compliant Smart Meter
S2
SMETS 2 compliant Smart Meter
TH
Thrift
U
Unknown
Example
"CR"GasMeterStatus
An enumeration.
Values
CA
Capped
CL
Clamped
CU
Cut off
FA
Faulty
IN
Inactive
LI
Live
NI
Not Installed
OT
Other
RE
Removed
SP
Spin Cap
UN
Unknown
Example
"LI"GasSupplyType
An enumeration.
Values
MEDIUM
Medium pressure gas supply.
STANDARD
Standard pressure gas supply.
Example
"STANDARD"GreennessForecastIndex
The greenness index LOW/MEDIUM/HIGH (higher is greener).
Values
HIGH
LOW
MEDIUM
Example
"LOW"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"HeatPumpHeatType
An enumeration.
Values
ELECTRIC_BOILER
ELECTRIC_RADIATOR
ELECTRIC_STORAGE_HEATER
LPG_BOILER
MAINS_GAS_BOILER
OIL_BOILER
OTHER
Example
"MAINS_GAS_BOILER"HeatPumpPropertyType
An enumeration.
Values
DETACHED
END_OF_TERRACE
FLAT
FLAT_GROUND_FLOOR
OTHER
SEMI_DETACHED
TERRACE
Example
"END_OF_TERRACE"IneligibilityReasons
An enumeration.
Values
ACTIVE_EXCLUSION_CAMPAIGN
ALREADY_SIGNED_UP
DISABLED_HH_READINGS
INCORRECT_BRAND
NO_DIRECT_DEBIT
NO_ELIGIBLE_METERS
NO_PROPERTIES
OCTOPLUS_DISABLED
Example
"OCTOPLUS_DISABLED"Values
GENERALLY_AVAILABLE
Generally Available - The device is available.
NOT_AVAILABLE
Not Available - The device is not available.
TESTING
Testing - The device is in testing status.
Example
"TESTING"JoinConsumerDeviceChoices
An enumeration.
Values
ALT_HAN
Alternative Home Area Network.
CAD
Consumer Access Device.
IHD
In-Home Display.
PPMID
Pre-Payment Meter Interface Device.
Example
"PPMID"JoinableDeviceType
Types of devices that can be joined to a HAN (Home Area Network).
Values
AUX_SWITCH
HAN Connected Auxiliary Load Control Switch (HCALCS).
ELECTRICITY_METER
Electricity meter.
GAS_METER
Gas meter.
IHD
In-Home Display.
PPMID
Pre-Payment Meter Interface Device.
Example
"ELECTRICITY_METER"KrakenFlexDeviceStatusChoices
The current lifecycle status of a KrakenFlex device on the smarter tariff API:
ONBOARDINGindicates the device has been registered on the system but has not yet completed the on-boarding process.- Including a test charge step, to validate that communication and control of the device is possible within expected limits.
ONBOARDING_TEST_IN_PROGRESSindicates that there is a test charge in progress for the device.LIVEindicates that the device has completed the on-boarding process and is ready for control.FAILED_ONBOARDING_TESTindicates that there has been an issue validating that the device can be reliably communicated with or controlled on the system.RETIREDindicates that the device has no connection details and is not currently available for control.
Values
FAILED_ONBOARDING_TEST
LIVE
ONBOARDING
ONBOARDING_TEST_IN_PROGRESS
PENDING_LIVE
RETIRED
Example
"ONBOARDING"KrakenFlexDeviceTypes
The device types that can be controlled by KrakenFlex.
Values
BATTERIES
ELECTRIC_VEHICLES
HEAT_PUMPS
INVERTERS
STORAGE_HEATERS
THERMOSTATS
Example
"BATTERIES"LifecycleSupplyPointProcessStatus
The status of the lifecycle process.
Values
CANCELLED
COMPLETED
ERRORED
FAILED
IN_PROGRESS
PARTIALLY_CANCELLED
PARTIALLY_COMPLETED
PARTIALLY_REVERSED
PENDING
REVERSED
REVERSE_IN_PROGRESS
STALLED
Example
"COMPLETED"LimitedBandCategories
Set of band categories that are currently
supported for creating product rates.
Values
CONSUMPTION_CHARGE
STANDING_CHARGE
Example
"STANDING_CHARGE"LinkTrainingStatus
An enumeration.
Values
IN_TRAINING
In training
NOT_APPLICABLE
Not applicable
QUALIFIED
Qualified
Example
"NOT_APPLICABLE"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"MessageChannel
An enumeration.
Values
INTERCOM
Intercom
JUNIFER
Junifer
PUSH_NOTIFICATION
Push Notification
SMS
SMS
Example
"EMAIL"MeterReadingEventType
Represents groupings of meter reading events Meter readings can be filtered by these event types.
Values
CHANGE_OF_SUPPLY
CUSTOMER
DATA_COLLECTOR
ESTIMATE
METER_EXCHANGE
PREPAY
PRE_SUPPLIER
SMART_METER
Example
"CUSTOMER"MeterStatus
An enumeration.
Values
ON_SITE
The meter was installed or work was done on an existing meter.
REMOVED
The meter was removed.
Example
"REMOVED"Values
ECONOMY7
FLAT_ECONOMY7
FLAT_THREE_RATE
SMART
SMART_ECONOMY7
SMART_FLAT_ECONOMY7
STANDARD
THREE_RATE
Example
"STANDARD"MeterTypeChoices
An enumeration.
Values
ELECTRICITY_METER
Electricity meter.
GAS_METER
Gas meter.
Example
"ELECTRICITY_METER"MeterTypes
An enumeration.
Values
ECONOMY7
FLAT_ECONOMY7
FLAT_THREE_RATE
NO_METER
OTHER
SMART
SMART_ECONOMY7
SMART_FLAT_ECONOMY7
STANDARD
THREE_RATE
Example
"NO_METER"NewMeterCategory
An enumeration.
Values
CHECK_METER
Check Meter.
SMETS1
SMETS1 (first generation smart meter).
SMETS2
SMETS2 (second generation smart meter).
TRADITIONAL
Traditional meter.
Example
"SMETS1"NonBespokeElectricityRateTypeChoices
An enumeration.
Values
ECO7_DAY
ECO7_NIGHT
OFF_PEAK
STANDARD
Example
"STANDARD"NotifiableApplicationService
An enumeration.
Values
APNS
iOS (APNs)
APNS_SANDBOX
iOS Sandbox (APNs Sandbox)
GCM
Android (GCM)
Example
"GCM"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"PaymentFrequency
An enumeration.
Values
ANNUALLY
FORTNIGHTLY
FOUR_WEEKLY
MONTHLY
QUARTERLY
SIX_MONTHLY
WEEKLY
Example
"WEEKLY"PaymentMode
The mode used by a SMETS2 meter to charge for energy consumed.
Energy consumption can either be paid for in advance (i.e. prepay / pay-as-you-go)
or at some time later (i.e. credit).
Values
CREDIT
Credit.
PREPAY
Prepayment.
Example
"PREPAY"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"PerformanceGrouping
The time interval that we report the performance for.
Values
DAY
LIVE
MONTH
WEEK
YEAR
Example
"LIVE"PreSignedTokenScope
Choices class for the pre-signed expiring tokens.
These choices must have a certain format:
{ACTION-VERB}_{DEFINING-NOUN}
They should start with an action verb. It should be a single word.
The action verb enables the account user to do the thing (defining noun)
that comes after the action verb. Together they represent a task.
The defining noun could be longer than a single word.
Preferably, it should be kept short and simple as much as possible.
Values
ACCEPT_TERMS_AND_CONDITIONS
Scope that enables account user to accept the terms and conditions for a product.
BOOK_SMART_METER_APPOINTMENTS
Scope that enables account user to book smart meter appointments.
CHECKOUT_QUOTE
Scope that enables account user to checkout a quote (validate terms & conds and provide a payment detail).
EDIT_CUSTOMER_MARKETING_PREFERENCE
Edit Customer Marketing Preference
JOIN_CAMPAIGNS
Scope that enables account user to join campaigns.
JOIN_CAMPAIGN_EVENTS
Scope that enables account user to join campaign events.
MANAGE_ACCOUNT_RENEWALS
Scope that enables account user to generate a renewal quote and renew agreements.
MANAGE_BUSINESS_SECURITY_DEPOSIT
Scope that enables account user to manage security deposit payments for business accounts.
MANAGE_GOODS_PURCHASES
Scope that enables account user to accept goods quotes and process goods purchases.
MANAGE_PRODUCT_SWITCH
Scope that enables account user to do a self-serve product switch through the Dashboard.
REDEEM_LOYALTY_POINTS
Scope that enables account user to redeem loyalty points
REPORT_MOVE_OUT
Scope that enables account user to report a property move-out.
SEND_LOSS_OBJECTION_FOR_CHANGE_OF_SUPPLIER
Scope that enables user to send a loss objection for a change of supplier process.
SET_GOODS_PURCHASE_SALE_ITEM_PRICES
Set Goods Purchase Sale Item Prices
SUBMIT_CUSTOMER_FEEDBACK
Scope that enables account user to submit customer feedback.
SUBMIT_METER_READINGS
Scope that enables account user to submit meter readings.
UPDATE_ACCOUNT_DETAILS
Scope that enables the user to update information about themselves and their account.
UPDATE_BLACKHOLE_EMAIL
Scope that enables account user to update their blackhole email address.
UPDATE_DIRECT_DEBIT
Scope that enables account user to update their direct debit details.
UPDATE_SENSITIVE_CUSTOMER_INFORMATION
Update Sensitive Customer Information
VIEW_CAMPAIGN_DASHBOARDS
Scope that enables account user to visit campaign dashboard.
VIEW_DETAILED_USAGE
Scope that enables account user to visit detailed property usage pages.
Example
"SUBMIT_METER_READINGS"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"PremiseType
The type of premise in which the CHF is located.
Values
DETACHED_OR_SEMI
Detached / Semi-detached.
HIGH_RISE_APARTMENT
An apartment block with more than 5 floors.
LOW_RISE_APARTMENT
An apartment block with 5 floors or less.
TERRACED
Terraced.
Example
"DETACHED_OR_SEMI"ProductRateBands
The product rate band of a line item.
Values
CONSUMPTION
CONSUMPTION.
FEE
FEE.
TIME
TIME.
Example
"CONSUMPTION"ProviderChoices
This refers to the provider that is used to authenticate when registering a device.
Values
DAIKIN
ECOBEE
ENERGIZER
ENODE
ENPHASE
FORD
GIVENERGY
HUAWEI
HYPERVOLT
INDRA
JEDLIX
MYENERGI
OCPP_WALLBOX
OHME
SENSI
SMARTCAR
SMART_PEAR
SOLAREDGE
TESLA
VP_AMAZON
VP_HONEYWELL_CC
VP_HONEYWELL_RES
VP_NEST
Example
"DAIKIN"QualifyingComponentOptions
All of the qualifying components that have ever been allowed for broader group applications. For currently accepted components please use CurrentQualifyingComponentOptions instead.
Values
ADULT_DISABILITY_PAYMENT
In receipt of Adult Disability Payment (ADP)
AGE_THRESHOLD
Are aged 62 and over (OR in receipt of any pensioner premium)
DEPENDENT_CHILD_OVER_FIVE
Have a dependent child aged 5 – 16 or under 18 if in full time education (dependent child who normally resides with the applicant)
DEPENDENT_CHILD_UNDER_FIVE
Have a dependent child under 5 (dependent child who normally resides with the applicant)
DISABILITY_BENEFITS
In receipt of Disability Living Allowance (DLA), any disability premium (all rates) or disabled child element of Universal Credit
HAS_DISABILITY
Have a medically dependant illness (disability or mobility issue)
INCOME_RELATED_BENEFITS
In receipt of any Income-related benefit which includes: Carer’s Premium and Carer’s Allowance (for someone within the household) OR Attendance Allowance (for applicant or their partner) OR Industrial Injuries Benefit
LIMITED_CAPABILITY_FOR_WORK
In receipt of the limited capability for work element of Universal Credit
MATERNITY_EXEMPTION_CERTIFICATE
Hold a Maternity Exemption Certificate (MATEX)
MEDICAL_EXEMPTION_CERTIFICATE
Hold a Medical Exemption Certificate (MEDEX)
PERSONAL_INDEPENDENCE_PAYMENTS
In receipt of Personal Independence Payments (PIP)
PRESCRIPTION_CHARGES_EXEMPTION
Are exempt from prescription charges (only for customers in England) or hold a HC2 certificate
WAR_PENSION_EXEMPTION_CERTIFICATE
Hold a valid war pension NHS exemption certificate and the prescription is for your disability
Example
"PERSONAL_INDEPENDENCE_PAYMENTS"QualifyingCriteriaOptions
All of the qualifying criteria currently permitted for broader group applications.
Values
CHILD_TAX_CREDIT
In receipt of Child Tax Credit where the award statement shows a total annual household income of £19,978 or less (before tax and National Insurance)
COUNCIL_TAX_REDUCTION
In receipt of Council Tax Reduction (excludes the 25% single person’s discount)
EMPLOYMENT_AND_SUPPORT_ALLOWANCE
In receipt of Income-related Employment & Support Allowance (ESA)
HOUSING_BENEFIT
In receipt of Housing Benefit with a total annual household income of £19,978 or less (before tax and National Insurance)
INCOME_SUPPORT
In receipt of Income Support
JOB_SEEKERS_ALLOWANCE
In receipt of Income-based Job Seeker’s Allowance (JSA)
LOW_INCOME_THRESHOLD
A total annual household income of £19,978 or less (before tax and National Insurance)
SAVINGS_ELEMENT_OF_PENSION_CREDIT
In receipt of the Savings Element of Pension Credit only
UNIVERSAL_CREDIT
In receipt of universal credit, and has an earned income of between zero and £1,665 in at least one of the twelve preceding assessment periods
WORKING_TAX_CREDIT
In receipt of Working Tax Credit with a total annual household income of £19,978 or less (before tax and National Insurance)
Example
"SAVINGS_ELEMENT_OF_PENSION_CREDIT"QuotePaymentMethod
An enumeration.
Values
CREDITCARD
Credit card
DIRECTDEBIT
Direct Debit
ONRECEIPT
Pay on receipt of bill
PREPAYMENT
Prepayment
Example
"DIRECTDEBIT"QuotePaymentMethodChoices
An enumeration.
Values
CREDITCARD
DIRECTDEBIT
ONRECEIPT
PREPAYMENT
Example
"DIRECTDEBIT"RateTypeChoices
An enumeration.
Values
ECONOMY7
Economy7.
STANDARD
Standard.
THREE_RATE
Three-rate.
Example
"STANDARD"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
MONTH_INTERVAL
POINT_IN_TIME
Readings taken at a point in time.
QUARTER_INTERVAL
RAW_INTERVAL
Interval Readings as provided, may be variable in length.
THIRTY_MIN_INTERVAL
Readings taken in every 30 minute intervals.
WEEK_INTERVAL
Example
"RAW_INTERVAL"ReadingStatisticTypeEnum
The type of statistic for the reading interval.
Values
CARBON_COST
The estimated carbon cost of the interval.
CONSUMPTION_COST
The calculated cost of consumption for the interval.
GENERATION_VALUE
The calculated monetary value of generation 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"ReferralSchemeTypeChoices
An enumeration.
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
An enumeration.
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"SMETS2InterestReason
An enumeration.
Values
SMETS2_INTEREST_REASON_ALREADY_HAS_SMART_METER
Already has or is about to have a smart meter installed.
SMETS2_INTEREST_REASON_CANNOT_ATTEND_APPOINTMENT
Cannot attend appointment.
SMETS2_INTEREST_REASON_CANNOT_SEE_BENEFIT
Cannot see benefit.
SMETS2_INTEREST_REASON_DO_NOT_OWN_HOME
Doesn't own own home.
SMETS2_INTEREST_REASON_HOUSE_MOVE_IMMINENT
About to move house.
SMETS2_INTEREST_REASON_IS_LANDLORD
Is a landlord.
SMETS2_INTEREST_REASON_MORE_INFORMATION_REQUIRED
More information about smart meters required.
SMETS2_INTEREST_REASON_NEGATIVE_PUBLICITY
Negative publicity about smart meters.
SMETS2_INTEREST_REASON_PROPERTY_NOT_OCCUPIED
Property rarely or never occupied.
SMETS2_INTEREST_REASON_RTS_NO_LONGER_ONSITE
RTS No Longer Onsite.
SMETS2_INTEREST_REASON_RTS_NO_LONGER_USED
RTS No Longer Used.
SMETS2_INTEREST_REASON_SWITCH_IMMINENT
About to switch supplier.
SMETS2_INTEREST_REASON_TECHNOLOGY_SCEPTICAL
Sceptical of technology.
SMETS2_INTEREST_REASON_VULNERABILITY
Has vulnerability.
SMETS2_INTEREST_REASON_WAIT_UNTIL_IT_IS_COMPULSORY
Wants to wait until it's compulsory.
SMETS2_INTEREST_REASON_WORRIED_ABOUT_INSTALLATION
Worried about installation.
SMETS2_INTEREST_REASON_WORRIED_ABOUT_SMART_METERS
Worried about smart meters.
SMETS2_INTEREST_REASON_WORRIED_ABOUT_USAGE_COST
Worried about energy usage cost increasing.
SMETS2_INTEREST_REASON_WORRIED_HEALTH_SAFETY
Worried about health & safety.
SMETS2_INTEREST_REASON_WORRIED_SECURITY
Worried about security.
Example
"SMETS2_INTEREST_REASON_DO_NOT_OWN_HOME"SalesChannelChoices
An enumeration.
Values
ACQUISITION
AGGREGATOR
BROKER
DEBT_COLLECTION_AGENCY
DIGI_TELESALES
DIRECT
EVENTS
FIELD_SALES
GIFT_OF_KIT
HIGH_REFERRER
LANDLORD
MOVE_IN
NEW_TENANT
OCTOPUS_TRUSTED_PARTNERS
PARENT_POWER
PARTNERSHIPS
PEOPLE_POWER
PRICE_COMPARISON
SUPPLIER_OF_LAST_RESORT
TELESALES
WORKPLACE_POP_UP
WORKS_WITH_OCTOPUS
Example
"DIRECT"SavingSessionsAccountEventResultStatusChoices
An enumeration.
Values
CALCULATING
FAIL
MISSING_READINGS
PARTIAL_SUCCESS
SUCCESS
UPCOMING
Example
"CALCULATING"ScheduleType
An enumeration.
Values
BACS_TRANSFER
CARD_PAYMENT
DIRECT_DEBIT
PAYMENT_SLIP
Example
"BACS_TRANSFER"SettingAction
An option to override an action in a schedule whilst remaining in AUTO mode.
Values
SET_TEMPERATURE
TURN_OFF
TURN_ON
Example
"TURN_ON"SmartControlAction
The smart control action choices, i.e. suspend or unsuspend.
Values
SUSPEND
UNSUSPEND
Example
"SUSPEND"SmartDeviceAutoTopupTriggerFailureReasons
An enumeration.
Values
FAILED_TO_COLLECT_PAYMENT
FAILED_TO_TRIGGER_ADD_CREDIT_TO_METER
NO_IMPORT_METER
PAYMENT_NOT_SUCCESSFUL
Example
"NO_IMPORT_METER"SmartDeviceAutoTopupTriggerSources
An enumeration.
Values
LOW_CREDIT_BALANCE
Example
"LOW_CREDIT_BALANCE"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"SmartMeterInterestChoices
An enumeration.
Values
INTERESTED
We have captured that this account is interested in a SMETS2 meter. This does not mean they've booked an appointment.
NOT_AT_THE_MOMENT
We have captured that this account could be interested in a SMETS2 meter in the future, so it is appropriate to follow up with them.
NOT_INTERESTED
We have captured that this account is not interested in a SMETS2 meter. We should use this to avoid advertising SMETS2 meters to them, or contacting them about installing a SMETS2 meter.
PRIORITY
We have captured that this account is a priority for a SMETS2 meter. This does not mean they've booked an appointment.
Example
"PRIORITY"SmartMeterReadingFrequencyChoices
Meter reading frequency choices for smart meters.
Please note: these labels are exposed in the API documentation.
Values
DAILY
Daily
HALF_HOURLY
Half hourly
MONTHLY
Monthly
Example
"DAILY"SmartOnboardingEventType
An enumeration.
Values
AGREEMENTS_UPDATED
Agreements Updated.
CANCELLED
Onboarding cancelled.
COMPLETED
Onboarding completed.
DOCUMENTS_CHECKED
Documents Checked.
EXPORT_ENABLED_IN_KRAKEN
Export Enabled In Kraken.
EXPORT_METER_READING_AVAILABLE
Export Meter Reading Available.
EXPORT_MPAN_APPLIED_FOR
Export MPAN applied for.
EXPORT_MPAN_CREATED
Export MPAN created.
EXPORT_MPAN_NOT_FOUND
Export Mpan Not Found.
EXPORT_MPAN_ON_SUPPLY
Export MPAN is on supply.
FIRST_CREDIT_APPLIED
First Credit Applied.
FIT_RESOLUTION
FIT resolution.
INTELLIGENT_OCTOPUS_INSTALL_APP_EMAIL_SENT
Email to install Intelligent Octopus app installed.
INTELLIGENT_OCTOPUS_TEST_DISPATCH_COMPLETE
Test dispatch in app complete.
METER_EXCHANGE_BOOKED
Meter exchange date agreed.
METER_EXCHANGE_EMAIL_SENT
Email sent to book meter exchange.
METER_INSTALLED
Meter Installed.
METER_READINGS_AVAILABLE
Meter Readings Available.
MTD_UPDATED
MTDs updated.
NOTE_ADDED
Note Added.
PREVIOUS_AGREEMENT_BILLING_GAP_FILLED
Previous Agreement Billing Gap Filled.
STARTED
Onboarding started.
TARIFF_CHANGED_ON_METER
Tariff Changed On Meter.
TARIFF_SWITCH_CONFIRMATION_EMAIL_SENT
Email sent to confirm tariff switch.
TERMS_ACCEPTED
Customer accepted terms and conditions.
TERMS_EMAIL_SENT
Email sent to request terms acceptance.
UNABLE_TO_PROCEED
Unable To Proceed.
Example
"STARTED"SmartOnboardingTariffCodes
An enumeration.
Values
AGILE_OCTOPUS
Octopus Energy's Agile Octopus tariff
COSY_OCTOPUS
Octopus Energy's Cosy Octopus tariff
INTELLIGENT_FLUX
Octopus Energy's Intelligent Octopus Flux tariff
INTELLIGENT_OCTOPUS
Octopus Energy's Intelligent Octopus Go tariff
OCTOPUS_FLUX
Octopus Energy's Flux tariff
OCTOPUS_GO
Octopus Energy's Octopus Go tariff
OCTOPUS_GO_FASTER
Octopus Energy's Octopus Go Faster tariff
OCTOPUS_GO_GREEN
Octopus Energy's Octopus Go Green tariff
OUTGOING_AGILE
Octopus Energy's Octopus Agile tariff
OUTGOING_FIXED
Octopus Energy's Outgoing Fixed tariff
OUTGOING_VARIABLE
Octopus Energy's Outgoing Octopus tariff
POWERLOOP
Octopus Energy's Powerloop tariff
TESLA_IMPORT
Octopus Energy's Tesla Energy Plan import tariff
Example
"AGILE_OCTOPUS"SmartOnboardingTermsStatuses
An enumeration.
Values
TERMS_ACCEPTANCE_REQUIRED
Customer acceptance of T&Cs required
TERMS_ACCEPTED
T&Cs accepted
TERMS_EMAIL_SENT
Awaiting customer acceptance of T&Cs
Example
"TERMS_ACCEPTANCE_REQUIRED"Values
ACCEPTED_BY_METER
RESOLVED
UTRN_RECEIVED
UTRN_REQUESTED
Example
"UTRN_REQUESTED"Values
COMPLETED
FAILED
INITIATED
NOT_STARTED
PENDING
UTRN_MUST_BE_APPLIED_MANUALLY
Example
"NOT_STARTED"Songs
An enumeration.
Values
NO_SONG_PREFERRED
.
SONG_1938
"Auf Wiederseh’n Sweetheart" by Vera Lynn.
SONG_1939
"I Believe" by Frankie Laine.
SONG_1940
"Secret Love" by Doris Day.
SONG_1941
"Rose Marie" by Slim Whitman.
SONG_1942
"I’ll Be Home" by Pat Boone.
SONG_1943
"Diana" by Paul Anka.
SONG_1944
"Jailhouse Rock" by Elvis Presley.
SONG_1945
"Living Doll" by Cliff Richard.
SONG_1946
"It’s Now or Never" by Elvis Presley.
SONG_1947
"Wooden Heart" by Elvis Presley.
SONG_1948
"I Remember You" by Frank Ifield.
SONG_1949
"She Loves You" by The Beatles.
SONG_1950
"Can’t Buy Me Love" by The Beatles.
SONG_1951
"Tears" by Ken Dodd.
SONG_1952
"Green, Green Grass of Home" by Tom Jones.
SONG_1953
"Release Me" by Engelbert Humperdinck.
SONG_1954
"Hey Jude" by The Beatles.
SONG_1955
"Sugar, Sugar" by The Archies.
SONG_1956
"The Wonder of You" by Elvis Presley.
SONG_1957
"My Sweet Lord" by George Harrison.
SONG_1958
"Amazing Grace" by The Royal Scots Dragoon Guards Band.
SONG_1959
"Tie a Yellow Ribbon Round the Ole Oak Tree" by Dawn.
SONG_1960
"Tiger Feet" by Mud.
SONG_1961
"Bye Bye Baby" by Bay City Rollers.
SONG_1962
"Save Your Kisses for Me" by Brotherhood of Man.
SONG_1963
"Mull of Kintyre" / "Girls’ School" by Wings.
SONG_1964
"Rivers of Babylon" / "Brown Girl in the Ring" by Boney M.
SONG_1965
"Bright Eyes" by Art Garfunkel.
SONG_1966
"Don’t Stand So Close to Me" by The Police.
SONG_1967
"Don’t You Want Me" by The Human League.
SONG_1968
"Come On Eileen" by Dexys Midnight Runners.
SONG_1969
"Karma Chameleon" by Culture Club.
SONG_1970
"I Just Called To Say I Love You" by Stevie Wonder.
SONG_1971
"The Power of Love" by Jennifer Rush.
SONG_1972
"Don’t Leave Me This Way" by The Communards.
SONG_1973
"Never Gonna Give You Up" by Rick Astley.
SONG_1974
"The Only Way Is Up" by Yazz.
SONG_1975
"Ride On Time" by Black Box.
SONG_1976
"Unchained Melody" by The Righteous Brothers.
SONG_1977
"Everything I Do I Do It for You" by Bryan Adams.
SONG_1978
"I Will Always Love You" by Whitney Houston.
SONG_1979
"I’d Do Anything for Love (But I Won’t Do That)" by Meat Loaf.
SONG_1980
"Love Is All Around" by Wet Wet Wet.
SONG_1981
"Unchained Melody" by Robson & Jerome.
SONG_1982
"Killing Me Softly" by Fugees.
SONG_1983
"Candle in the Wind 1997" / "Something About the Way You Look Tonight" by Elton John.
SONG_1984
"Believe" by Cher.
SONG_1985
"...Baby One More Time" by Britney Spears.
SONG_1986
"Pure Shores" by All Saints.
SONG_1987
"It Wasn’t Me" by Shaggy featuring Rikrok.
SONG_1988
"Anything Is Possible" / "Evergreen" by Will Young.
SONG_1989
"Where Is the Love?" by The Black Eyed Peas.
SONG_1990
"Call On Me" by Eric Prydz.
SONG_1991
"Is This the Way to Amarillo" by Tony Christie featuring Peter Kay.
SONG_1992
"Crazy" by Gnarls Barkley.
SONG_1993
"Bleeding Love" by Leona Lewis.
SONG_1994
"Hallelujah" by Alexandra Burke.
SONG_1995
"Poker Face" by Lady Gaga.
SONG_1996
"Just The Way You Are" by Bruno Mars.
SONG_1997
"Someone Like You" by Adele.
SONG_1998
"Somebody That I Used to Know" by Gotye featuring Kimbra.
SONG_1999
"Get Lucky" by Daft Punk.
SONG_2000
"Happy" by Pharrell Williams.
SONG_2001
"Uptown Funk" by Mark Ronson featuring Bruno Mars.
SONG_2002
"7 Years" by Lukas Graham.
SONG_2003
"Shape of You" by Ed Sheeran.
SONG_hold_music_4_33_silence
Silence.
SONG_hold_music_holding_firm
Relaxing: Holding Firm by Dan Phillipson.
Example
"NO_SONG_PREFERRED"State
An enumeration.
Values
AP_MODE
BLE_MODE
EMERGENCY_MODE
FACTORY_RESTORE
FAULT_MODE
NORMAL_MODE
SETUP
Example
"NORMAL_MODE"StatementReversalsAfterClose
An enumeration.
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"Status
An enumeration.
Values
APPROVED
Approved
APPROVED_CUSTOMER_SERVICE_GESTURE
Approved (customer service gesture)
AWAITING_AUDIT
Awaiting audit
AWAITING_CUSTOMER_EVIDENCE
Awaiting customer evidence
PENDING
Pending
REJECTED
Rejected
WITHDRAWN
Withdrawn
Example
"PENDING"TaxUnitType
The dimension of the tax rate.
e.g. a sales tax is a PROPORTION tax with a rate of 0.25, CCL is a CURRENCY_PER_KWH tax
with a value of 0.5.
Values
CURRENCY_PER_KWH
PROPORTION
Example
"PROPORTION"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"TransactionTypeFilter
Transaction types which will be included or excluded, depending on the input argument.
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.
ISSUED_TRANSACTIONS
For filtering/excluding issued transactions.
WATER_CHARGES
For filtering/excluding water charge transactions.
Example
"ISSUED_TRANSACTIONS"TypeOfVoiceCampaign
The type of campaign, e.g. preview or predictive.
Values
PREDICTIVE
PREVIEW
Example
"PREVIEW"WANCoverageStrengths
An enumeration.
Values
HIGH
WAN coverage for this postcode is high quality.
LOW
WAN coverage for this postcode is low quality.
MEDIUM
WAN coverage for this postcode is medium quality.
Example
"HIGH"WorkCategory
Categories of work that a Siteworks appointment is booked for.
Values
ACCURACY_TEST
Accuracy Test.
BRACKET_INSTALLATION
Bracket Installation.
COMMISSION
Commission.
COMMS_HUB_POWER_CYCLE
Comms Hub Power Cycle.
COMMS_HUB_REPLACEMENT
Comms Hub Replacement.
CONFIRM_METER_DETAILS
Confirm Meter Details.
DE_ENERGISE
De Energise.
ENERGISE
Energise.
EXCHANGE
Exchange.
IHD_INSTALL
Ihd Install.
INVESTIGATE_FAULT
Investigate Fault.
ISOLATOR_SWITCH_INSTALL
Isolator Switch Install.
METER_TAILS_UPGRADE
Meter Tails Upgrade.
MOVE
Move.
NEW_CONNECTION
New Connection.
REINSTALL
Reinstall.
REMOVE
Remove.
REPLACE_SEALS
Replace Seals.
Example
"EXCHANGE"