About 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.
ActionType
Actions are things to do upon a user interaction, such as tapping a button.
Possible types
Example
DeeplinkActionTypeBackendScreenType
A backend screen is the top-level container for mobile UI.
Possible types
Example
ComponentListTypePossible types
Example
StringCharacteristicValueTypeContractParty
Union type representing the subject that entered into a contract, either an Account or Business.
Possible types
Example
AccountTypePossible types
Example
AllDayAnnualConsumptionTypeEnergyConsumptionForecastType
Energy consumption forecast.
Possible types
Example
ElectricityConsumptionForecastTypePossible types
Example
ElectricityConsumptionRateTypePossible types
Example
ElectricityStandingRateTypePossible types
Example
JoinSupplierProcessTypePossible types
Example
SerializerErrorTypePossible types
Example
InkEmailItemType
Items are sections making up a screen. They can be different types, hence Union.
Possible types
Example
TextTypePossible types
Example
LineTextMessagePossible types
Example
LineLinkRedirectResponseOrderCustomerType
Union type representing a customer, either an account or a business.
Possible types
Example
AccountTypeOrderLinePeriodType
Union type representing either a date range or a duration for an order line period.
Possible types
Example
OrderLineDateRangeTypePaymentPreferenceUnion
One of PreferredInstructionType or UserManagedPaymentType
Possible types
Example
PreferredInstructionPossible types
Example
DecimalTypeSalesRecordType
A union type representing different kinds of sales records.
Example
KrakenDrivenSalesInfoTypePossible types
Example
SmartFlexChargingErrorExample
SpecialCircumstanceRecordTypePossible types
Example
DistributorTemporalClassTypePossible types
Example
LineUnlinkedResponsePossible types
Example
ElectricityFiltersOutput