au.org.consumerdatastandards.holder.model.energy

Class EnergyInvoice

java.lang.Object

au.org.consumerdatastandards.holder.model.energy.EnergyInvoice

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

EnergyInvoice

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnergyInvoice.PaymentStatusEnum Indicator of the payment status for the invoice

Constructor Summary

Constructors

Constructor and Description
EnergyInvoice()

Method Summary

Modifier and Type	Method and Description
EnergyInvoice	accountCharges(EnergyInvoiceAccountCharges accountCharges)
EnergyInvoice	accountId(String accountId)
EnergyInvoice	addServicePointsItem(String servicePointsItem)
EnergyInvoice	balanceAtIssue(String balanceAtIssue)
EnergyInvoice	dueDate(String dueDate)
EnergyInvoice	electricity(EnergyInvoiceElectricityUsageCharges electricity)
boolean	equals(Object o)
EnergyInvoice	gas(EnergyInvoiceGasUsageCharges gas)
@Valid EnergyInvoiceAccountCharges	getAccountCharges() Get accountCharges
@NotNull String	getAccountId() The ID of the account for which the invoice was issued
@NotNull String	getBalanceAtIssue() The account balance at the time the invoice was issued
String	getDueDate() The date that the invoice is due to be paid
@Valid EnergyInvoiceElectricityUsageCharges	getElectricity() Get electricity
@Valid EnergyInvoiceGasUsageCharges	getGas() Get gas
String	getGstAmount() The total GST amount for this invoice.
String	getInvoiceAmount() The net amount due for this invoice regardless of previous balance
@NotNull String	getInvoiceNumber() The number assigned to this invoice by the energy Retailer
@NotNull String	getIssueDate() The date that the invoice was actually issued (as opposed to generated or calculated)
@NotNull EnergyInvoice.PaymentStatusEnum	getPaymentStatus() Indicator of the payment status for the invoice
@Valid EnergyInvoicePayOnTimeDiscount	getPayOnTimeDiscount() Get payOnTimeDiscount
@Valid EnergyInvoicePeriod	getPeriod() Get period
@NotNull List<String>	getServicePoints() Array of service point IDs to which this invoice applies.
EnergyInvoice	gstAmount(String gstAmount)
int	hashCode()
EnergyInvoice	invoiceAmount(String invoiceAmount)
EnergyInvoice	invoiceNumber(String invoiceNumber)
EnergyInvoice	issueDate(String issueDate)
EnergyInvoice	paymentStatus(EnergyInvoice.PaymentStatusEnum paymentStatus)
EnergyInvoice	payOnTimeDiscount(EnergyInvoicePayOnTimeDiscount payOnTimeDiscount)
EnergyInvoice	period(EnergyInvoicePeriod period)
EnergyInvoice	servicePoints(List<String> servicePoints)
void	setAccountCharges(EnergyInvoiceAccountCharges accountCharges)
void	setAccountId(String accountId)
void	setBalanceAtIssue(String balanceAtIssue)
void	setDueDate(String dueDate)
void	setElectricity(EnergyInvoiceElectricityUsageCharges electricity)
void	setGas(EnergyInvoiceGasUsageCharges gas)
void	setGstAmount(String gstAmount)
void	setInvoiceAmount(String invoiceAmount)
void	setInvoiceNumber(String invoiceNumber)
void	setIssueDate(String issueDate)
void	setPaymentStatus(EnergyInvoice.PaymentStatusEnum paymentStatus)
void	setPayOnTimeDiscount(EnergyInvoicePayOnTimeDiscount payOnTimeDiscount)
void	setPeriod(EnergyInvoicePeriod period)
void	setServicePoints(List<String> servicePoints)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EnergyInvoice

public EnergyInvoice()

Method Detail

accountId

public EnergyInvoice accountId(String accountId)

getAccountId

@NotNull
public @NotNull String getAccountId()

The ID of the account for which the invoice was issued

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

invoiceNumber

public EnergyInvoice invoiceNumber(String invoiceNumber)

getInvoiceNumber

@NotNull
public @NotNull String getInvoiceNumber()

The number assigned to this invoice by the energy Retailer

Returns:

invoiceNumber

