Skip to content

Enums

Enums

AccountApplicationSalesChannel

Value Description
DIRECT
PRICE_COMPARISON
TELESALES
DIGI_TELESALES
EVENTS
FIELD_SALES
AGGREGATOR
PARTNERSHIPS
NEW_TENANT
MOVE_IN
WORKPLACE_POP_UP
BROKER
PARENT_POWER
SUPPLIER_OF_LAST_RESORT
ACQUISITION
LANDLORD

AccountApplicationStatus

Value Description
CURRENT
FAILED
HISTORIC

AccountBillingOptionsPeriodLength

Value Description
MONTHLY
QUARTERLY

AccountChargeReason

Value Description
BALANCE_TRANSFER
SOLR_BALANCE_TRANSFER
DATA_IMPORT_BALANCE_TRANSFER
BALANCE_TRANSFER_FOR_FINAL_BILLED_ACCOUNT
IMPORTED_CHARGE
SUPPLEMENTARY_LEDGER_BALANCE_TRANSFER
INCORRECT_PAYMENT_REVERSAL
REFUND
REVERSED_ACCOUNT_CREDIT
OUTGOING_BALANCE_TRANSFER
ADJUSTED_CREDIT_TO_ALLOW_REFUND
AC_ADJUSTMENT
NEST_LEARNING_THERMOSTAT_RENTAL
BUSINESS_ADVANCE_PAYMENT
PREPAY_BALANCE_ADJUSTMENT
FEED_IN_TARIFF_PAYMENT_TRANSFER_TO_NOMINATED_RECIPIENT
SERVICE_ORDER
CUSTOM
AUTO_RECONCILIATION
DEFAULT
BALANCE_TRANSFER_FOR_FINAL_BILLED_ACCOUNT_20
CREDIT_BALANCE_DONATED_TO_CHARITY
DIRECT_DEBIT_REFUND_BALANCING
METERING_JOB_BUSINESS
METERING_JOB_NATIONAL_GRID
METERING_JOB_SMS
PENALTY_CHARGE
PREPAY_DEBT_ADJUSTMENT
BUSINESS_PREPAYMENT
WRITE_BACK
EARLY_EXIT_FEE
DCA_CHARGE
GREEN_DEAL_CHARGE
WATER
PAPER_BILL_FEE
OVER_THE_COUNTER_PAYMENT_FEE
CARBON_OFFSET

AccountChargeReasonType

Value Description
DEFAULT

AccountCreditReason

