Unions

Unions are abstract types that can be used to return one of a number of different objects. They are useful for defining a common set of fields that objects can implement.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

EmailEventType

ActionType

Actions are things to do upon a user interaction, such as tapping a button.

Example

BackendScreenEventActionType

BackendScreenType

A backend screen is the top-level container for mobile UI.

Example

ComponentListType

CardItemType

Items are sections making up a card.

Example

AnimationType

Example

IntegerCharacteristicValueType

ChargeDetail

Supporting information about a charge

Possible types

Example

SupplyOrServiceCharge

ContractParty

Union type representing the subject that entered into a contract, either an Account or Business.

Possible types

Example

Account

CreateBankTransferPaymentMethodResponse

Returned when a customer creates a bank transfer payment method from their MyPage.

Example

BankTransferPaymentMethodCreated

CreateKonbiniPaymentMethodResponse

Returned when a customer creates a Konbini Payment method from their MyPage.

Example

CommonError

CreateKonbiniPaymentResponse

Returned when a customer creates a Konbini Payment from their MyPage.

Example

CommonError

CreatePaymentScheduleResponse

Returned when a customer creates a fixed payment schedule from their MyPage.

Example

CommonError

Example

CommonError

Example

JoinSupplierProcessType

Example

SerializerErrorType

InitiateAmperageChangeResponse

Returned when a customer initiates an Amperage Change from their MyPage.

Possible types

Example

AmperageChangeInitiated

Possible types

Example

CommonError

InitiateMoveOutAndMoveInResponse

Returned when a customer initiates a Move Out and MoveIn from their MyPage.

Example

CommonError

InitiateMoveOutResponse

Returned when a customer initiates a Move Out from their MyPage.

Example

CommonError

Possible types

Example

InkNewMessage

Example

InkEmail

Possible types

Example

Integration

Example

FractionSizeType

ItemType

Items are sections making up a screen. They can be different types, hence Union.

Example

AnimationType

LegacyOrderCustomerType

Union type representing a customer, either an account or a business.

Possible types

Example

Account

LegacyOrderLinePeriodType

Union type representing either a date range or a duration for an order line period.

Example

LegacyOrderLineDateRangeType

Example

LineImageMessage

Example

AlreadyLinkedError

PaymentPreferenceUnion

One of PreferredInstructionType or UserManagedPaymentType

Example

PreferredInstruction

Example

ElectricityFitProduct

Example

DecimalType

QuotedSupplyPoint

DEPRECATED - A single quoted supply point for a customers quote request.

Example

QuotedElectricityGenerationPoint

RegisterDemandResponseCampaignParticipantResponse

Returned when a customer registers for a Demand Response campaign.

Example

CommonError

SalesRecordType

A union type representing different kinds of sales records.

Example

ExternalSalesInfoType

Example

CardComponentType

Example

SmartFlexChargingError

Example

SpecialCircumstanceRecordType

StoreRefundBankAccountResponse

Returned when a customer stores a refund bank account from their MyPage.

Example

CommonError

SuggestFixedPaymentAmountResponse

Returned when a customer creates a fixed payment schedule from their MyPage.

Example

CommonError

SwitchInCorrectionResponse

Returned when a customer self-services a correction of switch-in data.

Example

SwitchInCorrectionPerformed

SwitchToProductWithFixedFuelCostAdjustmentResponse

Returned when a customer switches to the fixed FCA product on the consumer site.

Example

CommonError

Example

LineCommonError

Example

CommonError

Example

ElectricityFiltersOutput

In this section