au.org.consumerdatastandards.holder.model.energy

Class EnergyBillingUsageTransaction

java.lang.Object

au.org.consumerdatastandards.holder.model.energy.EnergyBillingUsageTransaction

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2022-01-11T14:03:27.755+11:00[Australia/Sydney]")
public class EnergyBillingUsageTransaction
extends Object

EnergyBillingUsageTransaction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnergyBillingUsageTransaction.MeasureUnitEnum The measurement unit of rate.
static class	EnergyBillingUsageTransaction.TimeOfUseTypeEnum The time of use type that the transaction applies to

Constructor Summary

Constructors

Constructor and Description
EnergyBillingUsageTransaction()

Method Summary

Modifier and Type	Method and Description
EnergyBillingUsageTransaction	addAdjustmentsItem(EnergyBillingUsageTransactionAdjustments adjustmentsItem)
EnergyBillingUsageTransaction	addCalculationFactorsItem(EnergyBillingUsageTransactionCalculationFactors calculationFactorsItem)
EnergyBillingUsageTransaction	adjustments(List<EnergyBillingUsageTransactionAdjustments> adjustments)
EnergyBillingUsageTransaction	amount(String amount)
EnergyBillingUsageTransaction	calculationFactors(List<EnergyBillingUsageTransactionCalculationFactors> calculationFactors)
EnergyBillingUsageTransaction	description(String description)
EnergyBillingUsageTransaction	endDate(String endDate)
boolean	equals(Object o)
@Valid List<EnergyBillingUsageTransactionAdjustments>	getAdjustments() Optional array of adjustments arising for this transaction
@NotNull String	getAmount() The amount charged or credited for this transaction prior to any adjustments being applied.
@Valid List<EnergyBillingUsageTransactionCalculationFactors>	getCalculationFactors() Additional calculation factors that inform the transaction
String	getDescription() Optional description of the transaction that can be used for display purposes
@NotNull String	getEndDate() Date and time when the usage period ends
String	getInvoiceNumber() The number of the invoice in which this transaction is included if it has been issued
Boolean	getIsEstimate() Flag indicating if the usage is estimated or actual.
EnergyBillingUsageTransaction.MeasureUnitEnum	getMeasureUnit() The measurement unit of rate.
String	getServicePointId() The ID of the service point to which this transaction applies if any
@NotNull String	getStartDate() Date and time when the usage period starts
@NotNull EnergyBillingUsageTransaction.TimeOfUseTypeEnum	getTimeOfUseType() The time of use type that the transaction applies to
@NotNull @Valid BigDecimal	getUsage() The usage for the period in measure unit.
int	hashCode()
EnergyBillingUsageTransaction	invoiceNumber(String invoiceNumber)
EnergyBillingUsageTransaction	isEstimate(Boolean isEstimate)
EnergyBillingUsageTransaction	measureUnit(EnergyBillingUsageTransaction.MeasureUnitEnum measureUnit)
EnergyBillingUsageTransaction	servicePointId(String servicePointId)
void	setAdjustments(List<EnergyBillingUsageTransactionAdjustments> adjustments)
void	setAmount(String amount)
void	setCalculationFactors(List<EnergyBillingUsageTransactionCalculationFactors> calculationFactors)
void	setDescription(String description)
void	setEndDate(String endDate)
void	setInvoiceNumber(String invoiceNumber)
void	setIsEstimate(Boolean isEstimate)
void	setMeasureUnit(EnergyBillingUsageTransaction.MeasureUnitEnum measureUnit)
void	setServicePointId(String servicePointId)
void	setStartDate(String startDate)
void	setTimeOfUseType(EnergyBillingUsageTransaction.TimeOfUseTypeEnum timeOfUseType)
void	setUsage(BigDecimal usage)
EnergyBillingUsageTransaction	startDate(String startDate)
EnergyBillingUsageTransaction	timeOfUseType(EnergyBillingUsageTransaction.TimeOfUseTypeEnum timeOfUseType)
String	toString()
EnergyBillingUsageTransaction	usage(BigDecimal usage)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnergyBillingUsageTransaction

public EnergyBillingUsageTransaction()

Method Detail

servicePointId

public EnergyBillingUsageTransaction servicePointId(String servicePointId)

getServicePointId

public String getServicePointId()

The ID of the service point to which this transaction applies if any