Value Description
ADDITIONAL_STANDARD_PAYMENT
BALANCE_ADJUSTMENT
BALANCE_TRANSFER
BANK_TRANSFER
CUSTOMER_REIMBURSEMENT
DISPUTED_CARD_PAYMENTS
IMPORTED_CREDIT
MARKET_RESEARCH_CLUB_REWARD
OFFSET
PREPAY_DEBT_ADJUSTMENT
REFERRALCANDY_INCENTIVE
REINSTATED_DIRECT_DEBIT
SOLR_BALANCE_TRANSFER
DATA_IMPORT_BALANCE_TRANSFER
BALANCE_TRANSFER_FOR_FINAL_BILLED_ACCOUNT
SOLR_WRITE_OFF
SOLR_EX_CUSTOMER_CREDIT
SUPPLEMENTARY_LEDGER_BALANCE_TRANSFER
SHARE_OF_PROFITS
GOODWILL_PAYMENT
DEPOSIT_REFUND
GO_CARDLESS_CHARGEBACK_CANCELLED
CHEQUE_PAYMENT_RECEIVED
GSS_FAILURE
ERRONEOUS_TRANSFER_REFUND
WAIVE_TERMINATION_FEES
ADJUSTED_CREDIT_TO_ALLOW_REFUND
DIRECT_DEBIT_BANK_CHARGE_MAY
GAS_OFF_SUPPLY_PAYMENT
HONOURED_BANK_CHARGES
MANAGEMENT_WAIVED_FEES
CLOSED_REVERSION
GSS_FAILURE_MOP
GSS_AFFECT
REVERSIONED_POST_DD_CANX
INCOMING_PAYMENT_GO_CARDLESS
DEBIT_BALANCE_TRANSFER
RECEIVED_VIA_CREDIT_STYLE
TARIFF_PRICE_ADJUSTMENT_GOODWILL
ECONOMY_7_DIFFERENCE
WRITE_OFF_BACK_BILLING
WRITE_OFF_PAST_BILLABLE_AUTOMATED
WRITE_OFF_MISSED_DELETION
TARIFF_DISCOUNT
RETURNED_BUSINESS_ADVANCE_PAYMENT
CUSTOM
STANDARDS_OF_PERFORMANCE_ERRONEOUS_TRANSFER
ADDITIONAL_SOP_PAYMENT_ERRONEOUS_TRANSFER
EXTERNAL_REFERRAL_CREDIT
STANDARDS_OF_PERFORMANCE_PAYMENTS
DISC_WARM_HOME_DISCOUNT
PAYMENT_AUSPOST
PAYMENT_IVR
PAYMENT_EAPA_VOUCHER
PAYMENT_CHEQUE
PAYMENT_BPAY
PAYMENT_CREDIT_CARD
PAYMENT_CENTREPAY
PAYMENT_BANK_ACCOUNT
ACCURACY_TEST_ADJUSTMENT
CUSTOMER_SERVICE_GESTURE
EXIT_FEE_REFUND
FEED_IN_TARIFF_PAYMENT
GAS_NETWORK_COMPENSATION
JOINING_REWARD
LOYALTY_REWARD
MISSED_SAVINGS
REFERRAL_REWARD
RETURNED_BUSINESS_PREPAYMENT
SALES_COMPENSATION
EXPORT_TARIFF_PAYMENT
WRITE_OFF_BANKRUPTCY
WRITE_OFF_DECEASED
WRITE_OFF_DRO
WRITE_OFF_IVA
WRITE_OFF_NEGLIGIBLE_VALUE
WRITE_OFF_UNRECOVERABLE_DEBT
WRITE_OFF_PAST_BILLABLE
WRITE_OFF_RECOVERY_DISCOUNT
WITHDRAWAL_NOT_ACTIONED
STAFF_DISCOUNT
DIRECT_DEBIT_DISCOUNT
REVERSE_ENERGY_CHARGE
REVERSED_ACCOUNT_CHARGE
WARM_HOME_DISCOUNT_BROADER_GROUP
WARM_HOME_DISCOUNT_CORE_GROUP
STANDARDS_OF_PERFORMANCE_ET_COMMS_OVERDUE
STANDARDS_OF_PERFORMANCE_ET_LOSS_UNRESOLVED
STANDARDS_OF_PERFORMANCE_ET_GAIN_UNRESOLVED
STANDARDS_OF_PERFORMANCE_CUSTOMER_NOT_RETURNED
STANDARDS_OF_PERFORMANCE_ET_GAIN_ACCEPTED
ADDITIONAL_SOP_PAYMENT_ET_COMMS_OVERDUE
ADDITIONAL_SOP_PAYMENT_ET_LOSS_UNRESOLVED
ADDITIONAL_SOP_PAYMENT_ET_GAIN_UNRESOLVED
ADDITIONAL_SOP_PAYMENT_CUSTOMER_NOT_RETURNED
ADDITIONAL_SOP_PAYMENT_ET_GAIN_ACCEPTED
STANDARDS_OF_PERFORMANCE_APPOINTMENTS_STANDARD_VISIT_ELEC
STANDARDS_OF_PERFORMANCE_APPOINTMENTS_FAULTY_METER_ELEC
STANDARDS_OF_PERFORMANCE_APPOINTMENTS_PREPAY_METER_ELEC
STANDARDS_OF_PERFORMANCE_APPOINTMENTS_RECONNECTION_ELEC
STANDARDS_OF_PERFORMANCE_LATE_SWITCH_ELEC
SINGLE_RATE_RMI
ADDITIONAL_SOP_PAYMENT_ELECTRICITY_SWITCH_DELAYED
STANDARDS_OF_PERFORMANCE_APPOINTMENTS_STANDARD_VISIT_GAS
STANDARDS_OF_PERFORMANCE_APPOINTMENTS_FAULTY_METER_GAS
STANDARDS_OF_PERFORMANCE_APPOINTMENTS_PREPAY_METER_GAS
STANDARDS_OF_PERFORMANCE_APPOINTMENTS_RECONNECTION_GAS
STANDARDS_OF_PERFORMANCE_LATE_SWITCH_GAS
STANDARDS_OF_PERFORMANCE_REFUND_ISSUED_LATE
STANDARDS_OF_PERFORMANCE_FINAL_BILL_ISSUED_LATE
ADDITIONAL_SOP_PAYMENT_APPOINTMENTS
PAYMENT_TRANSFER_FROM_SAP
NSW_FAMILY_ENERGY_REBATE
NSW_GOVERNMENT_GAS_REBATE
NSW_GOVERNMENT_HOUSEHOLD_REBATE
NSW_GOVERNMENT_LIFE_SUPPORT_REBATE
NSW_MEDICAL_ENERGY_REBATE
QLD_GOVERNMENT_ELECTRICITY_REBATE
QLD_GOVERNMENT_GAS_REBATE
QLD_ASSET_OWNERSHIP_DIVIDEND
SA_GOVERNMENT_ENERGY_CONCESSION
SME_REVERSED_PRE_MIGRATION_CHARGE
VIC_GOVERNMENT_ANNUAL_ELECTRICITY_CONCESSION
VIC_GOVERNMENT_CONTROLLED_LOAD_CONCESSION
VIC_GOVERNMENT_EXCESS_ELECTRICITY_CONCESSION
VIC_GOVERNMENT_LIFE_SUPPORT_CONCESSION
VIC_GOVERNMENT_MEDICAL_COOLING_CONCESSION
VIC_GOVERNMENT_SERVICE_TO_PROPERTY_CONCESSION

