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
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_ASSIGN_METERING_COORDINATOR_STEP_ERRORED
FIELDWORKS_ASSIGN_METERING_COORDINATOR_STEP_FAILED
FIELDWORKS_ASSIGN_METERING_PROVIDER_STEP_ERRORED
FIELDWORKS_ASSIGN_METERING_PROVIDER_STEP_FAILED
FIELDWORKS_BULK_DEPLOYMENT_JOURNEY_AUTO_CANCELLED
FIELDWORKS_CHANGE_RETAILER_ERRORED
FIELDWORKS_CHANGE_RETAILER_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_REQUEST_CUSTOMER_CLASSIFICATION_STEP_ERRORED
FIELDWORKS_REQUEST_CUSTOMER_CLASSIFICATION_STEP_FAILED
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_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_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
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
SOLR_FINAL_BILL_REMINDER
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"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"BrandChoices
An enumeration.
Values
OCTOPUS_ENERGY_GERMANY
Octopus Energy Germany.
Example
"OCTOPUS_ENERGY_GERMANY"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"Values
APPROVED
CANCELLED
CLEARED
FAILED
HELD_FOR_REVIEW
NONE
PENDING
REQUESTED
SCHEDULED
Example
"APPROVED"CollectionCampaignType
An enumeration.
Values
OFF_SUPPLY
OFF_SUPPLY_ELEC
OFF_SUPPLY_GAS
ON_SUPPLY
ON_SUPPLY_ELEC
ON_SUPPLY_GAS
Example
"ON_SUPPLY_GAS"CommsDeliveryPreference
The method the account has specified they prefer we contact them
Values
POSTAL_MAIL
Example
"EMAIL"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
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"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"Eligibility
An enumeration.
Values
BUSINESS_ACCOUNT
CAPPED_CATCHMENT
ELIGIBLE
HAS_SMART_TARIFF
INCORRECT_READ_PERMISSION
INVALID_CATCHMENT
NO_ACTIVE_AGREEMENTS
NO_RECENT_READING
NO_SMART_METER
ONBOARDING_TO_SMART_TARIFF
Example
"ELIGIBLE"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"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.
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_BLACKHOLE_EMAIL
Scope that enables account user to update their blackhole email address.
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"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"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"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"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"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"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"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"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"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.
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_BLACKHOLE_EMAIL
Scope that enables account user to update their blackhole email address.
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"ProductAvailabilityStatus
An enumeration.
Values
PUBLIC
No restrictions
RESTRICTED
Restricted
Example
"PUBLIC"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
TESLA
VP_AMAZON
VP_HONEYWELL_CC
VP_HONEYWELL_RES
VP_NEST
Example
"DAIKIN"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
The frequency of the reading.
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"ReadingOrigin
An enumeration.
Values
BACKOFFICE
Backoffice.
CUSTOMER
Customer.
KRAKEN
Kraken.
METER_OPERATOR
Meter operator.
NETWORK_OPERATOR
Network operator.
PREVIOUS_PROVIDER
Previous provider.
THIRD_PARTY
Third party.
Example
"CUSTOMER"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"RetentionQuoteSupplyTypeChoices
Enum of allowable supply types for retention quotes
Values
ELECTRICITY
GAS
Example
"ELECTRICITY"SalesChannelChoices
An enumeration.
Values
ACQUISITION
AGGREGATOR
BROKER
DEBT_COLLECTION_AGENCY
DEFAULT_SUPPLY
DIGI_TELESALES
DIRECT
EVENTS
FIELD_SALES
GIFT_OF_KIT
HIGH_REFERRER
LANDLORD
MOVE_IN
NEW_TENANT
PARENT_POWER
PARTNERSHIPS
PEOPLE_POWER
PRICE_COMPARISON
SUPPLIER_OF_LAST_RESORT
TELESALES
WORKPLACE_POP_UP
WORKS_WITH_OCTOPUS
Example
"DEFAULT_SUPPLY"ScheduleType
An enumeration.
Values
BACS_TRANSFER
CARD_PAYMENT
DIRECT_DEBIT
PAYMENT_SLIP
Example
"BACS_TRANSFER"SmartControlAction
The smart control action choices, i.e. suspend or unsuspend.
Values
SUSPEND
UNSUSPEND
Example
"SUSPEND"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
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"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.
Example
"ISSUED_TRANSACTIONS"TypeOfRead
An enumeration.
Values
BILLING
Billing.
ESTIMATE
Estimate.
INTERIM
Interim.
METER_INSTALLED
Meter installed.
METER_REMOVED
Meter removed.
MOVE_IN
Move in.
MOVE_OUT
Move out.
REGISTER_END
Register end.
REGISTER_START
Register start.
Example
"METER_INSTALLED"