Enums
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.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
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_SENT
The email messages that were sent by the account.
EMAIL_RECEIVED
The email messages that were received by the account.
MARKETING_EMAIL_SENT
The marketing email messages that were sent by the account.
PRINT_SENT
The print messages that were sent to the print partner by the account.
PRINT_FAILED
The print messages that failed to be delivered.
PRINT_RETURNED
The print messages that were returned to sender.
PRINT_CANCELLED
The print messages that were cancelled.
PRINT_SUCCEEDED
The print messages that were sent by the print partner.
SMS_SENT
The SMS messages that were sent by the account.
SMS_RECEIVED
The SMS messages that were received by the account.
PUSH_NOTIFICATION_SENT
The push notification messages that were sent by the account.
Example
"EMAIL_SENT"AccountPaymentStatusOptions
The current status of the payment. Note: REQUESTED payments are excluded by default.
Values
SCHEDULED
The payment has been scheduled for collection and the customer has been notified. While a payment is scheduled, it can still be deleted.
PENDING
The payment has been submitted. From this point it cannot be altered.
CLEARED
The payment has been approved by the merchant and added to your Kraken account.
FAILED
The payment failed permanently.
PROMISED
A payment promise has been created, but it has not left the customers bank account.
FULFILLED
The payment has been made successfully and applied to the Kraken balance.
PROMISE_BROKEN
The payment promise has been broken.
HISTORIC
Payments made in a previous system and then imported into Kraken.
THIRD_PARTY
Third Party payments are those recorded for financial purposes in a different system but should be added to statements.
REQUESTED
The initial state of a payment in Kraken. It should be scheduled with a payment vendor in the future.
DELETED
This payment was deleted. From this point it cannot be altered.
Example
"SCHEDULED"AccountPaymentTransactionTypeChoices
An enumeration.
Values
DD_FIRST_COLLECTION
DD_REGULAR_COLLECTION
DD_RE_PRESENTATION
DD_FINAL_COLLECTION
CREDIT_CARD
DEBIT_CARD
PREPAID_CARD
AGENCY
AUSTRALIA_POST
BACS_DEPOSIT
BPAY
BPOINT
BRISTOL_POUND
BTRE
CASH
CENTREPAY
CHEQUE
DESKTOP_DEPOSIT
EAPA_VOUCHER
EBOX
EFT
ERRONEOUS_PAYMENT
FUEL_DIRECT
HEEAS
IVR
MONEYGRAM
PAYPAL
SERVICE_TICKET
SOCIAL_WELFARE_PAYMENT
TELPAY
TRANSFER_FROM_SAP
URGS
WALMART_CASH
PAYPOINT_CASH
PAYPOINT_CARD
PAYPOINT_CHEQUE
ALLPAY_CASH
ALLPAY_CARD
ALLPAY_CHEQUE
PAYZONE
DWP
POST_OFFICE_CASH
POST_OFFICE_CHEQUE
POST_OFFICE_SAVINGS_STAMPS
POST_OFFICE_CARD
DCA_COLLECTION
PREPAY_KEY
PREPAY_CARD
PREPAY_TOKEN
PREPAY_SMART
PAYMENT_FEE
FAILED_REPAYMENT_REVERSAL
KONBINI
PAGOPA_NOTICE
IDEAL
UNKNOWN
Example
"DD_FIRST_COLLECTION"AccountReminderTypes
Contains reminder type choices for all territories.
Values
AD_HOC
GBR_ADD_PHOTO_TO_METER_READING
GBR_GET_PHOTO_OF_METER_AND_CALL_SUPPLIER
GBR_RAISE_DISPUTE
GBR_VERIFY_MHHS_MESSAGE
JPN_MULTIPLE_VALID_REFERRALS
JPN_FAILED_TO_SEND_SMS_FOR_BILLING_INFO
JPN_FAILED_TO_SEND_SMS_FOR_CONVENIENCE_STORE_PAYMENT
JPN_SWITCH_IN_SCHEDULE_OVERLAP
ITA_ACCOUNT_WITHDRAWN_WITHOUT_NOTIFICATION
ITA_PROCESS_WELCOME_PACK_STEP
AUS_EMBEDDED_CHILD_NMIS
FOLLOW_UP_PAYMENT_PROMISE
DUNNING_REMINDER
WITHDRAWAL_RECEIVED
CHURN_PREVENTION
PLANNED_INTERRUPTION
PLANNED_INTERRUPTION_MEDICAL_DEPENDENCY
MOVE_IN_MOVE_OUT_MANUAL_PROCESS
MOVE_IN_CES_LIFE_SUPPORT_REQUIRED
MOVE_IN_DEFAULT_PAYMENT_SCHEDULE_FAILED
CANCEL_MOVE_OUT_UNABLE_TO_REINSTATE_FUTURE_AGREEMENTS
COS_GAIN
COS_LOSS
MOVE_IN
MOVE_OUT
AMPERAGE_CHANGE
CUSTOMER_DETAILS_CHANGE
BILLING
INDUSTRY_CUSTOMER_TRANSFER_DELAYED
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_REJECTED
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_OBJECTED
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_CONFLICTING_PERIOD
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_REJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_CANCELLED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTION_MISSING_ACK
INDUSTRY_EXCEPTION_CHANGE_REQUEST_WITHDRAWAL_REJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTION_REJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTION_WITHDRAWAL_REJECTED
INDUSTRY_EXCEPTION_UNABLE_TO_PROCESS_ROLR
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_GAIN_COMPLETION_OVERDUE
INDUSTRY_EXCEPTION_CHANGE_REQUEST_CANCELLATION_FAILED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_UNABLE_TO_WITHDRAW
INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_REQUEST_REJECTED
INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_NOTIFICATION_REJECTED
INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_NOTIFICATION_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_MANUAL_CUSTOMER_DETAILS_NOTIFICATION_REQUIRED
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_MISSING_MANDATORY_FIELDS
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_INVALID_BILLING_ADDRESS
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_REQUEST_SPECIAL_REASON
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_REQUEST_REJECTED
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_REQUEST_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_REJECTED
INDUSTRY_EXCEPTION_LIFE_SUPPORT_MULTIPLE_ACCOUNTS_MATCHES
INDUSTRY_EXCEPTION_LIFE_SUPPORT_MULTIPLE_LIFE_SUPPORT_CONTACT_MATCHES
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_FAILED_TO_SEND
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_UNKNOWN_CONTACT
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_INVALID_PHONE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_INVALID_CONTACT_METHOD
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_RECEIVED_FROM_NON_REGISTRATION_OWNER
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_CONTAINS_UNEXPECTED_DATA
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_REJECTED
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_REJECTED
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_MISSING_LIFE_SUPPORT_NOTIFICATION
INDUSTRY_EXCEPTION_LIFE_SUPPORT_CONTACT_USER_REMOVED_FROM_ACCOUNT
INDUSTRY_MANUAL_LIFE_SUPPORT_NOTIFICATION_REQUIRED
INDUSTRY_VIC_DRO_MANUAL_LIFE_SUPPORT_EXTENSION_REQUEST
INDUSTRY_EXCEPTION_FAILED_TO_CANCEL_DEENERGISATION_SERVICE_ORDER
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_ENROLMENT_CANNOT_CALCULATE_MOVE_IN_READING
INDUSTRY_EXCEPTION_HOUSE_MOVE_OUT_CANNOT_CALCULATE_MOVE_OUT_READING
INDUSTRY_EXCEPTION_METER_POINT_ENROLMENT_INCOMPLETE_COULD_NOT_SEND_SERVICE_ORDER
INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_INCOMPLETE_COULD_NOT_SEND_CHANGE_REQUEST
INDUSTRY_EXCEPTION_RELINKING_OCCURRED_DURING_SDR_SYNC
INDUSTRY_SEND_LIFE_SUPPORT_DE_REGISTRATION_FORM
INDUSTRY_LIFE_SUPPORT_MANUAL_BEST_ENDEAVOUR_REQUIRED
INDUSTRY_LIFE_SUPPORT_REVIEW_DEREGISTRATION
INDUSTRY_LIFE_SUPPORT_REVIEW_POST_DEREGISTRATION_COMMS
INDUSTRY_LIFE_SUPPORT_REVIEW_POST_DEREGISTRATION
INDUSTRY_LIFE_SUPPORT_CANCEL_DEREGISTRATION_FAILED
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_UNABLE_TO_CREATE_RECORD
INDUSTRY_CHANGE_OF_SUPPLIER_DOUBLE_GAIN
INDUSTRY_METER_POINT_MISSING_CUSTOMER_CLASSIFICATION
SERVICE_ORDER_ACKNOWLEDGEMENT_OVERDUE
SERVICE_ORDER_INITIAL_RESPONSE_OVERDUE
SERVICE_ORDER_NOT_COMPLETED
SERVICE_ORDER_CANCELLATION_REQUEST_REJECTED
SERVICE_ORDER_PARTIALLY_COMPLETED
SERVICE_ORDER_UNABLE_TO_CHARGE
SERVICE_ORDER_REQUEST_REJECTED
SERVICE_ORDER_UNSOLICITED_RECEIVED
SERVICE_ORDER_UNSOLICITED_RECEIVED_DEENERGISED_METER_POINT
SERVICE_ORDER_FAILED
SERVICE_ORDER_CANCELLATION_FAILED
SERVICE_ORDER_OTHER_JOB_ENQUIRY_CODE
SMARTFLEX_DEVICE_INTEGRATION_POSTPONED
SPECIAL_READ_FAILED
SPECIAL_READ_CANCELLATION_FAILED
SPECIAL_READ_OUTSTANDING
SPECIAL_READ_WITH_ESTIMATE_READ_RECEIVED
NETWORK_TARIFF_ONE_WAY_NOTIFICATION
METER_EXCHANGE_ONE_WAY_NOTIFICATION
METER_FAULT_AND_ISSUE_ONE_WAY_NOTIFICATION_REJECTED
NOTICE_OF_METERING_WORKS_ONE_WAY_NOTIFICATION
COMMERCIAL_ENERGISATION_INTERVENTION_REQUIRED
PPA_EXPORT_INTERVENTION_REQUIRED
ACCOUNT_COOL_OFF
PLANNED_INTERRUPTION_ONE_WAY_NOTIFICATION
PLANNED_INTERRUPTION_ONE_WAY_NOTIFICATION_REJECTED
PLANNED_INTERRUPTION_NOTIFICATION_SENT_TO_LIFE_SUPPORT_CUSTOMER
FIELDWORKS_ALLOCATE_NMI_MARKET_PARTICIPANTS_NOT_SET
FIELDWORKS_BULK_DEPLOYMENT_JOURNEY_AUTO_CANCELLED
FIELDWORKS_METER_FAULT_JOURNEY_AUTO_CANCELLED
FIELDWORKS_MULTIPLE_OPEN_JOURNEYS_FOR_METER_POINT
FIELDWORKS_UPLOAD_ATTACHMENT_TO_JEMENA_PORTAL
FIELDWORKS_OBTAIN_SUPPLY_ABOLISHMENT_APPROVAL
FIELDWORKS_JOURNEY_CANCELLED_DUE_TO_LIFE_SUPPORT_REGISTRATION
FIELDWORKS_MIRN_DISCOVERY_FAILED
FIELDWORKS_SERVICE_ORDER_PARTIALLY_COMPLETED
FIELDWORKS_SERVICE_ORDER_FAILED
FIELDWORKS_PAYER_CONTACT_FAILED_VALIDATION
COS_GAIN_REL_RETRIEVAL_FAILURE
INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_INVALID_NMI_METER_STATUS
FIELDWORKS_JOURNEY_ATTACHMENTS
FIELDWORKS_SERVICE_ORDER_ATTACHMENTS
FIELDWORKS_SERVICE_ORDER_COMPLETED
FIELDWORKS_SERVICE_ORDER_UNABLE_TO_ACCESS_WITH_CUSTOMER_CONSULTATION
FIELDWORKS_SERVICE_ORDER_UNABLE_TO_ACCESS_WITHOUT_CUSTOMER_CONSULTATION
FIELDWORKS_MOVE_OUT_CANCELLED_WHILE_SUPPLY_ABOLISHMENT_IN_PROGRESS
FIELDWORKS_SUPPLY_PERIOD_DOES_NOT_EXIST_FOR_METERPOINT
FIELDWORKS_METERPOINT_IS_NOT_ACTIVE
FIELDWORKS_EXPECTED_METER_POINT_NOT_CREATED
FIELDWORKS_NEW_CONNECTION_DATA_NOT_VALID
FIELDWORKS_NEW_CONNECTION_COMPLETION_REVIEW
FIELDWORKS_EXPECTED_METER_READ_NOT_RECEIVED
FIELDWORKS_EXPECTED_NTCS_NOT_RECEIVED
FIELDWORKS_CONTACT_SO_RECIPIENT_TO_UPDATE_THE_SO_DETAILS
FIELDWORKS_INVESTIGATE_WHETHER_JOURNEY_NEEDS_CONTINUATION
FIELDWORKS_CHANGE_REQUEST_STEP_FAILED
FIELDWORKS_CHANGE_REQUEST_STEP_ERRORED
FIELDWORKS_SERVICE_ORDER_STEP_FAILED
FIELDWORKS_SERVICE_ORDER_STEP_ERRORED
FIELDWORKS_OBTAIN_CUSTOMER_APPROVAL_BEFORE_PROGRESSING
FIELDWORKS_MANUALLY_COMPLETE_CUSTOMER_MOVE_IN
FIELDWORKS_ACCOUNT_CREATED_WITH_NO_EMAIL_ADDRESS
FIELDWORKS_MAINTAIN_REGISTER_BILLABLE_OVERRIDE_FOR_UNSOLICITED_METER_CHANGES
AUS_EMBEDDED_WATER_READING_FAILURE
AUS_EMBEDDED_ACQUISITION_MATRIX_ERROR
AUS_VIC_SHAREDFUSE_NOTIFICATION
AUS_INDUSTRY_CUSTOMER_OWN_READING_NOT_SENT
JPN_READINGS_NOT_RECEIVED
JPN_FINAL_READING_OUTSIDE_AGREEMENT
JPN_CONFIRMATION_OF_RELOCATION
JPN_BILLING_FIX_INVALID_CHARGE_DATA
DUNNING_OUTBOUND_REMINDER_CALL
DUNNING_BEST_ENDEAVOURS_CALL
DUNNING_DISCONNECTION_OUTBOUND_REMINDER_CALL
DUNNING_DISCONNECTION_DE_ENERGISATION_ASSESSMENT
DUNNING_MANDATORY_NOTICE_EMAIL_FAILURE
DUNNING_DISCONNECTION_MANDATORY_NOTICE_EMAIL_FAILURE
DUNNING_VACANT_CONSUMPTION_DE_ENERGISATION_ASSESSMENT
DUNNING_REMINDER_CALL
DUNNING_REMINDER_DISCONNECTION_APPLICATION
DUNNING_REMINDER_PAYMENT_MADE
DUNNING_REMINDER_FUTURE_PAYMENT
NON_ENERGY_PAYMENT_CALL_REMINDER
PAYMENTS_FAILED_REPAYMENT
PAYMENT_PLAN
PAYMENT_PLAN_MISSED_INSTALMENT
ACTIVATE_PAYMENT_CANCELLATION_STOPPED
POST_HARDSHIP_CANCELLATION
PAYMENT_PLAN_HARDSHIP_COMPLETION
PAYMENT_PLAN_HARDSHIP_COMPLETION_WORKFLOW_CANCELLED
HARDSHIP_GRADUATION_ASSESSMENT
HARDSHIP_REMOVAL_ASSESSMENT
AUS_CENTREPAY_EXCESSIVE_CREDIT
PAYMENT_INSTRUCTION_FAILED
PAYMENT_SCHEDULE_FAILED_TO_CREATE
HARDSHIP_NO_PAYMENT_PLAN
DISCONNECTION_MANDATORY_NOTICE_EMAIL_FAILURE
DISCONNECTION_MANDATORY_NOTICE_SMS_FAILURE
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_TERMINATE
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_CREATE
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_UPDATE
MARKET_SUPPLY_EXCEPTION_MISSING_ACCOUNT_QUOTED_PRODUCT
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_REVERSE_TERMINATION
GAS_EXCEPTION_SITE_ACCESS_DETAILS_RECEIVED_FOR_NON_EXISTENT_METER
GAS_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_FAILED
GAS_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_FAILED
GAS_EXCEPTION_SITE_ACCESS_DETAILS_NOTIFICATION_FAILED
GAS_EXCEPTION_SITE_ADDRESS_DETAILS_NOTIFICATION_FAILED
GAS_EXCEPTION_METER_DATA_VERIFY_REQUEST_FAILED
GAS_EXCEPTION_METER_DATA_VERIFY_RESPONSE_OVERDUE
GAS_EXCEPTION_METER_DATA_VERIFY_RESPONSE_NO_CHANGE_WITH_EXPLANATION
GAS_EXCEPTION_METER_DATA_VERIFY_RESPONSE_WITHOUT_REVISED_READ
GAS_NOTIFICATION_CHANGE_OF_SITE_ADDRESS
INDUSTRY_EXCEPTION_NEXT_SCHEDULED_READ_DATE_TOO_FAR_IN_FUTURE
GAS_EXCEPTION_CUSTOMER_TRANSFER_REJECTED
GAS_MANUAL_SERVICE_ORDER_REQUIRED_FOR_ENROLMENT
GAS_UNKNOWN_CUSTOMER_CLASSIFICATION_CODE_RECEIVED
BILLING_AMENDED_METER_READ_BASIC
BILLING_AMENDED_METER_READ_GAS
BILLING_AMENDED_METER_READ_INTERVAL
BILLING_AMENDED_METER_READ_PRE_MIGRATION
BILLING_AMENDED_METER_READ_CES_ELEC_BASIC
BILLING_AMENDED_METER_READ_CES_ELEC_INTERVAL
BILLING_REGISTER_REPLACED_OR_REMOVED
BILLING_CUSTOMER_SELF_READ_RECEIVED
BILLING_MISSING_READ
SA_CONCESSION_STATEMENT_CLOSED
BILLING_QUOTED_NTC_DOES_NOT_ALIGN
FINAL_BILLING_UNABLE_TO_BILL
MANDATORY_COMMS_NOT_DELIVERED
CONTRACT_COMMS_NOT_DELIVERED
MOVE_IN_COMMS_NOT_DELIVERED
SMART_METER_MODE_CHANGE_UNSUPPORTED
HELD_STATEMENT
HELD_BILLING_DOCUMENT
AUTOMATED_BILLING_DISABLED
ASSIGNED_TO_CREDIT_TEAM
WORKFLOW_STEP_FAILED
WORKFLOW_STEP_ERRORED
WORKFLOW_CANCELLATION_FAILED
COS_GAIN_MIGRATION_ECOES_METER_MISMATCH
ACCOUNT_MIGRATION_SYNC_XOSERVE_METER_MISMATCH
SMART_CHANGE_OF_TENANCY_IN_PROGRESS
AGREEMENT_REVOKED
UNSUPPORTED_PAYMENT_DAY
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_LOST_OR_LOSING
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_RECEIVED_LIFE_SUPPORT_NOTIFICATION
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_RECEIVED_DANGEROUS_LIFE_SUPPORT_NOTIFICATION
EMBEDDED_NETWORK_EXCEPTION_DISTRIBUTOR_OWNED_PARENT_LIFE_SUPPORT_RECORD
EMBEDDED_NETWORK_ALL_CHILD_LIFE_SUPPORT_RECORDS_ARE_DEREGISTERED
SCHEDULED_BILLING_ADDRESS_UPDATE
SCHEDULED_OCCUPIER_PACK_SEND
PROPERTY_ADDRESS_NEEDS_UPDATE
FRA_ACTIVATION_PROCESS_INCEPTION_CHECKS
FRA_ACTIVATION_PROCESS_SCHEDULE_SITEWORKS
FRA_ACTIVATION_PROCESS_GAS_PROVIDER_CHANGE_REQUEST
FRA_ACTIVATION_PROCESS_PRM_ELIGIBILITY
FRA_ACTIVATION_PROCESS_AWAITING_SWITCH_READINGS
FRA_ELEC_ACTIVATION_PROCESS_WRONG_SWITCH_READINGS_FOR_PROVIDER_CALENDAR_TEMPORAL_CLASSES
FRA_ACTIVATION_PROCESS_COMMANDER_SOUSCRIPTION
FRA_ACTIVATION_PROCESS_AWAITING_SWITCH_IN_CONFIRMATION
FRA_TERMINATION_REQUEST_ERRORED
FRA_TERMINATION_PROCESS_NEEDS_INTERVENTION
FRA_ENERGY_CHEQUE_UNKNOWN
COMMS_TO_BE_PRINTED
FLOW_FILE_ERROR
NEW_PSR_ADDED_TO_PREPAY_ACCOUNT
PSR_IMPORT_COULD_NOT_IDENTIFY_ACCOUNT_USER
MAIL_RETURNED
MAIL_FAILED
DUPLICATE_CARD_FINGERPRINTS
WATER_METER_READING_ISSUE
WATER_ACCOUNT_REVERSION
DEU_SWICHTING_PROCESS_FAILED
DEU_METER_READINGS
DEU_MASTER_DATA_SYNCHRONISATION
DEU_MASTER_DATA_UPDATE
DEU_INBOUND_APERAK
FAMILY_ISSUES_ADDED
MIGRATION_TYPE
FIELDWORKS_APPOINTMENTS_UNAVAILABLE
COLLECTION_PROCESS_COMMS_FAILURE
Example
"AD_HOC"AccountRepaymentStatusOptions
An enumeration.
Values
REQUESTED
The request for a repayment has been received but not actioned yet.
APPROVED
The repayment has been approved but not made yet.
SUBMITTED
The payment has been submitted to the merchant. It is still possible for this repayment to fail.
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.
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.
THIRD_PARTY
Third Party payments are those recorded for financial purposes in a different system but should be added to statements.
HISTORIC
Payments made in a previous system and then imported into Kraken.
Example
"REQUESTED"AccountStatementStatus
Status of account statement (OPEN or CLOSED).
Values
OPEN
CLOSED
Example
"OPEN"Values
PENDING
A pending account is one that has been created but no registrations have started.
INCOMPLETE
Account requires processes to be completed before supply can be set up
WITHDRAWN
Withdrawn before supply started
ACTIVE
Supply could have started, be ongoing or ended.
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.
DORMANT
Dormant. Users should not be able to log into dormant accounts.
VOID
Void. Account created in error.
Example
"PENDING"AccountStatusChoices
An enumeration.
Values
PENDING
A pending account is one that has been created but no registrations have started.
INCOMPLETE
Account requires processes to be completed before supply can be set up
WITHDRAWN
Withdrawn before supply started
ACTIVE
Supply could have started, be ongoing or ended.
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.
DORMANT
Dormant. Users should not be able to log into dormant accounts.
Example
"PENDING"AccountTypeChoices
An enumeration.
Values
BUSINESS
An account designed to supply/bill business premises.
BUSINESS_OCCUPIER
An account created when we supply a business premises but do not have details for the occupants.
BUSINESS_THIRD_PARTY_BILLED
An account designed to supply/bill business premises where the bill is sent to a third party.
BUSINESS_VACANT
An account created when we supply a business premises and know there are definitely no occupants.
DOMESTIC
An account designed to supply/bill domestic premises.
DOMESTIC_THIRD_PARTY_BILLED
An account designed to supply/bill domestic premises where the bill is sent to a third party.
MANAGED
An account created when we supply domestic premises that are managed by a business, i.e., a B2B2C model.
OCCUPIER
An account created when we supply a domestic premises but do not have details for the occupants.
PORTFOLIO_LEAD
An account which is responsible for all other accounts in the portfolio, i.e. pays the bills for them.
SUPPLY_POINT
An account that represents the relationship between a supply point and a supplier.
VACANT
An account created when we supply a domestic premises and know there are definitely no occupants.
Example
"BUSINESS"AchievedCarbonIndexChoices
An enumeration.
Values
VERY_LOW
LOW
MODERATE
HIGH
VERY_HIGH
Example
"VERY_LOW"AchievedRegionalCarbonIndexChoices
An enumeration.
Values
VERY_LOW
LOW
MODERATE
HIGH
VERY_HIGH
Example
"VERY_LOW"AddressFieldTypeEnum
Input widget type for a single address field.
Values
TEXT
TEXTAREA
SELECT
NUMBER
HIDDEN
Example
"TEXT"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.
TERMINATION_REQUESTED
The contracts for which termination has been requested by the supplier.
TERMINATED
The contracts that have been terminated.
Example
"ACCEPTED"AgreementRescissionStatus
Status of an agreement rescission.
Values
IN_PROGRESS
REJECTED
ERRORED
COMPLETED
Example
"IN_PROGRESS"AgreementRolloverRolloverType
An enumeration.
Values
DEFAULT
Default Rollover
CUSTOM
Custom Renewal
EXTENSION
Custom Extension
CUSTOMER_REQUESTED
Customer Requested
Example
"DEFAULT"AgreementRolloverStatus
An enumeration.
Values
PENDING
Rollover Pending
REJECTED
Rollover Rejected
ENQUEUED
Rollover In Progress
ERROR
Error During Rollover
NEEDS_ATTENTION
Rollover Needs Attention
PENDING_VALIDATION
Rollover Pending Validation
VALIDATING
Rollover Validating
DONE
Rollover Completed
REVOKED
Rollover Revoked
Example
"PENDING"AllBandSubCategories
Combined list of subcategories for consumption, standing charges, and DUoS.
Values
STANDARD
ECO7_DAY
ECO7_NIGHT
THREE_RATE_PEAK
THREE_RATE_OFF_PEAK
THREE_RATE_SHOULDER
SUMMER_PEAK
SUMMER_OFF_PEAK
WINTER_PEAK
WINTER_OFF_PEAK
WEEKDAYS
WEEKENDS
ECONOMY7
THREE_RATE
FIXED
CAPACITY
EXCESS_CAPACITY
REACTIVE
SUPER_RED_UNIT
RED_UNIT
AMBER_UNIT
GREEN_UNIT
BLACK_UNIT
YELLOW_UNIT
NUCLEAR_RAB
TNUOS
CAPACITY_MARKET
DAY_AHEAD_HH_INDEX
HMC_GUARANTEE_ADVANCE
HMC_GUARANTEE_FULL
EV_DEVICE
EV_DEVICE_PEAK
EV_DEVICE_OFF_PEAK
FER_POWER
Example
"STANDARD"APIBrownoutStatus
Possible API Brownout statuses.
Values
SCHEDULED
IN_PROGRESS
CANCELLED
COMPLETED
ABORTED
Example
"SCHEDULED"APIExceptionResolutionStatus
An enumeration.
Values
ASSIGNED
CANCELLED
IN_PROGRESS
RESOLVED
UNASSIGNED
UNSUCCESSFUL
WAITING_ON_THIRD_PARTY
Example
"ASSIGNED"AppointmentStatus
Note: This enum has a corresponding GraphQL interface enum (OnSiteJobsAppointmentStatus). If adding new values that should be exposed via API, update the interface enum in: interfaces/apisite/graphql/territories/common/on_site_jobs/enums.py
Values
REQUIRES_TIMESLOT
PENDING
BOOKED
DISPATCHED
EN_ROUTE
ON_SITE
CANCELLED
ABORTED
PARTIALLY_COMPLETE
COMPLETED
Example
"REQUIRES_TIMESLOT"AppSessionOutcome
An enumeration.
Values
SWITCHED
Switched
SWITCHED_BUSINESS
Switched Business
SWITCHED_CREDIT_CHECK_WAIVER
Switched (Credit Check Waiver)
SWITCHED_FIRST_CONTACT
Switched (First Contact)
SWITCHED_CALLBACK
Switched (Callback)
SWITCHED_SMART_PRODUCT
Switched (Smart Product)
QUOTED_NO_SWITCH
Quoted - no switch
QUOTED_NO_SALE
Quoted - no sale
QUOTED_NO_SALE_QUOTE_EMAILED
Quoted - no sale - quote emailed
QUOTED_NO_SALE_PRICE
Quoted - no sale price
QUOTED_NO_SALE_EXIT_FEES
Quoted - no sale exit fees
QUOTED_NO_SALE_NO_EMAIL
Quoted - no sale no email
QUOTED_NO_SALE_ISSUE_BANK_DETAILS
Quoted - no sale issue bank details
QUOTED_NO_SALE_ADVANCED_PAYMENT
Quoted - no sale advanced payment
QUOTED_NO_SALE_STANDING_CHARGE
Quoted - no sale standing charge
QUOTED_NO_SALE_PAPER_BILLS
Quoted - no sale paper bills
QUOTED_NO_SALE_MONTHLY_DD
Quoted - no sale monthly dd
QUOTED_NO_SALE_CREDIT_CHECK_ISSUE
Quoted - no sale credit check issue
QUOTED_NO_SALE_WAIVER_WANTED
Quoted - no sale waiver wanted
QUOTED_NO_SALE_DEPOSIT
Quoted - no sale objected to deposit
QUOTED_NO_SALE_AUTOPAY
Quoted - no sale objected to autopay
QUOTED_NO_SALE_PREPAY
Quoted - no sale prepay too high
QUOTED_NO_SALE_UNSURE_OF_CURRENT_CONTRACT
Quoted - no sale unsure of current contract
QUOTED_NO_SALE_OTHER
Quoted - no sale other
INTERESTED
Interested
PITCH_NO_QUOTE
Pitch - no quote
NO_PITCH
No pitch
NO_PITCH_SWITCHED_RECENTLY
No pitch - switched recently
NO_PITCH_VULNERABLE
No pitch - vulnerable
NO_PITCH_NO_D2D
No pitch - no d2d
NO_PITCH_NOT_INTERESTED
No pitch - not interested
NO_PITCH_TPI_THIRD_PARTY
No pitch - TPI/third party
PITCH_NO_QUOTE_SWITCHED_RECENTLY
Pitch no quote - switched recently
PITCH_NO_QUOTE_PRICE
Pitch no quote - price
PITCH_NO_QUOTE_IN_CONTRACT
Pitch no quote - in contract
PITCH_NO_QUOTE_NO_EMAIL
Pitch no quote - no email
PITCH_NO_QUOTE_NOT_INTERESTED
Pitch no quote - not interested
PITCH_NO_QUOTE_ADVANCED_PAYMENT
Pitch no quote - advanced payment
CALLBACK
Callback
QUOTED_CALLBACK
Quoted - callback
CALLBACK_PITCHED
Callback - pitched
NO_ANSWER
No answer
NOT_BILL_PAYER
Not bill payer
NOT_DECISION_MAKER
Not decision maker
BUSY
Busy
MULTIPLE_PROPERTIES
Multiple properties owned
CALLBACK_COURTESY_CALL
Callback - courtesy call
DONT_CALL_AGAIN
Don’t call again
NO_COLD_CALLING
No cold calling
SHELTERED_HOUSING
Sheltered housing
NO_FIXED_ADDRESS
No fixed address
OCCUPY_ACCOUNT
Occupy account
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
METER_READING
Meter reading
METER_READING_UNABLE_TO_TAKE_READING
Meter reading - unable to take reading
METER_READING_NO_ANSWER
Meter reading - no answer
ENERGY_HELP_VISIT_COMPLETED
Energy help visit - completed
ENERGY_HELP_VISIT_LEAFLET
Energy help visit - leaflet left
PSR_REGISTERED
PSR registered
SMART_METER_REGISTERED
Smart meter registered
CONSUMER_APP_DOWNLOAD
Consumer app download
EBSS_VOUCHER_CHECK_IN
EBSS voucher check in
PPM_REQUESTED
PPM requested
COT_PROVEN
COT proven
COT_NO_PROOF
COT no proof
COS
COS
PAID_IN_FULL
Paid in full
PAYMENT_PLAN
Payment plan
PAID_PARTIAL
Paid partial
PAID_REDUCED_SETTLEMENT
Paid reduced settlement
INSOLVENCY
Insolvency
EXHAUSTED_NO_CONTACT
Exhausted - no contact
EXHAUSTED_CONTACT
Exhausted - contact
UNABLE_TO_LOCATE
Unable to locate
EMPTY
Empty
DEMOLISHED
Demolished
UNABLE_TO_TRACE
Unable to trace
PRISON
Prison
VULNERABLE
Vulnerable
DECEASED
Deceased
WITHDRAWN
Withdrawn
QUERY
Query
WRONG_ADDRESS_SELECTED
Wrong address selected
PREPAYMENT_METER
Prepayment meter
EXISTING_CUSTOMER
Already an existing customer
LEAD_GENERATION
Lead generation
LEAD_GENERATION_EV
Electric vehicle lead generation
LEAD_GENERATION_EJ
Electric juice switch & lead generation
LEAD_GENERATION_EJ_LITE
Electric juice lite switch & lead generation
LEAD_GENERATION_BUSINESS
Business lead generation
LEAD_GENERATION_SOLAR
Solar lead generation
LEAD_GENERATION_HEAT_PUMP
Heat pump lead generation
PROPERTY_INELIGIBLE
Property ineligible
ELECTRIC_JUICE_SWITCH
Electric juice switch
ELECTRIC_JUICE_SWITCH_LITE
Electric juice lite switch
ELECTRIC_JUICE_NOT_INTERESTED
Electric juice not interested
VULNERABILITY_PROJECT
Vulnerability project
TRANSFERRED
The customer was transferred to another team/agent
SUCCESS
Success
UNSUCCESSFUL
Unsuccessful
OTHER
Other
Example
"SWITCHED"AppSessionOutcomeCategories
Enumeration of app session types.
Values
SUCCESS
INTERESTED
QUOTED_NO_SWITCH
QUOTED_NO_SALE
PITCH_NO_QUOTE
NO_PITCH
CALLBACK
UNSUCCESSFUL
DONT_CALL_AGAIN
PSR_REGISTERED
SMART_METER_REGISTERED
CONSUMER_APP_DOWNLOAD
VULNERABILITY_PROJECT
TRANSFERRED
UNKNOWN
OTHER
SWITCHED
SWITCHED_BUSINESS
SWITCHED_CREDIT_CHECK_WAIVER
SWITCHED_FIRST_CONTACT
SWITCHED_CALLBACK
SWITCHED_SMART_PRODUCT
QUOTED_NO_SALE_QUOTE_EMAILED
QUOTED_NO_SALE_PRICE
QUOTED_NO_SALE_EXIT_FEES
QUOTED_NO_SALE_NO_EMAIL
QUOTED_NO_SALE_ISSUE_BANK_DETAILS
QUOTED_NO_SALE_ADVANCED_PAYMENT
QUOTED_NO_SALE_STANDING_CHARGE
QUOTED_NO_SALE_PAPER_BILLS
QUOTED_NO_SALE_MONTHLY_DD
QUOTED_NO_SALE_CREDIT_CHECK_ISSUE
QUOTED_NO_SALE_WAIVER_WANTED
QUOTED_NO_SALE_DEPOSIT
QUOTED_NO_SALE_AUTOPAY
QUOTED_NO_SALE_PREPAY
QUOTED_NO_SALE_UNSURE_OF_CURRENT_CONTRACT
QUOTED_NO_SALE_OTHER
NO_PITCH_SWITCHED_RECENTLY
NO_PITCH_VULNERABLE
NO_PITCH_NO_D2D
NO_PITCH_NOT_INTERESTED
NO_PITCH_TPI_THIRD_PARTY
PITCH_NO_QUOTE_SWITCHED_RECENTLY
PITCH_NO_QUOTE_PRICE
PITCH_NO_QUOTE_IN_CONTRACT
PITCH_NO_QUOTE_NO_EMAIL
PITCH_NO_QUOTE_NOT_INTERESTED
PITCH_NO_QUOTE_ADVANCED_PAYMENT
QUOTED_CALLBACK
CALLBACK_PITCHED
NO_ANSWER
NOT_BILL_PAYER
NOT_DECISION_MAKER
BUSY
MULTIPLE_PROPERTIES
CALLBACK_COURTESY_CALL
NO_COLD_CALLING
SHELTERED_HOUSING
NO_FIXED_ADDRESS
OCCUPY_ACCOUNT
OCCUPIER_NOT_BILL_PAYER
OCCUPIER_NO_ANSWER
OCCUPIER_REFUSED_TO_DISCUSS
OCCUPIER_SUSPECTED_EMPTY_PROPERTY
METER_READING
METER_READING_UNABLE_TO_TAKE_READING
METER_READING_NO_ANSWER
ENERGY_HELP_VISIT_COMPLETED
ENERGY_HELP_VISIT_LEAFLET
EBSS_VOUCHER_CHECK_IN
WRONG_ADDRESS_SELECTED
PREPAYMENT_METER
EXISTING_CUSTOMER
LEAD_GENERATION
LEAD_GENERATION_EV
LEAD_GENERATION_EJ
LEAD_GENERATION_EJ_LITE
LEAD_GENERATION_BUSINESS
LEAD_GENERATION_SOLAR
LEAD_GENERATION_HEAT_PUMP
PROPERTY_INELIGIBLE
ELECTRIC_JUICE_SWITCH
ELECTRIC_JUICE_SWITCH_LITE
ELECTRIC_JUICE_NOT_INTERESTED
PPM_REQUESTED
COT_PROVEN
COT_NO_PROOF
COS
PAID_IN_FULL
PAYMENT_PLAN
PAID_PARTIAL
PAID_REDUCED_SETTLEMENT
INSOLVENCY
EXHAUSTED_NO_CONTACT
EXHAUSTED_CONTACT
UNABLE_TO_LOCATE
EMPTY
DEMOLISHED
UNABLE_TO_TRACE
PRISON
VULNERABLE
DECEASED
WITHDRAWN
QUERY
Example
"SUCCESS"AppSessionOutcomeCategory
An enumeration.
Values
SUCCESS
Success
INTERESTED
Interested
QUOTED_NO_SWITCH
Quoted No Switch
QUOTED_NO_SALE
Quoted No Sale
PITCH_NO_QUOTE
Pitch No Quote
NO_PITCH
No Pitch
CALLBACK
Callback
UNSUCCESSFUL
Unsuccessful
DONT_CALL_AGAIN
Dont Call Again
PSR_REGISTERED
Psr Registered
SMART_METER_REGISTERED
Smart Meter Registered
CONSUMER_APP_DOWNLOAD
Consumer App Download
VULNERABILITY_PROJECT
Vulnerability Project
TRANSFERRED
Transferred
UNKNOWN
Unknown
OTHER
Other
SWITCHED
Switched
SWITCHED_BUSINESS
Switched Business
SWITCHED_CREDIT_CHECK_WAIVER
Switched Credit Check Waiver
SWITCHED_FIRST_CONTACT
Switched First Contact
SWITCHED_CALLBACK
Switched Callback
SWITCHED_SMART_PRODUCT
Switched Smart Product
QUOTED_NO_SALE_QUOTE_EMAILED
Quoted No Sale Quote Emailed
QUOTED_NO_SALE_PRICE
Quoted No Sale Price
QUOTED_NO_SALE_EXIT_FEES
Quoted No Sale Exit Fees
QUOTED_NO_SALE_NO_EMAIL
Quoted No Sale No Email
QUOTED_NO_SALE_ISSUE_BANK_DETAILS
Quoted No Sale Issue Bank Details
QUOTED_NO_SALE_ADVANCED_PAYMENT
Quoted No Sale Advanced Payment
QUOTED_NO_SALE_STANDING_CHARGE
Quoted No Sale Standing Charge
QUOTED_NO_SALE_PAPER_BILLS
Quoted No Sale Paper Bills
QUOTED_NO_SALE_MONTHLY_DD
Quoted No Sale Monthly Dd
QUOTED_NO_SALE_CREDIT_CHECK_ISSUE
Quoted No Sale Credit Check Issue
QUOTED_NO_SALE_WAIVER_WANTED
Quoted No Sale Waiver Wanted
QUOTED_NO_SALE_DEPOSIT
Quoted No Sale Deposit
QUOTED_NO_SALE_AUTOPAY
Quoted No Sale Autopay
QUOTED_NO_SALE_PREPAY
Quoted No Sale Prepay
QUOTED_NO_SALE_UNSURE_OF_CURRENT_CONTRACT
Quoted No Sale Unsure Of Current Contract
QUOTED_NO_SALE_OTHER
Quoted No Sale Other
NO_PITCH_SWITCHED_RECENTLY
No Pitch Switched Recently
NO_PITCH_VULNERABLE
No Pitch Vulnerable
NO_PITCH_NO_D2D
No Pitch No D2D
NO_PITCH_NOT_INTERESTED
No Pitch Not Interested
NO_PITCH_TPI_THIRD_PARTY
No Pitch Tpi Third Party
PITCH_NO_QUOTE_SWITCHED_RECENTLY
Pitch No Quote Switched Recently
PITCH_NO_QUOTE_PRICE
Pitch No Quote Price
PITCH_NO_QUOTE_IN_CONTRACT
Pitch No Quote In Contract
PITCH_NO_QUOTE_NO_EMAIL
Pitch No Quote No Email
PITCH_NO_QUOTE_NOT_INTERESTED
Pitch No Quote Not Interested
PITCH_NO_QUOTE_ADVANCED_PAYMENT
Pitch No Quote Advanced Payment
QUOTED_CALLBACK
Quoted Callback
CALLBACK_PITCHED
Callback Pitched
NO_ANSWER
No Answer
NOT_BILL_PAYER
Not Bill Payer
NOT_DECISION_MAKER
Not Decision Maker
BUSY
Busy
MULTIPLE_PROPERTIES
Multiple Properties
CALLBACK_COURTESY_CALL
Callback Courtesy Call
NO_COLD_CALLING
No Cold Calling
SHELTERED_HOUSING
Sheltered Housing
NO_FIXED_ADDRESS
No Fixed Address
OCCUPY_ACCOUNT
Occupy Account
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
METER_READING
Meter Reading
METER_READING_UNABLE_TO_TAKE_READING
Meter Reading Unable To Take Reading
METER_READING_NO_ANSWER
Meter Reading No Answer
ENERGY_HELP_VISIT_COMPLETED
Energy Help Visit Completed
ENERGY_HELP_VISIT_LEAFLET
Energy Help Visit Leaflet
EBSS_VOUCHER_CHECK_IN
Ebss Voucher Check In
WRONG_ADDRESS_SELECTED
Wrong Address Selected
PREPAYMENT_METER
Prepayment Meter
EXISTING_CUSTOMER
Existing Customer
LEAD_GENERATION
Lead Generation
LEAD_GENERATION_EV
Lead Generation Ev
LEAD_GENERATION_EJ
Lead Generation Ej
LEAD_GENERATION_EJ_LITE
Lead Generation Ej Lite
LEAD_GENERATION_BUSINESS
Lead Generation Business
LEAD_GENERATION_SOLAR
Lead Generation Solar
LEAD_GENERATION_HEAT_PUMP
Lead Generation Heat Pump
PROPERTY_INELIGIBLE
Property Ineligible
ELECTRIC_JUICE_SWITCH
Electric Juice Switch
ELECTRIC_JUICE_SWITCH_LITE
Electric Juice Switch Lite
ELECTRIC_JUICE_NOT_INTERESTED
Electric Juice Not Interested
PPM_REQUESTED
Ppm Requested
COT_PROVEN
Cot Proven
COT_NO_PROOF
Cot No Proof
COS
Cos
PAID_IN_FULL
Paid In Full
PAYMENT_PLAN
Payment Plan
PAID_PARTIAL
Paid Partial
PAID_REDUCED_SETTLEMENT
Paid Reduced Settlement
INSOLVENCY
Insolvency
EXHAUSTED_NO_CONTACT
Exhausted No Contact
EXHAUSTED_CONTACT
Exhausted Contact
UNABLE_TO_LOCATE
Unable To Locate
EMPTY
Empty
DEMOLISHED
Demolished
UNABLE_TO_TRACE
Unable To Trace
PRISON
Prison
VULNERABLE
Vulnerable
DECEASED
Deceased
WITHDRAWN
Withdrawn
QUERY
Query
Example
"SUCCESS"AppSessionOutcomeType
An enumeration.
Values
SALE
Sale
BUSINESS_SALE
Business Sale
OCCUPIER
Occupier
METER_READING
Meter Reading
ELECTROVERSE_LEAD
Electroverse Lead
ELECTROVERSE
Electroverse
EV_LEAD
Ev Lead
ENERGY_HELP
Energy Help
SOLAR_LEAD
Solar Lead
EV_CHARGER
Ev Charger
HEAT_PUMP_LEAD
Heat Pump Lead
INTELLIGENT_OCTOPUS_SIGNUP
Intelligent Octopus Signup
CREDIT
Credit
CREDIT_BUSINESS
Credit Business
BUSINESS_LEAD_HALF_HOURLY
Business Lead Half Hourly
UNKNOWN
Unknown
LEAD
Lead
BUSINESS_LEAD
Business Lead
ELECTRIC_UNIVERSE
Electric Universe
ENERGY_SUPPORT
Energy Support
Example
"SALE"AppSessionTypeChoices
Enumeration of app session types.
Values
SALE
BUSINESS_SALE
OCCUPIER
METER_READING
ELECTROVERSE_LEAD
ELECTROVERSE
EV_LEAD
ENERGY_HELP
SOLAR_LEAD
EV_CHARGER
HEAT_PUMP_LEAD
INTELLIGENT_OCTOPUS_SIGNUP
CREDIT
CREDIT_BUSINESS
BUSINESS_LEAD_HALF_HOURLY
UNKNOWN
LEAD
BUSINESS_LEAD
ELECTRIC_UNIVERSE
ENERGY_SUPPORT
Example
"SALE"BandChoices
Band choices to apply passthrough percentage to.
Values
RAG
DUOS
TNUOS
CONSUMPTION
Example
"RAG"BatteryCouplingType
Battery coupling type options (AC for separate solar, DC for hybrid solar).
Values
AC
DC
Example
"AC"BespokeNonHalfHourlyElectricityStandingChargePaymentMethod
An enumeration.
Values
DIRECT_DEBIT
Direct Debit
NON_DIRECT_DEBIT
Non-Direct Debit
PREPAYMENT
Prepayment
Example
"DIRECT_DEBIT"BespokeNonHalfHourlyElectricityUnitRatePaymentMethod
An enumeration.
Values
DIRECT_DEBIT
Direct Debit
NON_DIRECT_DEBIT
Non-Direct Debit
PREPAYMENT
Prepayment
Example
"DIRECT_DEBIT"BespokeNonHalfHourlyElectricityUnitRateRateType
An enumeration.
Values
STANDARD
Standard rate (pence per kWh)
ECO7_DAY
Day (or peak) rate (pence per kWh)
ECO7_NIGHT
Night (or off-peak) rate (pence per kWh)
OFF_PEAK
Additional off-peak rate for three-rate tariffs (pence per kWh)
PEAK
Peak rate (pence per kWh) for business tariffs
WEEKDAY
Weekday rate (pence per kWh) for business tariffs
OFF_PEAK_WEEKENDS
Off peak weekend rate (pence per kWh) for business tariffs
WEEKENDS_OTHER
Weekend rate (pence per kWh) for business tariffs
SUMMER
Summer rate (pence per kWh) for business tariffs
SUMMER_PEAK
Summer peak rate (pence per kWh) for two-rate tariffs
SUMMER_OFF_PEAK
Summer off-peak rate (pence per kWh) for two-rate tariffs
WINTER
Winter rate (pence per kWh) for business tariffs
WINTER_PEAK
Winter peak rate (pence per kWh) for two-rate tariffs
WINTER_OFF_PEAK
Winter off-peak rate (pence per kWh) for two-rate tariffs
NUCLEAR_RAB
Nuclear RAB rate (pence per day) for business tariffs
SUMMER_WEEKENDS_OFF_PEAK_WINTER
A rate that applies during summer, weekends and off-peak in winter periods(pence per kWh) for business tariffs
TNUOS
TNUoS rate (pence per day) for business tariffs
CAPACITY_MARKET
Capacity Market rate (pence per day) for business tariffs
HMC_GUARANTEE_ADVANCE
Hourly Matching Credit Guarantee Advance rate (pence per kWh) for business tariffs
HMC_GUARANTEE_FULL
Hourly Matching Credit Guarantee Full rate (pence per kWh) for business tariffs
EV_DEVICE
Electric vehicle device rate (pence per kWh) for sub-meter billing
EV_DEVICE_PEAK
Electric vehicle device peak rate (pence per kWh) for sub-meter billing
EV_DEVICE_OFF_PEAK
Electric vehicle device off-peak rate (pence per kWh) for sub-meter billing
Example
"STANDARD"BespokeNonHalfHourlyGasStandingChargePaymentMethod
An enumeration.
Values
DIRECT_DEBIT
Direct Debit
NON_DIRECT_DEBIT
Non-Direct Debit
PREPAYMENT
Prepayment
Example
"DIRECT_DEBIT"BespokeNonHalfHourlyGasUnitRatePaymentMethod
An enumeration.
Values
DIRECT_DEBIT
Direct Debit
NON_DIRECT_DEBIT
Non-Direct Debit
PREPAYMENT
Prepayment
Example
"DIRECT_DEBIT"BespokeRateItemTypeEnum
The type of a bespoke rate.
Values
PRODUCT_RATE
SHARED_RATE
Example
"PRODUCT_RATE"BillingTriggerFrequency
Billing frequency for billing triggers.
Values
DAILY
MONTHLY
ANNUALLY
Example
"DAILY"BillingTriggerOperationType
Billing trigger operation types.
Values
CHARGE_TARGET
CHARGE_TARGET_AND_ISSUE_INVOICE
CHARGE_TARGET_AND_ISSUE_STATEMENT
ISSUE_STATEMENT_FOR_TARGET
ISSUE_INVOICE_FOR_TARGET
Example
"CHARGE_TARGET"BillingTriggerTargetType
Billing trigger target types.
Values
CHARGING_LEDGER
ACCOUNT
PORTFOLIO
Example
"CHARGING_LEDGER"BrandChoices
An enumeration.
Values
OCTOPUS_ENERGY
Octopus Energy.
AFFECT_ENERGY
Affect Energy.
BULB
Bulb.
COOP_ENERGY
Coop Energy.
EBICO_LIVING
Ebico Living.
LONDON_POWER
London Power.
Example
"OCTOPUS_ENERGY"BroaderGroupRejectionReason
An enumeration.
Values
APPLICATIONS_NOT_OPEN
ALREADY_RECEIVED_DISCOUNT
HAS_OPEN_APPLICATION
HAS_CORE_GROUP_DISCOUNT
INSUFFICIENT_EVIDENCE_PROVIDED
NO_LONGER_ON_SUPPLY
DUPLICATE
NOT_IN_SCOTLAND
BUSINESS_ACCOUNT
NON_DOMESTIC_METER_POINT
Example
"APPLICATIONS_NOT_OPEN"BusinessTypeOptions
Available business account type options (e.g., sole trader, limited company, partnership, charity).
Values
SOLE_TRADER
A business account where the company type is sole trader.
LIMITED
A business account where the company type is limited.
PROPRIETARY_LIMITED_COMPANY
A business account where the company type is proprietary limited.
PARTNERSHIP
A business account where the company type is partnership.
CHARITY
A business account where the company type is charity.
PUBLIC_LIMITED_COMPANY
A business account where the company type is public limited.
LIMITED_LIABILITY_PARTNERSHIP
A business account where the company type is limited liability partnership.
TRUST
A business account where the company type is a trust.
TRADING_AS
A business account where the company has a trading name to carry out its business activities.
GOVERNMENT
A business account for a government institution.
NON_PROFIT
A business account for a non-profit organisation.
CHURCH
A business account for a church or other religious organisation.
HOMEOWNER_ASSOCIATION
A business account for a homeowner association or similar community group.
TO_BE_DETERMINED
A business account where the company type is to be determined.
Example
"SOLE_TRADER"CalculationPeriodFrequency
The frequency at which a tranche target calculation period is assessed.
Values
MONTHLY
ANNUALLY
Example
"MONTHLY"CampaignItemStatus
The status of the campaign item.
Values
UNASSIGNED
SELECTED_FOR_CALLING
ASSIGNED
IN_PROGRESS
COMPLETE
REMOVED
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_CUSTOMER
CANCELLED_BY_BUSINESS
CANCELLED_BY_SUPPLIER
CANCELLED_BY_PROVIDER
Example
"CANCELLED_BY_CUSTOMER"Values
OUT_OF_STOCK
MAX_CLAIMS_PER_PERIOD_REACHED
INSUFFICIENT_POINTS
Example
"OUT_OF_STOCK"CardPaymentNetwork
The payment network that processes card transactions.
Values
MASTERCARD
VISA
AMEX
JCB
DISCOVER
Example
"MASTERCARD"CatalogComponentStatus
Status of a catalog component (offering, product, etc.).
Values
DRAFT
ACTIVE
EXPIRED
AWAITING_APPROVAL
Example
"DRAFT"Category
An enumeration.
Values
FILE_ATTACHMENT_MCS_CERT
FILE_ATTACHMENT_DNO_LETTER
FILE_ATTACHMENT_FLEXI_ORB_CERT
FILE_ATTACHMENT_HEAT_PUMP_HANDOVER_DOCUMENT
Example
"FILE_ATTACHMENT_MCS_CERT"Channel
The set of channels that messages can be sent through.
Values
SMS
POST
ANDROID_PUSH_NOTIFICATION
IOS_PUSH_NOTIFICATION
Example
"EMAIL"ChargingSessionType
All possible types of charging sessions.
Values
PUBLIC
SMART
BOOST
Example
"PUBLIC"CHFConnectionMethod
How the CHF was installed and connected to the rest of the Smart Metering System.
Values
HOT_SHOE
Hot Shoe.
CRADLE
Cradle.
ESME
Esme.
Example
"HOT_SHOE"CHFFaultReason
The user's description of the fault, if the meter was not installed due to a technical problem.
Values
DAMAGED_CASE
Damaged Case.
DAMAGED_CONNECTOR
Damaged connector.
ILLEGAL_INTERFERENCE_OR_MISSING_SEALS
Illegal Interference Or Missing Seals.
ENVIRONMENTAL_CONDITIONS_EXCEEDED
Environmental Conditions Exceeded.
SM_WAN_FAULT
Fault with SM WAN.
SM_HAN_FAULT
Fault with SM HAN interface.
LED_FAULT
Fault with LED.
AERIAL_FAULT
Fault with aerial.
MANUFACTURING_DEFECT
Manufacturing Defect.
Example
"DAMAGED_CASE"CHFFaultReturnType
Whether the fault was identified before or after the installation.
Values
PRIOR_TO_INSTALLATION
Prior To Installation.
POST_INSTALLATION
Post 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
OUTSIDE
Outside of the premises.
INDOORS_ON_EXTERNAL_WALL
Indoors On External Wall.
DEEP_INDOORS
Indoors, NOT on an external wall.
BASEMENT_OR_CELLAR
In the basement/cellar.
Example
"OUTSIDE"CHFNoFaultReturnType
The reason for the meter not being installed if there was no technical issue.
Values
GENERAL
General.
NON_DOMESTIC_OPT_OUT
Non-domestic opt-out.
DUAL_SUPPLIER_HAN_VARIANT_REPLACEMENT
Dual supplier HAN variant replacement.
SM_WAN_VARIANT_REPLACEMENT
SM WAN variant replacement requested by DCC.
LOST_OR_STOLEN_HUB
Lost or stolen hub.
Example
"GENERAL"Values
APPROVED
CLEARED
CANCELLED
HELD_FOR_REVIEW
FAILED
PENDING
REQUESTED
SCHEDULED
NONE
Example
"APPROVED"CollectionCampaignType
An enumeration.
Values
VULNERABLE_CUSTOMER
HOME_VISIT
TRACE
DECEASED
THIRD_PARTY
FINAL_DEBT_COLLECTION
FINAL_DEBT_COLLECTION_2
OCCUPIER
LITIGATION
PERSISTENT_DEBT
DEBT_COLLECTION_AGENCY
LOW_RISK
MEDIUM_RISK
HIGH_RISK
INSOLVENT
TRACE_AND_COLLECT
VULNERABILITY_VISIT
LIVE_B2B
FINAL_B2B
B2B_DISCONNECTION_PROCESS
SWITCH_TO_SMART_PAYG
SUPPLY_DISCONNECTED
B2B_SITE_VISIT
LIVE_DEBT_COLLECTION
LIVE_DEBT_COLLECTION_2
LIVE_DEBT_COLLECTION_3
REQUESTED_SWITCH_TO_SMART_PAYG
PRE_LEGAL
DIGITAL_ONLY
RE_ENGAGEMENT
CONFIRMED_EMPTY
QUERY
EARLY_STAGE
WIST_DROP_OUT
TRACE_LIVE
TRACE_FINAL
DOMESTIC_LIVE
DOMESTIC_FINAL
REMOTE_SWITCH_TO_SPAYG
POST_WARRANT
POST_REMOTE_SWITCH
OCCUPIER_VISIT
FINAL_COLLECTIONS_NBF
ENFORCEMENT
PERSISTENT_DEBT_FINAL
LITIGATION_B2B_FINAL
LIVE_DEBT_COLLECTION_C
PORTFOLIO_MANAGEMENT
FINAL_DEBT_COLLECTION_HB
TRANSFER_HYPERCARE
RESPECT_ESCALATION
SUSPECTED_DEMOLITION
AGED_DEBT_TEAM
LIVE_DEBT_COLLECTION_HB
CHARITY_SPECIALISED_SUPPORT
OUTBOUND_TRIAL
TRACE_FINAL_HB
RESPECT_ESCALATION_DOMESTIC
LIVE_SYMEND_COMMS_ONLY_EC2
LIVE_SYMEND_DIALLER_EC2
FINAL_DEBT_COLLECTION_NCD
B2B_ENGAGEMENT_VISIT
LIVE_B2B_OCCUPIER
FINAL_B2B_OCCUPIER
PRE_LEGAL_B2B
LIVE_DEBT_COLLECTION_NCD
LIVE_AGED_PRE_LEGAL
FINAL_AGED_PRE_LEGAL
PRE_DCA
HOME_VISIT_R1
HOME_VISIT_R2
B2B_LIVE_PRE_LEGAL
FINAL_PRE_LEGAL
B2B_FINAL_PRE_LEGAL
LIVE_PRE_LEGAL
PLACEMENT_TEST_SCORING
THIS_ACCOUNT_HAS_BEEN_SELECTED_FOR_A_B2B_SITE_VISIT
TEST
FINAL_DEBT_COLLECTION_3
ARYZA_CHATBOT
FINAL_OCCUPIER_0_6M
FINAL_OCCUPIER_6_12M
FINAL_OCCUPIER_1Y_2Y
B2B_AGED_DEBT
DECEASED_ACTIVE
FINAL_OCCUPIER_GT2Y
ARYZA_CHATBOT_FINAL
DECEASED_FINAL
LITIGATION_B2B_LIVE
LITIGATION_FINAL
LITIGATION_LIVE
LITIGATION_DROP_OUT
POST_SITE_VISIT
LIVE_LITIGATION_DROP_OUT
FINAL_LITIGATION_DROP_OUT
HOME_VISIT_FINAL_1
HOME_VISIT_FINAL_2
DECEASED_ACTIVE_AGED
LATE_STAGE
TELLJO_1
TELLJO_2
LITIGATION_FINAL_PD
Example
"VULNERABLE_CUSTOMER"CollectionProcessAssociatedItemType
Associated item type choices.
Values
TRANSACTIONAL_MESSAGING_TRIGGER
CONTRACT_TERMINATION
LEAVE_SUPPLIER_PROCESS
TRANSACTIONAL_MESSAGING_PUBLISHING_ERROR
Example
"TRANSACTIONAL_MESSAGING_TRIGGER"CollectionProcessEventTypeEnum
Type of events that can occur in a collection process.
Values
REACTIVATION_PENDING
REACTIVATION_COMPLETED
TERMINATED_WITHOUT_REACTIVATION
Example
"REACTIVATION_PENDING"CollectionProcessRecordCompletionTypeChoices
Options for Collection Process Record Completion types. ENDED: endedWITHDRAWN: withdrawnCANCELLED: cancelledNEVER_ACTIONED: never_actioned
Values
ENDED
WITHDRAWN
CANCELLED
NEVER_ACTIONED
Example
"ENDED"CollectionProcessStepStatus
Collection process step status choices.
Values
COMPLETED
SKIPPED
PENDING
Example
"COMPLETED"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
SUCCESS
Success.
NO_SM_WAN
No SM Wide Area Network.
FAULT_RETURN
Returning CHF due to technical fault.
NO_FAULT_RETURN
Returning CHF for non-technical reason.
Example
"SUCCESS"CommsStrategy
Determines which communications will be sent for the appointment.
Values
SEND_ALL
SEND_ONLY_JOB_COMPLETED
SUPPRESS_ALL
Example
"SEND_ALL"CommunicationMethods
Preferred communication method.
Values
LANDLINE
MOBILE
POST
Example
"LANDLINE"ComparisonGroup
An enumeration.
Values
PROPERTY_BEDROOM_AREACODE
AREACODE
BEDROOM_OUTCODE
NO_MATCH
BEDROOM_AREACODE
PROPERTY_BEDROOM_OUTCODE
OUTCODE
Example
"PROPERTY_BEDROOM_AREACODE"ComplaintSourceChoices
Source of the complaint.
Values
TELEPHONE
ONLINE
PERSON
POST
SOCIAL_MEDIA
CUSTOMER_SURVEY
Example
"TELEPHONE"ConnectionStatus
Connection status of the device, provided as part of the telemetry data.
Values
ONLINE
OFFLINE
Example
"ONLINE"ConsentEventSource
The possible sources of a consent event.
Values
CONSUMER_SITE
SUPPORT_SITE
API_SITE
THIRD_PARTY_VENDOR
ONBOARDING
MIGRATION
DATA_IMPORT
COMMAND_JOB
Example
"CONSUMER_SITE"ConsentGranularity
The reading consent granularity value to be set.
Values
HH_CONSENT_GRANTED
DAILY_READS_ONLY
MONTHLY_READS_ONLY
NO_CONSENT
OBFUSCATED_VALUE
Example
"HH_CONSENT_GRANTED"ConsentGranularityValue
The reading consent granularity to be set.
Values
HALF_HOURLY
DAILY
MONTHLY
NO_CONSENT
Example
"HALF_HOURLY"ConsentValue
The possible values for a consent.
Values
ACCEPTED
REJECTED
UNKNOWN
PENDING
Example
"ACCEPTED"ConsumptionGroupings
An enumeration.
Values
QUARTER_HOUR
HALF_HOUR
HOUR
DAY
WEEK
MONTH
QUARTER
Example
"QUARTER_HOUR"ContractActivityTypeOptions
An enumeration.
Values
ALL_ACTIVITY_TYPES
CONTRACT_TERMINATION_STARTED
CONTRACT_VARIATION_STARTED
Example
"ALL_ACTIVITY_TYPES"ContractJourneyStatus
The status of the contract journey.
Values
IN_PROGRESS
STALLED
COMPLETED
CANCELLED
ERRORED
Example
"IN_PROGRESS"ContractJourneyType
The type of the contract journey.
Values
CONTRACT_CREATION
CONTRACT_TERMINATION
CONTRACT_VARIATION
Example
"CONTRACT_CREATION"ContractStatus
The status of the contract.
Values
REVOKED
ACTIVE
EXPIRED
RESCINDED
TERMINATED
INACTIVE
JOURNEY_IN_PROGRESS
Example
"REVOKED"ConversationClosedReasonChoices
The available reasons for closing a conversation.
Values
AGENT_CLOSED
CUSTOMER_CLOSED
STALE
INACTIVE
Example
"AGENT_CLOSED"CurrentQualifyingComponentOptions
All of the qualifying components currently permitted for broader group applications.
Values
PERSONAL_INDEPENDENCE_PAYMENTS
In receipt of Personal Independence Payments (PIP)
DISABILITY_BENEFITS
In receipt of Disability Living Allowance (DLA), any disability premium (all rates) or disabled child element of Universal Credit
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
MATERNITY_EXEMPTION_CERTIFICATE
Hold a Maternity Exemption Certificate (MATEX)
AGE_THRESHOLD
Are aged 62 and over (OR in receipt of any pensioner premium)
HAS_DISABILITY
Have a medically dependant illness (disability or mobility issue)
ADULT_DISABILITY_PAYMENT
In receipt of Adult Disability Payment (ADP)
DEPENDENT_CHILD_UNDER_FIVE
Have a dependent child under 5 (dependent child who normally resides with the applicant)
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)
LIMITED_CAPABILITY_FOR_WORK
In receipt of the limited capability for work element of Universal Credit
Example
"PERSONAL_INDEPENDENCE_PAYMENTS"CustomerAssetTypeEnum
The customer asset types that can be created.
Values
EV
EVSE
HEAT_PUMP
INVERTER
SMART_METER
STORAGE_HEATER
THERMOSTAT
Example
"EV"CustomerFeedbackSourceChoices
Source of the customer feedback.
Values
FEEDBACK_SOURCE_PHONE_CALL_FOLLOW_UP
FEEDBACK_SOURCE_EMAIL_FOLLOW_UP
FEEDBACK_SOURCE_TRUSTPILOT
FEEDBACK_SOURCE_MANUAL
FEEDBACK_SOURCE_LOGIN_FOLLOW_UP
FEEDBACK_SOURCE_CONSUMER_SITE
Example
"FEEDBACK_SOURCE_PHONE_CALL_FOLLOW_UP"CustomerVerificationType
The verification types available.
Values
Email.
SMS
SMS.
MANUAL
Manual.
OTHER
Other.
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
DAILY
WEEKLY
MONTHLY
ANNUALLY
Example
"DAILY"DayOfWeek
Day of the week.
Values
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY
Example
"MONDAY"DebtCollectionProceedingStopReason
An enumeration.
Values
BANKRUPT
Bankrupt
DECEASED
Deceased
GONE_AWAY
Gone away
IN_PRISON
In prison
NEGATIVE_TRACE
Negative trace
PAID_IN_FULL
Paid in full
PROCESS_EXHAUSTED
Process exhausted
PROCESS_EXHAUSTED_NO_CONTACT
Process exhausted - no contact
PROCESS_EXHAUSTED_CONTACT
Process exhausted - contact
REDUCED_SETTLEMENT
Reduced settlement
VULNERABLE
Vulnerable
WITHDRAWN
Withdrawn
WRITE_OFF
Write off
PAYMENT_ARRANGEMENT
Payment arrangement
PAYMENT_PLAN_AGREED
Payment plan agreed
PART_PAYMENT
Part payment
PPM_ARRANGEMENT
PPM arrangement
PPM_REQUESTED
PPM requested
ARREARS_TO_CLIENT
Arrears to client
HIGH_LEVEL_COMPLAINT
High level complaint
INSOLVENCIES_DEALING
Insolvencies dealing
PARTIAL_SETTLEMENT
Partial settlement
PPM_FITTED
PPM fitted
REFUSED_TO_DEAL
Refused to deal
LIVE_TO_FINAL
Live to final
COT_COS
COT / COS
COS
COS
COT_PROOF_SEEN
COT proof seen
COT_NO_PROOF
COT no proof
ENROLLED_IN_ERROR
Enrolled in Error
LOW_BALANCE
Low balance
EXP
Expired
UNABLE_TO_LOCATE_PROPERTY
Unable to locate property
CONFIRMED_EMPTY
Confirmed empty
DEMOLISHED
Demolished
UNABLE_TO_TRACE
Unable to trace
QUERY
Query
Example
"BANKRUPT"DeviceStatus
An enumeration.
Values
PENDING
Pending
WHITELISTED
Whitelisted
INSTALLED_NOT_COMMISSIONED
Installed but not commissioned
COMMISSIONED
Commissioned
DECOMMISSIONED
Decommissioned
WITHDRAWN
Withdrawn
SUSPENDED
Suspended
RECOVERY
In recovery
RECOVERED
Recovered
NOT_APPLICABLE
Not Applicable
Example
"PENDING"DeviceStatuses
An enumeration.
Values
PENDING
Pending
WHITELISTED
Device has been whitelisted
INSTALLED_NOT_COMMISSIONED
Installed but not commissioned
COMMISSIONED
Device has been commissioned
DECOMMISSIONED
Device has been decommissioned
WITHDRAWN
Device has been withdrawn
SUSPENDED
Decice suspended
RECOVERY
Device is in recovery mode
RECOVERED
Device recovered
NOT_APPLICABLE
Not applicable
Example
"PENDING"DeviceType
An enumeration.
Values
ESME
Electricity Smart Meter (ESME)
GSME
Gas Smart Meter (GSME)
GPF
Gas Proxy Function (GPF)
CHF
Communications Hub Function (CHF)
HCALCS
HAN Connected Auxiliary Load Control Switch (HCALCS)
PPMID
Prepayment Interface Device (PPMID)
IHD
In-House Display (IHD)
CAD
Consumer Access Device (CAD)
IHD_OR_CAD
IHD or CAD (a type 2 device)
Example
"ESME"DirectDebitInstructionStatus
An enumeration.
Values
ACTIVE
The instruction is active and can be used to take payments.
PROVISIONAL
The instruction has not yet been set up.
FAILED
The instruction could not be set up with the vendor.
Example
"ACTIVE"DNOStatus
The status of DNO being notified of this export request.
Values
NOTIFIED
Notified
NOT_NOTIFIED
Not Notified
UNKNOWN
Unknown
Example
"NOTIFIED"DocumentAccessibilityChoices
Enum representing document accessibility preferences for an account.
Values
LARGE_PRINT
BRAILLE
AUDIO
Example
"LARGE_PRINT"ElectricityAgentContractContractType
An enumeration.
Values
MOP
Meter Operator
DA
Data Aggregator
DC
Data Collector
MSA
Advanced Metering Service
MSS
Smart Metering Service
ADS
Advanced Data Service
SDS
Smart Data Service
UMSDS
Unmetered Data Service
UMSO
Unmetered Supplies Operator
Example
"MOP"Values
IMPORT
Electricity consumed from the grid
EXPORT
Electricity is directed back to the grid
Example
"IMPORT"ElectricityMeterMeterType
An enumeration.
Values
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
S2B
A twin element meter that is compliant with SMETS2
S2C
A polyphase meter that is compliant with SMETS2
S2AD
A single element meter with one or more ALCS that is compliant with SMETS2
S2BD
A twin element meter with one or more ALCS that is compliant with SMETS2
S2CD
A polyphase 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
S2BDE
A twin element meter with one or more ALCS and Boost Function 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
A_2AF
Single Element with 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_2ADEF
Single Element with ALCS, Boost Function and APC that is compliant with SMETS2
A_2BF
Twin Element with 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_2BDEF
Twin Element with ALCS, Boost Function and APC that is compliant with SMETS2
A_2CF
Polyphase with 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_2CDEF
Polyphase with ALCS, Boost Function and APC that is compliant with SMETS2
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
ELIGIBLE
BUSINESS_ACCOUNT
NO_ACTIVE_AGREEMENTS
HAS_SMART_TARIFF
ONBOARDING_TO_SMART_TARIFF
INVALID_CATCHMENT
CAPPED_CATCHMENT
NO_SMART_METER
INCORRECT_READ_PERMISSION
NO_RECENT_READING
INVALID_BRAND
Example
"ELIGIBLE"EnergyProductFilters
An enumeration.
Values
PREPAY
Display our prepayment products.
BUSINESS
Display our business products.
DOMESTIC
Display our domestic products.
VARIABLE
Display our variable-term products.
FIXED
Display our fixed-term products.
SMART
Display our smart (charged half-hourly) products.
GREEN
Display our greenest products.
Example
"PREPAY"EnrolmentStatus
An enumeration.
Values
NOT_STARTED
Not started
IN_PROGRESS
In progress
COMPLETED
Completed
STALLED
Stalled
CANCELLED
Cancelled
FAILED
Failed
ERRORED
Errored
Example
"NOT_STARTED"EnrolmentStatusOptions
An enumeration.
Values
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.
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
WITHDRAWN
The request to bring the meter point on supply has been withdrawn.
PRE_REGISTRATION
The meterpoint has been created but the enrolment process has not started yet.
REQUESTED
Enrolment has been requested. This is the default catch-all status, which is returned when no other defined process is happening.
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.
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)
Example
"OBJECTION_RECEIVED"EnrolmentStepStatus
An enumeration.
Values
SKIPPED
COMPLETED
PENDING
IN_PROGRESS
STALLED
CANCELLED
FAILED
ERRORED
Example
"SKIPPED"ExpiringTokenScope
An enumeration.
Values
SUBMIT_METER_READINGS
Scope that enables account user to submit meter readings.
SUBMIT_CUSTOMER_FEEDBACK
Scope that enables account user to submit customer feedback.
BOOK_SMART_METER_APPOINTMENTS
Scope that enables account user to book smart meter appointments.
UPDATE_SMART_METER_INTEREST
Scope that enables account user to update their smart meter interest.
UPDATE_DIRECT_DEBIT
Scope that enables account user to update their direct debit details.
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.
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.
REDEEM_LOYALTY_POINTS
Scope that enables account user to redeem loyalty points
MANAGE_ACCOUNT_RENEWALS
Scope that enables account user to generate a renewal quote and renew agreements.
CHECKOUT_QUOTE
Scope that enables account user to checkout a quote (validate terms & conds and provide a payment detail).
UPDATE_BLACKHOLE_EMAIL
Scope that enables account user to update their blackhole email address.
UPDATE_BLACKHOLE_EMAIL_NO_ACCOUNT_NUMBER
Scope that enables account user to update their blackhole email address without enabling access to account number.
UPDATE_SENSITIVE_CUSTOMER_INFORMATION
Update Sensitive Customer Information
MANAGE_GOODS_PURCHASES
Scope that enables account user to accept goods quotes and process goods purchases.
SET_GOODS_PURCHASE_SALE_ITEM_PRICES
Set Goods Purchase Sale Item Prices
REPORT_MOVE_OUT
Scope that enables account user to report a property move-out.
ACCEPT_TERMS_AND_CONDITIONS
Scope that enables account user to accept the terms and conditions for a product.
MANAGE_PRODUCT_SWITCH
Scope that enables account user to do a self-serve product switch through the Dashboard.
MANAGE_PRODUCT_SWITCH_WITH_QUOTES
Scope that enables account user to do a self-serve product switch with quotes.
MANAGE_BUSINESS_SECURITY_DEPOSIT
Scope that enables account user to manage security deposit payments for business accounts.
SEND_LOSS_OBJECTION_FOR_CHANGE_OF_SUPPLIER
Scope that enables user to send a loss objection for a change of supplier process.
UPDATE_ACCOUNT_DETAILS
Scope that enables the user to update information about themselves and their account.
CANCEL_ENROLLMENT
Scope that enables the user to cancel enrollment to a supplier.
VIEW_ACCOUNT_NUMBER
Scope that grants access to view the account number.
ACCEPT_FIT_SCHEDULE
Scope that grants ability to accept fit schedule.
AMEND_PAYMENTS
Scope that grants access to amend payments.
ACCEPT_FIT_TERMS
Scope that grants ability to accept fit terms.
VERIFY_CUSTOMER_DETAILS
Scope that grants ability to verify the customer details.
ACCEPT_QUOTE
Scope that enables user to review and accept a quote sent via an email link.
SUBMIT_FIT_METER_READINGS
Scope that grants ability to submit fit readings for a meter.
ACCESS_CHANGE_MY_TARIFF_EXPIRING_LINK
Scope grants ability to access Change My Tariff journey without login
SUBMIT_MISSING_METER_DETAILS
Scope that enables account user to submit missing meter details.
FINALIZE_ACCOUNT_SETUP
Scope that enables the user to finalize their account setup.
ESCALATE_INK_CONVERSATION
Scope that enables account user to escalate an Ink conversation to a team leader.
Example
"SUBMIT_METER_READINGS"ExportTechnologyType
The type of generator technology used for export.
Values
HYDRO
Hydro
SOLAR
Photovoltaic
STORAGE
Storage
WIND
Wind
SOLAR_AND_STORAGE
Photovoltaic and Storage
WIND_AND_STORAGE
Wind and Storage
UNKNOWN
Unknown
Example
"HYDRO"ExternalAccountEventCategory
Enum of allowable event type categories for external account events.
Values
COMMUNICATIONS
WEB
MOBILE
MESSAGING
DEBT
SALES
SECURITY
WORKFLOW
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
PLAINTEXT
LINK
HTML
S3
Example
"PLAINTEXT"ExternalAccountEventSubCategory
Enum of allowable event type subcategories for external account events.
Values
TELEPHONE
SMS
PUSH_NOTIFICATION
SOCIAL_MEDIA
FEEDBACK
CLICK_TO_CALL
DUNNING
THIRD_PARTY
INTERNAL
LIVE_CHAT
PASSWORD_RESET_EMAIL
FORCE_LOGOUT
DENY_ACCESS
UPDATED
CREATED
Example
"TELEPHONE"FailureReason
Stable GraphQL API enum for payment failure reasons.
These values are decoupled from the domain FailureReason enum to maintain API stability. Note: KRAKEN_ERROR is intentionally excluded as it's internal-only.
Values
PAYMENT_INSTRUCTION_NOT_USABLE
PAYER_DECEASED
INSUFFICIENT_FUNDS
ACTION_REQUIRED
CUSTOMER_OBJECTION
INSTITUTIONAL_OBJECTION
INVALID_AMOUNT
SUSPICIOUS
INSUFFICIENT_NOTICE
PAST_DATE
BAD_TIMING
VENDOR_SYSTEM_MALFUNCTION
UNKNOWN
Example
"PAYMENT_INSTRUCTION_NOT_USABLE"FetchSiteworksAppointmentStatus
The status of the fetch siteworks appointment operation. If the status is PENDING, the timeslots calculation is still in progress.
Values
PENDING
COMPLETE
ERROR
Example
"PENDING"FieldTypeChoices
The type of the field.
Values
STR
INT
FLOAT
DATE
DATETIME
BOOL
CHOICE
MULTIPLE_CHOICE
Example
"STR"FITStatus
The ownership status of FiT for this property.
Values
OWNER
Notified
PREVIOUS_OWNER
Previous owner
THIRD_PARTY_OWNED
Third party owned
UNKNOWN
Unknown
NONE
None
Example
"OWNER"FlatRateBehaviour
All possible behaviours for handling flat rates during a product switch.
Values
PERSIST
FORCE_FLAT
FORCE_NON_FLAT
Example
"PERSIST"FlexGridExportStatus
The status of the device's grid export capability.
Values
ENABLED
DISABLED
NOT_APPLICABLE
Example
"ENABLED"FlexIsChargingDurationCapped
The status of the device's charging duration cap.
Values
ENABLED
DISABLED
NOT_APPLICABLE
Example
"ENABLED"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"FuelType
An enumeration.
Values
ELECTRICITY
Electricity.
GAS
Gas.
DUAL_FUEL
Dual Fuel.
Example
"ELECTRICITY"FuelTypeChoices
An enumeration.
Values
ELECTRICITY
Electricity.
GAS
Gas.
DUAL_FUEL
Dual Fuel.
Example
"ELECTRICITY"FulfilmentSourceType
The type of the fulfilment source.
Values
UNKNOWN
CREDIT
PAYMENT
CHARGE
Example
"UNKNOWN"FunnelTypeChoices
The type of the funnels to get the schema for.
Values
LEAD
OPPORTUNITY
Example
"LEAD"GasMeterMechanism
An enumeration.
Values
CR
Credit
ET
Electronic Token Meter
PP
Prepayment
MT
Mechanical Token Meter
CM
Coin Meter
TH
Thrift
NS
Non Compliant SMETS Smart Meter
S1
SMETS 1 compliant Smart Meter
S2
SMETS 2 compliant Smart Meter
U
Unknown
Example
"CR"GasMeterPointMeterOwnershipType
An enumeration.
Values
T
Transporter
S
Supplier
C
Customer
Example
"T"GasMeterStatus
An enumeration.
Values
LI
Live
FA
Faulty
IN
Inactive
CU
Cut off
CL
Clamped
CA
Capped
SP
Spin Cap
RE
Removed
OT
Other
UN
Unknown
NI
Not Installed
Example
"LI"GasSupplyType
An enumeration.
Values
STANDARD
Standard pressure gas supply.
MEDIUM
Medium pressure gas supply.
Example
"STANDARD"GuaranteeOfOriginPercentage
The percentage of the guarantee of origin.
Values
ZERO
TWENTY_FIVE
FIFTY
SEVENTY_FIVE
ONE_HUNDRED
Example
"ZERO"HardshipAgreementExitReason
An enumeration.
Values
INITIAL_PAYMENT_PLAN_NOT_ESTABLISHED
Initial payment plan not established
CUSTOMER_REQUEST
Customer request
PAYMENT_PLAN_BROKEN_FOR_NON_PAYMENT
Payment plan broken for non-payment
PAYMENT_PLAN_COMPLETED_SUCCESSFULLY
Payment plan completed successfully
FURTHER_PAYMENT_PLAN_NOT_ESTABLISHED
Further payment plan not established
ACCOUNT_FINALISED
Account finalised
RAISED_IN_ERROR
Raised in Error
NO_ENGAGEMENT
No Engagement
CREDIT_OR_NIL_BALANCE
Credit or nil balance
OTHER
Other
Example
"INITIAL_PAYMENT_PLAN_NOT_ESTABLISHED"HardshipAgreementHardshipEntryReason
An enumeration.
Values
SELF_IDENTIFIED
Customer self-identified as being in hardship
EXTERNAL_REFERENCE
Financial counsellor or external agent referral
RETAILER_REFERRAL
Retailer referral
Example
"SELF_IDENTIFIED"HardshipAgreementHardshipType
An enumeration.
Values
DEATH_IN_FAMILY
Death in the family
HOUSEHOLD_ILLNESS
Household illness
FAMILY_VIOLENCE
Family violence
UNEMPLOYMENT
Unemployment
REDUCED_INCOME
Reduced income
OTHER
Other
Example
"DEATH_IN_FAMILY"HeatPumpActivity
All possible heat pump activities.
Values
PRE_HEATING
PRE_COOLING
PENDING
SCHEDULED_HEATING
SCHEDULED_COOLING
Example
"PRE_HEATING"IneligibilityReasons
An enumeration.
Values
OCTOPLUS_DISABLED
INCORRECT_BRAND
NO_PROPERTIES
NO_ELIGIBLE_METERS
INELIGIBLE_BUSINESS
DISABLED_HH_READINGS
NO_DIRECT_DEBIT
ACTIVE_EXCLUSION_CAMPAIGN
Example
"OCTOPLUS_DISABLED"InkCommunicationChannel
An enumeration.
Values
SMS
POST
GENERIC_API
LIVE_CHAT
Example
"EMAIL"Values
OPEN
OPEN_NEW
OPEN_CUSTOMER_REPLIED
OPEN_REMINDED
SNOOZED
CLOSED
Example
"OPEN"Values
PENDING
SENT
DELIVERED
FAILED
OUTSIDE_REPLY_WINDOW
READ
Example
"PENDING"Values
INTERNAL_TESTING
TESTING
Testing - The device is in testing status.
NOT_AVAILABLE
Not Available - The device is not available.
GENERALLY_AVAILABLE
Generally Available - The device is available.
Example
"INTERNAL_TESTING"JoinableDeviceType
Types of devices that can be joined to a HAN (Home Area Network).
Values
ELECTRICITY_METER
Electricity meter.
GAS_METER
Gas meter.
AUX_SWITCH
HAN Connected Auxiliary Load Control Switch (HCALCS).
PPMID
Pre-Payment Meter Interface Device.
IHD
In-Home Display.
CAD
Consumer Access Device (CAD).
Example
"ELECTRICITY_METER"JoinConsumerDeviceChoices
An enumeration.
Values
PPMID
Pre-Payment Meter Interface Device.
IHD
In-Home Display.
CAD
Consumer Access Device.
ALT_HAN
Alternative Home Area Network.
Example
"PPMID"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
ONBOARDING
PENDING_LIVE
LIVE
ONBOARDING_TEST_IN_PROGRESS
FAILED_ONBOARDING_TEST
RETIRED
Example
"ONBOARDING"KrakenFlexDeviceTypes
The device types that can be controlled by KrakenFlex.
Values
BATTERIES
ELECTRIC_VEHICLES
INVERTERS
HEAT_PUMPS
STORAGE_HEATERS
ELECTRICITY_METERS
THERMOSTATS
Example
"BATTERIES"LeadContactRoles
The roles a contact has in relation to their lead.
Values
LEGAL_CONTACT
COMMUNICATIONS_CONTACT
OTHER_CONTACT
Example
"LEGAL_CONTACT"LeaveSupplierSubType
Indicates the type of a leave supplier process.
Values
MOVE_OUT
DEMIGRATION
DEBT_DISCONNECTION
Example
"MOVE_OUT"LedgerDebtPositionStatus
The status of the debt position for a ledger.
Values
OK
UNAVAILABLE
Example
"OK"LifecycleSupplyPointProcessStatus
The status of the lifecycle process.
Values
PENDING
IN_PROGRESS
COMPLETED
PARTIALLY_COMPLETED
NEEDS_ATTENTION
STALLED
INVALID
FAILED
ERRORED
CANCELLATION_IN_PROGRESS
CANCELLED
PARTIALLY_CANCELLED
CANCELLATION_STALLED
CANCELLATION_ERRORED
CANCELLATION_FAILED
REVERSAL_IN_PROGRESS
REVERSE_IN_PROGRESS
REVERSED
PARTIALLY_REVERSED
REVERSAL_STALLED
REVERSAL_ERRORED
REVERSAL_FAILED
UPDATE_IN_PROGRESS
UPDATE_FAILED
UPDATE_ERRORED
UPDATE_STALLED
Example
"PENDING"LimitedBandCategories
Set of band categories that are currently supported for creating product rates.
Values
STANDING_CHARGE
CONSUMPTION_CHARGE
Example
"STANDING_CHARGE"LineItemGroupingOptions
An enumeration.
Values
NONE
HALF_HOUR
HOUR
DAY
WEEK
MONTH
QUARTER
Example
"NONE"LineItemTypeOptions
An enumeration.
Values
STANDING_CHARGE
CONSUMPTION_CHARGE
Example
"STANDING_CHARGE"LinkedObjectType
Types of objects that can have metadata associated with them.
Values
ACCOUNT
ACCOUNT_USER
PROPERTY
ACCOUNT_PROPERTY_EFFECTIVE_PERIOD
Example
"ACCOUNT"LinkTrainingStatus
An enumeration.
Values
NOT_APPLICABLE
Not applicable
IN_TRAINING
In training
QUALIFIED
Qualified
Example
"NOT_APPLICABLE"LoyaltyPointAwardEntryReasonCode
The reason code associated with the loyalty points entry.
Values
POINTS_AWARDED_FOR_ACCOUNT_ACTION
AD_HOC_CREDIT
GREENER_DAYS_REWARD
BUSINESS_RENEWAL_CREDIT
WHEEL_OF_FORTUNE_SPIN
OCTOPLUS_REWARD_REFUND
SAVING_SESSIONS_REWARD
Example
"POINTS_AWARDED_FOR_ACCOUNT_ACTION"LoyaltyPointDeductionEntryReasonCode
The reason code associated with the loyalty points entry.
Values
POINTS_DEDUCTED_FOR_ACCOUNT_ACTION
AD_HOC_DEDUCTION
CHARITY_DONATION
OCTO_ASSIST_FUND_DONATION
OCTOPLUS_REWARD
Example
"POINTS_DEDUCTED_FOR_ACCOUNT_ACTION"MaximumRefundReasonChoices
An enumeration.
Values
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.
MAX_ALLOWED_TO_REQUEST_VIA_DASHBOARD
Maximum refund is equal to the maximum refund amount allowed to be requested via the dashboard.
Example
"MAX_AVAILABLE_AMOUNT"MeasurementClass
The measurement class for the meter point.
Values
NHH_METERED
NHH_UNMETERED
HH_METERED_LARGE
HH_UNMETERED
HH_METERED_SMALL_CT
HH_METERED_SMALL_DOM
HH_METERED_SMALL_WC
Example
"NHH_METERED"MessageEventType
The type of message event.
Values
DELIVERED
DELIVERY_FAILED
DEFERRED
OPENED
CLICKED
SPAM_REPORT
Example
"DELIVERED"MeterDataQualities
Available quality types.
Values
ACTUAL
ESTIMATE
CALCULATED
ZEROED
MIXED
Example
"ACTUAL"MeterReadingEventType
Represents groupings of meter reading events Meter readings can be filtered by these event types.
Values
CUSTOMER
SMART_METER
ESTIMATE
CHANGE_OF_SUPPLY
METER_EXCHANGE
PREPAY
PRE_SUPPLIER
DATA_COLLECTOR
Example
"CUSTOMER"MeterStatus
An enumeration.
Values
REMOVED
The meter was removed.
ON_SITE
The meter was installed or work was done on an existing meter.
Example
"REMOVED"Values
STANDARD
ECONOMY7
SMART
SMART_ECONOMY7
SMART_FLAT_ECONOMY7
FLAT_ECONOMY7
THREE_RATE
FLAT_THREE_RATE
Example
"STANDARD"MeterTypeChoices
An enumeration.
Values
ELECTRICITY_METER
Electricity meter.
GAS_METER
Gas meter.
Example
"ELECTRICITY_METER"MeterTypes
An enumeration.
Values
NO_METER
STANDARD
ECONOMY7
SMART
SMART_ECONOMY7
SMART_FLAT_ECONOMY7
FLAT_ECONOMY7
THREE_RATE
FLAT_THREE_RATE
OTHER
Example
"NO_METER"MFAMethodChoices
MFA enrolment method choices.
Values
Email.
TOTP
Totp.
SMS
Sms.
Example
"EMAIL"NewMeterCategory
An enumeration.
Values
SMETS1
SMETS1 (first generation smart meter).
SMETS2
SMETS2 (second generation smart meter).
TRADITIONAL
Traditional meter.
CHECK_METER
Check Meter.
Example
"SMETS1"NonBespokeElectricityRateTypeChoices
The type of usage this rate applies to (e.g., STANDARD, EV_DEVICE).
Values
STANDARD
ECO7_DAY
ECO7_NIGHT
OFF_PEAK
PEAK
WEEKDAY
OFF_PEAK_WEEKENDS
WEEKENDS_OTHER
SUMMER
SUMMER_PEAK
SUMMER_OFF_PEAK
WINTER
WINTER_PEAK
WINTER_OFF_PEAK
NUCLEAR_RAB
SUMMER_WEEKENDS_OFF_PEAK_WINTER
TNUOS
CAPACITY_MARKET
HMC_GUARANTEE_ADVANCE
HMC_GUARANTEE_FULL
EV_DEVICE
EV_DEVICE_PEAK
EV_DEVICE_OFF_PEAK
Example
"STANDARD"NotifiableApplicationExternalProvider
An enumeration.
Values
PINPOINT
AWS Pinpoint
FCM
Firebase Cloud Messaging
Example
"PINPOINT"NotifiableApplicationService
An enumeration.
Values
GCM
Android (GCM)
APNS
iOS (APNs)
APNS_SANDBOX
iOS Sandbox (APNs Sandbox)
Example
"GCM"OccupyConsentGranularity
The reading consent granularity to be set.
Values
HALF_HOURLY
DAILY
MONTHLY
NO_CONSENT
Example
"HALF_HOURLY"Values
ENROLLED
The account is currently enrolled to Octoplus
UNENROLLED_NEVER_ENROLLED
The account is not currently enrolled to Octoplus, and never has been
UNENROLLED_PREVIOUSLY_ENROLLED
The account is not currently enrolled to Octoplus, although it has been in the past
Example
"ENROLLED"Values
GENERIC_AGENT
TTE_FACILITA
SMS
AES
OES
PROVIDOR
MDS
EON_METERING
LOWRI_BECK
METERPLUS
ENTERPRISE_MANAGED
MIDS_ELEC
N_POWERGRID
ELEC_NW
NATIONAL_GRID
SGN
ENERGY_ASSETS
SIEMENS
LONDON
ECM
OESL
EDF_FIELD
ESSENTIAL_FIELD
IFS
SAP
Example
"GENERIC_AGENT"Values
POST_APPOINTMENT_BOOKING
POST_APPOINTMENT_RESCHEDULED
POST_APPOINTMENT_COMPLETION
POST_APPOINTMENT_CANCELLATION
POST_APPOINTMENT_ABORTED
OTHER
Example
"POST_APPOINTMENT_BOOKING"OnSiteJobsAppointmentCancellationCategory
Appointment cancellation category with any subcategories in the format of 'CATEGORY___SUB_CATEGORY'. For categories without subcategories, just 'CATEGORY'.
Values
CANCELLED_BY_CUSTOMER___COMPLAINT
CANCELLED_BY_CUSTOMER___FORCE_MAJEURE
CANCELLED_BY_CUSTOMER___LANDLORD_REFUSED
CANCELLED_BY_CUSTOMER___NO_LONGER_REQUIRED_CHANGE_OF_CIRCUMSTANCE
CANCELLED_BY_CUSTOMER___NO_LONGER_RESPONSIBLE_FOR_SITE_MOVE_OUT
CANCELLED_BY_CUSTOMER___PROPERTY_UNSAFE
CANCELLED_BY_CUSTOMER___RESCHEDULE_REQUIRED_DATE_NO_LONGER_SUITABLE
CANCELLED_BY_CUSTOMER___SMART_REFUSED
CANCELLED_BY_CUSTOMER___UNABLE_TO_PROVIDE_ACCESS
CANCELLED_BY_SUPPLIER___FORCE_MAJEURE
CANCELLED_BY_SUPPLIER___JOB_RE_PRIORITISATION
CANCELLED_BY_SUPPLIER___NO_LONGER_REQUIRED_CHANGE_OF_CIRCUMSTANCE
CANCELLED_BY_SUPPLIER___NO_LONGER_RESPONSIBLE_FOR_SITE_COS
CANCELLED_BY_SUPPLIER___NO_LONGER_RESPONSIBLE_FOR_SITE_MOVE_OUT
CANCELLED_BY_SUPPLIER___RESCHEDULE_REQUIRED_DATE_NO_LONGER_SUITABLE
CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER
CANCELLED_BY_PROVIDER___ABORT_BY_WARRANT_OFFICER
CANCELLED_BY_PROVIDER___DEMOLISHED
CANCELLED_BY_PROVIDER___DNO_GT_INTERVENTION_REQUIRED
CANCELLED_BY_PROVIDER___FORCE_MAJEURE
CANCELLED_BY_PROVIDER___HIGHER_PRIORITY_REQUIRED
CANCELLED_BY_PROVIDER___HIGHER_SKILL_SET_REQUIRED
CANCELLED_BY_PROVIDER___INCORRECT_DATE_TIME_SELECTED
CANCELLED_BY_PROVIDER___INCORRECT_JOB_TYPE_SELECTED
CANCELLED_BY_PROVIDER___INCORRECT_METER
CANCELLED_BY_PROVIDER___INFRASTRUCTURE_INCOMPLETE
CANCELLED_BY_PROVIDER___NO_ACCESS
CANCELLED_BY_PROVIDER___NO_ENGINEER_AVAILABILITY
CANCELLED_BY_PROVIDER___NO_WAN
CANCELLED_BY_PROVIDER___REFUSED_ACCESS
CANCELLED_BY_PROVIDER___SHARED_FUSE
CANCELLED_BY_PROVIDER___SMART_METER_DISTANCE_INSURMOUNTABLE
CANCELLED_BY_PROVIDER___SUSPECT_TAMPERING
CANCELLED_BY_PROVIDER___TWO_PERSON_JOB
CANCELLED_BY_PROVIDER___UNABLE_TO_LOCATE_METER
CANCELLED_BY_PROVIDER___UNOCCUPIED
CANCELLED_BY_PROVIDER___UNSAFE_PREMISES
CANCELLED_BY_PROVIDER___WIRING_DANGEROUS_OR_INCOMPLETE
Example
"CANCELLED_BY_CUSTOMER___COMPLAINT"Values
REQUIRES_TIMESLOT
PENDING
BOOKED
DISPATCHED
EN_ROUTE
ON_SITE
CANCELLED
ABORTED
PARTIALLY_COMPLETE
COMPLETED
Example
"REQUIRES_TIMESLOT"Values
CANCELLED_BY_CUSTOMER
CANCELLED_BY_BUSINESS
CANCELLED_BY_SUPPLIER
CANCELLED_BY_PROVIDER
Example
"CANCELLED_BY_CUSTOMER"Values
POST_REQUEST_COMPLETION
Example
"POST_REQUEST_COMPLETION"OnSiteJobsRequestReason
Composite reason and sub-reason for on-site job request in the format of 'REASON___SUB_REASON'.
Values
GAINED_CUSTOMER_IN_PREPAY_MODE
NO_SMART_PRODUCT_SUPPORT
READS_NOT_ADVANCING
UNRESPONSIVE_DISPLAY
METER_NOT_COMMUNICATING
INCORRECT_CONSUMPTION
DCC_ENROL_OR_ADOPTION_ISSUE
REPLACE_METER_NOT_ENROLLED_TO_DCC
OMBUDSMAN_COMPLAINT
CUSTOMER_NO_LONGER_REQUIRES_GAS
N_A
Example
"GAINED_CUSTOMER_IN_PREPAY_MODE"OnSiteJobsRequestStatus
Request status.
Values
BOOKED
CANCELLED
APPROVAL_REJECTED
APPROVAL_ON_HOLD
APPOINTMENT_FAILED
APPROVAL_PENDING
PENDING
HELD
COMPLETED
Example
"BOOKED"OnSiteJobsWorkCategory
The work category of an on-site jobs appointment.
Values
ACCURACY_TEST
COMMISSION
COMMS_HUB_REPLACEMENT
CONFIRM_METER_DETAILS
EXCHANGE
IHD_INSTALL
INVESTIGATE_FAULT
ISOLATOR_SWITCH_INSTALL
NEW_CONNECTION
OTHER
REMOVE
Example
"ACCURACY_TEST"OnSiteJobsWorkflowStatus
The status of the workflow.
Values
SKIPPED
COMPLETED
PENDING
IN_PROGRESS
STALLED
CANCELLED
FAILED
ERRORED
Example
"SKIPPED"OpportunityAttachmentCategory
The category of the opportunity attachment.
Values
LEAD_FILE
Example
"LEAD_FILE"PaymentActionIntentTargetType
The type of target the intent's payment should be associated with.
Values
ledger
Example
"ledger"Values
OF_MONTH
The payment day is calculated forward.
BEFORE_END_OF_MONTH
The payment day is calculated backwards from the last day of the month.
Example
"OF_MONTH"PaymentFrequency
An enumeration.
Values
WEEKLY
FORTNIGHTLY
MONTHLY
QUARTERLY
FOUR_WEEKLY
SIX_MONTHLY
ANNUALLY
Example
"WEEKLY"PaymentFrequencyOptions
An enumeration.
Values
Weekly
Weekly
Monthly
Monthly
Planned
Planned
Example
"Weekly"PaymentInstructionOwnerTypeChoices
Available options for the type of entity a payment instruction owner may be.
Values
ACCOUNT_USER
BUSINESS
Example
"ACCOUNT_USER"PaymentInstructionStatus
An enumeration.
Values
ACTIVE
The instruction is active and can be used to take payments.
PROVISIONAL
The instruction has not yet been set up.
FAILED
The instruction could not be set up with the vendor.
Example
"ACTIVE"PaymentMethod
An enumeration.
Values
DIRECT_DEBIT
NON_DIRECT_DEBIT
PREPAYMENT
Example
"DIRECT_DEBIT"PaymentMethodActionIntentTargetType
The type of target the intent's payment method should be associated with.
Values
ledger
Example
"ledger"PaymentMethods
An enumeration.
Values
DIRECT_DEBIT
CREDIT_CARD
PAY_ON_RECEIPT
Example
"DIRECT_DEBIT"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
PREPAY
Prepayment.
CREDIT
Credit.
Example
"PREPAY"Values
BALANCE_THRESHOLD_CROSSED
BILL_ISSUED
PAYMENT_PLAN
REGULAR_SCHEDULE
Example
"BALANCE_THRESHOLD_CROSSED"PaymentScheduleReasonOptions
An enumeration.
Values
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.
FINAL_PAYMENT
A payment schedule created to take the final payment when an account is closed.
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.
Example
"GENERAL_ACCOUNT_PAYMENT"Values
SMARTDEBIT
GOCARDLESS
STRIPE
WESTPAC
BOTTOMLINE_PTX
BOTTOMLINE_PTX_BATCHED
Example
"SMARTDEBIT"PaymentType
Possible payment instruction types.
Values
BPAY
CARD
CUSTOM
DIRECT_DEBIT
GMO_REFUND
PAYMENT_SLIP
Example
"BPAY"PreferencesTargetType
The target type for a user's preferences.
Values
ABSOLUTE_STATE_OF_CHARGE
RELATIVE_STATE_OF_CHARGE
ABSOLUTE_TEMPERATURE
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
Example
"CELSIUS"PremiseType
The type of premise in which the CHF is located.
Values
DETACHED_OR_SEMI
Detached / Semi-detached.
TERRACED
Terraced.
LOW_RISE_APARTMENT
An apartment block with 5 floors or less.
HIGH_RISE_APARTMENT
An apartment block with more than 5 floors.
Example
"DETACHED_OR_SEMI"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
SUBMIT_METER_READINGS
Scope that enables account user to submit meter readings.
SUBMIT_CUSTOMER_FEEDBACK
Scope that enables account user to submit customer feedback.
BOOK_SMART_METER_APPOINTMENTS
Scope that enables account user to book smart meter appointments.
UPDATE_SMART_METER_INTEREST
Scope that enables account user to update their smart meter interest.
UPDATE_DIRECT_DEBIT
Scope that enables account user to update their direct debit details.
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.
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.
REDEEM_LOYALTY_POINTS
Scope that enables account user to redeem loyalty points
MANAGE_ACCOUNT_RENEWALS
Scope that enables account user to generate a renewal quote and renew agreements.
CHECKOUT_QUOTE
Scope that enables account user to checkout a quote (validate terms & conds and provide a payment detail).
UPDATE_BLACKHOLE_EMAIL
Scope that enables account user to update their blackhole email address.
UPDATE_BLACKHOLE_EMAIL_NO_ACCOUNT_NUMBER
Scope that enables account user to update their blackhole email address without enabling access to account number.
UPDATE_SENSITIVE_CUSTOMER_INFORMATION
Update Sensitive Customer Information
MANAGE_GOODS_PURCHASES
Scope that enables account user to accept goods quotes and process goods purchases.
SET_GOODS_PURCHASE_SALE_ITEM_PRICES
Set Goods Purchase Sale Item Prices
REPORT_MOVE_OUT
Scope that enables account user to report a property move-out.
ACCEPT_TERMS_AND_CONDITIONS
Scope that enables account user to accept the terms and conditions for a product.
MANAGE_PRODUCT_SWITCH
Scope that enables account user to do a self-serve product switch through the Dashboard.
MANAGE_PRODUCT_SWITCH_WITH_QUOTES
Scope that enables account user to do a self-serve product switch with quotes.
MANAGE_BUSINESS_SECURITY_DEPOSIT
Scope that enables account user to manage security deposit payments for business accounts.
SEND_LOSS_OBJECTION_FOR_CHANGE_OF_SUPPLIER
Scope that enables user to send a loss objection for a change of supplier process.
UPDATE_ACCOUNT_DETAILS
Scope that enables the user to update information about themselves and their account.
CANCEL_ENROLLMENT
Scope that enables the user to cancel enrollment to a supplier.
VIEW_ACCOUNT_NUMBER
Scope that grants access to view the account number.
ACCEPT_FIT_SCHEDULE
Scope that grants ability to accept fit schedule.
AMEND_PAYMENTS
Scope that grants access to amend payments.
ACCEPT_FIT_TERMS
Scope that grants ability to accept fit terms.
VERIFY_CUSTOMER_DETAILS
Scope that grants ability to verify the customer details.
ACCEPT_QUOTE
Scope that enables user to review and accept a quote sent via an email link.
SUBMIT_FIT_METER_READINGS
Scope that grants ability to submit fit readings for a meter.
ACCESS_CHANGE_MY_TARIFF_EXPIRING_LINK
Scope grants ability to access Change My Tariff journey without login
SUBMIT_MISSING_METER_DETAILS
Scope that enables account user to submit missing meter details.
FINALIZE_ACCOUNT_SETUP
Scope that enables the user to finalize their account setup.
ESCALATE_INK_CONVERSATION
Scope that enables account user to escalate an Ink conversation to a team leader.
Example
"SUBMIT_METER_READINGS"ProductRateBands
The product rate band of a line item.
Values
CONSUMPTION
CONSUMPTION.
TIME
TIME.
FEE
FEE.
Example
"CONSUMPTION"ProviderChoices
This refers to the provider that is used to authenticate when registering a device.
Values
BYD
DAIKIN
DAIKIN_LCM
ECOBEE
ECOBEE_V2
ENERGIZER
ENODE
ENPHASE
FORD
GIVENERGY
HUAWEI
HUAWEI_V2
HYPERVOLT
INDRA
JEDLIX
JEDLIX_V2
MERCEDES
MYENERGI
MYENERGI_V2
NATURE
NISSAN
OCPP_WALLBOX
OCPP
OCTOPUS_ENERGY
OHME
OHME_V2
SENSI
SENSI_V2
SMARTCAR
SMARTFLEX_CONNECT
SMART_PEAR
SOLAREDGE
TESLA
TESLA_V2
VOLKSWAGEN
VP_AMAZON
VP_HONEYWELL_CC
VP_HONEYWELL_RES
VP_NEST
Example
"BYD"QualifyingComponentOptions
All of the qualifying components that have ever been allowed for broader group applications. For currently accepted components please use CurrentQualifyingComponentOptions instead.
Values
PERSONAL_INDEPENDENCE_PAYMENTS
In receipt of Personal Independence Payments (PIP)
DISABILITY_BENEFITS
In receipt of Disability Living Allowance (DLA), any disability premium (all rates) or disabled child element of Universal Credit
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
MATERNITY_EXEMPTION_CERTIFICATE
Hold a Maternity Exemption Certificate (MATEX)
AGE_THRESHOLD
Are aged 62 and over (OR in receipt of any pensioner premium)
HAS_DISABILITY
Have a medically dependant illness (disability or mobility issue)
ADULT_DISABILITY_PAYMENT
In receipt of Adult Disability Payment (ADP)
DEPENDENT_CHILD_UNDER_FIVE
Have a dependent child under 5 (dependent child who normally resides with the applicant)
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)
LIMITED_CAPABILITY_FOR_WORK
In receipt of the limited capability for work element of Universal Credit
MEDICAL_EXEMPTION_CERTIFICATE
Hold a Medical Exemption Certificate (MEDEX)
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
SAVINGS_ELEMENT_OF_PENSION_CREDIT
In receipt of the Savings Element of Pension Credit only
COUNCIL_TAX_REDUCTION
In receipt of Council Tax Reduction (excludes the 25% single person’s discount)
INCOME_SUPPORT
In receipt of Income Support
JOB_SEEKERS_ALLOWANCE
In receipt of Income-based Job Seeker’s Allowance (JSA)
EMPLOYMENT_AND_SUPPORT_ALLOWANCE
In receipt of Income-related Employment & Support Allowance (ESA)
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)
HOUSING_BENEFIT
In receipt of Housing Benefit with a total annual household income of £19,978 or less (before tax and National Insurance)
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)
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
LOW_INCOME_THRESHOLD
A total annual household income of £19,978 or less (before tax and National Insurance)
Example
"SAVINGS_ELEMENT_OF_PENSION_CREDIT"QuoteConfigurationStatus
Valid statuses for a quote configuration.
Values
DRAFT
RATES_REQUESTED
RATES_REQUEST_FAILED
IN_REVIEW
READY
SENT
ACCEPTED
REJECTED
Example
"DRAFT"QuotePaymentMethod
An enumeration.
Values
DIRECTDEBIT
Direct Debit
CREDITCARD
Credit card
ONRECEIPT
Pay on receipt of bill
PREPAYMENT
Prepayment
Example
"DIRECTDEBIT"QuotePaymentMethodChoices
An enumeration.
Values
DIRECTDEBIT
CREDITCARD
ONRECEIPT
PREPAYMENT
Example
"DIRECTDEBIT"RateTypeChoices
An enumeration.
Values
STANDARD
Standard.
ECONOMY7
Economy7.
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
RAW_INTERVAL
Interval Readings as provided, may be variable in length.
FIVE_MIN_INTERVAL
Readings taken in every 5 minute intervals.
FIFTEEN_MIN_INTERVAL
Readings taken in every 15 minute intervals.
THIRTY_MIN_INTERVAL
Readings taken in every 30 minute intervals.
HOUR_INTERVAL
Readings taken in every 1 hour intervals.
DAY_INTERVAL
WEEK_INTERVAL
Readings taken in every 1 week intervals.
MONTH_INTERVAL
Readings taken in every 1 month intervals.
QUARTER_INTERVAL
Readings taken in every 3 months intervals.
DAILY
Readings taken on a day to day basis.
POINT_IN_TIME
Readings taken at a point in time.
INTERVALIZED
Readings taken at a point in time and intervalized.
Example
"RAW_INTERVAL"ReadingStatisticTypeEnum
The type of statistic for the reading interval.
Values
STANDING_CHARGE_COST
The calculated cost of standing charges for the interval.
CONSUMPTION_COST
The calculated cost of consumption for the interval.
CAPACITY_CHARGE_COST
The calculated cost of capacity charges for the interval.
CONSUMPTION_BREAKDOWN
The breakdown of consumption into time of use buckets.
GENERATION_VALUE
The calculated monetary value of generation for the interval
TOU_BUCKET_COST
The apportion cost of a time of use bucket for the interval.
CARBON_COST
The estimated carbon cost of the interval.
GAS_READING_INFORMATION
Information related to a gas reading eg. conversion_factor, volume etc.
POWER_FACTOR_STATISTIC
The calculated power factor for the interval.
CO2_EMISSION_STATISTIC
The calculated co2 emission for the interval.
Example
"STANDING_CHARGE_COST"ReadingTypes
Available reading types.
Values
INTERVAL
Readings indicating total consumption or generation of a utility between two points in time.
ACCUMULATION
Readings indicating total utility consumption since the meter was installed or reset.
PEAK
Readings indicating the maximum rate of utility transfer.
Example
"INTERVAL"ReadInventoryTypeChoices
Type of identifier to use in a Read Inventory request.
Values
DEVICE_EUI64
Device EUI64.
MPXN
MPxN (MPAN or MPRN).
Example
"DEVICE_EUI64"ReferralSchemeTypeChoices
Referral scheme type choices.
Values
REFERRAL_REWARD
Referral Reward.
SIGNUP_REWARD
Signup Reward.
PARTNER_REWARD
Partner Reward.
PROMO_REWARD
Promo Reward.
LEGACY_REFERRAL
Legacy Referral.
Example
"REFERRAL_REWARD"ReferralStatusChoices
Referral status choices.
Values
Pending
Pending.
Paid
Paid.
Cancelled
Cancelled.
Example
"Pending"RegularReadingCycle
The reading cycle for the meter point.
Values
ANNUAL
BIMONTHLY
DAILY
EIGHTEEN_MONTHLY
HALF_MONTHLY
MONTHLY
NO_READ_REQUIRED
OTHER
QUARTERLY
SIX_MONTHLY
TWENTY_EIGHT_DAYS
WEEKLY
TWENTY_FOUR_MONTHLY
Example
"ANNUAL"RepaymentMethod
Methods by which repayments can be sent to the customer.
Values
BANK_TRANSFER
CHEQUE
CARD
Example
"BANK_TRANSFER"RepaymentReason
The reason for the repayment.
Values
BILLING_ADJUSTMENT
CANCELED_BILL
CHARGEBACK
COMPLAINT_COMPENSATION
DEPOSIT_RETURN
DOMESTIC_EXPORT_ONLY_REPAYMENT
ETF_CREDIT
ET_ACCOUNT_REFUND
FAILED_PAYMENT
FAST_TRACK
FEED_IN_TARIFF_PAYMENT
FINAL_BALANCE_SETTLEMENT
FULL_CREDIT_REFUND
FULL_PREPAYMENT_REFUND
GENERATOR_ACCOUNT_REFUND
GSOS_PAYMENT
INDEMNITY_CLAIM
LATE_FAILED_PAYMENT
MISTAKEN_PAYMENT_TAKEN
PARTIAL_CREDIT_REFUND
PARTIAL_PREPAYMENT_REFUND
PAYMENT_CORRECTION
SEG_PAYMENT
Example
"BILLING_ADJUSTMENT"RepaymentRequestStatus
Possible status' for a repayment (or refund) request
Values
REQUESTED
ACCEPTED
CANCELLED
REJECTED
Example
"REQUESTED"RequestStatus
Request status.
Values
APPROVAL_PENDING
APPROVAL_ON_HOLD
APPROVAL_REJECTED
HELD
PENDING
BOOKED
IN_PROGRESS
APPOINTMENT_FAILED
CANCELLED
COMPLETED
Example
"APPROVAL_PENDING"RetrievalMethod
The method used to retrieve meter readings.
Values
VISUAL
MANUAL
UNKNOWN
REMOTE
SMART
UNMETERED
Example
"VISUAL"RolloverStatus
Status of an agreement rollover.
Values
PENDING
REJECTED
ENQUEUED
ERROR
NEEDS_ATTENTION
PENDING_VALIDATION
VALIDATING
DONE
REVOKED
Example
"PENDING"SalesChannelChoices
An enumeration.
Values
DIRECT
PRICE_COMPARISON
TELESALES
DIGI_TELESALES
EVENTS
FIELD_SALES
AGGREGATOR
PARTNERSHIPS
NEW_TENANT
MOVE_IN
WORKPLACE_POP_UP
BROKER
PARENT_POWER
PEOPLE_POWER
GIFT_OF_KIT
HIGH_REFERRER
SUPPLIER_OF_LAST_RESORT
ACQUISITION
WORKS_WITH_OCTOPUS
LANDLORD
DEBT_COLLECTION_AGENCY
OCTOPUS_TRUSTED_PARTNERS
CURRENT_ACCOUNT
Example
"DIRECT"ScheduleFrequencyEnum
The based unit of frequency at which payments are to be taken.
Values
WEEKLY
MONTHLY
Example
"WEEKLY"ScheduleType
An enumeration.
Values
BACS_TRANSFER
CARD_PAYMENT
DIRECT_DEBIT
PAYMENT_SLIP
Example
"BACS_TRANSFER"SelectIntegrationChoices
For when both the EV and charge point have an integration available.
Values
ELECTRIC_VEHICLE
CHARGE_POINT
Example
"ELECTRIC_VEHICLE"SettingAction
An option to override an action in a schedule whilst remaining in AUTO mode.
Values
TURN_ON
TURN_OFF
SET_TEMPERATURE
Example
"TURN_ON"SiteworksAppointmentAgent
The agent carrying out the appointment.
Values
GENERIC_AGENT
Generic Agent
TTE_FACILITA
Total Energies Facilita
SMS
Smart Metering Systems
AES
AES Smart Metering
OES
Octopus Energy Services
PROVIDOR
Providor Ltd
MDS
Morrison Data Services
EON_METERING
E.on Metering
LOWRI_BECK
Lowri Beck Services Ltd
METERPLUS
MeterPlus
ENTERPRISE_MANAGED
Enterprise Managed Services Ltd
MIDS_ELEC
Midlands Electricity plc
N_POWERGRID
Northern Powergrid
ELEC_NW
Electricity North West Limited
NATIONAL_GRID
National Grid
SGN
SGN Metering Services
ENERGY_ASSETS
Energy Assets Ltd
SIEMENS
Siemens Metering Services
LONDON
EDF Energy Customers Ltd
ECM
EDF Energy Customers PLC
OESL
Octopus Energy Services Ltd
EDF_FIELD
EDF Field Services
ESSENTIAL_FIELD
Essential Energy Field Services
IFS
IFS
SAP
SAP
Example
"GENERIC_AGENT"SmartControlAction
The smart control action choices, i.e. suspend or unsuspend.
Values
SUSPEND
UNSUSPEND
Example
"SUSPEND"SmartDeviceAutoTopupTriggerFailureReasons
An enumeration.
Values
NO_IMPORT_METER
FAILED_TO_COLLECT_PAYMENT
PAYMENT_NOT_SUCCESSFUL
FAILED_TO_TRIGGER_ADD_CREDIT_TO_METER
Example
"NO_IMPORT_METER"SmartDeviceAutoTopupTriggerSources
An enumeration.
Values
LOW_CREDIT_BALANCE
Example
"LOW_CREDIT_BALANCE"SmartDeviceAutoTopupTriggerStatus
An enumeration.
Values
INITIATED
COMPLETED
FAILED
Example
"INITIATED"Values
SOC_LIMIT_REACHED
State of charge limit reached - Charging prevented due to a device specific charging limit setting (current state of charge is equal to or above the set limit).
COMMUNICATION_ERROR
Unable to communicate with device - Dispatches were created but no telemetry readings available during the charge session.
THIRD_PARTY_CHARGING_INTERFERENCE
Third-party charging interference - Telemetry for an at-home charging event was found outside of Dispatch Schedules.
POWER_DISCREPANCY
Observed power discrepancy - Power during the session was observed to be significantly different from the value of the max. import in static data.
POWER_TAPERING
Observed power tapering - Power decreased at state of charge levels or towards the end of the session.
NO_SCHEDULED_CHARGE
No scheduled charge within session - There were no schedules for the given charge session period.
FAILURE_CAUSE_ERROR
Unable to determine cause of failure - If the charge session was not achieved, butwe are unable to determine the cause of failure.
CUSTOMER_ACTION_REQUIRED
Action required - Customer needs to take action to re-enable our control (i.e attemptto re-onboard).
NO_CHARGING
No charging - No charging (import of energy) was observed during the session.
FULL_CHARGE
Device fully charged - Device conducting a relative charge session indicated it hadreached 100% SoC or an internal SoC limit. Applied regardless of whether or not wewere able to add the energy requested.
POST_CHARGE_BATTERY_DRAIN
Post-charge battery drain - Target was hit but session ended below target due tobattery drain (caused e.g. by cell balancing).
UNKNOWN_CHARGING_ERROR_CAUSE
Unknown failure cause
Example
"SOC_LIMIT_REACHED"SmartFlexChargingTruncationCause
The possible causes for a charging session ending prematurely.
Values
DISCONNECTED
SUSPENDED
BOOST_CHARGING
UNKNOWN_TRUNCATION_CAUSE
CHARGING_OPTIMISATION_CREATED
DEVICE_DEAUTH_SUCCESS
Example
"DISCONNECTED"SmartFlexDeviceLifecycleStatus
The current lifecycle status of a KrakenFlex device on the smarter tariff API.
Values
ONBOARDING
PENDING_LIVE
LIVE
ONBOARDING_TEST_IN_PROGRESS
FAILED_ONBOARDING_TEST
RETIRED
Example
"ONBOARDING"Values
AUTHENTICATION_PENDING
Authentication Pending - ready to start authentication and authorization, or auth is in progress.
AUTHENTICATION_FAILED
Authentication Failed - failed to connect and ready to restart authentication and authorization.
AUTHENTICATION_COMPLETE
Authentication Complete - ready to start test (if needed) or pending live where auth or telemetry is delayed.
TEST_CHARGE_IN_PROGRESS
Test Charge in Progress - connection and smart control test has successfully started and is occurring.
TEST_CHARGE_FAILED
Test Charge Failed - connection or smart control test has failed or could not start, ready to retry test.
TEST_CHARGE_NOT_AVAILABLE
Test Charge Not Available - not currently capable of smart control test (e.g. away from home or unplugged).
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.
BOOSTING
Manual Boosting (e.g. bump charging) - user has overridden the schedule to immediately boost (e.g. bump charge now).
SMART_CONTROL_OFF
Smart Control Off (suspended) - smart control has been (temporarily) disabled (e.g. by the user with holiday mode).
SMART_CONTROL_NOT_AVAILABLE
Smart Control Not Available - not currently capable of smart control (e.g. away from home or unplugged).
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).
Example
"AUTHENTICATION_PENDING"SmartMeterInterestChoices
An enumeration.
Values
PRIORITY
We have captured that this account is a priority for a SMETS2 meter. This does not mean they've booked an appointment.
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.
Example
"PRIORITY"SmartMeterInterestSourceChoices
An enumeration.
Values
WEBSITE
Website
AFFILIATE
Affiliate
Example
"WEBSITE"SmartMeterReadingFrequencyChoices
Meter reading frequency choices for smart meters.
Please note: these labels are exposed in the API documentation.
Values
DAILY
Daily
MONTHLY
Monthly
HALF_HOURLY
Half hourly
Example
"DAILY"SmartOnboardingEventType
An enumeration.
Values
STARTED
Onboarding started.
COMPLETED
Onboarding completed.
CANCELLED
Onboarding cancelled.
NOTE_ADDED
Note Added.
METER_EXCHANGE_EMAIL_SENT
Email sent to book meter exchange.
METER_EXCHANGE_BOOKED
Meter exchange date agreed.
METER_INSTALLED
Meter Installed.
METER_READINGS_AVAILABLE
Meter Readings Available.
TERMS_EMAIL_SENT
Email sent to request terms acceptance.
TERMS_ACCEPTED
Customer accepted terms and conditions.
AGREEMENTS_UPDATED
Agreements Updated.
TARIFF_SWITCH_CONFIRMATION_EMAIL_SENT
Email sent to confirm tariff switch.
TARIFF_CHANGED_ON_METER
Tariff Changed On Meter.
UNABLE_TO_PROCEED
Unable To Proceed.
PREVIOUS_AGREEMENT_BILLING_GAP_FILLED
Previous Agreement Billing Gap Filled.
INTELLIGENT_OCTOPUS_INSTALL_APP_EMAIL_SENT
Email to install Intelligent Octopus app installed.
INTELLIGENT_OCTOPUS_TEST_DISPATCH_COMPLETE
Test dispatch in app complete.
DOCUMENTS_CHECKED
Documents Checked.
FIT_RESOLUTION
FIT resolution.
EXPORT_MPAN_APPLIED_FOR
Export MPAN applied for.
EXPORT_MPAN_CREATED
Export MPAN created.
EXPORT_MPAN_NOT_FOUND
Export Mpan Not Found.
MTD_UPDATED
MTDs updated.
EXPORT_ENABLED_IN_KRAKEN
Export Enabled In Kraken.
EXPORT_METER_READING_AVAILABLE
Export Meter Reading Available.
EXPORT_MPAN_ON_SUPPLY
Export MPAN is on supply.
FIRST_CREDIT_APPLIED
First Credit Applied.
Example
"STARTED"SmartOnboardingTariffCodes
An enumeration.
Values
AGILE_OCTOPUS
Octopus Energy's Agile Octopus 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
TESLA_IMPORT
Octopus Energy's Tesla Energy Plan import tariff
INTELLIGENT_OCTOPUS
Octopus Energy's Intelligent Octopus Go tariff
INTELLIGENT_FLUX
Octopus Energy's Intelligent Octopus Flux tariff
OUTGOING_FIXED
Octopus Energy's Outgoing Fixed tariff
OUTGOING_AGILE
Octopus Energy's Octopus Agile tariff
OUTGOING_VARIABLE
Octopus Energy's Outgoing Octopus tariff
COSY_OCTOPUS
Octopus Energy's Cosy Octopus tariff
OCTOPUS_FLUX
Octopus Energy's Flux tariff
POWERLOOP
Octopus Energy's Powerloop tariff
Example
"AGILE_OCTOPUS"SmartOnboardingTermsStatuses
An enumeration.
Values
TERMS_ACCEPTANCE_REQUIRED
Customer acceptance of T&Cs required
TERMS_EMAIL_SENT
Awaiting customer acceptance of T&Cs
TERMS_ACCEPTED
T&Cs accepted
Example
"TERMS_ACCEPTANCE_REQUIRED"Values
UTRN_REQUESTED
UTRN_RECEIVED
ACCEPTED_BY_METER
RESOLVED
Example
"UTRN_REQUESTED"Values
NOT_STARTED
INITIATED
PENDING
COMPLETED
FAILED
UTRN_MUST_BE_APPLIED_MANUALLY
Example
"NOT_STARTED"SMETS2InterestReason
An enumeration.
Values
SMETS2_INTEREST_REASON_DO_NOT_OWN_HOME
Doesn't own own home.
SMETS2_INTEREST_REASON_TECHNOLOGY_SCEPTICAL
Sceptical of technology.
SMETS2_INTEREST_REASON_WORRIED_SECURITY
Worried about security.
SMETS2_INTEREST_REASON_WORRIED_HEALTH_SAFETY
Worried about health & safety.
SMETS2_INTEREST_REASON_NEGATIVE_PUBLICITY
Negative publicity about smart meters.
SMETS2_INTEREST_REASON_WORRIED_ABOUT_USAGE_COST
Worried about energy usage cost increasing.
SMETS2_INTEREST_REASON_ALREADY_HAS_SMART_METER
Already has or is about to have a smart meter installed.
SMETS2_INTEREST_REASON_HOUSE_MOVE_IMMINENT
About to move house.
SMETS2_INTEREST_REASON_SWITCH_IMMINENT
About to switch supplier.
SMETS2_INTEREST_REASON_MORE_INFORMATION_REQUIRED
More information about smart meters required.
SMETS2_INTEREST_REASON_IS_LANDLORD
Is a landlord.
SMETS2_INTEREST_REASON_CANNOT_SEE_BENEFIT
Cannot see benefit.
SMETS2_INTEREST_REASON_WAIT_UNTIL_IT_IS_COMPULSORY
Wants to wait until it's compulsory.
SMETS2_INTEREST_REASON_VULNERABILITY
Has vulnerability.
SMETS2_INTEREST_REASON_WORRIED_ABOUT_SMART_METERS
Worried about smart meters.
SMETS2_INTEREST_REASON_WORRIED_ABOUT_INSTALLATION
Worried about installation.
SMETS2_INTEREST_REASON_PROPERTY_NOT_OCCUPIED
Property rarely or never occupied.
SMETS2_INTEREST_REASON_CANNOT_ATTEND_APPOINTMENT
Cannot attend appointment.
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_RTS_LIKELY_NOT_USED
RTS Likely No Longer Used.
Example
"SMETS2_INTEREST_REASON_DO_NOT_OWN_HOME"Songs
An enumeration.
Values
NO_SONG_PREFERRED
.
SONG_hold_music_4_33_silence
Silence.
SONG_hold_music_holding_firm
Relaxing: Holding Firm by Dan Phillipson.
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.
Example
"NO_SONG_PREFERRED"State
An enumeration.
Values
NORMAL_MODE
EMERGENCY_MODE
FAULT_MODE
BLE_MODE
AP_MODE
SETUP
FACTORY_RESTORE
Example
"NORMAL_MODE"StatementReversalsAfterClose
Tracking of charge reversals after statement closure (ALL, SOME, NONE, or NOT_CLOSED).
Values
ALL
All charges have been reversed after the statement was closed.
SOME
Some 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.
Example
"ALL"Status
An enumeration.
Values
PENDING
Pending
AWAITING_AUDIT
Awaiting audit
AWAITING_CUSTOMER_EVIDENCE
Awaiting customer evidence
APPROVED
Approved
REJECTED
Rejected
WITHDRAWN
Withdrawn
APPROVED_CUSTOMER_SERVICE_GESTURE
Approved (customer service gesture)
Example
"PENDING"StorylineAnalyzerTypeChoices
The available types of storyline analyzers.
Values
DIAGNOSTIC_QUESTIONS
Example
"DIAGNOSTIC_QUESTIONS"StorylineEntryTypes
The available types of storyline entries.
Values
INBOUND_MESSAGE
OUTBOUND_MESSAGE
INBOUND_CTI_CALL
OUTBOUND_CTI_CALL
INBOUND_VOICE_CALL
OUTBOUND_VOICE_CALL
CONVERSATION_NOTE_SUMMARY
COMPLAINT_SUMMARY
TRANSACTIONAL_MESSAGE
APPOINTMENT
METER_READING
STATEMENT
REFUND
PAYMENT
REPAYMENT
OTHER
MESSAGE_SUMMARY
CTI_CALL_SUMMARY
VOICE_CALL_SUMMARY
Example
"INBOUND_MESSAGE"SupplyPointMarketNameEnum
An enumeration.
Values
GBR_ELECTRIC_JUICE
GBR_ELECTRICITY
GBR_GAS
EV_PUBLIC_CHARGING
SIMPLE_SERVICES
Example
"GBR_ELECTRIC_JUICE"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
PROPORTION
CURRENCY_PER_KWH
Example
"PROPORTION"TechnologyType
Technology type of an installation.
Values
ANAEROBIC_DIGESTION
Anaerobic Digestion
HYDRO
Hydro
MICRO_CHP
Micro CHP
SOLAR
Photovoltaic
WIND
Wind
Example
"ANAEROBIC_DIGESTION"Values
TEN_SECONDS
ONE_MINUTE
FIVE_MINUTES
HALF_HOURLY
HOURLY
Example
"TEN_SECONDS"TerminationFeeTypeEnum
The type of termination fee.
Values
FLAT
WHOLE_MONTHS_REMAINING
WHOLE_DAYS_REMAINING
Example
"FLAT"TestChargeErrorType
The type of test charge error.
Values
UNABLE_TO_INITIATE_TEST_CHARGE
An error occurred when attempting to initiate a test charge.
UNABLE_TO_COMPLETE_TEST_CHARGE
An error occurred during a test charge attempt.
Example
"UNABLE_TO_INITIATE_TEST_CHARGE"TestChargeRefusalReason
All possible reasons for refusing a test charge.
Values
DEVICE_LIVE
DEVICE_ONBOARDING_IN_PROGRESS
DEVICE_RETIRED
DEVICE_SUSPENDED
DEVICE_DISCONNECTED
DEVICE_ALREADY_CHARGING
DEVICE_AWAY_FROM_HOME
DEVICE_NO_LOCATION_CONFIGURED
DEVICE_LOCATION_UNABLE_TO_IDENTIFY
DEVICE_LOCATION_MISSING
Example
"DEVICE_LIVE"TestDispatchAssessmentFailureReason
The reason (if any) that we believe a test dispatch (test charge) did not succeed.
Values
NONE
UNKNOWN
ASSESSMENTS_FAILED
NOT_AT_HOME
UNABLE_TO_COMMUNICATE
DEVICE_DISCONNECTED
SOC_LIMIT_REACHED
ERROR
Example
"NONE"TestDispatchStatus
All possible test dispatch statuses.
Values
TRIGGERED
COMPLETE
FAILED
Example
"TRIGGERED"TextStyleV1
The style is the typographical hierarchy. These are Typescale Categories from the Mobile Design System (Figma).
Values
TITLE1
TITLE2
TITLE3
TITLE4
TITLE5
TITLE6
BODY1
BODY2
BUTTON_TEXT
CALLOUT1
CALLOUT2
CALLOUT3
SMALL1
SMALL2
SMALL3
INPUT_TITLE
TABULAR
Example
"TITLE1"TimeGranularities
Time buckets into which readings are grouped.
Values
FIVE_MIN
FIFTEEN_MIN
THIRTY_MIN
HOUR
DAY
WEEK
MONTH
QUARTER
YEAR
Example
"FIVE_MIN"TopUpChannelChoices
The channels through which customer top-ups can be made.
Values
APP
App.
IVR
Interactive Voice Response (IVR).
WEB
Web.
Example
"APP"TraditionalFallBackReadFrequency
The read frequency (MHHS only).
Values
WEEKLY
FORTNIGHTLY
MONTHLY
QUARTERLY
SIX_MONTHLY
ANNUALLY
OBFUSCATED_VALUE
Example
"WEEKLY"TransactionTypeFilter
Filter options for transaction types (e.g., energy charges, water charges, imported payments).
Values
UNISSUED_TRANSACTIONS
For filtering/excluding unissued transactions.
ENERGY_CHARGES
For filtering/excluding energy charge transactions: Gas or Electricity.
WATER_CHARGES
For filtering/excluding water charge transactions.
IMPORTED_CHARGES
For filtering/excluding imported charge transactions.
IMPORTED_CREDITS
For filtering/excluding imported credit transactions.
IMPORTED_REPAYMENTS
For filtering/excluding imported repayment transactions.
IMPORTED_PAYMENTS
For filtering/excluding imported payment transactions.
Example
"UNISSUED_TRANSACTIONS"TriggerProcessingStatus
Set of possible outcomes resulting from the processing of a Trigger.
Values
UNPROCESSED
PROCESSED
PROCESSING_SKIPPED
PROCESSING_FAILED
Example
"UNPROCESSED"TypeOfVoiceCampaign
The type of campaign, e.g. preview or predictive.
Values
PREVIEW
PREDICTIVE
Example
"PREVIEW"Values
NO_BILL_ISSUED_IN_LAST_60_DAYS
ACCOUNT_HAS_MULTIPLE_AGREEMENTS_INCLUDING_HALF_HOURLY
ACCOUNT_WITH_UNQUOTABLE_HALF_HOURLY_AGREEMENT
NO_ACTIVE_FIXED_DIRECT_DEBIT_PAYMENT_SCHEDULE
Example
"NO_BILL_ISSUED_IN_LAST_60_DAYS"Units
Available units relevant to electricity, gas, and water.
Values
WATT
WATT_HOURS
KILOWATT
KILOWATT_HOURS
MEGAWATT_HOURS
AMPERE
KILOAMPERE
VOLT
KILOVOLT
VOLT_AMPERE
VOLT_AMPERE_HOURS
VOLT_AMPERE_REACTIVE
VOLT_AMPERE_REACTIVE_HOURS
KILOVOLT_AMPERE
KILOVOLT_AMPERE_HOURS
KILOVOLT_AMPERE_REACTIVE
KILOVOLT_AMPERE_REACTIVE_HOURS
POWER_FACTOR
METERS_CUBED
FEET_CUBED
DECALITERS
LITER
KILOLITERS
US_GALLONS
Example
"WATT"Vendor
Possible payment vendors.
Values
GOCARDLESS
GOCARDLESS_BULB
GOCARDLESS_AFFECT
GOCARDLESS_GEN4U
GOCARDLESS_IRESA
SMARTDEBIT
WORLDPAY
ACCESS_PAYSUITE
ACCESS_PAYSUITE_EXPORT
ACCESS_PAYSUITE_FIT
ACCESS_PAYSUITE_SHELL
BOTTOMLINE_PTX
BOTTOMLINE_PTX_BATCHED
BOTTOMLINE_PTX_BATCHED_HD
BOTTOMLINE_PTX_BATCHED_HD_NHH
BOTTOMLINE_GLOBAL_PAYMENTS_HUB
STRIPE
STRIPE_CONNECT
STRIPE_CONNECT_VOICE
STRIPE_VOICE
WESTPAC
WESTPAC_ILINK
WESTPAC_ILINK_MERIDIAN
WESTPAC_ILINK_POWERSHOP
WESTPAC_QUICKSTREAM
WESTPAC_QUICKSTREAM_MERIDIAN
WESTPAC_QUICKSTREAM_POWERSHOP
GMO
GMO_CARD
STRIPE_KONBINI
TESORO
DUMMY
COMMBANK
BPOINT
TG_PAYMENTS
TG_PAYMENTS_MYPAY
PAGOPA
BUCKAROO
BUCKAROO_SEPA
TOTALENERGIES
PAYMENTUS_DIGITAL_WALLET
ADYEN
ANZ
CUSTOM
Example
"GOCARDLESS"VerificationRequestStatus
The status of verification for associated email.
Values
NOT_SENT
PENDING
COMPLETED
Example
"NOT_SENT"WANCoverageStrengths
An enumeration.
Values
HIGH
WAN coverage for this postcode is high quality.
MEDIUM
WAN coverage for this postcode is medium quality.
LOW
WAN coverage for this postcode is low quality.
Example
"HIGH"WanPrimaryIdentifierChoices
Type of primary identifier to use.
Values
UPRN
UPRN.
POSTCODE
Postcode.
Example
"UPRN"WithdrawnReasons
An enumeration.
Values
WIN_BACK
Win-back from previous supplier
HIGH_PRESSURE_SALE
High pressure sale
SWITCH_TOO_MUCH_HASSLE
Decided switch is too much hassle
MISQUOTED
Misquoted
NO_SAVING
No saving
EXIT_FEES
Want to avoid exit fees
DELAY_SSD
Want to delay SSD
OLD_SUPPLIER_DEBT
Debt with old supplier
FIRST_DD
First direct debit
NONE_GIVEN
Rather not say
OTHER
Other
Example
"WIN_BACK"WorkCategory
The work categories that an appointment can be booked for.
Values
ACCURACY_TEST
COMMISSION
COMMS_HUB_REPLACEMENT
CONFIRM_METER_DETAILS
EXCHANGE
IHD_INSTALL
INVESTIGATE_FAULT
ISOLATOR_SWITCH_INSTALL
NEW_CONNECTION
OTHER
REMOVE
Example
"ACCURACY_TEST"WorkScheduleOpenOrClosedReason
Why a Work Schedule is open or closed.
Values
CLOSED_DUE_TO_PUBLIC_HOLIDAY
CLOSED_DUE_TO_DAY_OF_WEEK
CLOSED_BEFORE_OPEN_TIME
CLOSED_AFTER_CLOSE_TIME
OPEN_INSIDE_WORK_SCHEDULE
WORK_SCHEDULE_TIME_ZONE_MISCONFIGURED
Example
"CLOSED_DUE_TO_PUBLIC_HOLIDAY"