AccountCreditReasonType

Value Description
EXTERNAL_REFERRAL_CREDIT

AccountEventType

Value Description
EMAIL_SENT
EMAIL_RECEIVED

AccountPaymentStatusOptions

Value Description
SCHEDULED
PENDING
CLEARED
FAILED
PROMISED
FULFILLED
PROMISE_BROKEN
HISTORIC
THIRD_PARTY
REQUESTED

AccountRepaymentStatusOptions

Value Description
REQUESTED
APPROVED
SUBMITTED
FAILED
PAID
THIRD_PARTY
HISTORIC

AccountStatus

Value Description
PENDING
INCOMPLETE
WITHDRAWN
ACTIVE
ENROLMENT_ERROR
ENROLMENT_REJECTED
DORMANT

AccountTypeChoices

Value Description
BUSINESS
DOMESTIC
BUSINESS_OCCUPIER
OCCUPIER

BandCategory

Value Description
STANDING_CHARGE
CONSUMPTION_CHARGE

BillTypeEnum

Value Description
STATEMENT
INVOICE
CREDIT_NOTE
PRE_KRAKEN

Category

Value Description
FILE_ATTACHMENT_CUSTOMER_SIGNATURE

CodeType

Value Description
PROMO_CODE
REFERRAL_CODE
SIGNUP_CODE

CollectDepositStatusChoices

Value Description
APPROVED
CLEARED
CANCELLED
HELD_FOR_REVIEW
FAILED
PENDING
REQUESTED
SCHEDULED
NONE

CommsDeliveryPreference

Value Description
EMAIL
POSTAL_MAIL

ConsumptionUnit

Value Description
kWh
MJ

CreditCheckStatus

Value Description
PASSED
FAILED
NOT_AVAILABLE

Currency

Value Description
AUSTRALIAN_CENTS
UK_PENCE
EURO_CENTS
USA_CENTS
JAPANESE_YEN
NEW_ZEALAND_CENTS

DeletePushNotificationBindingOutput

Value Description
SUCCESSFUL
FAILED

DirectDebitInstructionStatus

Value Description
ACTIVE
PROVISIONAL
FAILED
ACCOUNT_CLOSED

EFLFileServiceProvider

Value Description
AEP_TCC
AEP_TNC
CENTERPOINT
ONCOR
TNMP

EFLLanguage