setInvoiceNumber

public void setInvoiceNumber(String invoiceNumber)

issueDate

public EnergyInvoice issueDate(String issueDate)

getIssueDate

@NotNull
public @NotNull String getIssueDate()

The date that the invoice was actually issued (as opposed to generated or calculated)

Returns:

issueDate

setIssueDate

public void setIssueDate(String issueDate)

dueDate

public EnergyInvoice dueDate(String dueDate)

getDueDate

public String getDueDate()

The date that the invoice is due to be paid

Returns:

dueDate

setDueDate

public void setDueDate(String dueDate)

period

public EnergyInvoice period(EnergyInvoicePeriod period)

getPeriod

@Valid
public @Valid EnergyInvoicePeriod getPeriod()

Get period

Returns:

period

setPeriod

public void setPeriod(EnergyInvoicePeriod period)

invoiceAmount

public EnergyInvoice invoiceAmount(String invoiceAmount)

getInvoiceAmount

public String getInvoiceAmount()

The net amount due for this invoice regardless of previous balance

Returns:

invoiceAmount

setInvoiceAmount

public void setInvoiceAmount(String invoiceAmount)

gstAmount

public EnergyInvoice gstAmount(String gstAmount)

getGstAmount

public String getGstAmount()

The total GST amount for this invoice. If absent then zero is assumed

Returns:

gstAmount

setGstAmount

public void setGstAmount(String gstAmount)

payOnTimeDiscount

public EnergyInvoice payOnTimeDiscount(EnergyInvoicePayOnTimeDiscount payOnTimeDiscount)

getPayOnTimeDiscount

@Valid
public @Valid EnergyInvoicePayOnTimeDiscount getPayOnTimeDiscount()

Get payOnTimeDiscount

Returns:

payOnTimeDiscount

setPayOnTimeDiscount

public void setPayOnTimeDiscount(EnergyInvoicePayOnTimeDiscount payOnTimeDiscount)

balanceAtIssue

public EnergyInvoice balanceAtIssue(String balanceAtIssue)

getBalanceAtIssue

@NotNull
public @NotNull String getBalanceAtIssue()

The account balance at the time the invoice was issued

Returns:

balanceAtIssue

setBalanceAtIssue

public void setBalanceAtIssue(String balanceAtIssue)

servicePoints

public EnergyInvoice servicePoints(List<String> servicePoints)

addServicePointsItem

public EnergyInvoice addServicePointsItem(String servicePointsItem)

getServicePoints

@NotNull
public @NotNull List<String> getServicePoints()

Array of service point IDs to which this invoice applies. May be empty if the invoice contains no electricity usage related charges

Returns:

servicePoints

setServicePoints

public void setServicePoints(List<String> servicePoints)

gas

public EnergyInvoice gas(EnergyInvoiceGasUsageCharges gas)

getGas

@Valid
public @Valid EnergyInvoiceGasUsageCharges getGas()

Get gas

Returns:

gas

setGas

public void setGas(EnergyInvoiceGasUsageCharges gas)

electricity

public EnergyInvoice electricity(EnergyInvoiceElectricityUsageCharges electricity)

getElectricity

@Valid
public @Valid EnergyInvoiceElectricityUsageCharges getElectricity()

Get electricity

Returns:

electricity

setElectricity

public void setElectricity(EnergyInvoiceElectricityUsageCharges electricity)

accountCharges

public EnergyInvoice accountCharges(EnergyInvoiceAccountCharges accountCharges)

getAccountCharges

@Valid
public @Valid EnergyInvoiceAccountCharges getAccountCharges()

Get accountCharges

Returns:

accountCharges

setAccountCharges

public void setAccountCharges(EnergyInvoiceAccountCharges accountCharges)

paymentStatus

public EnergyInvoice paymentStatus(EnergyInvoice.PaymentStatusEnum paymentStatus)

getPaymentStatus

@NotNull
public @NotNull EnergyInvoice.PaymentStatusEnum getPaymentStatus()

Indicator of the payment status for the invoice

Returns:

paymentStatus

setPaymentStatus

public void setPaymentStatus(EnergyInvoice.PaymentStatusEnum paymentStatus)

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