Returns:

servicePointId

setServicePointId

public void setServicePointId(String servicePointId)

invoiceNumber

public EnergyBillingUsageTransaction invoiceNumber(String invoiceNumber)

getInvoiceNumber

public String getInvoiceNumber()

The number of the invoice in which this transaction is included if it has been issued

Returns:

invoiceNumber

setInvoiceNumber

public void setInvoiceNumber(String invoiceNumber)

timeOfUseType

public EnergyBillingUsageTransaction timeOfUseType(EnergyBillingUsageTransaction.TimeOfUseTypeEnum timeOfUseType)

getTimeOfUseType

@NotNull
public @NotNull EnergyBillingUsageTransaction.TimeOfUseTypeEnum getTimeOfUseType()

The time of use type that the transaction applies to

Returns:

timeOfUseType

setTimeOfUseType

public void setTimeOfUseType(EnergyBillingUsageTransaction.TimeOfUseTypeEnum timeOfUseType)

description

public EnergyBillingUsageTransaction description(String description)

getDescription

public String getDescription()

Optional description of the transaction that can be used for display purposes

Returns:

description

setDescription

public void setDescription(String description)

isEstimate

public EnergyBillingUsageTransaction isEstimate(Boolean isEstimate)

getIsEstimate

public Boolean getIsEstimate()

Flag indicating if the usage is estimated or actual. True indicates estimate. False or absent indicates actual

Returns:

isEstimate

setIsEstimate

public void setIsEstimate(Boolean isEstimate)

startDate

public EnergyBillingUsageTransaction startDate(String startDate)

getStartDate

@NotNull
public @NotNull String getStartDate()

Date and time when the usage period starts

Returns:

startDate

setStartDate

public void setStartDate(String startDate)

endDate

public EnergyBillingUsageTransaction endDate(String endDate)

getEndDate

@NotNull
public @NotNull String getEndDate()

Date and time when the usage period ends

Returns:

endDate

setEndDate

public void setEndDate(String endDate)

measureUnit

public EnergyBillingUsageTransaction measureUnit(EnergyBillingUsageTransaction.MeasureUnitEnum measureUnit)

getMeasureUnit

public EnergyBillingUsageTransaction.MeasureUnitEnum getMeasureUnit()

The measurement unit of rate. Assumed to be KWH if absent

Returns:

measureUnit

setMeasureUnit

public void setMeasureUnit(EnergyBillingUsageTransaction.MeasureUnitEnum measureUnit)

usage

public EnergyBillingUsageTransaction usage(BigDecimal usage)

getUsage

@NotNull
 @Valid
public @NotNull @Valid BigDecimal getUsage()

The usage for the period in measure unit. A negative value indicates power generated

Returns:

usage

setUsage

public void setUsage(BigDecimal usage)

amount

public EnergyBillingUsageTransaction amount(String amount)

getAmount

@NotNull
public @NotNull String getAmount()

The amount charged or credited for this transaction prior to any adjustments being applied. A negative value indicates a credit

Returns:

amount

setAmount

public void setAmount(String amount)

calculationFactors

public EnergyBillingUsageTransaction calculationFactors(List<EnergyBillingUsageTransactionCalculationFactors> calculationFactors)

addCalculationFactorsItem

public EnergyBillingUsageTransaction addCalculationFactorsItem(EnergyBillingUsageTransactionCalculationFactors calculationFactorsItem)

getCalculationFactors

@Valid
public @Valid List<EnergyBillingUsageTransactionCalculationFactors> getCalculationFactors()

Additional calculation factors that inform the transaction

Returns:

calculationFactors

setCalculationFactors

public void setCalculationFactors(List<EnergyBillingUsageTransactionCalculationFactors> calculationFactors)

adjustments

public EnergyBillingUsageTransaction adjustments(List<EnergyBillingUsageTransactionAdjustments> adjustments)

addAdjustmentsItem

public EnergyBillingUsageTransaction addAdjustmentsItem(EnergyBillingUsageTransactionAdjustments adjustmentsItem)

getAdjustments

@Valid
public @Valid List<EnergyBillingUsageTransactionAdjustments> getAdjustments()

Optional array of adjustments arising for this transaction

Returns:

adjustments

setAdjustments

public void setAdjustments(List<EnergyBillingUsageTransactionAdjustments> adjustments)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object