| Interface | Description |
|---|---|
| EnergyAccountBase | |
| EnergyAccountBaseV2 | |
| EnergyAccountDetailBase | |
| EnergyPlan | |
| EnergyPlanDetail |
| Class | Description |
|---|---|
| EnergyAccountDetailAuthorisedContacts |
EnergyAccountDetailAllOfAuthorisedContacts
|
| EnergyAccountDetailPlanDetail |
Detail on the plan applicable to this account
|
| EnergyAccountDetailPlans |
EnergyAccountDetailAllOfPlans
|
| EnergyAccountDetailResponse |
EnergyAccountDetailResponse
|
| EnergyAccountDetailV1 |
EnergyAccountDetailV1
|
| EnergyAccountDetailV2 |
EnergyAccountDetailV2
|
| EnergyAccountListResponse |
EnergyAccountListResponse
|
| EnergyAccountListResponseData |
EnergyAccountListResponseData
|
| EnergyAccountPlanOverview |
EnergyAccountAllOfPlanOverview
|
| EnergyAccountPlans |
EnergyAccountAllOfPlans
|
| EnergyAccountV1 |
EnergyAccount
|
| EnergyAccountV2 |
EnergyAccountV2
|
| EnergyBalanceListResponse |
EnergyBalanceListResponse
|
| EnergyBalanceListResponseData |
EnergyBalanceListResponseData
|
| EnergyBalanceListResponseDataBalances |
EnergyBalanceListResponseDataBalances
|
| EnergyBalanceResponse |
EnergyBalanceResponse
|
| EnergyBalanceResponseData |
EnergyBalanceResponseData
|
| EnergyBillingDemandTransaction |
EnergyBillingDemandTransaction
|
| EnergyBillingListResponse |
EnergyBillingListResponse
|
| EnergyBillingListResponseData |
EnergyBillingListResponseData
|
| EnergyBillingOnceOffTransaction |
EnergyBillingOnceOffTransaction
|
| EnergyBillingOtherTransaction |
EnergyBillingOtherTransaction
|
| EnergyBillingPaymentTransaction |
EnergyBillingPaymentTransaction
|
| EnergyBillingTransaction |
EnergyBillingTransaction
|
| EnergyBillingUsageTransaction |
EnergyBillingUsageTransaction
|
| EnergyBillingUsageTransactionAdjustments |
EnergyBillingUsageTransactionAdjustments
|
| EnergyBillingUsageTransactionCalculationFactors |
EnergyBillingUsageTransactionCalculationFactors
|
| EnergyConcession |
EnergyConcession
|
| EnergyConcessionsResponse |
EnergyConcessionsResponse
|
| EnergyConcessionsResponseData |
EnergyConcessionsResponseData
|
| EnergyDerDetailResponse |
EnergyDerDetailResponse
|
| EnergyDerListResponse |
EnergyDerListResponse
|
| EnergyDerListResponseData |
EnergyDerListResponseData
|
| EnergyDerRecord |
EnergyDerRecord
|
| EnergyDerRecordAcConnections |
EnergyDerRecordAcConnections
|
| EnergyDerRecordDerDevices |
EnergyDerRecordDerDevices
|
| EnergyDerRecordProtectionMode |
Required only when the hasCentralProtectionAndControl flag is set to true.
|
| EnergyInvoice |
EnergyInvoice
|
| EnergyInvoiceAccountCharges |
Object contains account level charges and credits related to electricity usage
|
| EnergyInvoiceElectricityUsageCharges |
EnergyInvoiceElectricityUsageCharges
|
| EnergyInvoiceGasUsageCharges |
EnergyInvoiceGasUsageCharges
|
| EnergyInvoiceGasUsageChargesOtherCharges |
EnergyInvoiceGasUsageChargesOtherCharges
|
| EnergyInvoiceListResponse |
EnergyInvoiceListResponse
|
| EnergyInvoiceListResponseData |
EnergyInvoiceListResponseData
|
| EnergyInvoicePayOnTimeDiscount |
A discount for on time payment
|
| EnergyInvoicePeriod |
Object containing the start and end date for the period covered by the invoice.
|
| EnergyPaymentSchedule |
EnergyPaymentSchedule
|
| EnergyPaymentScheduleCardDebit |
Represents a regular credit card payment schedule.
|
| EnergyPaymentScheduleDigitalWallet |
Represents a regular payment from a digital wallet.
|
| EnergyPaymentScheduleDirectDebit |
Represents a regular direct debit from a specified bank account.
|
| EnergyPaymentScheduleManualPayment |
Represents a manual payment schedule where the customer pays in response to a delivered statement.
|
| EnergyPaymentScheduleResponse |
EnergyPaymentScheduleResponse
|
| EnergyPaymentScheduleResponseData | |
| EnergyPlanAdditionalInformation |
Object that contains links to additional information on specific topics
|
| EnergyPlanContract |
EnergyPlanContract
|
| EnergyPlanContractDemandCharges |
EnergyPlanContractDemandCharges
|
| EnergyPlanContractDiscounts |
EnergyPlanContractDiscounts
|
| EnergyPlanContractEligibility |
EnergyPlanContractEligibility
|
| EnergyPlanContractFees |
EnergyPlanContractFees
|
| EnergyPlanContractFixedAmount |
Required if methodUType is fixedAmount
|
| EnergyPlanContractFull |
EnergyPlanContractFull
|
| EnergyPlanContractGreenPowerCharges |
EnergyPlanContractGreenPowerCharges
|
| EnergyPlanContractIncentives |
EnergyPlanContractIncentives
|
| EnergyPlanContractIntrinsicGreenPower |
Describes intrinsic green power for the plan.
|
| EnergyPlanContractPercentOfBill |
Required if methodUType is percentOfBill
|
| EnergyPlanContractPercentOfUse |
Required if methodUType is percentOfUse
|
| EnergyPlanContractPercentOverThreshold |
Required if methodUType is percentOverThreshold
|
| EnergyPlanContractSingleRate |
Object representing a single rate.
|
| EnergyPlanContractSingleRateRates |
EnergyPlanContractSingleRateRates
|
| EnergyPlanContractSingleTariff |
Represents a constant tariff.
|
| EnergyPlanContractSolarFeedInTariff |
EnergyPlanContractSolarFeedInTariff
|
| EnergyPlanContractTariffPeriod |
EnergyPlanContractTariffPeriod
|
| EnergyPlanContractTiers |
EnergyPlanContractTiers
|
| EnergyPlanContractTimeOfUseRates |
EnergyPlanContractTimeOfUseRates
|
| EnergyPlanContractTimeVaryingTariffs |
Represents a tariff based on time.
|
| EnergyPlanContractTimeVaryingTariffsTimeVariations |
EnergyPlanContractTimeVaryingTariffsTimeVariations
|
| EnergyPlanControlledLoad |
Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD
|
| EnergyPlanControlledLoadSingleRate |
EnergyPlanContractTimeOfUseRates
|
| EnergyPlanControlledLoadTimeOfUse |
EnergyTimeOfUse
|
| EnergyPlanControlledLoadTimeOfUseRates |
EnergyPlanControlledLoadTimeOfUseRates
|
| EnergyPlanDetailEntity |
EnergyPlanDetail
|
| EnergyPlanEntity | |
| EnergyPlanGeography |
Describes the geographical area that the plan is available for.
|
| EnergyPlanListResponse |
EnergyPlanListResponse
|
| EnergyPlanListResponseData |
EnergyPlanListResponseData
|
| EnergyPlanResponse |
EnergyPlanResponse
|
| EnergyRates |
EnergyRates
|
| EnergyServicePoint |
EnergyServicePoint
|
| EnergyServicePointConsumerProfile |
EnergyServicePointConsumerProfile
|
| EnergyServicePointDetail |
EnergyServicePointDetail
|
| EnergyServicePointDetailDistributionLossFactor |
EnergyServicePointDetailDistributionLossFactor
|
| EnergyServicePointDetailMeters |
EnergyServicePointDetailMeters
|
| EnergyServicePointDetailRegisters |
Usage data registers available from the meter
|
| EnergyServicePointDetailRelatedParticipants |
EnergyServicePointDetailRelatedParticipants
|
| EnergyServicePointDetailResponse |
EnergyServicePointDetailResponse
|
| EnergyServicePointDetailSpecifications |
Technical characteristics of the meter
|
| EnergyServicePointListResponse |
EnergyServicePointListResponse
|
| EnergyServicePointListResponseData |
EnergyServicePointListResponseData
|
| EnergyTimeOfUse |
EnergyTimeOfUse
|
| EnergyUsageListResponse |
EnergyUsageListResponse
|
| EnergyUsageListResponseData |
EnergyUsageListResponseData
|
| EnergyUsageRead |
EnergyUsageRead
|
| EnergyUsageReadBasicRead |
Mandatory if readUType is set to basicRead
|
| EnergyUsageReadIntervalRead |
Mandatory if readUType is set to intervalRead
|
| EnergyUsageReadIntervalReadReadQualities |
Specifies quality of reads that are not ACTUAL.
|
| MeteringCharges |
EnergyPlanDetailAllOfMeteringCharges
|
| RequestAccountIds | |
| RequestAccountIdsData | |
| RequestServicePointIds | |
| RequestServicePointIdsData |
| Enum | Description |
|---|---|
| EnergyAccountBaseV2.OpenStatus | |
| EnergyAccountDetailPlanDetail.FuelTypeEnum |
The fuel types covered by the plan
|
| EnergyBillingDemandTransaction.TimeOfUseTypeEnum |
The time of use type that the transaction applies to
|
| EnergyBillingOtherTransaction.TypeEnum |
Type of charge.
|
| EnergyBillingPaymentTransaction.MethodEnum |
The method of payment
|
| EnergyBillingTransaction.TransactionUTypeEnum |
Indicator of the type of transaction object present in this record
|
| EnergyBillingUsageTransaction.MeasureUnitEnum |
The measurement unit of rate.
|
| EnergyBillingUsageTransaction.TimeOfUseTypeEnum |
The time of use type that the transaction applies to
|
| EnergyBillingUsageTransactionCalculationFactors.TypeEnum |
The type of the calculation factor
|
| EnergyConcession.Type | |
| EnergyDerRecordAcConnections.EquipmentTypeEnum |
Indicates whether the DER device is connected via an inverter (and what category of inverter it is) or not (e.g.
|
| EnergyDerRecordAcConnections.StatusEnum |
Code used to indicate the status of the Inverter.
|
| EnergyDerRecordDerDevices.StatusEnum |
Code used to indicate the status of the device.
|
| EnergyDerRecordDerDevices.TypeEnum |
Used to indicate the primary technology used in the DER device
|
| EnergyInvoice.PaymentStatusEnum |
Indicator of the payment status for the invoice
|
| EnergyInvoiceGasUsageChargesOtherCharges.TypeEnum |
Type of charge.
|
| EnergyPaymentSchedule.PaymentScheduleUTypeEnum |
The type of object present in this response
|
| EnergyPaymentScheduleCardDebit.CalculationTypeEnum |
The mechanism by which the payment amount is calculated.
|
| EnergyPaymentScheduleCardDebit.CardSchemeEnum |
The type of credit card held on file
|
| EnergyPaymentScheduleDigitalWallet.IdentifierTypeEnum | |
| EnergyPaymentScheduleDigitalWallet.ProviderEnum | |
| EnergyPaymentScheduleDirectDebit.CalculationTypeEnum |
The mechanism by which the payment amount is calculated.
|
| EnergyPlan.CustomerTypeEnum |
The type of customer that the plan is offered to.
|
| EnergyPlan.FuelTypeEnum |
The fuel types covered by the plan
|
| EnergyPlan.TypeEnum |
The type of the plan
|
| EnergyPlanContract.PaymentOptionEnum |
Gets or Sets paymentOption
|
| EnergyPlanContract.PricingModelEnum |
The pricing model for the contract.
|
| EnergyPlanContract.TimeZoneEnum |
Required if pricingModel is set to TIME_OF_USE.
|
| EnergyPlanContractDemandCharges.ChargePeriodEnum |
Charge period for the demand tariff
|
| EnergyPlanContractDemandCharges.DaysEnum |
Gets or Sets days
|
| EnergyPlanContractDemandCharges.MeasurementPeriodEnum |
Application period for the demand tariff
|
| EnergyPlanContractDemandCharges.MeasureUnitEnum |
The measurement unit of charge amount.
|
| EnergyPlanContractDiscounts.CategoryEnum |
The type of the discount.
|
| EnergyPlanContractDiscounts.MethodUTypeEnum |
The method of calculation of the discount
|
| EnergyPlanContractDiscounts.TypeEnum |
The type of the discount
|
| EnergyPlanContractEligibility.TypeEnum |
The type of the eligibility restriction.
The CONTINGENT_PLAN value indicates that the plan is contingent on the customer taking up an alternate fuel plan from the same retailer (for instance, if the fuelType is ELECTRICITY then a GAS plan from the same retailer must be taken up) |
| EnergyPlanContractFees.TermEnum |
The term of the fee
|
| EnergyPlanContractFees.TypeEnum |
The type of the fee
|
| EnergyPlanContractFull.PaymentOptionEnum |
Gets or Sets paymentOption
|
| EnergyPlanContractFull.PricingModelEnum |
The pricing model for the contract.
|
| EnergyPlanContractFull.TermTypeEnum |
The term for the contract.
|
| EnergyPlanContractFull.TimeZoneEnum |
Required if pricingModel is set to TIME_OF_USE.
|
| EnergyPlanContractGreenPowerCharges.SchemeEnum |
The applicable green power scheme
|
| EnergyPlanContractGreenPowerCharges.TypeEnum |
The type of charge
|
| EnergyPlanContractIncentives.CategoryEnum |
The type of the incentive
|
| EnergyPlanContractSingleRateRates.MeasureUnitEnum |
The measurement unit of rate.
|
| EnergyPlanContractSolarFeedInTariff.PayerTypeEnum |
The type of the payer
|
| EnergyPlanContractSolarFeedInTariff.SchemeEnum |
The applicable scheme
|
| EnergyPlanContractSolarFeedInTariff.TariffUTypeEnum |
The type of the payer
|
| EnergyPlanContractTariffPeriod.RateBlockUTypeEnum |
Specifies the type of rate applicable to this tariff period
|
| EnergyPlanContractTariffPeriod.TimeZone |
Specifies the charge specific time zone for calculation of the time of use thresholds.
|
| EnergyPlanContractTariffPeriod.TypeEnum |
Type of charge.
|
| EnergyPlanContractTimeOfUseRates.TypeEnum |
The type of usage that the rate applies to
|
| EnergyPlanContractTimeVaryingTariffs.TypeEnum |
The type of the charging time period.
|
| EnergyPlanContractTimeVaryingTariffsTimeVariations.DaysEnum | |
| EnergyPlanControlledLoad.RateBlockUTypeEnum | |
| EnergyPlanControlledLoadTimeOfUse.DaysEnum |
Gets or Sets days
|
| EnergyPlanControlledLoadTimeOfUseRates.TypeEnum |
The type of usage that the rate applies to
|
| EnergyRates.MeasureUnitEnum |
The measurement unit of rate.
|
| EnergyServicePoint.JurisdictionCodeEnum |
Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point.
|
| EnergyServicePoint.ServicePointClassificationEnum |
The classification of the service point as defined in MSATS procedures
|
| EnergyServicePoint.ServicePointStatusEnum |
Code used to indicate the status of the service point.
|
| EnergyServicePointConsumerProfile.ClassificationEnum |
A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments
|
| EnergyServicePointConsumerProfile.ThresholdEnum |
A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments.
|
| EnergyServicePointDetail.JurisdictionCodeEnum |
Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point.
|
| EnergyServicePointDetail.ServicePointClassificationEnum |
The classification of the service point as defined in MSATS procedures
|
| EnergyServicePointDetail.ServicePointStatusEnum |
Code used to indicate the status of the service point.
|
| EnergyServicePointDetailRegisters.ConsumptionTypeEnum |
Actual/Subtractive Indicator.
|
| EnergyServicePointDetailRegisters.RegisterConsumptionTypeEnum |
Indicates the consumption type of register
|
| EnergyServicePointDetailRegisters.TimeOfDayEnum |
Code to identify the time validity of register contents
|
| EnergyServicePointDetailRelatedParticipants.RoleEnum |
The role performed by this participant in relation to the service point.
|
| EnergyServicePointDetailSpecifications.InstallationTypeEnum |
The metering Installation type code indicates whether the metering installation has to be manually read.
|
| EnergyServicePointDetailSpecifications.StatusEnum |
A code to denote the status of the meter.
|
| EnergyTimeOfUse.DaysEnum |
Gets or Sets days
|
| EnergyUsageRead.ReadUTypeEnum |
Specify the type of the meter read data
|
| EnergyUsageReadBasicRead.QualityEnum |
The quality of the read taken.
|
| EnergyUsageReadIntervalReadReadQualities.QualityEnum | |
| ParamAccountOpenStatus |
Used to filter results according to open/closed status.
|
| ParamEffective | |
| ParamFuelTypeEnum |
The type of the plan
|
| ParamIntervalReadsEnum |
ParamIntervalReadsEnum
|
| ParamTypeEnum |
The type of the plan
|
Copyright © 2023. All rights reserved.