About Enums
Enums represent possible sets of values for a field. They are useful for defining a specific set of allowed values for a field.
APIBrownoutStatus
Possible API Brownout statuses.
Values
ABORTED
CANCELLED
COMPLETED
IN_PROGRESS
SCHEDULED
Example
"SCHEDULED"APIExceptionResolutionStatus
An enumeration.
Values
ASSIGNED
CANCELLED
IN_PROGRESS
RESOLVED
UNASSIGNED
UNSUCCESSFUL
WAITING_ON_THIRD_PARTY
Example
"ASSIGNED"APIExceptionTags
An enumeration.
Values
FDV
LIFE_SUPPORT
MOVE_IN
MOVE_OUT
PRODUCT_UPDATE
SAME_DAY
TRANSFER_IN
VACANT_CONSUMPTION
Example
"FDV"AccountBillingOptionsPeriodLength
An enumeration.
Values
MONTHLY
Monthly
QUARTERLY
Quarterly
Example
"MONTHLY"AccountCreditReasonType
Please note: these labels are exposed in the API documentation.
Values
EXTERNAL_REFERRAL_CREDIT
External referral credit
Example
"EXTERNAL_REFERRAL_CREDIT"AccountEventType
An enumeration.
Values
EMAIL_RECEIVED
The email messages that were received by the account.
EMAIL_SENT
The email messages that were sent by the account.
MARKETING_EMAIL_SENT
The marketing email messages that were sent by the account.
PRINT_CANCELLED
The print messages that were cancelled.
PRINT_FAILED
The print messages that failed to be delivered.
PRINT_RETURNED
The print messages that were returned to sender.
PRINT_SENT
The print messages that were sent to the print partner by the account.
PRINT_SUCCEEDED
The print messages that were sent by the print partner.
SMS_RECEIVED
The SMS messages that were received by the account.
SMS_SENT
The SMS messages that were sent by the account.
Example
"EMAIL_SENT"AccountPaymentStatusOptions
The current status of the payment. Note: REQUESTED payments are excluded by default.
Values
CLEARED
The payment has been approved by the merchant and added to your Kraken account.
DELETED
This payment was deleted. From this point it cannot be altered.
FAILED
The payment failed permanently.
FULFILLED
The payment has been made successfully and applied to the Kraken balance.
HISTORIC
Payments made in a previous system and then imported into Kraken.
PENDING
The payment has been submitted. From this point it cannot be altered.
PROMISED
A payment promise has been created, but it has not left the customers bank account.
PROMISE_BROKEN
The payment promise has been broken.
REQUESTED
The initial state of a payment in Kraken. It should be scheduled with a payment vendor in the future.
SCHEDULED
The payment has been scheduled for collection and the customer has been notified. While a payment is scheduled, it can still be deleted.
THIRD_PARTY
Third Party payments are those recorded for financial purposes in a different system but should be added to statements.
Example
"SCHEDULED"AccountPaymentTransactionTypeChoices
An enumeration.
Values
AGENCY
ALLPAY_CARD
ALLPAY_CASH
ALLPAY_CHEQUE
AUSTRALIA_POST
BACS_DEPOSIT
BPAY
BPOINT
BRISTOL_POUND
BTRE
CASH
CENTREPAY
CHEQUE
CREDIT_CARD
DCA_COLLECTION
DD_FINAL_COLLECTION
DD_FIRST_COLLECTION
DD_REGULAR_COLLECTION
DD_RE_PRESENTATION
DEBIT_CARD
DESKTOP_DEPOSIT
DWP
EAPA_VOUCHER
EBOX
EFT
ERRONEOUS_PAYMENT
FAILED_REPAYMENT_REVERSAL
FUEL_DIRECT
HEEAS
IDEAL
IVR
KONBINI
MONEYGRAM
PAGOPA_NOTICE
PAYMENT_FEE
PAYPAL
PAYPOINT_CARD
PAYPOINT_CASH
PAYPOINT_CHEQUE
PAYZONE
POST_OFFICE_CARD
POST_OFFICE_CASH
POST_OFFICE_CHEQUE
POST_OFFICE_SAVINGS_STAMPS
PREPAID_CARD
PREPAY_CARD
PREPAY_KEY
PREPAY_SMART
PREPAY_TOKEN
SERVICE_TICKET
SOCIAL_WELFARE_PAYMENT
TELPAY
TRANSFER_FROM_SAP
UNKNOWN
URGS
WALMART_CASH
Example
"DD_FIRST_COLLECTION"AccountReminderTypes
Contains reminder type choices for all territories.
Values
ACCOUNT_COOL_OFF
ACCOUNT_MIGRATION_SYNC_XOSERVE_METER_MISMATCH
ACTIVATE_PAYMENT_CANCELLATION_STOPPED
AD_HOC
AGREEMENT_REVOKED
AMPERAGE_CHANGE
ASSIGNED_TO_CREDIT_TEAM
AUS_CENTREPAY_EXCESSIVE_CREDIT
AUS_EMBEDDED_ACQUISITION_MATRIX_ERROR
AUS_EMBEDDED_CHILD_NMIS
AUS_EMBEDDED_WATER_ESTIMATION_REQUIRED_FOR_SKIPPED_READING
AUS_EMBEDDED_WATER_READING_FAILURE
AUS_INDUSTRY_CUSTOMER_OWN_READING_NOT_SENT
AUS_VIC_SHAREDFUSE_NOTIFICATION
AUTOMATED_BILLING_DISABLED
BILLING
BILLING_AMENDED_METER_READ_BASIC
BILLING_AMENDED_METER_READ_CES_ELEC_BASIC
BILLING_AMENDED_METER_READ_CES_ELEC_INTERVAL
BILLING_AMENDED_METER_READ_GAS
BILLING_AMENDED_METER_READ_INTERVAL
BILLING_AMENDED_METER_READ_PRE_MIGRATION
BILLING_CUSTOMER_SELF_READ_RECEIVED
BILLING_MISSING_READ
BILLING_QUOTED_NTC_DOES_NOT_ALIGN
BILLING_REGISTER_REPLACED_OR_REMOVED
CANCEL_MOVE_OUT_UNABLE_TO_REINSTATE_FUTURE_AGREEMENTS
CHURN_PREVENTION
COLLECTION_PROCESS_COMMS_FAILURE
COMMERCIAL_ENERGISATION_INTERVENTION_REQUIRED
COMMS_TO_BE_PRINTED
CONTRACT_COMMS_NOT_DELIVERED
COS_GAIN
COS_GAIN_MIGRATION_ECOES_METER_MISMATCH
COS_GAIN_REL_RETRIEVAL_FAILURE
COS_LOSS
CUSTOMER_DETAILS_CHANGE
DEU_INBOUND_APERAK
DEU_MASTER_DATA_SYNCHRONISATION
DEU_MASTER_DATA_UPDATE
DEU_METER_READINGS
DEU_SWICHTING_PROCESS_FAILED
DISCONNECTION_MANDATORY_NOTICE_EMAIL_FAILURE
DISCONNECTION_MANDATORY_NOTICE_SMS_FAILURE
DUNNING_BEST_ENDEAVOURS_CALL
DUNNING_DISCONNECTION_DE_ENERGISATION_ASSESSMENT
DUNNING_DISCONNECTION_MANDATORY_NOTICE_EMAIL_FAILURE
DUNNING_DISCONNECTION_OUTBOUND_REMINDER_CALL
DUNNING_MANDATORY_NOTICE_EMAIL_FAILURE
DUNNING_OUTBOUND_REMINDER_CALL
DUNNING_REMINDER
DUNNING_REMINDER_CALL
DUNNING_REMINDER_DISCONNECTION_APPLICATION
DUNNING_REMINDER_FUTURE_PAYMENT
DUNNING_REMINDER_PAYMENT_MADE
DUNNING_VACANT_CONSUMPTION_DE_ENERGISATION_ASSESSMENT
DUPLICATE_CARD_FINGERPRINTs
EMBEDDED_NETWORK_ALL_CHILD_LIFE_SUPPORT_RECORDS_ARE_DEREGISTERED
EMBEDDED_NETWORK_EXCEPTION_DISTRIBUTOR_OWNED_PARENT_LIFE_SUPPORT_RECORD
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_LOST_OR_LOSING
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_RECEIVED_DANGEROUS_LIFE_SUPPORT_NOTIFICATION
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_RECEIVED_LIFE_SUPPORT_NOTIFICATION
FAMILY_ISSUES_ADDED
FIELDWORKS_ACCOUNT_CREATED_WITH_NO_EMAIL_ADDRESS
FIELDWORKS_ALLOCATE_NMI_MARKET_PARTICIPANTS_NOT_SET
FIELDWORKS_APPOINTMENTS_UNAVAILABLE
FIELDWORKS_BULK_DEPLOYMENT_JOURNEY_AUTO_CANCELLED
FIELDWORKS_CHANGE_REQUEST_STEP_ERRORED
FIELDWORKS_CHANGE_REQUEST_STEP_FAILED
FIELDWORKS_CONTACT_SO_RECIPIENT_TO_UPDATE_THE_SO_DETAILS
FIELDWORKS_EXPECTED_METER_POINT_NOT_CREATED
FIELDWORKS_EXPECTED_METER_READ_NOT_RECEIVED
FIELDWORKS_EXPECTED_NTCS_NOT_RECEIVED
FIELDWORKS_INVESTIGATE_WHETHER_JOURNEY_NEEDS_CONTINUATION
FIELDWORKS_JOURNEY_ATTACHMENTS
FIELDWORKS_JOURNEY_CANCELLED_DUE_TO_LIFE_SUPPORT_REGISTRATION
FIELDWORKS_MAINTAIN_REGISTER_BILLABLE_OVERRIDE_FOR_UNSOLICITED_METER_CHANGES
FIELDWORKS_MANUALLY_COMPLETE_CUSTOMER_MOVE_IN
FIELDWORKS_METERPOINT_IS_NOT_ACTIVE
FIELDWORKS_METER_FAULT_JOURNEY_AUTO_CANCELLED
FIELDWORKS_MIRN_DISCOVERY_FAILED
FIELDWORKS_MOVE_OUT_CANCELLED_WHILE_SUPPLY_ABOLISHMENT_IN_PROGRESS
FIELDWORKS_MULTIPLE_OPEN_JOURNEYS_FOR_METER_POINT
FIELDWORKS_NEW_CONNECTION_COMPLETION_REVIEW
FIELDWORKS_NEW_CONNECTION_DATA_NOT_VALID
FIELDWORKS_OBTAIN_CUSTOMER_APPROVAL_BEFORE_PROGRESSING
FIELDWORKS_OBTAIN_SUPPLY_ABOLISHMENT_APPROVAL
FIELDWORKS_PAYER_CONTACT_FAILED_VALIDATION
FIELDWORKS_SERVICE_ORDER_ATTACHMENTS
FIELDWORKS_SERVICE_ORDER_COMPLETED
FIELDWORKS_SERVICE_ORDER_FAILED
FIELDWORKS_SERVICE_ORDER_PARTIALLY_COMPLETED
FIELDWORKS_SERVICE_ORDER_STATUS_UPDATED
FIELDWORKS_SERVICE_ORDER_STEP_ERRORED
FIELDWORKS_SERVICE_ORDER_STEP_FAILED
FIELDWORKS_SERVICE_ORDER_UNABLE_TO_ACCESS_WITHOUT_CUSTOMER_CONSULTATION
FIELDWORKS_SERVICE_ORDER_UNABLE_TO_ACCESS_WITH_CUSTOMER_CONSULTATION
FIELDWORKS_SUPPLY_PERIOD_DOES_NOT_EXIST_FOR_METERPOINT
FIELDWORKS_UPLOAD_ATTACHMENT_TO_JEMENA_PORTAL
FINAL_BILLING_UNABLE_TO_BILL
FLOW_FILE_ERROR
FOLLOW_UP_PAYMENT_PROMISE
FRA_ACTIVATION_PROCESS_AWAITING_SWITCH_IN_CONFIRMATION
FRA_ACTIVATION_PROCESS_AWAITING_SWITCH_READINGS
FRA_ACTIVATION_PROCESS_COMMANDER_SOUSCRIPTION
FRA_ACTIVATION_PROCESS_GAS_PROVIDER_CHANGE_REQUEST
FRA_ACTIVATION_PROCESS_INCEPTION_CHECKS
FRA_ACTIVATION_PROCESS_PRM_ELIGIBILITY
FRA_ACTIVATION_PROCESS_SCHEDULE_SITEWORKS
FRA_ELEC_ACTIVATION_PROCESS_WRONG_SWITCH_READINGS_FOR_PROVIDER_CALENDAR_TEMPORAL_CLASSES
FRA_ENERGY_CHEQUE_UNKNOWN
FRA_TERMINATION_PROCESS_NEEDS_INTERVENTION
FRA_TERMINATION_REQUEST_ERRORED
GAS_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_FAILED
GAS_EXCEPTION_CUSTOMER_TRANSFER_CANCELLED
GAS_EXCEPTION_CUSTOMER_TRANSFER_REJECTED
GAS_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_FAILED
GAS_EXCEPTION_METER_DATA_VERIFY_REQUEST_FAILED
GAS_EXCEPTION_METER_DATA_VERIFY_RESPONSE_NO_CHANGE_WITH_EXPLANATION
GAS_EXCEPTION_METER_DATA_VERIFY_RESPONSE_OVERDUE
GAS_EXCEPTION_METER_DATA_VERIFY_RESPONSE_WITHOUT_REVISED_READ
GAS_EXCEPTION_SITE_ACCESS_DETAILS_NOTIFICATION_FAILED
GAS_EXCEPTION_SITE_ACCESS_DETAILS_RECEIVED_FOR_NON_EXISTENT_METER
GAS_EXCEPTION_SITE_ADDRESS_DETAILS_NOTIFICATION_FAILED
GAS_MANUAL_SERVICE_ORDER_REQUIRED_FOR_ENROLMENT
GAS_NOTIFICATION_CHANGE_OF_SITE_ADDRESS
GAS_READING_REMOVED_INSTALLED_RECEIVED
GAS_UNKNOWN_CUSTOMER_CLASSIFICATION_CODE_RECEIVED
GBR_ADD_PHOTO_TO_METER_READING
GBR_GET_PHOTO_OF_METER_AND_CALL_SUPPLIER
GBR_RAISE_DISPUTE
GBR_VERIFY_MHHS_MESSAGE
HARDSHIP_GRADUATION_ASSESSMENT
HARDSHIP_NO_PAYMENT_PLAN
HARDSHIP_REMOVAL_ASSESSMENT
HELD_BILLING_DOCUMENT
HELD_STATEMENT
INDUSTRY_CHANGE_OF_SUPPLIER_DOUBLE_GAIN
INDUSTRY_CUSTOMER_TRANSFER_DELAYED
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_CANCELLED
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_CONFLICTING_PERIOD
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_GAIN_COMPLETION_OVERDUE
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_OBJECTED
INDUSTRY_EXCEPTION_CHANGE_OF_SUPPLIER_REJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_CANCELLATION_FAILED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_CANCELLED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_COMPLETED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTION_MISSING_ACK
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTION_REJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_OBJECTION_WITHDRAWAL_REJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_REJECTED
INDUSTRY_EXCEPTION_CHANGE_REQUEST_UNABLE_TO_WITHDRAW
INDUSTRY_EXCEPTION_CHANGE_REQUEST_WITHDRAWAL_REJECTED
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_INVALID_BILLING_ADDRESS
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_MISSING_MANDATORY_FIELDS
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_NOTIFICATION_REJECTED
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_REQUEST_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_REQUEST_REJECTED
INDUSTRY_EXCEPTION_CUSTOMER_DETAILS_REQUEST_SPECIAL_REASON
INDUSTRY_EXCEPTION_FAILED_TO_CANCEL_DEENERGISATION_SERVICE_ORDER
INDUSTRY_EXCEPTION_HOUSE_MOVE_ENROLMENT_CANNOT_CALCULATE_MOVE_IN_READING
INDUSTRY_EXCEPTION_HOUSE_MOVE_ENROLMENT_SERVICE_ORDER_ALREADY_IN_PROGRESS
INDUSTRY_EXCEPTION_HOUSE_MOVE_ENROLMENT_UNABLE_TO_COPY_LAST_METER_READING
INDUSTRY_EXCEPTION_HOUSE_MOVE_OUT_CANNOT_CALCULATE_MOVE_OUT_READING
INDUSTRY_EXCEPTION_LIFE_SUPPORT_CONTACT_USER_REMOVED_FROM_ACCOUNT
INDUSTRY_EXCEPTION_LIFE_SUPPORT_MULTIPLE_ACCOUNTS_MATCHES
INDUSTRY_EXCEPTION_LIFE_SUPPORT_MULTIPLE_LIFE_SUPPORT_CONTACT_MATCHES
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_CONTAINS_UNEXPECTED_DATA
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_FAILED_TO_SEND
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_INVALID_CONTACT_METHOD
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_INVALID_PHONE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_RECEIVED_FROM_NON_REGISTRATION_OWNER
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_REJECTED
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_UNKNOWN_CONTACT
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_MISSING_LIFE_SUPPORT_NOTIFICATION
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_REJECTED
INDUSTRY_EXCEPTION_METER_POINT_ENROLMENT_INCOMPLETE_COULD_NOT_SEND_SERVICE_ORDER
INDUSTRY_EXCEPTION_NEXT_SCHEDULED_READ_DATE_TOO_FAR_IN_FUTURE
INDUSTRY_EXCEPTION_RELINKING_OCCURRED_DURING_SDR_SYNC
INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_NOTIFICATION_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_NOTIFICATION_REJECTED
INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_REQUEST_REJECTED
INDUSTRY_EXCEPTION_STANDING_DATA_PROPERTIES_ADDRESS_FAILED_TO_UPDATE
INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_INCOMPLETE_COULD_NOT_SEND_CHANGE_REQUEST
INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_INVALID_NMI_METER_STATUS
INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_NEXT_SCHEDULED_READ_DATE_PAST
INDUSTRY_EXCEPTION_UNABLE_TO_PROCESS_ROLR
INDUSTRY_LIFE_SUPPORT_CANCEL_DEREGISTRATION_FAILED
INDUSTRY_LIFE_SUPPORT_MANUAL_BEST_ENDEAVOUR_REQUIRED
INDUSTRY_LIFE_SUPPORT_REGISTRATION_FOLLOW_UP_REQUIRED
INDUSTRY_LIFE_SUPPORT_REVIEW_AFTER_CANCELLED_MOVE_OUT_FOR_NEXT_ACCOUNT
INDUSTRY_LIFE_SUPPORT_REVIEW_ATTEMPTED_CANCELLED_MOVE_OUT_FOR_NEXT_ACCOUNT
INDUSTRY_LIFE_SUPPORT_REVIEW_DEREGISTRATION
INDUSTRY_LIFE_SUPPORT_REVIEW_POST_DEREGISTRATION
INDUSTRY_LIFE_SUPPORT_REVIEW_POST_DEREGISTRATION_COMMS
INDUSTRY_MANUAL_ACTION_REQUIRED
INDUSTRY_MANUAL_CUSTOMER_DETAILS_NOTIFICATION_REQUIRED
INDUSTRY_MANUAL_LIFE_SUPPORT_NOTIFICATION_REQUIRED
INDUSTRY_METER_POINT_MISSING_CUSTOMER_CLASSIFICATION
INDUSTRY_SEND_LIFE_SUPPORT_DE_REGISTRATION_FORM
INDUSTRY_UNABLE_TO_CREATE_RECORD
INDUSTRY_VIC_DRO_MANUAL_LIFE_SUPPORT_EXTENSION_REQUEST
INDUSTRY_WARNING_MESSAGE_RECEIVED
ITA_ACCOUNT_WITHDRAWN_WITHOUT_NOTIFICATION
ITA_PROCESS_WELCOME_PACK_STEP
JPN_BILLING_FIX_INVALID_CHARGE_DATA
JPN_BILLING_PATTERN_CHANGED_DUE_TO_READING_DATE_CHANGE
JPN_CONFIRMATION_OF_RELOCATION
JPN_FAILED_TO_SEND_SMS_FOR_BILLING_INFO
JPN_FAILED_TO_SEND_SMS_FOR_CONVENIENCE_STORE_PAYMENT
JPN_FINAL_READING_OUTSIDE_AGREEMENT
JPN_MULTIPLE_VALID_REFERRALS
JPN_READINGS_NOT_RECEIVED
JPN_SHORT_TERM_MOVE_IN_REJECTION
JPN_SUPPLY_POINT_FAILS_CAN_SUPPLY_CHECK
JPN_SWITCH_IN_SCHEDULE_OVERLAP
MAIL_FAILED
MAIL_RETURNED
MANDATORY_COMMS_NOT_DELIVERED
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_CREATE
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_REVERSE_TERMINATION
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_TERMINATE
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_UPDATE
MARKET_SUPPLY_EXCEPTION_MISSING_ACCOUNT_QUOTED_PRODUCT
METER_EXCHANGE_ONE_WAY_NOTIFICATION
METER_FAULT_AND_ISSUE_ONE_WAY_NOTIFICATION_ACCEPTED
METER_FAULT_AND_ISSUE_ONE_WAY_NOTIFICATION_REJECTED
MIGRATION_TYPE
MOVE_IN
MOVE_IN_CES_LIFE_SUPPORT_REQUIRED
MOVE_IN_COMMS_NOT_DELIVERED
MOVE_IN_DEFAULT_PAYMENT_SCHEDULE_FAILED
MOVE_IN_MOVE_OUT_MANUAL_PROCESS
MOVE_OUT
NETWORK_TARIFF_ONE_WAY_NOTIFICATION
NEW_PSR_ADDED_TO_PREPAY_ACCOUNT
NON_ENERGY_PAYMENT_CALL_REMINDER
NOTICE_OF_METERING_WORKS_ONE_WAY_NOTIFICATION
PAYMENTS_FAILED_REPAYMENT
PAYMENT_INSTRUCTION_FAILED
PAYMENT_PLAN
PAYMENT_PLAN_HARDSHIP_COMPLETION
PAYMENT_PLAN_HARDSHIP_COMPLETION_WORKFLOW_CANCELLED
PAYMENT_PLAN_MISSED_INSTALMENT
PAYMENT_SCHEDULE_FAILED_TO_CREATE
PLANNED_INTERRUPTION
PLANNED_INTERRUPTION_MEDICAL_DEPENDENCY
PLANNED_INTERRUPTION_NOTIFICATION_SENT_TO_LIFE_SUPPORT_CUSTOMER
PLANNED_INTERRUPTION_ONE_WAY_NOTIFICATION
PLANNED_INTERRUPTION_ONE_WAY_NOTIFICATION_REJECTED
POST_HARDSHIP_CANCELLATION
PPA_EXPORT_INTERVENTION_REQUIRED
PROPERTY_ADDRESS_NEEDS_UPDATE
PSR_IMPORT_COULD_NOT_IDENTIFY_ACCOUNT_USER
SA_CONCESSION_STATEMENT_CLOSED
SCHEDULED_BILLING_ADDRESS_UPDATE
SCHEDULED_OCCUPIER_PACK_SEND
SERVICE_ORDER_ACKNOWLEDGEMENT_OVERDUE
SERVICE_ORDER_CANCELLATION_FAILED
SERVICE_ORDER_CANCELLATION_REQUEST_REJECTED
SERVICE_ORDER_FAILED
SERVICE_ORDER_INITIAL_RESPONSE_OVERDUE
SERVICE_ORDER_NOT_COMPLETED
SERVICE_ORDER_OTHER_JOB_ENQUIRY_CODE
SERVICE_ORDER_PARTIALLY_COMPLETED
SERVICE_ORDER_REQUEST_REJECTED
SERVICE_ORDER_UNABLE_TO_CHARGE
SERVICE_ORDER_UNSOLICITED_RECEIVED
SERVICE_ORDER_UNSOLICITED_RECEIVED_DEENERGISED_METER_POINT
SMARTFLEX_DEVICE_INTEGRATION_POSTPONED
SMART_CHANGE_OF_TENANCY_IN_PROGRESS
SMART_METER_MODE_CHANGE_UNSUPPORTED
SOLAR_EXPORT_CREDITS_EXCESS
SPECIAL_READ_CANCELLATION_FAILED
SPECIAL_READ_FAILED
SPECIAL_READ_OUTSTANDING
SPECIAL_READ_WITH_ESTIMATE_READ_RECEIVED
UNSUPPORTED_FEATURE
UNSUPPORTED_PAYMENT_DAY
WATER_ACCOUNT_REVERSION
WATER_METER_READING_ISSUE
WITHDRAWAL_RECEIVED
WORKFLOW_CANCELLATION_FAILED
WORKFLOW_STEP_ERRORED
WORKFLOW_STEP_FAILED
Example
"AD_HOC"AccountRepaymentStatusOptions
An enumeration.
Values
APPROVED
The repayment has been approved but not made yet.
FAILED
The repayment failed permanently. This could be because of technical issues, or if the merchant rejects the payment for some reason. The payment will need to be retried by ops.
HISTORIC
Payments made in a previous system and then imported into Kraken.
PAID
The repayment has been made to the merchant to be sent to the customer. This is a terminal state, we don't get any further confirmation.
REQUESTED
The request for a repayment has been received but not actioned yet.
SUBMITTED
The payment has been submitted to the merchant. It is still possible for this repayment to fail.
THIRD_PARTY
Third Party payments are those recorded for financial purposes in a different system but should be added to statements.
Example
"REQUESTED"Values
ACTIVE
Supply could have started, be ongoing or ended.
DORMANT
Dormant. Users should not be able to log into dormant accounts.
ENROLMENT_ERROR
An error occurred when we tried to enroll a meter point. This may be deprecated in future in favour of exposing this through enrollment property of a meter point.
ENROLMENT_REJECTED
Meter point enrollment was rejected. This may be deprecated in future in favour of exposing this through enrollment property of a meter point.
INCOMPLETE
Account requires processes to be completed before supply can be set up
PENDING
A pending account is one that has been created but no registrations have started.
VOID
Void. Account created in error.
WITHDRAWN
Withdrawn before supply started
Example
"PENDING"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"AgreementRescissionStatus
Status of an agreement rescission.
Values
COMPLETED
ERRORED
IN_PROGRESS
REJECTED
Example
"IN_PROGRESS"AgreementRolloverRolloverType
An enumeration.
Values
CUSTOM
Custom Renewal
CUSTOMER_REQUESTED
Customer Requested
DEFAULT
Default Rollover
EXTENSION
Custom Extension
Example
"DEFAULT"AgreementRolloverStatus
An enumeration.
Values
DONE
Rollover Completed
ENQUEUED
Rollover In Progress
ERROR
Error During Rollover
PENDING
Rollover Pending
REJECTED
Rollover Rejected
REVOKED
Rollover Revoked
Example
"PENDING"AmphioIntervalReadingReasonCode
An enumeration.
Values
A_0
Free Text Description
A_1
Meter Equipment Changed
A_10
Unable To Open
A_100
Incorrect Meter Multiplier
A_101
Temporarily Connection Point Unmetered
A_102
Customer Bypass
A_103
Network Bypass
A_104
Transposed Channel
A_105
Transposed Channel - UoM Correction
A_106
Transposed Channel - Reverse Polarity
A_107
Transposed Meter
A_108
Network Bypass Extreme Weather
A_109
Defined Load Method
A_11
In Wrong Route
A_12
Locked Premises
A_13
Locked Gate
A_14
Locked Meter Box
A_15
Overgrown Vegetation
A_16
Noxious Weeds
A_17
Unsafe Location
A_18
Read Less Than Previous
A_19
Consumer Wanted
A_2
Extreme Weather Conditions
A_20
Damaged Equipment
A_21
Main Switch Off
A_22
Meter Seals Missing
A_23
Reader Error
A_24
Substituted Data
A_25
Unable To Locate Premises
A_26
Negative Consumption
A_27
ROLR
A_28
CT/VT Fault
A_29
Relay Damaged
A_3
Quarantined Premises
A_30
Meter Stop Switch On
A_31
Not All Meters Read
A_32
Reenergised Without Readings
A_33
Deenergised Without Readings
A_34
Meter Not In Handheld
A_35
Timeswitch Faulty
A_36
Ladder Required
A_37
Meter Under Churn
A_38
Unmarried Lock
A_39
Reverse Energy Observed
A_4
Dangerous Dog
A_40
Unrestrained Livestock
A_41
Fault Meter Display
A_42
Channel Added/Removed
A_43
Power Outage
A_44
Meter Testing
A_45
Readings Failed To Validate
A_46
Extreme Weather/Hot
A_47
Refused Access
A_48
Dog On Premises
A_49
Wet Paint
A_5
Blank Screen
A_50
Wrong Tariff
A_51
Installation Demolished
A_52
Access Blocked
A_53
Pests In Meter Box
A_54
Meter Box Damaged
A_55
Dials Obscured
A_58
Meter Ok - Supply Failure
A_6
Deenergised Premises
A_60
Illegal Connection
A_61
Equipment Tampered
A_62
NSRD Window Expired
A_64
Key Required
A_65
Wrong Key Provided
A_67
Transfer
A_68
Zero Consumption
A_69
Reading Exceeds Substitute
A_7
Unable To Locate Meter
A_70
Probe Reports Tampering
A_71
Probe Read Error
A_72
Recalculated Based On Actual
A_73
Low Consumption
A_74
High Consumption
A_75
Customer Read
A_76
Communications Fault
A_77
Estimation Forecast
A_78
Null Data
A_79
Power Outage Alarm
A_8
Vacant Premises
A_80
Short Interval Alarm
A_81
Long Interval Alarm
A_82
CRC Error
A_83
RAM Checksum Error
A_84
ROM Checksum Error
A_85
Data Missing Alarm
A_86
Clock Error Alarm
A_87
Reset Occurred
A_88
Watchdog Timeout Alarm
A_89
Time Reset Occurred
A_9
Under Investigation
A_90
Test Mode
A_91
Load Control
A_92
Added Interval (Data Correction)
A_93
Replaced Interval (Data Correction)
A_94
Estimated Interval (Data Correction)
A_95
Pulse Overflow Alarm
A_96
Data Out Of Limits
A_97
Excluded Data
A_98
Parity Alarm
A_99
Energy Type (Register Changed)
Example
"A_0"AppSessionOutcomeCategories
Enumeration of app session types.
Values
BUSY
CALLBACK
CALLBACK_COURTESY_CALL
CALLBACK_PITCHED
CONSUMER_APP_DOWNLOAD
COS
COT_NO_PROOF
COT_PROVEN
DECEASED
DEMOLISHED
DONT_CALL_AGAIN
EBSS_VOUCHER_CHECK_IN
ELECTRIC_JUICE_NOT_INTERESTED
ELECTRIC_JUICE_SWITCH
ELECTRIC_JUICE_SWITCH_LITE
EMPTY
ENERGY_HELP_VISIT_COMPLETED
ENERGY_HELP_VISIT_LEAFLET
EXHAUSTED_CONTACT
EXHAUSTED_NO_CONTACT
EXISTING_CUSTOMER
INSOLVENCY
INTERESTED
LEAD_GENERATION
LEAD_GENERATION_BUSINESS
LEAD_GENERATION_EJ
LEAD_GENERATION_EJ_LITE
LEAD_GENERATION_EV
LEAD_GENERATION_HEAT_PUMP
LEAD_GENERATION_SOLAR
METER_READING
METER_READING_NO_ANSWER
METER_READING_UNABLE_TO_TAKE_READING
MULTIPLE_PROPERTIES
NOT_BILL_PAYER
NOT_DECISION_MAKER
NO_ANSWER
NO_COLD_CALLING
NO_FIXED_ADDRESS
NO_PITCH
NO_PITCH_NOT_INTERESTED
NO_PITCH_NO_D2D
NO_PITCH_SWITCHED_RECENTLY
NO_PITCH_TPI_THIRD_PARTY
NO_PITCH_VULNERABLE
OCCUPIER_NOT_BILL_PAYER
OCCUPIER_NO_ANSWER
OCCUPIER_REFUSED_TO_DISCUSS
OCCUPIER_SUSPECTED_EMPTY_PROPERTY
OCCUPY_ACCOUNT
OTHER
PAID_IN_FULL
PAID_PARTIAL
PAID_REDUCED_SETTLEMENT
PAYMENT_PLAN
PITCH_NO_QUOTE
PITCH_NO_QUOTE_ADVANCED_PAYMENT
PITCH_NO_QUOTE_IN_CONTRACT
PITCH_NO_QUOTE_NOT_INTERESTED
PITCH_NO_QUOTE_NO_EMAIL
PITCH_NO_QUOTE_PRICE
PITCH_NO_QUOTE_SWITCHED_RECENTLY
PPM_REQUESTED
PREPAYMENT_METER
PRISON
PROPERTY_INELIGIBLE
PSR_REGISTERED
QUERY
QUOTED_CALLBACK
QUOTED_NO_SALE
QUOTED_NO_SALE_ADVANCED_PAYMENT
QUOTED_NO_SALE_AUTOPAY
QUOTED_NO_SALE_CREDIT_CHECK_ISSUE
QUOTED_NO_SALE_DEPOSIT
QUOTED_NO_SALE_EXIT_FEES
QUOTED_NO_SALE_ISSUE_BANK_DETAILS
QUOTED_NO_SALE_MONTHLY_DD
QUOTED_NO_SALE_NO_EMAIL
QUOTED_NO_SALE_OTHER
QUOTED_NO_SALE_PAPER_BILLS
QUOTED_NO_SALE_PREPAY
QUOTED_NO_SALE_PRICE
QUOTED_NO_SALE_QUOTE_EMAILED
QUOTED_NO_SALE_STANDING_CHARGE
QUOTED_NO_SALE_UNSURE_OF_CURRENT_CONTRACT
QUOTED_NO_SALE_WAIVER_WANTED
QUOTED_NO_SWITCH
SHELTERED_HOUSING
SMART_METER_REGISTERED
SUCCESS
SWITCHED
SWITCHED_BUSINESS
SWITCHED_CALLBACK
SWITCHED_CREDIT_CHECK_WAIVER
SWITCHED_FIRST_CONTACT
SWITCHED_SMART_PRODUCT
TRANSFERRED
UNABLE_TO_LOCATE
UNABLE_TO_TRACE
UNKNOWN
UNSUCCESSFUL
VULNERABILITY_PROJECT
VULNERABLE
WITHDRAWN
WRONG_ADDRESS_SELECTED
Example
"SUCCESS"AppSessionOutcomeCategory
An enumeration.
Values
BUSY
Busy
CALLBACK
Callback
CALLBACK_COURTESY_CALL
Callback Courtesy Call
CALLBACK_PITCHED
Callback Pitched
CONSUMER_APP_DOWNLOAD
Consumer App Download
COS
Cos
COT_NO_PROOF
Cot No Proof
COT_PROVEN
Cot Proven
DECEASED
Deceased
DEMOLISHED
Demolished
DONT_CALL_AGAIN
Dont Call Again
EBSS_VOUCHER_CHECK_IN
Ebss Voucher Check In
ELECTRIC_JUICE_NOT_INTERESTED
Electric Juice Not Interested
ELECTRIC_JUICE_SWITCH
Electric Juice Switch
ELECTRIC_JUICE_SWITCH_LITE
Electric Juice Switch Lite
EMPTY
Empty
ENERGY_HELP_VISIT_COMPLETED
Energy Help Visit Completed
ENERGY_HELP_VISIT_LEAFLET
Energy Help Visit Leaflet
EXHAUSTED_CONTACT
Exhausted Contact
EXHAUSTED_NO_CONTACT
Exhausted No Contact
EXISTING_CUSTOMER
Existing Customer
INSOLVENCY
Insolvency
INTERESTED
Interested
LEAD_GENERATION
Lead Generation
LEAD_GENERATION_BUSINESS
Lead Generation Business
LEAD_GENERATION_EJ
Lead Generation Ej
LEAD_GENERATION_EJ_LITE
Lead Generation Ej Lite
LEAD_GENERATION_EV
Lead Generation Ev
LEAD_GENERATION_HEAT_PUMP
Lead Generation Heat Pump
LEAD_GENERATION_SOLAR
Lead Generation Solar
METER_READING
Meter Reading
METER_READING_NO_ANSWER
Meter Reading No Answer
METER_READING_UNABLE_TO_TAKE_READING
Meter Reading Unable To Take Reading
MULTIPLE_PROPERTIES
Multiple Properties
NOT_BILL_PAYER
Not Bill Payer
NOT_DECISION_MAKER
Not Decision Maker
NO_ANSWER
No Answer
NO_COLD_CALLING
No Cold Calling
NO_FIXED_ADDRESS
No Fixed Address
NO_PITCH
No Pitch
NO_PITCH_NOT_INTERESTED
No Pitch Not Interested
NO_PITCH_NO_D2D
No Pitch No D2D
NO_PITCH_SWITCHED_RECENTLY
No Pitch Switched Recently
NO_PITCH_TPI_THIRD_PARTY
No Pitch Tpi Third Party
NO_PITCH_VULNERABLE
No Pitch Vulnerable
OCCUPIER_NOT_BILL_PAYER
Occupier Not Bill Payer
OCCUPIER_NO_ANSWER
Occupier No Answer
OCCUPIER_REFUSED_TO_DISCUSS
Occupier Refused To Discuss
OCCUPIER_SUSPECTED_EMPTY_PROPERTY
Occupier Suspected Empty Property
OCCUPY_ACCOUNT
Occupy Account
OTHER
Other
PAID_IN_FULL
Paid In Full
PAID_PARTIAL
Paid Partial
PAID_REDUCED_SETTLEMENT
Paid Reduced Settlement
PAYMENT_PLAN
Payment Plan
PITCH_NO_QUOTE
Pitch No Quote
PITCH_NO_QUOTE_ADVANCED_PAYMENT
Pitch No Quote Advanced Payment
PITCH_NO_QUOTE_IN_CONTRACT
Pitch No Quote In Contract
PITCH_NO_QUOTE_NOT_INTERESTED
Pitch No Quote Not Interested
PITCH_NO_QUOTE_NO_EMAIL
Pitch No Quote No Email
PITCH_NO_QUOTE_PRICE
Pitch No Quote Price
PITCH_NO_QUOTE_SWITCHED_RECENTLY
Pitch No Quote Switched Recently
PPM_REQUESTED
Ppm Requested
PREPAYMENT_METER
Prepayment Meter
PRISON
Prison
PROPERTY_INELIGIBLE
Property Ineligible
PSR_REGISTERED
Psr Registered
QUERY
Query
QUOTED_CALLBACK
Quoted Callback
QUOTED_NO_SALE
Quoted No Sale
QUOTED_NO_SALE_ADVANCED_PAYMENT
Quoted No Sale Advanced Payment
QUOTED_NO_SALE_AUTOPAY
Quoted No Sale Autopay
QUOTED_NO_SALE_CREDIT_CHECK_ISSUE
Quoted No Sale Credit Check Issue
QUOTED_NO_SALE_DEPOSIT
Quoted No Sale Deposit
QUOTED_NO_SALE_EXIT_FEES
Quoted No Sale Exit Fees
QUOTED_NO_SALE_ISSUE_BANK_DETAILS
Quoted No Sale Issue Bank Details
QUOTED_NO_SALE_MONTHLY_DD
Quoted No Sale Monthly Dd
QUOTED_NO_SALE_NO_EMAIL
Quoted No Sale No Email
QUOTED_NO_SALE_OTHER
Quoted No Sale Other
QUOTED_NO_SALE_PAPER_BILLS
Quoted No Sale Paper Bills
QUOTED_NO_SALE_PREPAY
Quoted No Sale Prepay
QUOTED_NO_SALE_PRICE
Quoted No Sale Price
QUOTED_NO_SALE_QUOTE_EMAILED
Quoted No Sale Quote Emailed
QUOTED_NO_SALE_STANDING_CHARGE
Quoted No Sale Standing Charge
QUOTED_NO_SALE_UNSURE_OF_CURRENT_CONTRACT
Quoted No Sale Unsure Of Current Contract
QUOTED_NO_SALE_WAIVER_WANTED
Quoted No Sale Waiver Wanted
QUOTED_NO_SWITCH
Quoted No Switch
SHELTERED_HOUSING
Sheltered Housing
SMART_METER_REGISTERED
Smart Meter Registered
SUCCESS
Success
SWITCHED
Switched
SWITCHED_BUSINESS
Switched Business
SWITCHED_CALLBACK
Switched Callback
SWITCHED_CREDIT_CHECK_WAIVER
Switched Credit Check Waiver
SWITCHED_FIRST_CONTACT
Switched First Contact
SWITCHED_SMART_PRODUCT
Switched Smart Product
TRANSFERRED
Transferred
UNABLE_TO_LOCATE
Unable To Locate
UNABLE_TO_TRACE
Unable To Trace
UNKNOWN
Unknown
UNSUCCESSFUL
Unsuccessful
VULNERABILITY_PROJECT
Vulnerability Project
VULNERABLE
Vulnerable
WITHDRAWN
Withdrawn
WRONG_ADDRESS_SELECTED
Wrong Address Selected
Example
"SUCCESS"AppSessionOutcomeType
An enumeration.
Values
BUSINESS_LEAD
Business Lead
BUSINESS_LEAD_HALF_HOURLY
Business Lead Half Hourly
BUSINESS_SALE
Business Sale
CREDIT
Credit
CREDIT_BUSINESS
Credit Business
ELECTRIC_UNIVERSE
Electric Universe
ELECTROVERSE
Electroverse
ELECTROVERSE_LEAD
Electroverse Lead
ENERGY_HELP
Energy Help
ENERGY_SUPPORT
Energy Support
EV_CHARGER
Ev Charger
EV_LEAD
Ev Lead
HEAT_PUMP_LEAD
Heat Pump Lead
INTELLIGENT_OCTOPUS_SIGNUP
Intelligent Octopus Signup
LEAD
Lead
METER_READING
Meter Reading
OCCUPIER
Occupier
SALE
Sale
SOLAR_LEAD
Solar Lead
UNKNOWN
Unknown
Example
"SALE"AppSessionTypeChoices
Enumeration of app session types.
Values
BUSINESS_LEAD
BUSINESS_LEAD_HALF_HOURLY
BUSINESS_SALE
CREDIT
CREDIT_BUSINESS
ELECTRIC_UNIVERSE
ELECTROVERSE
ELECTROVERSE_LEAD
ENERGY_HELP
ENERGY_SUPPORT
EV_CHARGER
EV_LEAD
HEAT_PUMP_LEAD
INTELLIGENT_OCTOPUS_SIGNUP
LEAD
METER_READING
OCCUPIER
SALE
SOLAR_LEAD
UNKNOWN
Example
"SALE"AppointmentChoices
An enumeration.
Values
EMPTY
T0800_1300
T0900_1400
T1000_1500
T1100_1600
T1200_1700
T1300_1800
Example
"EMPTY"AustralianTelephoneServiceType
Possible phone number types.
Values
FAX
Fax
FIXED_VOICE
Fixed Voice
MOBILE_VOICE
Mobile Voice
MODEM
Modem
PAGER
Pager
Example
"FIXED_VOICE"BandCategory
An enumeration.
Values
ADDON
CAPACITY_CHARGE
CONSUMPTION_CHARGE
DEMAND_CHARGE
DISCOUNT_CREDIT
EXCESS_CAPACITY_CHARGE
GENERATION_CREDIT
PLACEHOLDER
STANDING_CHARGE
UNKNOWN
Example
"STANDING_CHARGE"BrandChoices
An enumeration.
Values
ESSENTIAL_ENERGY
Essential Energy.
ESSENTIAL_WATER
Essential Water.
Example
"ESSENTIAL_ENERGY"BusinessTypeChoices
An enumeration.
Values
CHARITY
CHURCH
GOVERNMENT
HOMEOWNER_ASSOCIATION
LLP
LTD
NONE
NON_PROFIT
PARTNERSHIP
PLC
PTY_LTD
SOLE_TRADER
TBD
TRADING_AS
TRUST
Example
"NONE"BusinessTypeOptions
Available business account type options (e.g., sole trader, limited company, partnership, charity).
Values
CHARITY
A business account where the company type is charity.
CHURCH
A business account for a church or other religious organisation.
GOVERNMENT
A business account for a government institution.
HOMEOWNER_ASSOCIATION
A business account for a homeowner association or similar community group.
LIMITED
A business account where the company type is limited.
LIMITED_LIABILITY_PARTNERSHIP
A business account where the company type is limited liability partnership.
NON_PROFIT
A business account for a non-profit organisation.
PARTNERSHIP
A business account where the company type is partnership.
PROPRIETARY_LIMITED_COMPANY
A business account where the company type is proprietary limited.
PUBLIC_LIMITED_COMPANY
A business account where the company type is public limited.
SOLE_TRADER
A business account where the company type is sole trader.
TO_BE_DETERMINED
A business account where the company type is to be determined.
TRADING_AS
A business account where the company has a trading name to carry out its business activities.
TRUST
A business account where the company type is a trust.
Example
"SOLE_TRADER"C4RequestRoleType
The market participant role for the C4 request.
Values
LOCAL_NETWORK_SERVICE_PROVIDER
LOCAL_RETAILER
METERING_COORDINATOR
METERING_DATA_PROVIDER
METERING_PROVIDER
METERING_PROVIDER_COLLECTION
RETAILER_OF_LAST_RESORT
SUPPLIER
Example
"SUPPLIER"CampaignItemStatus
The status of the campaign item.
Values
ASSIGNED
COMPLETE
IN_PROGRESS
REMOVED
SELECTED_FOR_CALLING
UNASSIGNED
Example
"UNASSIGNED"CampaignStatus
The status of the campaign.
Indicates whether calls can be made for items in the campaign or not.
Values
ACTIVE
INACTIVE
Example
"ACTIVE"CatalogComponentStatus
Status of a catalog component (offering, product, etc.).
Values
ACTIVE
DRAFT
EXPIRED
Example
"DRAFT"Values
ABY
ABSTUDY
CDA
Carer Allowance
FTB
Family Tax Benefit
MOB
Mobility Allowance
NSS
JobSeeker Payment, Youth Allowance, Austudy
PEN
Age Pension, Disability Support Pension
PES
Pension Education Supplement
PGA
Parenting Payment Partnered
Example
"ABY"Values
CANCELLING
Pending Cancellation
CHANGING
Pending Change
CREATING
Pending Creation
Example
"CREATING"ChangeOfSupplierStatusOptions
An enumeration.
Values
CANCELLATION_REQUESTED
If the account is withdrawn after the change request is sent, the meter points will have this status until we get a response to the request to withdraw.
CANCELLED
The Cancelled status occurs where:
Not all Objections have been withdrawn at expiry of the Objection Clearing Period; or
The initiator of the Change Request has withdrawn the transaction.
When a Change Request is Cancelled, notifications are sent to the relevant Participants in accordance with the Change Request Status Notification Rules.
COMPLETED
The Completed status occurs where the Objection Logging Period has passed, all required data is present in MSATS and the Proposed Change Date has been reached or is passed. Notifications are sent to the relevant Participants in accordance with the Change Request Status Notification Rules.
INITIATED
Initiation is the first status of a new change of supplier request. During this status, the initiating participant send an appropriate change reason code to MSATS. MSATS will then validate the change request prior to changing the status to PENDING_VALIDATION status.
OBJECTED
The Objected status occurs where one or more Objections have been received. Notifications of the Objections are sent to the relevant parties. This includes details of the Objections and whether the transaction was already being Objected to. When an Objection is withdrawn, the relevant parties will be notified of the details of the withdrawn Objection. When the last Objection is withdrawn, the transaction status changes back to REQUESTED, unless the Objection Logging Period has expired, in which case it will move to Pending status. If the Objection Clearing Period has expired and an Objection that is subject to the Objection Logging Period has not been withdrawn the status will be changed to CANCELLED.
OBJECTION_WITHDRAWN
A raised objection was withdrawn and the change request will continue.
PENDING
The Pending status is where no Objections have been received, or all Objections have been withdrawn and the Objection period has passed. The transaction is waiting for the change date to be reached. If the Proposed Change Date is reached and all required data is present, the status will change to COMPLETED. The status will remain PENDING whilst any required data remains outstanding or an Objection that is not subject to the Objection Logging Period is not raised. Notifications are sent to the relevant Participants in accordance with the Change Request Status Notification Rules.
PENDING_VALIDATION
The Pending Validation status commences after the Change Request has passed initial validation for entry into MSATS. However, not all the data that is required to initiate the transaction may be present in MSATS. If mandatory data is missing from the Change Request, the Change Request will be Rejected. If the missing data is for the NMI Master Record, a Data Request will be sent to the nominated Participant, and MSATS will check for the receipt of that data. There is no time limit imposed by MSATS for the provision of this data, however, the Participant that receives the Data Request must respond in a reasonable time. The Change Request will be approved only after all required data has been submitted.
PRE_REGISTRATION
The meterpoint has been enrolled but the change request has not been sent yet (as the cooling off period is still active)
REJECTED
The Rejected status occurs where a Change Request has failed validation. This can occur:
During the validation of a Change Request whilst it is at the
PENDING_VALIDATIONstatus; orAt the time of completion of the Change Request (in rare circumstances where a change to some other data made after this Change Request was submitted has now made this change invalid).
When a transaction has been Rejected, all Participants associated with the transaction will be notified in accordance with the Change Request Status Notification Rules.
REQUESTED
The Requested status is where a transaction has been validated, i.e. there is no missing data. Notifications of the Requested transaction are sent to the relevant Participants. The Objection Logging Period and Objection Clearing Periods have been identified. Any Objections received are validated against the Objection Rules or no Objections have been submitted.
WITHDRAWN
The enrolment was started and then either the customer or a staff member has withdrawn it.
Example
"INITIATED"ChangeRequestStatus
An enumeration.
Values
CANCELLED
Cancelled
COMPLETED
Completed
INITIATED
Initiated
OBJECTED
Objected
PENDING
Pending
PENDING_VALIDATION
Pending Validation
REJECTED
Rejected
REQUESTED
Requested
Example
"INITIATED"Channel
The set of channels that messages can be sent through.
Values
ANDROID_PUSH_NOTIFICATION
IOS_PUSH_NOTIFICATION
POST
SMS
Example
"EMAIL"Values
APPROVED
CANCELLED
CLEARED
FAILED
HELD_FOR_REVIEW
NONE
PENDING
REQUESTED
SCHEDULED
Example
"APPROVED"CollectionProcessAssociatedItemType
Associated item type choices.
Values
CONTRACT_TERMINATION
LEAVE_SUPPLIER_PROCESS
TRANSACTIONAL_MESSAGING_PUBLISHING_ERROR
TRANSACTIONAL_MESSAGING_TRIGGER
Example
"TRANSACTIONAL_MESSAGING_TRIGGER"CollectionProcessEventTypeEnum
Type of events that can occur in a collection process.
Values
REACTIVATION_COMPLETED
REACTIVATION_PENDING
TERMINATED_WITHOUT_REACTIVATION
Example
"REACTIVATION_PENDING"CollectionProcessRecordCompletionTypeChoices
Options for Collection Process Record Completion types. ENDED: endedWITHDRAWN: withdrawnCANCELLED: cancelledNEVER_ACTIONED: never_actioned
Values
CANCELLED
ENDED
NEVER_ACTIONED
WITHDRAWN
Example
"ENDED"CommsDeliveryPreference
The method the account has specified they prefer we contact them
Values
POSTAL_MAIL
Example
"EMAIL"CommsDeliveryPreferenceEnum
Communication delivery preference for family issues input.
Values
POST
Example
"EMAIL"ComplaintSourceChoices
Source of the complaint.
Values
CUSTOMER_SURVEY
ONLINE
PERSON
POST
SOCIAL_MEDIA
TELEPHONE
Example
"TELEPHONE"ConcessionCardType
An enumeration.
Values
ACT_SERVICES_ACCESS_CARD_IMMI_CARD
ACT Services Access Card/ Immi Card
ASYLUM_SEEKER
Asylum Seeker
CENTRELINK_HEALTH_CARE
Centrelink - Health Care
CENTRELINK_PENSIONER
Centrelink - Pensioner
OTHER
Other - (no concessions apply)
QUEENSLAND_SENIORS_CARD
Queensland Seniors Card
REPATRIATION_HEALTH_CARE_CARD
Repatriation Health Care Card
SA_GENERIC
South Australia Concession
VETERANS_AFFAIRS_DVA_GOLD
Veterans Affairs - DVA Gold
VETERANS_AFFAIRS_DVA_GOLD_EDA
Veterans Affairs - DVA Gold - EDA
VETERANS_AFFAIRS_DVA_GOLD_TPI
Veterans Affairs - DVA Gold - TPI
VETERANS_AFFAIRS_DVA_GOLD_WW
Veterans Affairs - DVA Gold - WW
VETERANS_AFFAIRS_PENSIONER
Veterans Affairs - Pensioner
Example
"CENTRELINK_PENSIONER"ConcessionCardValidationMethod
An enumeration.
Values
API
API
BATCH
Batch
KRAKEN
Kraken
MANUAL
Manual
Example
"API"ConsentEventSource
The possible sources of a consent event.
Values
API_SITE
COMMAND_JOB
CONSUMER_SITE
DATA_IMPORT
MIGRATION
ONBOARDING
SUPPORT_SITE
THIRD_PARTY_VENDOR
Example
"CONSUMER_SITE"ConsumptionGranularity
An enumeration.
Values
DAILY
HALF_HOURLY
MONTHLY
QUARTER_HOURLY
Example
"QUARTER_HOURLY"ConsumptionGroupings
An enumeration.
Values
DAY
HALF_HOUR
HOUR
MONTH
QUARTER
QUARTER_HOUR
WEEK
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
CANCELLED
COMPLETED
ERRORED
IN_PROGRESS
STALLED
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
ACTIVE
EXPIRED
INACTIVE
JOURNEY_IN_PROGRESS
REVOKED
TERMINATED
Example
"REVOKED"ConversationClosedReasonChoices
The available reasons for closing a conversation.
Values
AGENT_CLOSED
CUSTOMER_CLOSED
INACTIVE
STALE
Example
"AGENT_CLOSED"CustomerFeedbackSourceChoices
Source of the customer feedback.
Values
FEEDBACK_SOURCE_CONSUMER_SITE
FEEDBACK_SOURCE_EMAIL_FOLLOW_UP
FEEDBACK_SOURCE_LOGIN_FOLLOW_UP
FEEDBACK_SOURCE_MANUAL
FEEDBACK_SOURCE_PHONE_CALL_FOLLOW_UP
FEEDBACK_SOURCE_TRUSTPILOT
Example
"FEEDBACK_SOURCE_PHONE_CALL_FOLLOW_UP"CustomerVerificationType
The verification types available.
Values
Email.
MANUAL
Manual.
OTHER
Other.
SMS
SMS.
Example
"EMAIL"DebtCollectionProceedingStopReason
An enumeration.
Values
ARREARS_TO_CLIENT
Arrears to client
BANKRUPT
Bankrupt
CONFIRMED_EMPTY
Confirmed empty
COS
COS
COT_COS
COT / COS
COT_NO_PROOF
COT no proof
COT_PROOF_SEEN
COT proof seen
DECEASED
Deceased
DEMOLISHED
Demolished
ENROLLED_IN_ERROR
Enrolled in Error
EXP
Expired
GONE_AWAY
Gone away
HIGH_LEVEL_COMPLAINT
High level complaint
INSOLVENCIES_DEALING
Insolvencies dealing
IN_PRISON
In prison
LIVE_TO_FINAL
Live to final
LOW_BALANCE
Low balance
NEGATIVE_TRACE
Negative trace
PAID_IN_FULL
Paid in full
PARTIAL_SETTLEMENT
Partial settlement
PART_PAYMENT
Part payment
PAYMENT_ARRANGEMENT
Payment arrangement
PAYMENT_PLAN_AGREED
Payment plan agreed
PPM_ARRANGEMENT
PPM arrangement
PPM_FITTED
PPM fitted
PPM_REQUESTED
PPM requested
PROCESS_EXHAUSTED
Process exhausted
PROCESS_EXHAUSTED_CONTACT
Process exhausted - contact
PROCESS_EXHAUSTED_NO_CONTACT
Process exhausted - no contact
QUERY
Query
REDUCED_SETTLEMENT
Reduced settlement
REFUSED_TO_DEAL
Refused to deal
UNABLE_TO_LOCATE_PROPERTY
Unable to locate property
UNABLE_TO_TRACE
Unable to trace
VULNERABLE
Vulnerable
WITHDRAWN
Withdrawn
WRITE_OFF
Write off
Example
"BANKRUPT"DirectDebitInstructionStatus
An enumeration.
Values
ACTIVE
The instruction is active and can be used to take payments.
FAILED
The instruction could not be set up with the vendor.
PROVISIONAL
The instruction has not yet been set up.
Example
"ACTIVE"DirectionChoices
Origin of the change request, either inbound from external parties or outbound from kraken itself.
Values
INBOUND
OUTBOUND
Example
"INBOUND"DocumentAccessibilityChoices
Enum representing document accessibility preferences for an account.
Values
AUDIO
BRAILLE
LARGE_PRINT
Example
"LARGE_PRINT"Values
BASED_ON_ACTUAL_READINGS
BASED_ON_ESTIMATED_READINGS
NOT_APPLICABLE
NOT_SUPPORTED
Example
"BASED_ON_ESTIMATED_READINGS"EventTypeChoices
An enumeration.
Values
ACCOUNT_CREATED
ACCOUNT_UPDATED
ACCOUNT_USER_CREATED
ACCOUNT_USER_REMOVED
ACCOUNT_USER_UPDATED
FINAL_BILL
Example
"ACCOUNT_CREATED"ExpiringTokenScope
An enumeration.
Values
ACCEPT_FIT_SCHEDULE
Scope that grants ability to accept fit schedule.
ACCEPT_FIT_TERMS
Scope that grants ability to accept fit terms.
ACCEPT_QUOTE
Scope that enables user to review and accept a quote sent via an email link.
ACCEPT_TERMS_AND_CONDITIONS
Scope that enables account user to accept the terms and conditions for a product.
ACCESS_CHANGE_MY_TARIFF_EXPIRING_LINK
Scope grants ability to access Change My Tariff journey without login
AMEND_PAYMENTS
Scope that grants access to amend payments.
BOOK_SMART_METER_APPOINTMENTS
Scope that enables account user to book smart meter appointments.
CANCEL_ENROLLMENT
Scope that enables the user to cancel enrollment to a supplier.
CHECKOUT_QUOTE
Scope that enables account user to checkout a quote (validate terms & conds and provide a payment detail).
EDIT_CUSTOMER_MARKETING_PREFERENCE
Edit Customer Marketing Preference
FINALIZE_ACCOUNT_SETUP
Scope that enables the user to finalize their account setup.
JOIN_CAMPAIGNS
Scope that enables account user to join campaigns.
JOIN_CAMPAIGN_EVENTS
Scope that enables account user to join campaign events.
MANAGE_ACCOUNT_RENEWALS
Scope that enables account user to generate a renewal quote and renew agreements.
MANAGE_BUSINESS_SECURITY_DEPOSIT
Scope that enables account user to manage security deposit payments for business accounts.
MANAGE_GOODS_PURCHASES
Scope that enables account user to accept goods quotes and process goods purchases.
MANAGE_PRODUCT_SWITCH
Scope that enables account user to do a self-serve product switch through the Dashboard.
MANAGE_PRODUCT_SWITCH_WITH_QUOTES
Scope that enables account user to do a self-serve product switch with quotes.
REDEEM_LOYALTY_POINTS
Scope that enables account user to redeem loyalty points
REPORT_MOVE_OUT
Scope that enables account user to report a property move-out.
SEND_LOSS_OBJECTION_FOR_CHANGE_OF_SUPPLIER
Scope that enables user to send a loss objection for a change of supplier process.
SET_GOODS_PURCHASE_SALE_ITEM_PRICES
Set Goods Purchase Sale Item Prices
SUBMIT_CUSTOMER_FEEDBACK
Scope that enables account user to submit customer feedback.
SUBMIT_FIT_METER_READINGS
Scope that grants ability to submit fit readings for a meter.
SUBMIT_METER_READINGS
Scope that enables account user to submit meter readings.
SUBMIT_MISSING_METER_DETAILS
Scope that enables account user to submit missing meter details.
UPDATE_ACCOUNT_DETAILS
Scope that enables the user to update information about themselves and their account.
UPDATE_BLACKHOLE_EMAIL
Scope that enables account user to update their blackhole email address.
UPDATE_BLACKHOLE_EMAIL_NO_ACCOUNT_NUMBER
Scope that enables account user to update their blackhole email address without enabling access to account number.
UPDATE_DIRECT_DEBIT
Scope that enables account user to update their direct debit details.
UPDATE_SENSITIVE_CUSTOMER_INFORMATION
Update Sensitive Customer Information
UPDATE_SMART_METER_INTEREST
Scope that enables account user to update their smart meter interest.
VERIFY_CUSTOMER_DETAILS
Scope that grants ability to verify the customer details.
VIEW_ACCOUNT_NUMBER
Scope that grants access to view the account number.
VIEW_CAMPAIGN_DASHBOARDS
Scope that enables account user to visit campaign dashboard.
VIEW_DETAILED_USAGE
Scope that enables account user to visit detailed property usage pages.
Example
"SUBMIT_METER_READINGS"ExternalAccountEventCategory
Enum of allowable event type categories for external account events.
Values
COMMUNICATIONS
DEBT
MESSAGING
MOBILE
SALES
SECURITY
WEB
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
HTML
LINK
PLAINTEXT
S3
Example
"PLAINTEXT"ExternalAccountEventSubCategory
Enum of allowable event type subcategories for external account events.
Values
CLICK_TO_CALL
CREATED
DENY_ACCESS
DUNNING
FEEDBACK
FORCE_LOGOUT
INTERNAL
LIVE_CHAT
PASSWORD_RESET_EMAIL
PUSH_NOTIFICATION
SMS
SOCIAL_MEDIA
TELEPHONE
THIRD_PARTY
UPDATED
Example
"TELEPHONE"FieldTypeChoices
The type of the field.
Values
BOOL
CHOICE
DATE
DATETIME
FLOAT
INT
MULTIPLE_CHOICE
STR
Example
"STR"FlatOrUnitType
Possible values for "flat or unit type" in an Australian address.
Values allowed by the Australian Standard but not by aseXML are omitted.
Values
ANTENNA
APARTMENT
ATM
BARBECUE
BLOCK
BOATSHED
BUILDING
BUNGALOW
CAGE
CARPARK
CARSPACE
CLUB
COOLROOM
COTTAGE
DUPLEX
FACTORY
FLAT
GARAGE
HALL
HOUSE
KIOSK
LEASE
LOBBY
LOFT
LOT
MAISONETTE
MARINE_BERTH
OFFICE
PENTHOUSE
REAR
RESERVE
ROOM
SECTION
SHED
SHOP
SHOWROOM
SIGN
SITE
STALL
STORE
STRATA_UNIT
STUDIO
SUBSTATION
SUITE
TENANCY
TOWER
TOWNHOUSE
UNIT
VAULT
VILLA
WARD
WAREHOUSE
WORKSHOP
Example
"ANTENNA"FloorOrLevelType
Possible values for an Australian "floor or level type". Drawn from the AS4590 standard.
Values
BASEMENT
FLOOR
GROUND_FLOOR
LEVEL
LOBBY
LOWER_GROUND
LOWER_LEVEL
MEZZANINE
OBSERVATION_DECK
PARKING
PENTHOUSE
PLATFORM
PODIUM
ROOFTOP
SUB_BASEMENT
UPPER_GROUND_FLOOR
Example
"BASEMENT"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"FulfilmentSourceType
The type of the fulfilment source.
Values
CHARGE
CREDIT
PAYMENT
UNKNOWN
Example
"UNKNOWN"GasEnergizationStatus
An enumeration.
Values
Commissioned
Decommissioned
Deregistered
Registered
Unclaimed
Example
"Registered"GasMeterInstallationType
An enumeration.
Values
MASTER_METER
Master Meter
ORDINARY
Ordinary
SUB_METER
Sub Meter
Example
"MASTER_METER"GasMeterReadFrequency
An enumeration.
Values
BI_MONTHLY
Bi Monthly
DAILY
Daily
MONTHLY
Monthly
QUARTERLY
Quarterly
Example
"BI_MONTHLY"GasMeterStatus
An enumeration.
Values
NO_METER
No Meter
NO_REG
No Reg
PLUGGED
Plugged
TRAILER_AC
Trailer Ac
TURNED_OFF
Turned Off
TURNED_ON
Turned On
Example
"TURNED_ON"HardshipAgreementExitReason
An enumeration.
Values
ACCOUNT_FINALISED
Account finalised
CREDIT_OR_NIL_BALANCE
Credit or nil balance
CUSTOMER_REQUEST
Customer request
FURTHER_PAYMENT_PLAN_NOT_ESTABLISHED
Further payment plan not established
INITIAL_PAYMENT_PLAN_NOT_ESTABLISHED
Initial payment plan not established
NO_ENGAGEMENT
No Engagement
OTHER
Other
PAYMENT_PLAN_BROKEN_FOR_NON_PAYMENT
Payment plan broken for non-payment
PAYMENT_PLAN_COMPLETED_SUCCESSFULLY
Payment plan completed successfully
RAISED_IN_ERROR
Raised in Error
Example
"INITIAL_PAYMENT_PLAN_NOT_ESTABLISHED"HardshipAgreementHardshipEntryReason
An enumeration.
Values
EXTERNAL_REFERENCE
Financial counsellor or external agent referral
RETAILER_REFERRAL
Retailer referral
SELF_IDENTIFIED
Customer self-identified as being in hardship
Example
"SELF_IDENTIFIED"HardshipAgreementHardshipType
An enumeration.
Values
DEATH_IN_FAMILY
Death in the family
FAMILY_VIOLENCE
Family violence
HOUSEHOLD_ILLNESS
Household illness
OTHER
Other
REDUCED_INCOME
Reduced income
UNEMPLOYMENT
Unemployment
Example
"DEATH_IN_FAMILY"HardshipEntryReasonEnum
How the customer entered the hardship program.
Values
EXTERNAL_REFERENCE
RETAILER_REFERRAL
SELF_IDENTIFIED
Example
"SELF_IDENTIFIED"HardshipExitReasonEnum
The reason for exiting the hardship agreement.
Values
ACCOUNT_FINALISED
CREDIT_OR_NIL_BALANCE
CUSTOMER_REQUEST
FURTHER_PAYMENT_PLAN_NOT_ESTABLISHED
INITIAL_PAYMENT_PLAN_NOT_ESTABLISHED
NO_ENGAGEMENT
OTHER
PAYMENT_PLAN_BROKEN_FOR_NON_PAYMENT
PAYMENT_PLAN_COMPLETED_SUCCESSFULLY
RAISED_IN_ERROR
Example
"INITIAL_PAYMENT_PLAN_NOT_ESTABLISHED"HardshipTypeEnum
The type of hardship the account holder is experiencing.
Values
DEATH_IN_FAMILY
FAMILY_VIOLENCE
HOUSEHOLD_ILLNESS
OTHER
REDUCED_INCOME
UNEMPLOYMENT
Example
"DEATH_IN_FAMILY"HazardType
An enumeration.
Values
ASBESTOS_BOARD
Asbestos Board
ASBESTOS_FUSE
Asbestos Fuse
CUSTOMER_CAUTION
Customer Caution
CUSTOMER_REPORTS_NO_HAZARD
Customer Reports No Hazard
DOG
Dog
ELECTRICAL_SAFETY_ISSUE
Electrical Safety Issue
ELECTRIC_FENCE
Electric Fence
NOT_KNOWN
Not Known
Example
"ASBESTOS_BOARD"IntermediaryScheduleType
An enumeration.
Values
PAYMENT_HOLIDAY
VARIABLE_SCHEDULE
Example
"PAYMENT_HOLIDAY"JobEnquiryCodeChoices
An enumeration.
Values
ATTACH_LOCKS_OR_PLUGS_TO_METER_FOR_DEBT
ATTACH_METER_LOCK_FOR_BREACH_OF_CONTRACT
ATTACH_METER_LOCK_FOR_CUSTOMER_REQUEST
ATTACH_METER_LOCK_FOR_ILLEGAL_USE
ATTACH_METER_LOCK_FOR_MOVE_OUT
ATTACH_METER_LOCK_FOR_NON_PAYMENT
ATTACH_METER_LOCK_FOR_UNAUTHORISED_USAGE
BAD_SUPPLY
CRITICAL_SUPPLY_LOSS
DISCONNECT_SERVICE_IN_STREET_FOR_BREACH_OF_CONTRACT
DISCONNECT_SERVICE_IN_STREET_FOR_DEBT
DISCONNECT_SERVICE_IN_STREET_FOR_ILLEGAL_USAGE
DISCONNECT_SERVICE_IN_STREET_FOR_NON_PAYMENT
DISCONNECT_SERVICE_IN_STREET_FOR_NO_ACCESS
DISCONNECT_SERVICE_IN_STREET_FOR_UNAUTHORISED_USAGE
DISSATISFIED_CUSTOMER
DOWNGRADE_METER
EMERGENCY
EMERGENCY_CHANGE_OVER
ESCAPE_BAD
ESCAPE_BAD_STREET
ESCAPE_METER
ESCAPE_OTHER
ESCAPE_STREET
EXPLOSION
FATALITIES
FIRE_APPLIANCE
FIRE_HOUSE
FIRE_MAIN
FIRE_METER
FIRE_SERVICE
INSTALL_TRAILER_AIR_COUPLING
INSTALL_TRAILER_AIR_COUPLING_FOR_BREACH_OF_CONTRACT
INSTALL_TRAILER_AIR_COUPLING_FOR_ILLEGAL_USAGE
INSTALL_TRAILER_AIR_COUPLING_FOR_NON_PAYMENT
INSTALL_TRAILER_AIR_COUPLING_FOR_UNAUTHORISED_USAGE
INTERVAL_METER_REMOVAL
METER_ALTER_POSITION
METER_CHANGE
METER_DAMAGED
METER_DEFECTIVE_OPERATION_ORDINARY
METER_FIX
METER_FIX_FAULT_RECTIFIED
METER_HIGH_ACCOUNT_COMPLAINT
METER_PRE_PAY_BROKEN
METER_REFIX
METER_REFIX_AND_RELIGHT
METER_REFIX_AND_RELIGHT_KNOWN_GAS_SUPPLY
METER_REMOVE
METER_REMOVE_FOR_BREACH_OF_CONTRACT
METER_REMOVE_FOR_CUSTOMER_REQUEST
METER_REMOVE_FOR_ILLEGAL_USAGE
METER_REMOVE_FOR_NON_PAYMENT
METER_REMOVE_FOR_UNAUTHORISED_USAGE
METER_RETAKE_AND_TEST
METER_STOLEN
METER_TAP_JAMMED
METER_TURN_ON
METER_TURN_ON_CUT_OFF_IN_ERROR
NEW_CONNECTION_CLUSTER_DEVELOPMENT
NO_GAS
OTHER
POLICE_AND_OR_FIRE_BRIGADE
PRACTICALLY_NO_GAS
PRESSURE_CHANGE_REQUEST
RECONNECT_SERVICE_IN_STREET_AFTER_PAYMENT
RELOCATE_SERVICE_ONLY_REQUEST
REMOVE_LOCKS_PLUGS_TO_METER_FOR_DEBT
REMOVE_TRAILER_AIR_COUPLING
SERVICE_CONNECTION_REQUEST
SERVICE_DISCONNECTION_REQUEST
STREET_EXCAVATIONS
UPGRADE_METER_SIZE_REQUEST
UPGRADE_SERVICE_REQUEST
UPSTREAM_EQUIPMENT_FAULT
Example
"ATTACH_LOCKS_OR_PLUGS_TO_METER_FOR_DEBT"JurisdictionChoices
An enumeration.
Values
AUSTRALIAN_CAPITAL_TERRITORY
ISOLATED
NEW_SOUTH_WALES
NORTHERN_TERRITORY
QUEENSLAND
SOUTH_AUSTRALIA
TASMANIA
VICTORIA
WAGGA_WAGGA_TAMWORTH
WESTERN_AUSTRALIA
Example
"AUSTRALIAN_CAPITAL_TERRITORY"LeadContactRoles
The roles a contact has in relation to their lead.
Values
COMMUNICATIONS_CONTACT
LEGAL_CONTACT
OTHER_CONTACT
Example
"LEGAL_CONTACT"LeaveSupplierSubType
Indicates the type of a leave supplier process.
Values
DEMIGRATION
MOVE_OUT
Example
"MOVE_OUT"LifeSupportEquipment
An enumeration.
Values
CHRONIC_POSITIVE_AIRWAYS_PRESSURE_RESPIRATOR
Chronic Positive Airways Pressure Respirator
CRIGLER_NAJJAR_SYNDROME_PHOTOTHERAPY_EQUIPMENT
Crigler Najjar Syndrome Phototherapy Equipment
INTERMITTENT_PERITONEAL_DIALYSIS_MACHINE
Intermittent Peritoneal Dialysis Machine
KIDNEY_DIALYSIS_MACHINE
Kidney Dialysis Machine
OTHER
Other
OXYGEN_CONCENTRATOR
Oxygen Concentrator
VENTILATOR_FOR_LIFE_SUPPORT
Ventilator For Life Support
Example
"OXYGEN_CONCENTRATOR"LifeSupportPreferredContactMethod
An enumeration.
Values
EMAIL_ADDRESS
Email Address
PHONE
Phone
POSTAL_ADDRESS
Postal Address
SITE_ADDRESS
Site Address
Example
"POSTAL_ADDRESS"LifeSupportStatus
An enumeration.
Values
DEREGISTERED_CUSTOMER_ADVICE
Deregistered - Customer Advice
DEREGISTERED_NO_CUSTOMER_RESPONSE
Deregistered - No Customer Response
DEREGISTERED_NO_MEDICAL_CONFIRMATION
Deregistered - No Medical Confirmation
NONE
None
REGISTERED_MEDICAL_CONFIRMATION
Registered - Medical Confirmation
REGISTERED_NO_MEDICAL_CONFIRMATION
Registered - No Medical Confirmation
Example
"REGISTERED_NO_MEDICAL_CONFIRMATION"LifecycleSupplyPointProcessStatus
The status of the lifecycle process.
Values
CANCELLATION_ERRORED
CANCELLATION_FAILED
CANCELLATION_IN_PROGRESS
CANCELLATION_STALLED
CANCELLED
COMPLETED
ERRORED
FAILED
IN_PROGRESS
NEEDS_ATTENTION
PARTIALLY_CANCELLED
PARTIALLY_COMPLETED
PARTIALLY_REVERSED
PENDING
REVERSAL_ERRORED
REVERSAL_FAILED
REVERSAL_IN_PROGRESS
REVERSAL_STALLED
REVERSED
REVERSE_IN_PROGRESS
STALLED
Example
"PENDING"LineItemCurrency
An enumeration.
Values
AED_FILS
UAE fils
AUD_CENTS
Australian cents
CAD_CENTS
Canadian cents
DKK_ORE
Danish øre
EURO_CENTS
Euro cents
GBP_PENCE
UK pence
JPN_YEN
Japanese yen
NZD_CENTS
New Zealand cents
USA_CENTS
USA cents
Example
"AUD_CENTS"LinkTrainingStatus
An enumeration.
Values
IN_TRAINING
In training
NOT_APPLICABLE
Not applicable
QUALIFIED
Qualified
Example
"NOT_APPLICABLE"LoyaltyPointAwardEntryReasonCode
The reason code associated with the loyalty points entry.
Values
POINTS_AWARDED_FOR_ACCOUNT_ACTION
Example
"POINTS_AWARDED_FOR_ACCOUNT_ACTION"LoyaltyPointDeductionEntryReasonCode
The reason code associated with the loyalty points entry.
Values
POINTS_DEDUCTED_FOR_ACCOUNT_ACTION
Example
"POINTS_DEDUCTED_FOR_ACCOUNT_ACTION"MDHXProcessType
An enumeration.
Values
ACCOUNT_CREATION_NOTIFICATION
Account Creation Notification
AMEND_SITE_ACCESS_DETAILS
Amend Site Access Details
AMEND_SITE_ADDRESS_DETAILS
Amend Site Address Details
CUSTOMER_DETAILS_NOTIFICATION
Customer Details Notification
CUSTOMER_DETAILS_REQUEST
Customer Details Request
CUSTOMER_TRANSFER
Customer Transfer
LIFE_SUPPORT_NOTIFICATION
Life Support Notification
LIFE_SUPPORT_REQUEST
Life Support Request
MAINS_SERVICE_RENEWAL
Mains Service Renewal
METER_DATA_NOTIFICATION
Meter Data Notification
METER_DATA_VERIFY_REQUEST
Meter Data Verify Request
METER_READ_INPUT_NOTIFICATION
Meter Read Input Notification
MIRN_DISCOVERY
Mirn Discovery
MISSING_METER_DATA_NOTIFICATION
Missing Meter Data Notification
SERVICE_ORDER
Service Order
SPECIAL_READ
Special Read
STANDING_DATA_UPDATE_NOTIFICATION
Standing Data Update Notification
TIME_EXPIRED_METERS
Time Expired Meters
Example
"MIRN_DISCOVERY"MDHXStatusReason
An enumeration.
Values
ACN_RECEIVED
ACN Received
CANCELLATION_FAILED_SERVICE_ORDER_RESPONSE_RECEIVED
Cancellation Failed Service Order Response Received
CANCELLATION_FAILED_SPECIAL_READ_RESPONSE_RECEIVED
Cancellation Failed Special Read Response Received
CANCELLATION_SERVICE_ORDER_SENT
Cancellation Service Order Sent
CANCELLATION_SPECIAL_READ_SENT
Cancellation Special Read Sent
CANCELLED
Cancelled
CDN_REQUEST_SENT
CDN Request Sent
CLOSURE_SERVICE_ORDER_RESPONSE_RECEIVED
Closure Service Order Response Received
CLOSURE_SPECIAL_READ_RESPONSE_RECEIVED
Closure Special Read Response Received
COMPLETED
Completed
CUSTOMER_DETAILS_REQUEST_NOTIFICATION_SENT
Customer Details Request Notification Sent
CUSTOMER_DETAILS_REQUEST_RECEIVED
Customer Details Request Received
DISCOVERY_REQUEST_SENT
Discovery Request Sent
FAILED
Failed
FAILED_SERVICE_ORDER_RESPONSE_RECEIVED
Failed Service Order Response Received
FAILED_SPECIAL_READ_RESPONSE_RECEIVED
Failed Special Read Response Received
INITIAL_SERVICE_ORDER_RESPONSE_RECEIVED
Initial Service Order Response Received
INITIAL_SPECIAL_READ_RESPONSE_RECEIVED
Initial Special Read Response Received
INITIATED
Initiated
LIFE_SUPPORT_NOTIFICATION_RECEIVED
Life Support Notification Received
LIFE_SUPPORT_NOTIFICATION_RECEIVED_ACKNOWLEDGEMENT_SENT
Life Support Notification Received Acknowledgement Sent
LIFE_SUPPORT_NOTIFICATION_SENT
Life Support Notification Sent
LIFE_SUPPORT_REQUEST_NOTIFICATION_RECEIVED
Life Support Request Notification Received
LIFE_SUPPORT_REQUEST_NOTIFICATION_RECEIVED_ACKNOWLEDGEMENT_SENT
Life Support Request Notification Received Acknowledgement Sent
LIFE_SUPPORT_REQUEST_NOTIFICATION_SENT
Life Support Request Notification Sent
LIFE_SUPPORT_REQUEST_RECEIVED
Life Support Request Received
LIFE_SUPPORT_REQUEST_RECEIVED_ACKNOWLEDGEMENT_SENT
Life Support Request Received Acknowledgement Sent
LIFE_SUPPORT_REQUEST_SENT
Life Support Request Sent
MAINS_SERVICE_RENEWAL_RECEIVED
Mains Service Renewal Received
METER_DATA_NOTIFICATION_RECEIVED
Meter Data Notification Received
METER_DATA_RESPONSE_SENT
Meter Data Response Sent
METER_DATA_VERIFY_REQUEST_SENT
Meter Data Verify Request Sent
METER_DATA_VERIFY_RESPONSE_RECEIVED
Meter Data Verify Response Received
METER_READ_INPUT_SENT
Meter Read Input Sent
MISSING_METER_DATA_NOTIFICATION_SENT
Missing Meter Data Notification Sent
MULTIPLE_MIRNS_FOUND
Multiple Mirns Found
OBJECTED
Objected
PARTIAL_STANDING_DATA_RECEIVED
Partial Standing Data Received
PENDING
Pending
PENDING_VALIDATION
Pending Validation
PRE_REGISTRATION
Pre Registration
READ_FAILURE
Read Failure
REJECTED
Rejected
REQUESTED
Requested
REQUEST_ACCEPTED
Request Accepted
REQUEST_RECEIVED
Request Received
SERVICE_ORDER_REQUEST_SENT
Service Order Request Sent
SITE_ACCESS_DETAILS_RECEIVED
Site Access Details Received
SITE_ACCESS_DETAILS_REQUEST_SENT
Site Access Details Request Sent
SITE_ADDRESS_DETAILS_RECEIVED
Site Address Details Received
SITE_ADDRESS_DETAILS_REQUEST_SENT
Site Address Details Request Sent
SPECIAL_READ_REQUEST_SENT
Special Read Request Sent
STANDING_DATA_REQUEST_SENT
Standing Data Request Sent
STANDING_DATA_UPDATE_NOTIFICATION_RECEIVED
Standing Data Update Notification Received
TIME_EXPIRED_METERS_RECEIVED
Time Expired Meters Received
UNSOLICITED_SERVICE_ORDER_RESPONSE_RECEIVED
Unsolicited Service Order Response Received
UNSOLICITED_SPECIAL_READ_RESPONSE_RECEIVED
Unsolicited Special Read Response Received
WITHDRAWAL_RAISED
Withdrawal Raised
Example
"REQUEST_RECEIVED"MaximumRefundReasonChoices
An enumeration.
Values
MAX_ALLOWED_TO_REQUEST_VIA_DASHBOARD
Maximum refund is equal to the maximum refund amount allowed to be requested via the dashboard.
MAX_AVAILABLE_AMOUNT
Maximum refund is equal to the current balance minus the account recommended balance.
TOTAL_AMOUNT_PAID_VIA_ACTIVE_DDI
Maximum refund is equal to the total amount the customer has paid using the current account Direct Debit instruction.
Example
"MAX_AVAILABLE_AMOUNT"MessageChannel
An enumeration.
Values
INTERCOM
Intercom
JUNIFER
Junifer
PUSH_NOTIFICATION
Push Notification
SMS
SMS
Example
"EMAIL"MeterDataIssueFlowStatus
The current status of the meter data issue flow.
Values
CANCELLED
COMPLETED
ERRORED
PROCESSING
Example
"PROCESSING"MeterDataIssueStatus
The status of a meter data issue.
Values
ACTIONED
IGNORED
IN_REVIEW
OPEN
RESOLVED
Example
"OPEN"MeterInstallationTypeCodeType
An enumeration.
Values
BASIC
COMMS1
COMMS2
COMMS3
COMMS4
COMMS4A
COMMS4C
COMMS4D
COMMS9
COMMS9CM
MRAM
MRIM
NCONUML
PROF
SAMPLE
UMCP
UNKNOWN
VICAMI
Example
"BASIC"MeterPointIdentifierType
An enumeration.
Values
EMBEDDED_GAS_METER_POINT_ID
MIRN
NMI
WATER_METER_POINT_ID
Example
"NMI"MeterReadTypeFrequency
An enumeration.
Values
A_1
Monthly
A_2
Bi Monthly
A_3
Quarterly
D
Daily Or Weekly
Example
"A_1"MeterReadTypeMode
An enumeration.
Values
G
Galvanic
I
Infra Red
P
Powerline
T
Telephone
V
Visual
W
Wireless
Example
"T"Values
IN_SITU
Switching retailer but staying in the same property.
MOVE_IN
Moving into to a new property.
Example
"MOVE_IN"NotifiableApplicationService
An enumeration.
Values
APNS
iOS (APNs)
APNS_SANDBOX
iOS Sandbox (APNs Sandbox)
GCM
Android (GCM)
Example
"GCM"Notification
An enumeration.
Values
ARRANGEMENT_AMENDED
ARRANGEMENT_CREATED
ARRANGEMENT_EXPIRED
ARRANGEMENT_REVOKED
SECONDARY_USER_INSTRUCTION_ACTION
SHARING_DISABLED
SHARING_REQUESTED
SHARING_REQUEST_ACTION_ONE
SHARING_REQUEST_COMPLETE
Example
"SHARING_REQUESTED"Values
AES
ECM
EDF_FIELD
ELEC_NW
ENERGY_ASSETS
ENTERPRISE_MANAGED
EON_METERING
ESSENTIAL_FIELD
GENERIC_AGENT
LONDON
LOWRI_BECK
MDS
METERPLUS
MIDS_ELEC
NATIONAL_GRID
N_POWERGRID
OES
OESL
PROVIDOR
SGN
SIEMENS
SMS
TTE_FACILITA
Example
"GENERIC_AGENT"Values
OTHER
POST_APPOINTMENT_ABORTED
POST_APPOINTMENT_BOOKING
POST_APPOINTMENT_CANCELLATION
POST_APPOINTMENT_COMPLETION
Example
"POST_APPOINTMENT_BOOKING"OnSiteJobsAppointmentCancellationCategory
Appointment cancellation category with any subcategories in the format of 'CATEGORY__SUBCATEGORY'. For categories without subcategories, just 'CATEGORY'.
Values
CANCELLED_BY_CUSTOMER
CANCELLED_BY_PROVIDER___ERROR_IN_MIDDLEWARE
CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER
Example
"CANCELLED_BY_CUSTOMER"Values
ABORTED
BOOKED
CANCELLED
COMPLETED
DISPATCHED
EN_ROUTE
ON_SITE
PARTIALLY_COMPLETE
PENDING
Example
"PENDING"Values
CANCELLED_BY_BUSINESS
CANCELLED_BY_CUSTOMER
CANCELLED_BY_PROVIDER
CANCELLED_BY_SUPPLIER
Example
"CANCELLED_BY_CUSTOMER"OnSiteJobsRequestStatus
Request status.
Values
BOOKED
CANCELLED
COMPLETED
IN_PROGRESS
PENDING
Example
"BOOKED"Values
ACCURACY_TEST
AD_HOC_READING
BRACKET_INSTALLATION
COMMISSION
COMMS_HUB_POWER_CYCLE
COMMS_HUB_REPLACEMENT
CONFIRM_METER_DETAILS
DE_ENERGISE
ENERGISE
EV
EXCHANGE
IHD_INSTALL
INTERNAL
INVESTIGATE_FAULT
ISOLATOR_SWITCH_INSTALL
METERING_SERVICE_WORKS
METER_TAILS_UPGRADE
MOVE
NEW_CONNECTION
OTHER
REINSTALL
REMOVE
REPLACE_SEALS
SEWER
SUPPLY_SERVICE_WORKS
WATER
Example
"EXCHANGE"OnSiteJobsWorkflowStatus
The status of the workflow.
Values
CANCELLED
COMPLETED
ERRORED
FAILED
IN_PROGRESS
PENDING
SKIPPED
STALLED
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
BEFORE_END_OF_MONTH
The payment day is calculated backwards from the last day of the month.
OF_MONTH
The payment day is calculated forward.
Example
"OF_MONTH"PaymentExtensionOption
Available options for extending the payment.
Values
FORTNIGHTLY
PAY_IN_FULL
WEEKLY
Example
"PAY_IN_FULL"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.
FAILED
The instruction could not be set up with the vendor.
PROVISIONAL
The instruction has not yet been set up.
Example
"ACTIVE"PaymentMethodCDREnum
An enumeration.
Values
BPAY
CARD
CASH
CHEQUE
DIRECT_DEBIT
OTHER
TRANSFER
Example
"DIRECT_DEBIT"Values
BALANCE_THRESHOLD_CROSSED
BILL_ISSUED
PAYMENT_PLAN
REGULAR_SCHEDULE
Example
"BALANCE_THRESHOLD_CROSSED"PaymentScheduleReasonOptions
An enumeration.
Values
DEBT_REPAYMENT_PLAN
A payment schedule created to take payments to pay back a debt. These schedules typically expire once the debt has been re-payed.
FINAL_PAYMENT
A payment schedule created to take the final payment when an account is closed.
GENERAL_ACCOUNT_PAYMENT
The default value for usual account payments.
SSD_PAYMENT
A payment schedule created to take a payment around the supply start date of a meterpoint to help prevent accounts accruing debt.
Example
"GENERAL_ACCOUNT_PAYMENT"PaymentType
Possible payment instruction types.
Values
BPAY
CARD
DIRECT_DEBIT
GMO_REFUND
PAYMENT_SLIP
Example
"BPAY"PersonNameType
The name type of the contact person.
Values
AKA
Aka
BTH
Bth
LGL
Lgl
MDN
Mdn
PRF
Prf
STG
Stg
TRB
Trb
XFR
Xfr
Example
"AKA"PostalDeliveryType
Postal delivery types defined in aseXML schema ClientInformation_r36.xsd
Valid for aseXML revisions from r36-r41 (possibly future revisions too)
From the schema: Purpose - Define postal delivery types as per Australian Standard AS4590:2006 Detail - There are several additions in this list over and above what is in AS4590:2006. The extra types have been derived from the Australia Post AMAS standard. -- Version 5.0 additions -- Element AustralianPostalDeliveryType has been restricted to 11 characters
Values
CARE_PO
CMA
CMB
CPA
GPO_BOX
LOCKED_BAG
MS
PO_BOX
PRIVATE_BAG
RMB
RMS
RSD
Example
"CARE_PO"PreSignedTokenScope
Choices class for the pre-signed expiring tokens.
These choices must have a certain format:
{ACTION-VERB}_{DEFINING-NOUN}
They should start with an action verb. It should be a single word. The action verb enables the account user to do the thing (defining noun) that comes after the action verb. Together they represent a task.
The defining noun could be longer than a single word. Preferably, it should be kept short and simple as much as possible.
Values
ACCEPT_FIT_SCHEDULE
Scope that grants ability to accept fit schedule.
ACCEPT_FIT_TERMS
Scope that grants ability to accept fit terms.
ACCEPT_QUOTE
Scope that enables user to review and accept a quote sent via an email link.
ACCEPT_TERMS_AND_CONDITIONS
Scope that enables account user to accept the terms and conditions for a product.
ACCESS_CHANGE_MY_TARIFF_EXPIRING_LINK
Scope grants ability to access Change My Tariff journey without login
AMEND_PAYMENTS
Scope that grants access to amend payments.
BOOK_SMART_METER_APPOINTMENTS
Scope that enables account user to book smart meter appointments.
CANCEL_ENROLLMENT
Scope that enables the user to cancel enrollment to a supplier.
CHECKOUT_QUOTE
Scope that enables account user to checkout a quote (validate terms & conds and provide a payment detail).
EDIT_CUSTOMER_MARKETING_PREFERENCE
Edit Customer Marketing Preference
FINALIZE_ACCOUNT_SETUP
Scope that enables the user to finalize their account setup.
JOIN_CAMPAIGNS
Scope that enables account user to join campaigns.
JOIN_CAMPAIGN_EVENTS
Scope that enables account user to join campaign events.
MANAGE_ACCOUNT_RENEWALS
Scope that enables account user to generate a renewal quote and renew agreements.
MANAGE_BUSINESS_SECURITY_DEPOSIT
Scope that enables account user to manage security deposit payments for business accounts.
MANAGE_GOODS_PURCHASES
Scope that enables account user to accept goods quotes and process goods purchases.
MANAGE_PRODUCT_SWITCH
Scope that enables account user to do a self-serve product switch through the Dashboard.
MANAGE_PRODUCT_SWITCH_WITH_QUOTES
Scope that enables account user to do a self-serve product switch with quotes.
REDEEM_LOYALTY_POINTS
Scope that enables account user to redeem loyalty points
REPORT_MOVE_OUT
Scope that enables account user to report a property move-out.
SEND_LOSS_OBJECTION_FOR_CHANGE_OF_SUPPLIER
Scope that enables user to send a loss objection for a change of supplier process.
SET_GOODS_PURCHASE_SALE_ITEM_PRICES
Set Goods Purchase Sale Item Prices
SUBMIT_CUSTOMER_FEEDBACK
Scope that enables account user to submit customer feedback.
SUBMIT_FIT_METER_READINGS
Scope that grants ability to submit fit readings for a meter.
SUBMIT_METER_READINGS
Scope that enables account user to submit meter readings.
SUBMIT_MISSING_METER_DETAILS
Scope that enables account user to submit missing meter details.
UPDATE_ACCOUNT_DETAILS
Scope that enables the user to update information about themselves and their account.
UPDATE_BLACKHOLE_EMAIL
Scope that enables account user to update their blackhole email address.
UPDATE_BLACKHOLE_EMAIL_NO_ACCOUNT_NUMBER
Scope that enables account user to update their blackhole email address without enabling access to account number.
UPDATE_DIRECT_DEBIT
Scope that enables account user to update their direct debit details.
UPDATE_SENSITIVE_CUSTOMER_INFORMATION
Update Sensitive Customer Information
UPDATE_SMART_METER_INTEREST
Scope that enables account user to update their smart meter interest.
VERIFY_CUSTOMER_DETAILS
Scope that grants ability to verify the customer details.
VIEW_ACCOUNT_NUMBER
Scope that grants access to view the account number.
VIEW_CAMPAIGN_DASHBOARDS
Scope that enables account user to visit campaign dashboard.
VIEW_DETAILED_USAGE
Scope that enables account user to visit detailed property usage pages.
Example
"SUBMIT_METER_READINGS"ProductReferencePricingZone
An enumeration.
Values
ACTEWAGL
Evoenergy
AGLNORTH_TRUCENTRAL
AusNet Services Central
AGLNSW
Jemena
AGNSA
AGN - SA
ALBURY
AGN Albury
ALICESPNGS
AGN - NT
APTALLGAS
Allgas Energy
BRISNORTH
AGN - Brisbane
COOMABOMBA
AGN Bombala and Cooma
MIDWSOUTHW
ATCO Australia
MILDURA
AGN - Mildura
MURYVALLEY
AGN Murray Valley (NSW)
OEBRNSDALE
AGN - Bairnsdale
OEMETRO_AGLSOUTH
Multinet
OEMURVLYV
AGN - Murray Vic
OENORTH
AGN North
OEWGPLAND
AGN - Cardinia
OEYRVALLEY
Multinet Yarra Valley
QLDNORTH
AGN - Northern
TAMWORTH
Tamworth
TEMORA_HHOLCWALLA
AGN Temora Culciarn Holbrook
TRUEAST_OESTHEAST
AGN Central
TRURCBARWN
AusNet Services Adjoining Central
TRURULWEST
AusNet Services Adjoining West
TRUWEST
AusNet Services West
TUMUTGUNDA
AGN Adelong, Gundagai and Tumut
WAGGAURANQ
AGN Wagga Wagga
WIDEBAY
AGN - Wide Bay
Example
"AGLNSW"ReadingDirectionType
An enumeration.
Values
CONSUMPTION
Reading is based on the customer's usage of the utility.
GENERATION
Reading is based on the utility generated by the customer.
For example: This will return solar readings if a customer has solar panels installed at their location.
Example
"CONSUMPTION"ReadingFrequencyType
An enumeration.
Values
DAILY
Readings taken on a day to day basis.
DAY_INTERVAL
FIFTEEN_MIN_INTERVAL
Readings taken in every 15 minute intervals.
FIVE_MIN_INTERVAL
Readings taken in every 5 minute intervals.
HOUR_INTERVAL
Readings taken in every 1 hour intervals.
INTERVALIZED
Readings taken at a point in time and intervalized.
MONTH_INTERVAL
Readings taken in every 1 month intervals.
POINT_IN_TIME
Readings taken at a point in time.
QUARTER_INTERVAL
Readings taken in every 3 months intervals.
RAW_INTERVAL
Interval Readings as provided, may be variable in length.
THIRTY_MIN_INTERVAL
Readings taken in every 30 minute intervals.
WEEK_INTERVAL
Readings taken in every 1 week intervals.
Example
"RAW_INTERVAL"ReadingReasonForRead
An enumeration.
Values
INI
Meter Installation Read
MDV
Meter Data Verify
OSO
Other Service Order
REM
Meter Removed Read
SCH
Schedule Cycle Read
SRA
Special Account Investigation
SRD
Special Disconnection
SRF
Special Final Read
SRR
Special Reference Read
SRT
Special Transfer Read
Example
"SRF"ReadingStatisticTypeEnum
The type of statistic for the reading interval.
Values
CAPACITY_CHARGE_COST
The calculated cost of capacity charges for the interval.
CARBON_COST
The estimated carbon cost of the interval.
CO2_EMISSION_STATISTIC
The calculated co2 emission for the interval.
CONSUMPTION_BREAKDOWN
The breakdown of consumption into time of use buckets.
CONSUMPTION_COST
The calculated cost of consumption for the interval.
GAS_READING_INFORMATION
Information related to a gas reading eg. conversion_factor, volume etc.
GENERATION_VALUE
The calculated monetary value of generation for the interval
POWER_FACTOR_STATISTIC
The calculated power factor for the interval.
STANDING_CHARGE_COST
The calculated cost of standing charges for the interval.
TOU_BUCKET_COST
The apportion cost of a time of use bucket for the interval.
Example
"STANDING_CHARGE_COST"ReadingTypeOfRead
An enumeration.
Values
A
Actual
C
Customer Own Read
D
Deemed Read
E
Estimated
S
Substituted
U
Unknown
Example
"A"ReadingTypes
Available reading types.
Values
ACCUMULATION
Readings indicating total utility consumption since the meter was installed or reset.
INTERVAL
Readings indicating total consumption or generation of a utility between two points in time.
PEAK
Readings indicating the maximum rate of utility transfer.
Example
"INTERVAL"ReferralSchemeTypeChoices
Referral scheme type choices.
Values
LEGACY_REFERRAL
Legacy Referral.
PARTNER_REWARD
Partner Reward.
PROMO_REWARD
Promo Reward.
REFERRAL_REWARD
Referral Reward.
SIGNUP_REWARD
Signup Reward.
Example
"REFERRAL_REWARD"ReferralStatusChoices
Referral status choices.
Values
Cancelled
Cancelled.
Paid
Paid.
Pending
Pending.
Example
"Pending"RepaymentMethod
Methods by which repayments can be sent to the customer.
Values
BANK_TRANSFER
CARD
CHEQUE
Example
"BANK_TRANSFER"RepaymentRequestStatus
Possible status' for a repayment (or refund) request
Values
ACCEPTED
CANCELLED
REJECTED
REQUESTED
Example
"REQUESTED"RequestReason
An enumeration.
Values
CONFIRM_LIFE_SUPPORT
DATA_QUALITY_ISSUE
MISSING_CUSTOMER_DETAILS
NEW_CONNECTION_NO_CDN_RECEIVED
NO_RESPONSE_TO_REJECTED_CDN
OTHER
REC_CONFIRM_NO_SENSITIVE_LOAD
RETURNED_MAIL
TRANSFER_COMPLETE_NO_CDN_RECEIVED
Example
"CONFIRM_LIFE_SUPPORT"RequestStatus
Request status.
Values
APPOINTMENT_FAILED
APPROVAL_ON_HOLD
APPROVAL_PENDING
APPROVAL_REJECTED
BOOKED
CANCELLED
COMPLETED
HELD
IN_PROGRESS
PENDING
Example
"APPROVAL_PENDING"RequestedAt
When is the payment extension requested
Values
AFTER_DUE_DATE
BEFORE_DUE_DATE
Example
"AFTER_DUE_DATE"RolloverStatus
Status of an agreement rollover.
Values
DONE
ENQUEUED
ERROR
PENDING
REJECTED
REVOKED
Example
"PENDING"SalesChannelChoices
An enumeration.
Values
ACQUISITION
AGGREGATOR
BROKER
DEBT_COLLECTION_AGENCY
DIGI_TELESALES
DIRECT
EVENTS
FIELD_SALES
GIFT_OF_KIT
HIGH_REFERRER
LANDLORD
MOVE_IN
NEW_TENANT
PARENT_POWER
PARTNERSHIPS
PEOPLE_POWER
PRICE_COMPARISON
SUPPLIER_OF_LAST_RESORT
TELESALES
WORKPLACE_POP_UP
WORKS_WITH_OCTOPUS
Example
"DIRECT"ScheduleFrequencyEnum
The based unit of frequency at which payments are to be taken.
Values
MONTHLY
WEEKLY
Example
"WEEKLY"ScheduleType
An enumeration.
Values
BACS_TRANSFER
CARD_PAYMENT
DIRECT_DEBIT
PAYMENT_SLIP
Example
"BACS_TRANSFER"ServiceOrderDeEnergisationReasonChoices
An enumeration.
Values
BREACH_OF_CONTRACT
CUSTOMER_REQUESTED
DEFECT
ILLEGAL_USAGE
MOVE_OUT
NON_PAYMENT_D_N_P
NO_ACCESS
OTHER
SAFETY
SITE_WORKS
UNAUTHORISED_USAGE_D_N_I
Example
"CUSTOMER_REQUESTED"ServiceOrderResponseCode
The response code for a service order cancellation.
Values
APPOINTMENT_REQUIRED
Appointment Required
COMMS_REFUSED
Comms Refused
COORDINATION_FAILURE
Coordination Failure
CUSTOMER_ON_SITE
Customer On Site
CUSTOMER_PREVENTED
Customer Prevented
DEFECT
Defect
DEMOLISHED
Demolished
DE_ENERGISATION_NOT_COMPLETED_DUE_TO_A_RE_ENERGISATION
De Energisation Not Completed Due To A Re Energisation
DOCUMENTATION_NOT_PROVIDED
Documentation Not Provided
DOG
Dog
INADEQUATE_INFRASTRUCTURE
Inadequate Infrastructure
INCORRECT_SERVICE_ORDER
Incorrect Service Order
INITIATOR_CANCELLATION
Initiator Cancellation
LIFE_SUPPORT
Life Support
METERING_NOT_COMPATIBLE_WITH_PROPOSED_TARIFF_CHANGE
Metering Not Compatible With Proposed Tariff Change
METERING_PROBLEM
Metering Problem
METER_NOT_RETRIEVED
Meter Not Retrieved
METER_READING_ONLY_UNDERTAKEN_DUE_TO_PRIOR_RE_ENERGISATION
Meter Reading Only Undertaken Due To Prior Re Energisation
MISMATCH_WITH_STANDING_DATA
Mismatch With Standing Data
NATURAL_EVENT
Natural Event
NEW_CUSTOMER_ON_SITE
New Customer On Site
NOT_FRMP
Not Frmp
NO_ACCESS_NETWORK_SUPPORT_REQUIRED
No Access Network Support Required
NO_ADULT_PRESENT
No Adult Present
NO_COMMS
No Comms
NO_SUPPLY
No Supply
OBSTRUCTION
Obstruction
OTHER
Other
READING_PROBLEM
Reading Problem
RECIPIENT_CANCELLATION
Recipient Cancellation
REQUEST_SUBMITTED_BY_ANOTHER_INITIATOR
Request Submitted By Another Initiator
SENSITIVE_LOAD
Sensitive Load
SHARED_FUSE_SCOPING_REQUIRED
Shared Fuse Scoping Required
SHARED_SUPPLY_POINT
Shared Supply Point
SITE_ALREADY_ENERGISED
Site Already Energised
SITE_NOT_READY
Site Not Ready
TARIFF_CHANGE_NOT_APPROVED
Tariff Change Not Approved
UNABLE_TO_ACCESS
Unable To Access
UNABLE_TO_ISOLATE
Unable To Isolate
UNABLE_TO_LOCATE_SITE
Unable To Locate Site
UNKNOWN_CONNECTION_STATUS
Unknown Connection Status
UNKNOWN_LOAD
Unknown Load
UNSAFE
Unsafe
Example
"CUSTOMER_ON_SITE"ServiceOrderStatus
An enumeration.
Values
ACCEPTED
Accepted
CANCELLED
Cancelled
COMPLETED
Completed
DISPUTED
Disputed
NOT_COMPLETED
Not Completed
NO_ACCESS
No Access
PARTIALLY_COMPLETED
Partially Completed
PENDING
Pending
REJECTED
Rejected
REQUESTED
Requested
Example
"PENDING"ServiceOrderSubTypeChoices
An enumeration.
Values
AFTER_DISCONNECTION_FOR_NON_PAYMENT
ALLOCATE_NMI
BLANK_NOT_PROVIDED
CHANGE_TIMESWITCH_SETTINGS
CHECK_READ
DISCONNECT_AT_PILLAR_BOX_PIT_OR_POLE_TOP
ESTABLISH_PERMANENT_SUPPLY
ESTABLISH_TEMPORARY_IN_PERMANENT
ESTABLISH_TEMPORARY_SUPPLY
EXCHANGE_METER
FINAL_READ
INSTALL_CONTROLLED_LOAD
INSTALL_METER
INSTALL_METER_ISOLATION_DEVICE
LOCAL_METER_DISCONNECTION
METER_INVESTIGATION_INSPECT
METER_INVESTIGATION_TEST
METER_RECONFIGURATION
MOVE_IN
MOVE_METER
NEW_READING_REQUIRED
PHYSICAL_VISIT
RECIPIENT_DISCRETION
REMOTE
REMOVE_FUSE
REMOVE_METER
RESEAL_DEVICE
RETROSPECTIVE_MOVE_IN
SUPPLY_ABOLISHMENT
SUPPLY_ALTERATION
TARIFF_CHANGE
TEMPORARY_ISOLATION
TEMPORARY_ISOLATION_GROUP_SUPPLY
TEMPORARY_ISOLATION_ONE_IN_ALL_IN
TEMPORARY_ISOLATION_SCOPING_REQUEST
Example
"AFTER_DISCONNECTION_FOR_NON_PAYMENT"ServiceOrderTypeChoices
An enumeration.
Values
DE_ENERGISATION
METERING_SERVICE_WORKS
MISCELLANEOUS
RE_ENERGISATION
SPECIAL_READ
SUPPLY_SERVICE_WORKS
Example
"SUPPLY_SERVICE_WORKS"SpecialReadReasonCodeChoices
An enumeration.
Values
ACCOUNT_INVESTIGATION
CHANGE_OF_RETAILER
CHECK_READ
FINAL_READ
Example
"FINAL_READ"State
.. note::
Various versions of the Australian Standard have included a
ninth option. AS4590:1999 includes the Australian Antarctic
Territory (which has no postal service and no permanent
residents), and AS4590.1:2017 includes "Other".
We omit these, because every non-self-governing territory
"belongs" to one of these eight values as far as Australia Post
is concerned.
Values
ACT
NSW
NT
QLD
SA
TAS
VIC
WA
Example
"ACT"Values
AUSTRALIAN_CAPITAL_TERRITORY
NEW_SOUTH_WALES
NORTHERN_TERRITORY
QUEENSLAND
SOUTH_AUSTRALIA
TASMANIA
VICTORIA
WESTERN_AUSTRALIA
Example
"AUSTRALIAN_CAPITAL_TERRITORY"StatementReversalsAfterClose
Tracking of charge reversals after statement closure (ALL, SOME, NONE, or NOT_CLOSED).
Values
ALL
All charges have been reversed after the statement was closed.
NONE
No reversals after the statement was closed.
NOT_CLOSED
The statement has not been closed yet.
SOME
Some charges have been reversed after the statement was closed.
Example
"ALL"Status
The status of a workflow.
Values
CANCELLED
COMPLETED
ERRORED
FAILED
IN_PROGRESS
PENDING
SKIPPED
STALLED
Example
"SKIPPED"Statuses
The current status of the market gateway flow.
Values
CANCELLED
COMPLETED
ERRORED
PROCESSING
Example
"PROCESSING"StorylineEntryTypes
The available types of storyline entries.
Values
APPOINTMENT
COMPLAINT_SUMMARY
CONVERSATION_NOTE_SUMMARY
CTI_CALL_SUMMARY
INBOUND_CTI_CALL
INBOUND_MESSAGE
INBOUND_VOICE_CALL
MESSAGE_SUMMARY
METER_READING
OTHER
OUTBOUND_CTI_CALL
OUTBOUND_MESSAGE
OUTBOUND_VOICE_CALL
PAYMENT
REFUND
REPAYMENT
STATEMENT
TRANSACTIONAL_MESSAGE
VOICE_CALL_SUMMARY
Example
"INBOUND_MESSAGE"StreetSuffix
An enumeration.
Values
CENTRAL
DEVIATION
EAST
EXTENSION
INNER
LOWER
MALL
NORTH
NORTH_EAST
NORTH_WEST
OFF
ON
OUTER
OVERPASS
SOUTH
SOUTH_EAST
SOUTH_WEST
UPPER
WEST
Example
"CENTRAL"StreetType
Possible street types for an Australian address.
.. note::
This list includes all values that are in AS4590:1999, AS4590:2006,
AS4590.1:2017, plus many that appear in no Australian Standard but are
used in aseXML. In cases where two versions of the standard give
different abbreviations, the one aseXML uses (usually the one from the
older standard) is used here.
This does mean that if e.g. a bulk mail provider expects strict
conformance to the latest version of the standard, some translation
might be required.
Values
ACCESS
ACRE
ALLEY
ALLEYWAY
AMBLE
ANCHORAGE
ANNEX
APPROACH
ARCADE
ARTERIAL
ARTERY
AVENUE
BANAN
BANK
BASIN
BAY
BEACH
BEND
BLOCK
BOARDWALK
BOULEVARD
BOULEVARDE
BOWL
BRACE
BRAE
BRANCH
BREAK
BRETT
BRIDGE
BROADWAY
BROW
BYPASS
BYWAY
CAUSEWAY
CENTRE
CENTREWAY
CHASE
CIRCLE
CIRCLET
CIRCUIT
CIRCUS
CLOSE
CLUSTER
COLONNADE
COMMON
CONCORD
CONCOURSE
CONNECTION
COPSE
CORNER
CORSO
COURSE
COURT
COURTYARD
COVE
CRESCENT
CREST
CRIEF
CROOK
CROSS
CROSSING
CROSSROAD
CROSSWAY
CRUISEWAY
CUL_DE_SAC
CUT
CUTTING
DALE
DASH
DELL
DENE
DEVIATION
DIP
DISTRIBUTOR
DIVIDE
DOCK
DOMAIN
DOWN
DOWNS
DRIVE
DRIVEWAY
EASEMENT
EDGE
ELBOW
END
ENTRANCE
ESPLANADE
ESTATE
EXPRESSWAY
EXTENSION
FAIRWAY
FIREBREAK
FIRELINE
FIRETRAIL
FIRE_TRACK
FLAT
FLATS
FOLLOW
FOOTWAY
FORD
FORESHORE
FORK
FORMATION
FREEWAY
FRONT
FRONTAGE
GAP
GARDEN
GARDENS
GATE
GATES
GATEWAY
GLADE
GLEN
GRANGE
GREEN
GROUND
GROVE
GULLY
HARBOUR
HAVEN
HEATH
HEIGHTS
HIGHROAD
HIGHWAY
HILL
HOLLOW
HUB
INLET
INTERCHANGE
INTERSECTION
ISLAND
JUNCTION
KEY
KEYS
KNOLL
LADDER
LANDING
LANE
LANEWAY
LEAD
LEADER
LEES
LINE
LINK
LITTLE
LOOKOUT
LOOP
LOWER
LYNNE
MALL
MANOR
MART
MEAD
MEANDER
MEW
MEWS
MILE
MOTORWAY
MOUNT
NOOK
NORTH
NULL
OUTLET
OUTLOOK
OVAL
PALMS
PARADE
PARADISE
PARK
PARKLANDS
PARKWAY
PART
PASS
PASSAGE
PATH
PATHWAY
PENINSULA
PIAZZA
PLACE
PLATEAU
PLAZA
POINT
PORT
PRECINCT
PROMENADE
PURSUIT
QUAD
QUADRANGLE
QUADRANT
QUAY
QUAYS
RAMBLE
RAMP
RANGE
REACH
REEF
RESERVE
REST
RETREAT
RETURN
RIDE
RIDGE
RIDGEWAY
RIGHT_OF_WAY
RING
RISE
RISING
RIVER
RIVERWAY
RIVIERA
ROAD
ROADS
ROADSIDE
ROADWAY
RONDE
ROSEBOWL
ROTARY
ROUND
ROUTE
ROW
ROWE
RUE
RUN
SERVICE_WAY
SHUNT
SIDING
SKYLINE
SLOPE
SOUND
SOUTH
SPUR
SQUARE
STAIRS
STATE_HIGHWAY
STEPS
STRAIGHT
STRAIT
STRAND
STREET
STRIP
SUBWAY
TARN
TERRACE
THOROUGHFARE
THROUGHWAY
TOLLWAY
TOP
TOR
TOWERS
TRACK
TRAIL
TRAILER
TRAMWAY
TRAVERSE
TRIANGLE
TRUNKWAY
TUNNEL
TURN
UNDERPASS
UPPER
VALE
VALLEY
VIADUCT
VIEW
VIEWS
VILLA
VILLAGE
VILLAS
VISTA
VUE
WADE
WALK
WALKWAY
WATERS
WATERWAY
WAY
WHARF
WOOD
WOODS
WYND
YARD
Example
"ACCESS"SupplyPointMarketNameEnum
An enumeration.
Values
AUS_ELECTRICITY
AUS_ELECTRICITY_DISTRIBUTION
AUS_GAS
AUS_WATER
SIMPLE_SERVICES
Example
"AUS_ELECTRICITY"SupplyType
An enumeration.
Values
ELECTRICITY
Electricity
EMBEDDED_ELECTRICITY
Embedded Electricity
GAS
Gas
Example
"ELECTRICITY"TextStyleV1
The style is the typographical hierarchy. These are Typescale Categories from the Mobile Design System (Figma).
Values
BODY1
BODY2
BUTTON_TEXT
CALLOUT1
CALLOUT2
CALLOUT3
INPUT_TITLE
SMALL1
SMALL2
SMALL3
TABULAR
TITLE1
TITLE2
TITLE3
TITLE4
TITLE5
TITLE6
Example
"TITLE1"TimeGranularities
Time buckets into which readings are grouped.
Values
DAY
FIFTEEN_MIN
FIVE_MIN
HOUR
MONTH
QUARTER
THIRTY_MIN
WEEK
YEAR
Example
"FIVE_MIN"TransactionTypeFilter
Filter options for transaction types (e.g., energy charges, water charges, imported payments).
Values
ENERGY_CHARGES
For filtering/excluding energy charge transactions: Gas or Electricity.
IMPORTED_CHARGES
For filtering/excluding imported charge transactions.
IMPORTED_CREDITS
For filtering/excluding imported credit transactions.
IMPORTED_PAYMENTS
For filtering/excluding imported payment transactions.
IMPORTED_REPAYMENTS
For filtering/excluding imported repayment transactions.
UNISSUED_TRANSACTIONS
For filtering/excluding unissued transactions.
WATER_CHARGES
For filtering/excluding water charge transactions.
Example
"UNISSUED_TRANSACTIONS"TriggerProcessingStatus
Set of possible outcomes resulting from the processing of a Trigger.
Values
PROCESSED
PROCESSING_FAILED
PROCESSING_SKIPPED
UNPROCESSED
Example
"UNPROCESSED"TypeOfVoiceCampaign
The type of campaign, e.g. preview or predictive.
Values
PREDICTIVE
PREVIEW
Example
"PREVIEW"UnitOfMeasure
An enumeration.
Values
A
A
KA
kA
KV
kV
KVA
kVA
KVAH
kVAh
KVAR
kVAr
KVARH
kVArh
KW
kW
KWH
kWh
MVA
MVA
MVAH
MVAh
MVAR
MVAr
MVARH
MVArh
MW
MW
MWH
MWh
PF
pf
V
V
VA
VA
VAH
VAh
VAR
VAr
VARH
VArh
W
W
WH
Wh
Example
"MWH"UnitType
An enumeration.
Values
AMPERE_MONTHS
CHARGES_INCURRED
CUBIC_METRES_CONSUMPTION
CURRENCY_YEAR
DAYS_ON_SUPPLY
DIMENSIONLESS
KL_CONSUMPTION
KVARH_CONSUMPTION
KVA_CAPACITY_DAYS
KVA_CAPACITY_MONTHS
KVA_DEMAND
KVA_DEMAND_DAYS
KVA_DEMAND_MONTHS
KWH_CONSUMPTION
KW_CAPACITY_MONTHS
KW_DEMAND
KW_DEMAND_DAYS
LITRES_CONSUMPTION
MEGAJOULES_CONSUMPTION
MONTHS_ON_SUPPLY
MWH_CONSUMPTION
PARTNER_CHARGES_INCURRED
PER_ITEM
STANDARD_CUBIC_METRES_CONSUMPTION
UNITS_WA
YEARS_ON_SUPPLY_PER_DIEM
Example
"DAYS_ON_SUPPLY"Units
Available units relevant to electricity, gas, and water.
Values
AMPERE
DECALITERS
FEET_CUBED
KILOAMPERE
KILOLITERS
KILOVOLT
KILOVOLT_AMPERE
KILOVOLT_AMPERE_HOURS
KILOVOLT_AMPERE_REACTIVE
KILOVOLT_AMPERE_REACTIVE_HOURS
KILOWATT
KILOWATT_HOURS
LITER
METERS_CUBED
POWER_FACTOR
US_GALLONS
VOLT
VOLT_AMPERE
VOLT_AMPERE_HOURS
VOLT_AMPERE_REACTIVE
VOLT_AMPERE_REACTIVE_HOURS
WATT
WATT_HOURS
Example
"WATT"UsageReferencePricingZone
An enumeration.
Values
ACTEWAGL
Evoenergy
AGLNORTH_TRUCENTRAL
AusNet Services Central
AGLNSW
Jemena
AGNSA
AGN - SA
ALBURY
AGN Albury
ALICESPNGS
AGN - NT
APTALLGAS
Allgas Energy
BRISNORTH
AGN - Brisbane
COOMABOMBA
AGN Bombala and Cooma
MIDWSOUTHW
ATCO Australia
MILDURA
AGN - Mildura
MURYVALLEY
AGN Murray Valley (NSW)
OEBRNSDALE
AGN - Bairnsdale
OEMETRO_AGLSOUTH
Multinet
OEMURVLYV
AGN - Murray Vic
OENORTH
AGN North
OEWGPLAND
AGN - Cardinia
OEYRVALLEY
Multinet Yarra Valley
QLDNORTH
AGN - Northern
TAMWORTH
Tamworth
TEMORA_HHOLCWALLA
AGN Temora Culciarn Holbrook
TRUEAST_OESTHEAST
AGN Central
TRURCBARWN
AusNet Services Adjoining Central
TRURULWEST
AusNet Services Adjoining West
TRUWEST
AusNet Services West
TUMUTGUNDA
AGN Adelong, Gundagai and Tumut
WAGGAURANQ
AGN Wagga Wagga
WIDEBAY
AGN - Wide Bay
Example
"AGLNSW"UsageReferenceState
An enumeration.
Values
ACT
Australian Capital Territory
NSW
New South Wales
NT
Northern Territory
QLD
Queensland
SA
South Australia
TAS
Tasmania
VIC
Victoria
WA
Western Australia
Example
"ACT"Vendor
Possible payment vendors.
Values
ACCESS_PAYSUITE
ACCESS_PAYSUITE_EXPORT
ACCESS_PAYSUITE_FIT
ACCESS_PAYSUITE_SHELL
BOTTOMLINE_GLOBAL_PAYMENTS_HUB
BOTTOMLINE_PTX
BOTTOMLINE_PTX_BATCHED
BPOINT
BUCKAROO
BUCKAROO_SEPA
COMMBANK
CUSTOM
DUMMY
GMO
GMO_CARD
GOCARDLESS
GOCARDLESS_AFFECT
GOCARDLESS_BULB
GOCARDLESS_GEN4U
GOCARDLESS_IRESA
PAGOPA
PAYMENTUS_DIGITAL_WALLET
SMARTDEBIT
STRIPE
STRIPE_CONNECT
STRIPE_CONNECT_VOICE
STRIPE_KONBINI
STRIPE_VOICE
TESORO
TG_PAYMENTS
TG_PAYMENTS_MYPAY
TOTALENERGIES
WESTPAC
WESTPAC_ILINK
WESTPAC_ILINK_MERIDIAN
WESTPAC_ILINK_POWERSHOP
WESTPAC_QUICKSTREAM
WESTPAC_QUICKSTREAM_MERIDIAN
WESTPAC_QUICKSTREAM_POWERSHOP
WORLDPAY
Example
"GOCARDLESS"VerificationRequestStatus
The status of verification for associated email.
Values
COMPLETED
NOT_SENT
PENDING
Example
"NOT_SENT"WaterMeterCapabilityType
An enumeration.
Values
AMI
AMI
AMR
AMR
MANUAL
Manual
TOUCHPAD
Touchpad
VISUAL
Visual
Example
"AMR"WaterMeterStatus
An enumeration.
Values
COMPANY_USE
Company use
CONSUMPTION_SURVEY
Consumption survey
IN_USE
In use
NOT_IN_USE
Not in use
REMOVED
Removed
TURNED_OFF
Turned off
Example
"NOT_IN_USE"WorkScheduleOpenOrClosedReason
Why a Work Schedule is open or closed.
Values
CLOSED_AFTER_CLOSE_TIME
CLOSED_BEFORE_OPEN_TIME
CLOSED_DUE_TO_DAY_OF_WEEK
CLOSED_DUE_TO_PUBLIC_HOLIDAY
OPEN_INSIDE_WORK_SCHEDULE
WORK_SCHEDULE_TIME_ZONE_MISCONFIGURED
Example
"CLOSED_DUE_TO_PUBLIC_HOLIDAY"source
An enumeration.
Values
IMPORT_READING_CREATE
IMPORT_READING_UPDATE
KRAKEN_ESTIMATE
OPS_READING_CREATE
OPS_READING_UPDATE
READING_FROM_AMPHIO
READING_FROM_NEM12
READING_FROM_NEM13
READING_SYNCED_FROM_AMPHIO
READING_UPDATED_BY_NEM12
READING_UPDATED_BY_NEM13
REGISTER_REMOVAL_ALIGNMENT
SELF_READING_CREATE
SELF_READING_UPDATE
Example
"OPS_READING_UPDATE"