Value Description
EN
ES

ElectricityMeterPointLoadZone

Value Description
LZ_HOUSTON
LZ_NORTH
LZ_SOUTH
LZ_WEST

ElectricityMeterPointServiceProvider

Value Description
AEP_TCC
AEP_TNC
CENTERPOINT
ONCOR
TNMP

ElectricityMeterPointStatus

Value Description
INITIAL
PENDING_MOVE_IN_REQUEST
PENDING_MOVE_OUT_REQUEST
PENDING_SWITCH_REQUEST
CANCELLED_APPLICATION
REJECTED_APPLICATION
PENDING_APPLICATION_ACCEPTANCE
PENDING_MOVE_OUT_RESPONSE
PENDING_FINAL_USAGE
PENDING_INITIAL_METER_READ
PENDING_SWITCH_HOLD_REQUEST
PENDING_SWITCH_HOLD_RESPONSE
PENDING_DISCONNECT_REQUEST
PENDING_DISCONNECT_RESPONSE
PENDING_RECONNECT_REQUEST
PENDING_RECONNECT_RESPONSE
DISCONNECTED
SWITCH_HOLD
ON_SUPPLY
LOST
CUSTOM_REQUIREMENT_NEEDED

EmailFormats

Value Description
TEXT
HTML

EstimationInterval

Value Description
MONTHLY
ANNUALLY

ExpiringTokenScope

Value Description
SUBMIT_METER_READINGS
SUBMIT_CUSTOMER_FEEDBACK
BOOK_SMART_METER_APPOINTMENTS

FormType

Value Description
COVID_19_FINANCIAL_ENERGY_ASSESSMENT
COVID_19_GAS_PRICES_FINANCIAL_ENERGY_ASSESSMENT

LanguagePreferenceChoices

Value Description
ENGLISH
SPANISH

LegalDocumentLanguageOption

Value Description
ENGLISH
SPANISH

LinkTrainingStatus

Value Description
NOT_APPLICABLE
IN_TRAINING
QUALIFIED

LinkedObjectType

Value Description
ACCOUNT
ACCOUNT_USER

LoadZone

Value Description
LZ_HOUSTON
LZ_NORTH
LZ_SOUTH
LZ_WEST

LoadZoneName

Value Description
LZ_HOUSTON
LZ_NORTH
LZ_SOUTH
LZ_WEST

MaximumRefundReasonChoices

Value Description
MAX_AVAILABLE_AMOUNT
TOTAL_AMOUNT_PAID_VIA_ACTIVE_DDI
MAX_ALLOWED_TO_REQUEST_VIA_DASHBOARD

NotifiableApplicationExternalProvider

Value Description
PINPOINT

NotifiableApplicationService

Value Description
GCM
APNS
APNS_SANDBOX

PaymentFrequencyOptions

Value Description
Daily
Weekly
Monthly

PaymentMethods

Value Description
DIRECT_DEBIT
CREDIT_CARD
PAY_ON_RECEIPT

PaymentReasonOptions

Value Description
BALANCE_THRESHOLD_CROSSED
BILL_ISSUED
PAYMENT_PLAN
REGULAR_SCHEDULE

PaymentScheduleReasonOptions

Value Description
GENERAL_ACCOUNT_PAYMENT
SSD_PAYMENT
FINAL_PAYMENT
DEBT_REPAYMENT_PLAN

PaymentScheduleScheduleType

Value Description
BACS_TRANSFER
CARD_PAYMENT
DIRECT_DEBIT

PaymentType

Value Description
DIRECT_DEBIT
CARD

PostcodeZoneMappingLoadZone

Value Description
LZ_HOUSTON
LZ_NORTH
LZ_SOUTH
LZ_WEST

PostcodeZoneMappingServiceProvider

Value Description
AEP_TCC
AEP_TNC
CENTERPOINT
ONCOR
TNMP

PreSignedTokenScope

Value Description
SUBMIT_METER_READINGS
SUBMIT_CUSTOMER_FEEDBACK
BOOK_SMART_METER_APPOINTMENTS

ProductAvailabilityStatus

Value Description
PUBLIC
RESTRICTED

