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"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
An enumeration.
Values
CLEARED
The payment has been approved by the merchant and added to your Kraken account.
DELETED
This payment was deleted. From this point it cannot be altered.
FAILED
The payment failed permanently.
FULFILLED
The payment has been made successfully and applied to the Kraken balance.
HISTORIC
Payments made in a previous system and then imported into Kraken.
PENDING
The payment has been submitted. From this point it cannot be altered.
PROMISED
A payment promise has been created, but it has not left the customers bank account.
PROMISE_BROKEN
The payment promise has been broken.
REQUESTED
The initial state of a payment in Kraken. It should be scheduled with a payment vendor in the future.
SCHEDULED
The payment has been scheduled for collection and the customer has been notified. While a payment is scheduled, it can still be deleted.
THIRD_PARTY
Third Party payments are those recorded for financial purposes in a different system but should be added to statements.
Example
"SCHEDULED"AccountPaymentTransactionTypeChoices
An enumeration.
Values
AGENCY
ALLPAY_CARD
ALLPAY_CASH
ALLPAY_CHEQUE
AUSTRALIA_POST
BACS_DEPOSIT
BPAY
BPOINT
BRISTOL_POUND
BTRE
CASH
CENTREPAY
CHEQUE
CREDIT_CARD
DCA_COLLECTION
DD_FINAL_COLLECTION
DD_FIRST_COLLECTION
DD_REGULAR_COLLECTION
DD_RE_PRESENTATION
DEBIT_CARD
DWP
EAPA_VOUCHER
EFT
ERRONEOUS_PAYMENT
FAILED_REPAYMENT_REVERSAL
FUEL_DIRECT
HEEAS
IDEAL
IVR
KONBINI
PAGOPA_NOTICE
PAYMENT_FEE
PAYPOINT_CARD
PAYPOINT_CASH
PAYPOINT_CHEQUE
PAYZONE
POST_OFFICE_CARD
POST_OFFICE_CASH
POST_OFFICE_CHEQUE
POST_OFFICE_SAVINGS_STAMPS
PREPAID_CARD
PREPAY_CARD
PREPAY_KEY
PREPAY_SMART
PREPAY_TOKEN
TELPAY
TRANSFER_FROM_SAP
UNKNOWN
URGS
Example
"DD_FIRST_COLLECTION"AccountReminderTypes
Contains reminder type choices for all territories.
Values
ACCOUNT_COOL_OFF
ACCOUNT_MIGRATION_SYNC_XOSERVE_METER_MISMATCH
ACTIVATE_PAYMENT_CANCELLATION_STOPPED
AD_HOC
AGREEMENT_REVOKED
AMPERAGE_CHANGE
ASSIGNED_TO_CREDIT_TEAM
AUS_CENTREPAY_EXCESSIVE_CREDIT
AUS_EMBEDDED_ACQUISITION_MATRIX_ERROR
AUS_EMBEDDED_CHILD_NMIS
AUS_EMBEDDED_WATER_ESTIMATION_REQUIRED_FOR_SKIPPED_READING
AUS_EMBEDDED_WATER_READING_FAILURE
AUS_GET_CORRECT_PHONE_NUMBER
AUS_INDUSTRY_CUSTOMER_OWN_READING_NOT_SENT
AUS_VIC_SHAREDFUSE_NOTIFICATION
AUTOMATED_BILLING_DISABLED
BILLING
BILLING_AMENDED_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
COMMERCIAL_ENERGISATION_INTERVENTION_REQUIRED
COMMS_TO_BE_PRINTED
CONTRACT_COMMS_NOT_DELIVERED
COS_GAIN
COS_GAIN_MIGRATION_ECOES_METER_MISMATCH
COS_GAIN_REL_RETRIEVAL_FAILURE
COS_LOSS
CUSTOMER_DETAILS_CHANGE
CUSTOMER_REPORTED_SMART_METER_ISSUES
D0010_CREATION_FAILURE
DEU_INBOUND_APERAK
DEU_MASTER_DATA_SYNCHRONISATION
DEU_MASTER_DATA_UPDATE
DEU_METER_READINGS
DEU_SWICHTING_PROCESS_FAILED
DISCONNECTION_MANDATORY_NOTICE_EMAIL_FAILURE
DISCONNECTION_MANDATORY_NOTICE_SMS_FAILURE
DUNNING_BEST_ENDEAVOURS_CALL
DUNNING_DISCONNECTION_DE_ENERGISATION_ASSESSMENT
DUNNING_DISCONNECTION_MANDATORY_NOTICE_EMAIL_FAILURE
DUNNING_DISCONNECTION_OUTBOUND_REMINDER_CALL
DUNNING_MANDATORY_NOTICE_EMAIL_FAILURE
DUNNING_OUTBOUND_REMINDER_CALL
DUNNING_REMINDER
DUNNING_REMINDER_CALL
DUNNING_REMINDER_DISCONNECTION_APPLICATION
DUNNING_REMINDER_FUTURE_PAYMENT
DUNNING_REMINDER_PAYMENT_MADE
DUNNING_VACANT_CONSUMPTION_DE_ENERGISATION_ASSESSMENT
DUPLICATE_CARD_FINGERPRINTs
EMBEDDED_NETWORK_ALL_CHILD_LIFE_SUPPORT_RECORDS_ARE_DEREGISTERED
EMBEDDED_NETWORK_EXCEPTION_DISTRIBUTOR_OWNED_PARENT_LIFE_SUPPORT_RECORD
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_LOST_OR_LOSING
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_RECEIVED_DANGEROUS_LIFE_SUPPORT_NOTIFICATION
EMBEDDED_NETWORK_EXCEPTION_PARENT_METER_POINT_RECEIVED_LIFE_SUPPORT_NOTIFICATION
FAMILY_ISSUES_ADDED
FIELDWORKS_ACCOUNT_CREATED_WITH_NO_EMAIL_ADDRESS
FIELDWORKS_ALLOCATE_NMI_MARKET_PARTICIPANTS_NOT_SET
FIELDWORKS_APPOINTMENTS_UNAVAILABLE
FIELDWORKS_BULK_DEPLOYMENT_JOURNEY_AUTO_CANCELLED
FIELDWORKS_CHANGE_REQUEST_STEP_ERRORED
FIELDWORKS_CHANGE_REQUEST_STEP_FAILED
FIELDWORKS_CONTACT_SO_RECIPIENT_TO_UPDATE_THE_SO_DETAILS
FIELDWORKS_EXPECTED_METER_POINT_NOT_CREATED
FIELDWORKS_EXPECTED_METER_READ_NOT_RECEIVED
FIELDWORKS_EXPECTED_NTCS_NOT_RECEIVED
FIELDWORKS_INVESTIGATE_WHETHER_JOURNEY_NEEDS_CONTINUATION
FIELDWORKS_JOURNEY_ATTACHMENTS
FIELDWORKS_JOURNEY_CANCELLED_DUE_TO_LIFE_SUPPORT_REGISTRATION
FIELDWORKS_MAINTAIN_REGISTER_BILLABLE_OVERRIDE_FOR_UNSOLICITED_METER_CHANGES
FIELDWORKS_MANUALLY_COMPLETE_CUSTOMER_MOVE_IN
FIELDWORKS_METERPOINT_IS_NOT_ACTIVE
FIELDWORKS_METER_FAULT_JOURNEY_AUTO_CANCELLED
FIELDWORKS_METER_FAULT_NCOM_COMMS_FAILED
FIELDWORKS_METER_FAULT_RECEIVED
FIELDWORKS_MIRN_DISCOVERY_FAILED
FIELDWORKS_MOVE_OUT_CANCELLED_WHILE_SUPPLY_ABOLISHMENT_IN_PROGRESS
FIELDWORKS_MULTIPLE_OPEN_JOURNEYS_FOR_METER_POINT
FIELDWORKS_NEW_CONNECTION_COMPLETION_REVIEW
FIELDWORKS_NEW_CONNECTION_DATA_NOT_VALID
FIELDWORKS_OBTAIN_CUSTOMER_APPROVAL_BEFORE_PROGRESSING
FIELDWORKS_OBTAIN_SUPPLY_ABOLISHMENT_APPROVAL
FIELDWORKS_PAYER_CONTACT_FAILED_VALIDATION
FIELDWORKS_SERVICE_ORDER_ATTACHMENTS
FIELDWORKS_SERVICE_ORDER_COMPLETED
FIELDWORKS_SERVICE_ORDER_FAILED
FIELDWORKS_SERVICE_ORDER_PARTIALLY_COMPLETED
FIELDWORKS_SERVICE_ORDER_STATUS_UPDATED
FIELDWORKS_SERVICE_ORDER_STEP_ERRORED
FIELDWORKS_SERVICE_ORDER_STEP_FAILED
FIELDWORKS_SERVICE_ORDER_UNABLE_TO_ACCESS_WITH_CUSTOMER_CONSULTATION
FIELDWORKS_SUPPLY_PERIOD_DOES_NOT_EXIST_FOR_METERPOINT
FIELDWORKS_UPLOAD_ATTACHMENT_TO_JEMENA_PORTAL
FINAL_BILLING_UNABLE_TO_BILL
FLOW_FILE_ERROR
FOLLOW_UP_PAYMENT_PROMISE
FRA_ACTIVATION_PROCESS_AWAITING_SWITCH_IN_CONFIRMATION
FRA_ACTIVATION_PROCESS_AWAITING_SWITCH_READINGS
FRA_ACTIVATION_PROCESS_COMMANDER_SOUSCRIPTION
FRA_ACTIVATION_PROCESS_GAS_PROVIDER_CHANGE_REQUEST
FRA_ACTIVATION_PROCESS_INCEPTION_CHECKS
FRA_ACTIVATION_PROCESS_PRM_ELIGIBILITY
FRA_ACTIVATION_PROCESS_SCHEDULE_SITEWORKS
FRA_ELEC_ACTIVATION_PROCESS_WRONG_SWITCH_READINGS_FOR_PROVIDER_CALENDAR_TEMPORAL_CLASSES
FRA_ENERGY_CHEQUE_UNKNOWN
FRA_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_SPECIAL_REASON
INDUSTRY_EXCEPTION_FAILED_TO_CANCEL_DEENERGISATION_SERVICE_ORDER
INDUSTRY_EXCEPTION_HOUSE_MOVE_ENROLMENT_CANNOT_CALCULATE_MOVE_IN_READING
INDUSTRY_EXCEPTION_HOUSE_MOVE_ENROLMENT_SERVICE_ORDER_ALREADY_IN_PROGRESS
INDUSTRY_EXCEPTION_HOUSE_MOVE_ENROLMENT_UNABLE_TO_COPY_LAST_METER_READING
INDUSTRY_EXCEPTION_HOUSE_MOVE_OUT_CANNOT_CALCULATE_MOVE_OUT_READING
INDUSTRY_EXCEPTION_LIFE_SUPPORT_CONTACT_USER_REMOVED_FROM_ACCOUNT
INDUSTRY_EXCEPTION_LIFE_SUPPORT_MULTIPLE_ACCOUNTS_MATCHES
INDUSTRY_EXCEPTION_LIFE_SUPPORT_MULTIPLE_LIFE_SUPPORT_CONTACT_MATCHES
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_CONTAINS_UNEXPECTED_DATA
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_FAILED_TO_SEND
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_INVALID_CONTACT_METHOD
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_INVALID_PHONE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_RECEIVED_FROM_NON_REGISTRATION_OWNER
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_REJECTED
INDUSTRY_EXCEPTION_LIFE_SUPPORT_NOTIFICATION_UNKNOWN_CONTACT
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_MISSING_LIFE_SUPPORT_NOTIFICATION
INDUSTRY_EXCEPTION_LIFE_SUPPORT_REQUEST_REJECTED
INDUSTRY_EXCEPTION_METER_POINT_ENROLMENT_INCOMPLETE_COULD_NOT_SEND_SERVICE_ORDER
INDUSTRY_EXCEPTION_NEXT_SCHEDULED_READ_DATE_TOO_FAR_IN_FUTURE
INDUSTRY_EXCEPTION_RELINKING_OCCURRED_DURING_SDR_SYNC
INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_NOTIFICATION_MISSING_BUSINESS_ACCEPTANCE
INDUSTRY_EXCEPTION_SITE_ACCESS_DETAILS_NOTIFICATION_REJECTED
INDUSTRY_EXCEPTION_STANDING_DATA_PROPERTIES_ADDRESS_FAILED_TO_UPDATE
INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_INCOMPLETE_COULD_NOT_SEND_CHANGE_REQUEST
INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_INVALID_NMI_METER_STATUS
INDUSTRY_EXCEPTION_UNABLE_TO_ENROL_METER_POINT_NEXT_SCHEDULED_READ_DATE_PAST
INDUSTRY_EXCEPTION_UNABLE_TO_PROCESS_ROLR
INDUSTRY_LIFE_SUPPORT_CANCEL_DEREGISTRATION_FAILED
INDUSTRY_LIFE_SUPPORT_MANUAL_BEST_ENDEAVOUR_REQUIRED
INDUSTRY_LIFE_SUPPORT_REGISTRATION_FOLLOW_UP_REQUIRED
INDUSTRY_LIFE_SUPPORT_REVIEW_AFTER_CANCELLED_MOVE_OUT_FOR_NEXT_ACCOUNT
INDUSTRY_LIFE_SUPPORT_REVIEW_ATTEMPTED_CANCELLED_MOVE_OUT_FOR_NEXT_ACCOUNT
INDUSTRY_LIFE_SUPPORT_REVIEW_DEREGISTRATION
INDUSTRY_LIFE_SUPPORT_REVIEW_POST_DEREGISTRATION
INDUSTRY_LIFE_SUPPORT_REVIEW_POST_DEREGISTRATION_COMMS
INDUSTRY_MANUAL_ACTION_REQUIRED
INDUSTRY_MANUAL_CUSTOMER_DETAILS_NOTIFICATION_REQUIRED
INDUSTRY_MANUAL_LIFE_SUPPORT_NOTIFICATION_REQUIRED
INDUSTRY_METER_POINT_MISSING_CUSTOMER_CLASSIFICATION
INDUSTRY_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
KMT
MAIL_FAILED
MAIL_RETURNED
MANDATORY_COMMS_NOT_DELIVERED
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_CREATE
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_REVERSE_TERMINATION
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_TERMINATE
MARKET_SUPPLY_EXCEPTION_AGREEMENT_FAILED_TO_UPDATE
MARKET_SUPPLY_EXCEPTION_MISSING_ACCOUNT_QUOTED_PRODUCT
METER_EXCHANGE_ONE_WAY_NOTIFICATION
METER_FAULT_AND_ISSUE_ONE_WAY_NOTIFICATION_ACCEPTED
METER_FAULT_AND_ISSUE_ONE_WAY_NOTIFICATION_REJECTED
MIGRATION_TYPE
MOVE_IN
MOVE_IN_CES_LIFE_SUPPORT_REQUIRED
MOVE_IN_COMMS_NOT_DELIVERED
MOVE_IN_DEFAULT_PAYMENT_SCHEDULE_FAILED
MOVE_IN_MOVE_OUT_MANUAL_PROCESS
MOVE_OUT
NETWORK_TARIFF_ONE_WAY_NOTIFICATION
NEW_PSR_ADDED_TO_PREPAY_ACCOUNT
NON_ENERGY_PAYMENT_CALL_REMINDER
NOTICE_OF_METERING_WORKS_ONE_WAY_NOTIFICATION
NZ_BILLING_QUERY
NZ_DUNNING
NZ_METERING_QUERY
NZ_SOLAR_METER_CHANGE
NZ_SWITCHING_WITHDRAWAL
NZ_VACANT_PROPERTY
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_CHANGE_OF_TENANCY_REQUEST_FAILED
SMART_METER_MODE_CHANGE_UNSUPPORTED
SMART_PREPAY_ADD_DEBT_FAILURE
SMART_PREPAY_NEED_TO_ADJUST_DEBT
SMART_PREPAY_TOP_UP_FAILURE
SMART_PREPAY_TOP_UP_UTRN
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_VACANT
An account created when we supply a business premises and know there are definitely no occupants.
DOMESTIC
An account designed to supply/bill domestic premises.
MANAGED
An account created when we supply domestic premises that are managed by a business, i.e., a B2B2C model.
OCCUPIER
An account created when we supply a domestic premises but do not have details for the occupants.
PORTFOLIO_LEAD
An account which is responsible for all other accounts in the portfolio, i.e. pays the bills for them.
VACANT
An account created when we supply a domestic premises and know there are definitely no occupants.
Example
"BUSINESS"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_SALE
Business Sale
CREDIT
Credit
ELECTRIC_UNIVERSE
Electric Universe
ELECTROVERSE
Electroverse
ELECTROVERSE_LEAD
Electroverse Lead
ENERGY_HELP
Energy Help
ENERGY_SUPPORT
Energy Support
EV_CHARGER
Ev Charger
EV_LEAD
Ev Lead
HEAT_PUMP_LEAD
Heat Pump Lead
INTELLIGENT_OCTOPUS_SIGNUP
Intelligent Octopus Signup
LEAD
Lead
METER_READING
Meter Reading
OCCUPIER
Occupier
SALE
Sale
SOLAR_LEAD
Solar Lead
UNKNOWN
Unknown
Example
"SALE"AppSessionTypeChoices
Enumeration of app session types.
Values
BUSINESS_LEAD
BUSINESS_SALE
CREDIT
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"AttendantType
The relationship of the on-site attendant to the Account holder.
Values
ACCOUNT_HOLDER
FAMILY
OTHER
REALTOR
USER
Example
"FAMILY"BrandChoices
An enumeration.
Values
OCTOPUS_ENERGY_JAPAN
Octopus Energy Japan.
Example
"OCTOPUS_ENERGY_JAPAN"BusinessTypeOptions
An enumeration.
Values
CHARITY
A business account where the company type is charity.
CHURCH
A business account for a church or other religious organisation.
GOVERNMENT
A business account for a government institution.
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.
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"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"CanSupplyRejectionType
The type of rejection created by our "Can Supply" checks during the equipment enquiry
Values:
INVALID_GRID_OPERATOR: The grid operator is not one of those that
can be serviced
INVALID_VOLTAGE_FLAG: The voltage flag (low-voltage or high-voltage)
indicates a type of supply point that cannot be serviced
INVALID_CONTRACT_DETERMINATION_METHOD: The contract determination method
(e.g. appliance basis, actual volume basis) is not one of
those that can be supplied
INVALID_CONTRACT_CODE: The contract type code (e.g. lighting, power)
is not one of those that can be supplied
UNIVERSAL_SERVICE_SUPPLY: The supply point is in a remote area and
therefore eligible for "universal service" obligations, which means
it cannot be supplied
SUPPLY_POINT_USES_KW: The supply contract value is kW, but for
the MVP these cannot be supplied
INVALID_DECOMMISSIONING_STATUS: The supply point has been decommissioned,
i.e. it is not on supply with another supplier
POWER_TRANSMISSION_SERVICE_MENU_NOT_EMPTY: The power transmission
service menu (setsuzokuSodenServiceMenu) field is not empty,
which means the supply point is already on supply with us.
ALREADY_ON_SUPPLY: A supply point is already on supply in the system,
or is in the process of being on supply.
Values
ALREADY_ON_SUPPLY
INVALID_CONTRACT_DETERMINATION_METHOD
INVALID_CONTRACT_TYPE_CODE
INVALID_DECOMMISSIONING_STATUS
INVALID_GRID_OPERATOR
INVALID_VOLTAGE_FLAG
ON_CONTRACT_WITH_OUTSTANDING_MOVE_OUT
POWER_TRANSMISSION_SERVICE_MENU_EMPTY
POWER_TRANSMISSION_SERVICE_MENU_NOT_EMPTY
SUPPLY_POINT_USES_KW
UNIVERSAL_SERVICE_SUPPLY
Example
"INVALID_GRID_OPERATOR"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_TRIGGER
Example
"TRANSACTIONAL_MESSAGING_TRIGGER"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"ContractCapacityPattern
The kind of contract capacity pattern.
Values
NON_TIERED
OEPC
TIERED_HIGH
TIERED_LOW
Example
"NON_TIERED"ContractStatus
The status of the contract.
Values
ACTIVE
EXPIRED
INACTIVE
REVOKED
TERMINATED
TERMINATING
Example
"REVOKED"CosLossProcessStatus
An enumeration.
Values
AWAITING_MANUAL_DECISION
CANCELLATION_APPLICATION_ACCEPTED
CANCELLATION_APPLICATION_REJECTED
CHECKING_MATCHING_STATUS
CHECKING_SWITCHING_RESULT
COMPLETED_AFTER_FAILED_TO_WITHDRAW
INGESTION_FAILED
READY_TO_SEND_DECISION
REPLACED
REQUEST_BUILDER_ERROR
REQUEST_ERROR
SWITCH_OUT_CLOSED
SWITCH_OUT_COMPLETED
SWITCH_OUT_FAILED
SWITCH_OUT_FAILED_TO_WITHDRAW
SWITCH_OUT_WITHDRAWN
Example
"READY_TO_SEND_DECISION"DebtCollectionProceedingStopReason
An enumeration.
Values
ARREARS_TO_CLIENT
Arrears to client
BANKRUPT
Bankrupt
CONFIRMED_EMPTY
Confirmed empty
COS
COS
COT_COS
COT / COS
COT_NO_PROOF
COT no proof
COT_PROOF_SEEN
COT proof seen
DECEASED
Deceased
DEMOLISHED
Demolished
ENROLLED_IN_ERROR
Enrolled in Error
EXP
Expired
GONE_AWAY
Gone away
HIGH_LEVEL_COMPLAINT
High level complaint
INSOLVENCIES_DEALING
Insolvencies dealing
IN_PRISON
In prison
LIVE_TO_FINAL
Live to final
LOW_BALANCE
Low balance
NEGATIVE_TRACE
Negative trace
PAID_IN_FULL
Paid in full
PARTIAL_SETTLEMENT
Partial settlement
PART_PAYMENT
Part payment
PAYMENT_ARRANGEMENT
Payment arrangement
PAYMENT_PLAN_AGREED
Payment plan agreed
PPM_ARRANGEMENT
PPM arrangement
PPM_FITTED
PPM fitted
PPM_REQUESTED
PPM requested
PROCESS_EXHAUSTED
Process exhausted
PROCESS_EXHAUSTED_CONTACT
Process exhausted - contact
PROCESS_EXHAUSTED_NO_CONTACT
Process exhausted - no contact
QUERY
Query
REDUCED_SETTLEMENT
Reduced settlement
REFUSED_TO_DEAL
Refused to deal
UNABLE_TO_LOCATE_PROPERTY
Unable to locate property
UNABLE_TO_TRACE
Unable to trace
VULNERABLE
Vulnerable
WITHDRAWN
Withdrawn
WRITE_OFF
Write off
Example
"BANKRUPT"DirectDebitInstructionStatus
An enumeration.
Values
ACCOUNT_CLOSED
The account for this instruction was closed.
ACTIVE
The instruction is active and can be used to take payments.
FAILED
The instruction could not be set up with the vendor.
PROVISIONAL
The instruction has not yet been set up.
Example
"ACTIVE"DisconnectionProcessStatus
An enumeration.
Values
CLOSED
COMPLETED
COMPLETED_AFTER_FAILED_TO_UPDATE
FAILED_TO_UPDATE
INGESTION_FAILED
IN_PROGRESS
REJECTED
REQUEST_BUILDER_ERROR
REQUEST_ERROR
WAITING_TO_APPLY
WITHDRAWN
Example
"WAITING_TO_APPLY"DocumentAccessibilityChoices
An enumeration.
Values
AUDIO
Audio-accessible documents are requested for this account.
BRAILLE
Braille documents are requested for this account.
LARGE_PRINT
Large print documents are requested for this account.
Example
"LARGE_PRINT"DunningProcessStatus
An enumeration.
Values
ACTIVE
Active
COMPLETE
Complete
WITHDRAWING
Withdrawing
WITHDRAWN
Withdrawn
Example
"ACTIVE"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_TERMS_AND_CONDITIONS
Scope that enables account user to accept the terms and conditions for a product.
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
JOIN_CAMPAIGNS
Scope that enables account user to join campaigns.
JOIN_CAMPAIGN_EVENTS
Scope that enables account user to join campaign events.
MANAGE_ACCOUNT_RENEWALS
Scope that enables account user to generate a renewal quote and renew agreements.
MANAGE_BUSINESS_SECURITY_DEPOSIT
Scope that enables account user to manage security deposit payments for business accounts.
MANAGE_GOODS_PURCHASES
Scope that enables account user to accept goods quotes and process goods purchases.
MANAGE_PRODUCT_SWITCH
Scope that enables account user to do a self-serve product switch through the Dashboard.
REDEEM_LOYALTY_POINTS
Scope that enables account user to redeem loyalty points
REPORT_MOVE_OUT
Scope that enables account user to report a property move-out.
SEND_LOSS_OBJECTION_FOR_CHANGE_OF_SUPPLIER
Scope that enables user to send a loss objection for a change of supplier process.
SET_GOODS_PURCHASE_SALE_ITEM_PRICES
Set Goods Purchase Sale Item Prices
SUBMIT_CUSTOMER_FEEDBACK
Scope that enables account user to submit customer feedback.
SUBMIT_METER_READINGS
Scope that enables account user to submit meter readings.
UPDATE_ACCOUNT_DETAILS
Scope that enables the user to update information about themselves and their account.
UPDATE_BLACKHOLE_EMAIL
Scope that enables account user to update their blackhole email address.
UPDATE_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.
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
WEB
Example
"COMMUNICATIONS"ExternalAccountEventContentType
Enum of allowable content types for external account events.
The content type field is used to determine how to display the content in the account event description.
Values
HTML
LINK
PLAINTEXT
S3
Example
"PLAINTEXT"ExternalAccountEventSubCategory
Enum of allowable event type subcategories for external account events.
Values
CLICK_TO_CALL
DUNNING
FEEDBACK
INTERNAL
LIVE_CHAT
PUSH_NOTIFICATION
SMS
SOCIAL_MEDIA
TELEPHONE
THIRD_PARTY
Example
"TELEPHONE"FormType
An enumeration.
Values
COVID_19_FINANCIAL_ENERGY_ASSESSMENT
Covid-19 Financial Energy Assessment
COVID_19_GAS_PRICES_FINANCIAL_ENERGY_ASSESSMENT
Covid-19 Gas Prices Financial Energy Assessment
Example
"COVID_19_FINANCIAL_ENERGY_ASSESSMENT"GasSupplyPointStatus
An enumeration.
Values
CONNECTION_PENDING
DISCONNECTION_PENDING
LOST
OFF_SUPPLY
OFF_SUPPLY_DUE_TO_DUNNING
ON_SUPPLY
SWITCH_IN_PENDING
SWITCH_OUT_PENDING
Example
"ON_SUPPLY"GenerationPointStatus
An enumeration.
Values
LOST
MOVE_IN_PENDING
MOVE_OUT_PENDING
NEVER_UNDER_CONTRACT
SWITCH_IN_PENDING
SWITCH_OUT_PENDING
UNDER_CONTRACT
Example
"UNDER_CONTRACT"GuaranteeOfOriginPercentage
The percentage of the guarantee of origin.
Values
FIFTY
ONE_HUNDRED
SEVENTY_FIVE
TWENTY_FIVE
ZERO
Example
"ZERO"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"Hour
Hour requested by the customer for on-site attendance.
Values
_0000
_0100
_0200
_0300
_0400
_0500
_0600
_0700
_0800
_0900
_1000
_1100
_1200
_1300
_1400
_1500
_1600
_1700
_1800
_1900
_2000
_2100
_2200
_2300
Example
"_0000"JpnLeaveSupplierProcessDataDetailedReason
An enumeration.
Values
DEMIGRATION
Demigration
DUNNING
Dunning
MOVING
Moving
MOVING_INITIATED_OUTSIDE_KRAKEN
Moving initiated from outside Kraken
NOT_IN_USE
Not in use
ONE_STOP_SWITCHING
One stop switching
TWO_STOP_SWITCHING
Two stop switching
Example
"MOVING"JpnLeaveSupplierProcessDataReason
An enumeration.
Values
CONSUMER_REQUEST
Consumer request
RETAILER_REQUEST
Retailer request
Example
"CONSUMER_REQUEST"LifecycleSupplyPointProcessStatus
The status of the lifecycle process.
Values
CANCELLATION_ERRORED
CANCELLATION_FAILED
CANCELLATION_IN_PROGRESS
CANCELLATION_STALLED
CANCELLED
COMPLETED
ERRORED
FAILED
IN_PROGRESS
PARTIALLY_CANCELLED
PARTIALLY_COMPLETED
PARTIALLY_REVERSED
PENDING
REVERSAL_ERRORED
REVERSAL_FAILED
REVERSAL_IN_PROGRESS
REVERSAL_STALLED
REVERSED
REVERSE_IN_PROGRESS
STALLED
Example
"PENDING"LifelineAgencySignUpsFileRecordStatus
AWAITING_CUSTOMER_DATA_VALIDATION:
Initial status when the record is created. The record's customer data
is awaiting validation.
AWAITING_TERMS_AND_CONDITIONS_OR_SPIN:
Terms and conditions have not been accepted by the customer or, SPIN has
not been provided and validated for the record.
- If the record has an Application with a QuoteRequest and, the record
has an Account with ACCOUNT_CONSENT_DATA_TERMS_AGREED_AT_KEY_NAME
consent data, we know that the customer has accepted the Ts&Cs.
- If the record has valid_spin_provided set to True, we know that the
record has a valid (correct format) SPIN.
INDUSTRY_APPLICATION_IN_PROGRESS:
There is SPIN, so the industry application will have
started, but it has not yet completed. On the happy path, the
application will stay in this status until the move-in date.
COMPLETED_SUCCESSFULLY:
The industry process completed successfully and the customer came on
supply.
CANCELLED:
Customer has requested cancellation.
CLOSED:
Move in process has been closed, or withdrawn by reason other than customers' contact
DUPLICATE:
A duplicate application.
ACTION_REQUIRED_EMAIL_BOUNCED:
The initial action required email bounced.
ACTION_REQUIRED_INDUSTRY_REJECTION:
The move-in application was rejected by the industry body but the deadline has not
been reached, so this is recoverable.
ACTION_REQUIRED_STILL_UNDER_CONTRACT:
The application's OCCTO status is 契約中に再点申込あり but the user action deadline
has not yet been reached.
REJECTED_VALIDATION_ERROR:
Kraken could not process the record because of a validation error
REJECTED_MOVE_IN_TOO_SOON:
The application was rejected upon processing the customer information
file because the move-in date was less than 3 business days in the future
REJECTED_CANT_SUPPLY:
The move-in application was rejected by TGOE because the type of supply
point is one that TGOE does not supply
REJECTED_TERMS_AND_CONDITIONS_OR_SPIN_NOT_FOUND:
The customer has not yet accepted Ts&Cs or a valid SPIN was not yet provided.
REJECTED_DUPLICATE:
Rejected as application with exact same data was already been made
REJECTED_EMAIL_ASSOCIATED_WITH_ANOTHER_USER:
The provided email is associated with another AccountUser with a different name.
EXPIRED_NO_PAYMENT_DETAILS:
DEPRECATED
The application expired because the customer did not provide payment
details by the deadline
EXPIRED_EMAIL_BOUNCED:
DEPRECATED
The application expired because the customer did not provide payment
details by the deadline after the email bounced
EXPIRED_STILL_UNDER_CONTRACT:
The application's OCCTO status is still 契約中に再点申込あり by the user action
deadline.
Values
ACTION_REQUIRED_EMAIL_BOUNCED
ACTION_REQUIRED_INDUSTRY_REJECTION
ACTION_REQUIRED_STILL_UNDER_CONTRACT
AWAITING_CUSTOMER_DATA_VALIDATION
AWAITING_TERMS_AND_CONDITIONS_OR_SPIN
CANCELLED
CLOSED
COMPLETED_SUCCESSFULLY
DUPLICATE
EXPIRED_EMAIL_BOUNCED
EXPIRED_NO_PAYMENT_DETAILS
EXPIRED_STILL_UNDER_CONTRACT
INDUSTRY_APPLICATION_IN_PROGRESS
REJECTED_CANT_SUPPLY
REJECTED_DUPLICATE
REJECTED_EMAIL_ASSOCIATED_WITH_ANOTHER_USER
REJECTED_MOVE_IN_TOO_SOON
REJECTED_TERMS_AND_CONDITIONS_OR_SPIN_NOT_FOUND
REJECTED_VALIDATION_ERROR
Example
"AWAITING_CUSTOMER_DATA_VALIDATION"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"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"MoveOutProcessStatus
An enumeration.
Values
COMPLETED_AFTER_FAILED_TO_WITHDRAW
DUPLICATE_APPLICATION
FAILED_TO_WITHDRAW
INGESTION_FAILED
MOVE_OUT_CLOSED
MOVE_OUT_COMPLETED
MOVE_OUT_FAILED
MOVE_OUT_PENDING
MOVE_OUT_REQUESTED
MOVE_OUT_WITHDRAWN
READY_TO_APPLY
REPLACED
REQUEST_BUILDER_ERROR
REQUEST_ERROR
WAITING_TO_APPLY
Example
"WAITING_TO_APPLY"NotifiableApplicationService
An enumeration.
Values
APNS
iOS (APNs)
APNS_SANDBOX
iOS Sandbox (APNs Sandbox)
GCM
Android (GCM)
Example
"GCM"Values
BEFORE_END_OF_MONTH
The payment day is calculated backwards from the last day of the month.
OF_MONTH
The payment day is calculated forward.
Example
"OF_MONTH"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
ACCOUNT_CLOSED
The account for this instruction was closed.
ACTIVE
The instruction is active and can be used to take payments.
FAILED
The instruction could not be set up with the vendor.
PROVISIONAL
The instruction has not yet been set up.
Example
"ACTIVE"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"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_TERMS_AND_CONDITIONS
Scope that enables account user to accept the terms and conditions for a product.
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
JOIN_CAMPAIGNS
Scope that enables account user to join campaigns.
JOIN_CAMPAIGN_EVENTS
Scope that enables account user to join campaign events.
MANAGE_ACCOUNT_RENEWALS
Scope that enables account user to generate a renewal quote and renew agreements.
MANAGE_BUSINESS_SECURITY_DEPOSIT
Scope that enables account user to manage security deposit payments for business accounts.
MANAGE_GOODS_PURCHASES
Scope that enables account user to accept goods quotes and process goods purchases.
MANAGE_PRODUCT_SWITCH
Scope that enables account user to do a self-serve product switch through the Dashboard.
REDEEM_LOYALTY_POINTS
Scope that enables account user to redeem loyalty points
REPORT_MOVE_OUT
Scope that enables account user to report a property move-out.
SEND_LOSS_OBJECTION_FOR_CHANGE_OF_SUPPLIER
Scope that enables user to send a loss objection for a change of supplier process.
SET_GOODS_PURCHASE_SALE_ITEM_PRICES
Set Goods Purchase Sale Item Prices
SUBMIT_CUSTOMER_FEEDBACK
Scope that enables account user to submit customer feedback.
SUBMIT_METER_READINGS
Scope that enables account user to submit meter readings.
UPDATE_ACCOUNT_DETAILS
Scope that enables the user to update information about themselves and their account.
UPDATE_BLACKHOLE_EMAIL
Scope that enables account user to update their blackhole email address.
UPDATE_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.
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"ReadingDirectionType
An enumeration.
Values
CONSUMPTION
Reading is based on the customer's usage of the utility.
GENERATION
Reading is based on the utility generated by the customer.
For example: This will return solar readings if a customer has solar panels installed at their location.
Example
"CONSUMPTION"ReadingFrequencyType
An enumeration.
Values
DAILY
Readings taken on a day to day basis.
DAY_INTERVAL
FIFTEEN_MIN_INTERVAL
Readings taken in every 15 minute intervals.
FIVE_MIN_INTERVAL
Readings taken in every 5 minute intervals.
HOUR_INTERVAL
MONTH_INTERVAL
POINT_IN_TIME
Readings taken at a point in time.
QUARTER_INTERVAL
RAW_INTERVAL
Interval Readings as provided, may be variable in length.
THIRTY_MIN_INTERVAL
Readings taken in every 30 minute intervals.
WEEK_INTERVAL
Example
"RAW_INTERVAL"ReadingStatisticTypeEnum
The type of statistic for the reading interval.
Values
CARBON_COST
The estimated carbon cost of the interval.
CONSUMPTION_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
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"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"RequestStatus
Status to update this request to.
Values
APPOINTMENT_FAILED
BOOKED
CANCELLED
COMPLETED
HELD
IN_PROGRESS
PENDING
Example
"APPOINTMENT_FAILED"SalesChannelChoices
An enumeration.
Values
ACQUISITION
AGGREGATOR
B2B
B2B2C
DIRECT
EVENTS
FIELD_SALES
INTERMEDIARY
LIFELINE_AGENCY
NEW_TENANT
PARTNERSHIPS
PRICE_COMPARISON
PV_BATTERY
TELE_SALES
Example
"DIRECT"ScheduleType
An enumeration.
Values
BACS_TRANSFER
CARD_PAYMENT
DIRECT_DEBIT
PAYMENT_SLIP
Example
"BACS_TRANSFER"SelfServiceAction
An enumeration.
Values
CONTRACT_NUMBER_CORRECTION
CUSTOMER_NAME_CORRECTION
RETAILER_CORRECTION
Example
"CUSTOMER_NAME_CORRECTION"StatementReversalsAfterClose
An enumeration.
Values
ALL
All charges have been reversed after the statement was closed.
NONE
No reversals after the statement was closed.
NOT_CLOSED
The statement has not been closed yet.
SOME
Some charges have been reversed after the statement was closed.
Example
"ALL"SupplyEndScheduledTime
Time slot requested by the customer for on-site attendance.
Values
AM
PM_1_3
PM_3_5
PM_5_7
Example
"AM"SupplyPointStatus
An enumeration.
Values
LOST
MOVE_IN_PENDING
MOVE_OUT_MOVE_IN_PENDING
MOVE_OUT_PENDING
OFF_SUPPLY
ON_SUPPLY
REGISTRATION_REJECTED
SWITCH_IN_PENDING
SWITCH_OUT_PENDING
Example
"ON_SUPPLY"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"TimeOptions
Time slot requested by the customer for demolition.
Values
AM
NOT_SPECIFIED
PM
_0900
_1000
_1100
_1200
_1300
_1400
_1500
_1600
_1700
Example
"_0900"TransactionTypeFilter
Transaction types which will be included or excluded, depending on the input argument.
Values
ENERGY_CHARGES
For filtering/excluding energy charge transactions: Gas or Electricity.
IMPORTED_CHARGES
For filtering/excluding imported charge transactions.
IMPORTED_CREDITS
For filtering/excluding imported credit transactions.
IMPORTED_PAYMENTS
For filtering/excluding imported payment transactions.
IMPORTED_REPAYMENTS
For filtering/excluding imported repayment transactions.
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"UnitType
An enumeration.
Values
CHARGES_INCURRED
CUBIC_METRES_CONSUMPTION
CURRENCY_YEAR
DAYS_ON_SUPPLY
KL_CONSUMPTION
KVARH_CONSUMPTION
KVA_CAPACITY_DAYS
KVA_CAPACITY_MONTHS
KVA_DEMAND_DAYS
KVA_DEMAND_MONTHS
KWH_CONSUMPTION
KW_CAPACITY_MONTHS
KW_DEMAND
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"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
COMMBANK
DUMMY
GMO
GMO_CARD
GOCARDLESS
GOCARDLESS_AFFECT
GOCARDLESS_BULB
GOCARDLESS_GEN4U
GOCARDLESS_IRESA
PAGOPA
SMARTDEBIT
STRIPE
STRIPE_CONNECT
STRIPE_CONNECT_VOICE
STRIPE_KONBINI
STRIPE_VOICE
TESORO
TESORO_SEPA_CORE
TG_PAYMENTS
TG_PAYMENTS_MYPAY
WESTPAC
WORLDPAY
Example
"GOCARDLESS"VerificationRequestStatus
The status of verification for associated email.
Values
COMPLETED
NOT_SENT
PENDING
Example
"NOT_SENT"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"