au.org.consumerdatastandards.holder.model.telco

Class TelcoInvoice

java.lang.Object

au.org.consumerdatastandards.holder.model.telco.TelcoInvoice

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2022-12-23T11:32:06.900+11:00[Australia/Sydney]")
public class TelcoInvoice
extends Object

TelcoInvoice

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
TelcoInvoice()

Method Summary

Modifier and Type	Method and Description
TelcoInvoice	accountCharges(TelcoInvoiceAccountCharges accountCharges)
TelcoInvoice	accountId(String accountId)
TelcoInvoice	accountUsage(TelcoUsage accountUsage)
TelcoInvoice	addServicesItem(String servicesItem)
TelcoInvoice	balanceAtIssue(String balanceAtIssue)
TelcoInvoice	dueDate(String dueDate)
boolean	equals(Object o)
@Valid TelcoInvoiceAccountCharges	getAccountCharges() Get accountCharges
@NotNull String	getAccountId() The ID of the account for which the invoice was issued.
@Valid TelcoUsage	getAccountUsage() Get accountUsage
@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
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 telco Retailer
@NotNull String	getIssueDate() The date that the invoice was actually issued (as opposed to generated or calculated)
@NotNull TelcoInvoice.PaymentStatusEnum	getPaymentStatus() Indicator of the payment status for the invoice
@Valid TelcoInvoicePayOnTimeDiscount	getPayOnTimeDiscount() Get payOnTimeDiscount
@Valid TelcoInvoicePeriod	getPeriod() Get period
@NotNull List<String>	getServices() An array of service IDs to which this invoice applies.
TelcoInvoice	gstAmount(String gstAmount)
int	hashCode()
TelcoInvoice	invoiceAmount(String invoiceAmount)
TelcoInvoice	invoiceNumber(String invoiceNumber)
TelcoInvoice	issueDate(String issueDate)
TelcoInvoice	paymentStatus(TelcoInvoice.PaymentStatusEnum paymentStatus)
TelcoInvoice	payOnTimeDiscount(TelcoInvoicePayOnTimeDiscount payOnTimeDiscount)
TelcoInvoice	period(TelcoInvoicePeriod period)
TelcoInvoice	services(List<String> services)
void	setAccountCharges(TelcoInvoiceAccountCharges accountCharges)
void	setAccountId(String accountId)
void	setAccountUsage(TelcoUsage accountUsage)
void	setBalanceAtIssue(String balanceAtIssue)
void	setDueDate(String dueDate)
void	setGstAmount(String gstAmount)
void	setInvoiceAmount(String invoiceAmount)
void	setInvoiceNumber(String invoiceNumber)
void	setIssueDate(String issueDate)
void	setPaymentStatus(TelcoInvoice.PaymentStatusEnum paymentStatus)
void	setPayOnTimeDiscount(TelcoInvoicePayOnTimeDiscount payOnTimeDiscount)
void	setPeriod(TelcoInvoicePeriod period)
void	setServices(List<String> services)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TelcoInvoice

public TelcoInvoice()

Method Detail

accountId

public TelcoInvoice accountId(String accountId)

getAccountId

@NotNull
public @NotNull String getAccountId()

The ID of the account for which the invoice was issued. accountId must comply in accordance with [CDR ID permanence](#id-permanence)

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

invoiceNumber

public TelcoInvoice invoiceNumber(String invoiceNumber)

getInvoiceNumber

@NotNull
public @NotNull String getInvoiceNumber()

The number assigned to this invoice by the telco Retailer

Returns:

invoiceNumber

setInvoiceNumber

public void setInvoiceNumber(String invoiceNumber)

issueDate

public TelcoInvoice 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 TelcoInvoice 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 TelcoInvoice period(TelcoInvoicePeriod period)

getPeriod

@Valid
public @Valid TelcoInvoicePeriod getPeriod()

Get period

Returns:

period

setPeriod

public void setPeriod(TelcoInvoicePeriod period)

invoiceAmount

public TelcoInvoice 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 TelcoInvoice 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 TelcoInvoice payOnTimeDiscount(TelcoInvoicePayOnTimeDiscount payOnTimeDiscount)

getPayOnTimeDiscount

@Valid
public @Valid TelcoInvoicePayOnTimeDiscount getPayOnTimeDiscount()

Get payOnTimeDiscount

Returns:

payOnTimeDiscount

setPayOnTimeDiscount

public void setPayOnTimeDiscount(TelcoInvoicePayOnTimeDiscount payOnTimeDiscount)

balanceAtIssue

public TelcoInvoice 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)

services

public TelcoInvoice services(List<String> services)

addServicesItem

public TelcoInvoice addServicesItem(String servicesItem)

getServices

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

An array of service IDs to which this invoice applies. May be empty if the invoice contains no usage related charges

Returns:

services

setServices

public void setServices(List<String> services)

accountCharges

public TelcoInvoice accountCharges(TelcoInvoiceAccountCharges accountCharges)

getAccountCharges

@Valid
public @Valid TelcoInvoiceAccountCharges getAccountCharges()

Get accountCharges

Returns:

accountCharges

setAccountCharges

public void setAccountCharges(TelcoInvoiceAccountCharges accountCharges)

accountUsage

public TelcoInvoice accountUsage(TelcoUsage accountUsage)

getAccountUsage

@Valid
public @Valid TelcoUsage getAccountUsage()

Get accountUsage

Returns:

accountUsage

setAccountUsage

public void setAccountUsage(TelcoUsage accountUsage)

paymentStatus

public TelcoInvoice paymentStatus(TelcoInvoice.PaymentStatusEnum paymentStatus)

getPaymentStatus

@NotNull
public @NotNull TelcoInvoice.PaymentStatusEnum getPaymentStatus()

Indicator of the payment status for the invoice

Returns:

paymentStatus

setPaymentStatus

public void setPaymentStatus(TelcoInvoice.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