ReadingFrequencyType

Field Type Description
FIVE_MIN_INTERVAL String Readings taken in every 5 minute intervals.
FIFTEEN_MIN_INTERVAL String Readings taken in every 15 minute intervals.
THIRTY_MIN_INTERVAL String Readings taken in every 30 minute intervals.
HOUR_INTERVAL String Fifteen minute interval readings aggregated by the hour.
DAY_INTERVAL String Fifteen minute interval readings aggregated by day. Note: this interval is distinct from `DAILY`. These readings _should_ match `DAILY` with respect to total kWh; however, it is possible they will not match exactly.
WEEK_INTERVAL String Fifteen minute interval readings aggregated by week.
MONTH_INTERVAL String Fifteen minute interval readings aggregated by month.
QUARTER_INTERVAL String Fifteen minute interval readings aggregated by quarter.
DAILY String Readings taken on a day to day basis. These readings come from our vendor and are distinct from readings aggregated by `DAY_INTERVAL`. These readings _should_ match `DAY_INTERVAL` with respect to total kWh; however, it is possible they will not match exactly.

ReadingDirectionType

Field Type Description
CONSUMPTION String Reading is based on the customer's usage of the utility.
GENERATION String Reading is based on the utility generated by the customer.

ReadingQualityType

Field Type Description
ACTUAL String Query only for verified reading values. OEUS only supports `Actual` readings.
ESTIMATED String Query only for estimated reading values. Unsupported in OEUS.
COMBINED String Query for both reading types. Unsupported in OEUS.

UtilityType

Field Type Description
ELETRICITY String
GAS String

ReadingStatisticTypeEnum

Field Type Description
STANDING_CHARGE_COST String The calculated cost of standing charges for the interval. Unsupported by OEUS.
CONSUMPTION_COST String The calculated cost of consumption for the interval. Supported by OEUS for variable rate products.
GENERATION_COST String The calculated cost of generation for the interval. Supported by OEUS for all product types.
TOU_BUCKET_COST String The apportion cost of a time of use bucket for the interval. Unsupported by OEUS.
CARBON_COST String The estimated carbon cost of the interval. Unsupported by OEUS.

ReferralCodeApplicationStatusChoices

Value Description
PROMO_CODE_APPLIED
REFERRAL_CODE_APPLIED
SIGNUP_CODE_APPLIED

RiskBracket

Value Description
LOW
MEDIUM
HIGH

SalesSubchannel

Value Description
LEVIATHAN
SUPPORT_SITE
ICHOOSR
BILL_BUDDY
NAVIGATOR

ServiceProvider

Value Description
AEP_TCC
AEP_TNC
CENTERPOINT
ONCOR
TNMP

SettlementPointOptions

Value Description
HB_BUSAVG
HB_HOUSTON
HB_HUBAVG
HB_NORTH
HB_PAN
HB_SOUTH
HB_WEST
LZ_AEN
LZ_CPS
LZ_HOUSTON
LZ_LCRA
LZ_NORTH
LZ_RAYBN
LZ_SOUTH
LZ_WEST

ShellAccountEnrollmentTypeEnum

Value Description
PENDING_MOVE_IN_REQUEST
PENDING_SWITCH_REQUEST

Songs

Value Description
NO_SONG_PREFERRED

SortByOptions

Value Description
GREATER_THAN
LESS_THAN
EQUAL_TO
LESS_THAN_OR_EQUAL_TO
GREATER_THAN_OR_EQUAL_TO

StatementReversalsAfterClose

Value Description
ALL
SOME
NONE
NOT_CLOSED

TimeOfUse

Value Description
DAY
NIGHT

TransactionTypeFilter

Value Description
ENERGY_CHARGES

UnitType

Value Description
DAYS_ON_SUPPLY
KWH_CONSUMPTION
MEGAJOULES_CONSUMPTION
MONTHS_ON_SUPPLY_PER_DIEM
PARTNER_CHARGES_INCURRED
MONTHS_ON_SUPPLY
PER_ITEM

UtilityType

Field Type Description
GAS String
ELECTRICITY String

communication_preference

Value Description
ONLINE
PRINT
Back to top