Unions

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.

  • API Site

    • Example

    EmailEventType

    ActionType

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

    Example

    DeeplinkActionType

    BackendScreenType

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

    Example

    ComponentListType

    CardItemType

    Items are sections making up a card.

    Example

    TextType

    Example

    StringCharacteristicValueType

    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

    AccountType

    Example

    {
  "consumptions": [ElectricityConsumptionByCategory],
  "endDate": "2000-02-24",
  "startDate": "2023-08-18",
  "total": "1.0"
}

    Example

    ProductTariffInformationLabelStandard

    Example

    StandardTariff

    Example

    StandardTariff

    Example

    JoinSupplierProcessType

    Example

    SerializerErrorType

    Possible types

    Example

    InkNewMessage

    Example

    InkEmail

    Example

    FractionSizeType

    ItemType

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

    Example

    TextType

    LegacyOrderCustomerType

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

    Possible types

    Example

    AccountType

    LegacyOrderLinePeriodType

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

    Example

    LegacyOrderLineDateRangeType

    Example

    LineTextMessage

    Example

    LineLinkRedirectResponse

    Example

    ElectricityMeterPointType

    PaymentPreferenceUnion

    One of PreferredInstructionType or UserManagedPaymentType

    Example

    PreferredInstruction

    Example

    DecimalType

    SalesRecordType

    A union type representing different kinds of sales records.

    Example

    KrakenDrivenSalesInfoType

    Example

    CardComponentType

    Example

    ADCSensorConfiguration

    Example

    SmartFlexChargingError

    Example

    SpecialCircumstanceRecordType

    Example

    TariffInformationLabelStandard

    Example

    LineUnlinkedResponse

    Example

    ElectricityFiltersOutput

    Example

    OctoplusVoucherType

    In this section