io.konik.zugferd.entity.trade

Class MonetarySummation

java.lang.Object

io.konik.zugferd.entity.trade.MonetarySummation

All Implemented Interfaces:

CommonMonetarySummation, java.io.Serializable

public class MonetarySummation
extends java.lang.Object
implements CommonMonetarySummation

The Monetary Summation of a trade settlement

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MonetarySummation()

Method Summary

Modifier and Type	Method and Description
Amount	getAllowanceTotal() Gets the total amount of discounts.
Amount	getChargeTotal() Gets the total amount of surcharges.
Amount	getDuePayable() Gets the due payable amount.
Amount	getGrandTotal() Gets the grand total amount.
Amount	getLineTotal() Gets total amount of the line position/s The line total amount is the net amount, including any additions and deductions without specifying the value-added tax.
Amount	getTaxBasisTotal() Gets the invoice total value excluding VAT.
Amount	getTaxTotal() Gets the total tax amount.
Amount	getTotalPrepaid() Gets the total prepaid amount.
MonetarySummation	setAllowanceTotal(Amount allowanceTotal) Sets the total amount of discounts.
MonetarySummation	setChargeTotal(Amount chargeTotal) Sets the total amount of surcharges.
MonetarySummation	setDuePayable(Amount duePayable) Sets the due payable amount.
MonetarySummation	setGrandTotal(Amount grandTotal) Sets the grand total amount.
MonetarySummation	setLineTotal(Amount lineTotal) Sets total amount of the line position/s.
MonetarySummation	setTaxBasisTotal(Amount taxBasisTotal) Sets the invoice total value excluding VAT.
MonetarySummation	setTaxTotal(Amount taxTotal) Sets the total tax amount.
MonetarySummation	setTotalPrepaid(Amount totalPrepaid) Sets the total prepaid amount.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MonetarySummation

public MonetarySummation()

Method Detail

getAllowanceTotal

@Basic
 @NotNull
public Amount getAllowanceTotal()

Gets the total amount of discounts.

Returns:

the allowance total amount

getChargeTotal

@Basic
 @NotNull
public Amount getChargeTotal()

Gets the total amount of surcharges.

Returns:

the charge total amount

getDuePayable

@Comfort
public Amount getDuePayable()

Gets the due payable amount.

Returns:

the due payable amount

getGrandTotal

@Basic
 @NotNull
public Amount getGrandTotal()

Gets the grand total amount.

Example

grandTotal == + taxTotal

Returns:

the grand total amount

getLineTotal

public Amount getLineTotal()

Description copied from interface: CommonMonetarySummation

Gets total amount of the line position/s The line total amount is the net amount, including any additions and deductions without specifying the value-added tax.

Specified by:

getLineTotal in interface CommonMonetarySummation

Returns:

the line total

getTaxBasisTotal

@Basic
 @NotNull
public Amount getTaxBasisTotal()

Gets the invoice total value excluding VAT.

Example

The taxBasisTotal = netTotal + chargeTotal - allowanceTotal.

Returns:

the tax basis total amount

getTaxTotal

@Basic
 @NotNull
public Amount getTaxTotal()

Gets the total tax amount.

Returns:

the tax total amount

getTotalPrepaid

@Comfort
public Amount getTotalPrepaid()

Gets the total prepaid amount.

Returns:

the total prepaid amount

setAllowanceTotal

public MonetarySummation setAllowanceTotal(Amount allowanceTotal)

Sets the total amount of discounts.

Parameters:

allowanceTotal - the new allowance total amount

Returns:

the trade settlement monetary summation

setChargeTotal

public MonetarySummation setChargeTotal(Amount chargeTotal)

Sets the total amount of surcharges.

Parameters:

chargeTotal - the new charge total amount

Returns:

the trade settlement monetary summation

setDuePayable

public MonetarySummation setDuePayable(Amount duePayable)

Sets the due payable amount.

Parameters:

duePayable - the new due payable amount

Returns:

the trade settlement monetary summation

setGrandTotal

public MonetarySummation setGrandTotal(Amount grandTotal)

Sets the grand total amount.

Parameters:

grandTotal - the new grand total amount

Returns:

the trade settlement monetary summation

setLineTotal

public MonetarySummation setLineTotal(Amount lineTotal)

Description copied from interface: CommonMonetarySummation

Sets total amount of the line position/s. The line total amount is the net amount, including any additions and deductions without specifying the value-added tax.

Specified by:

setLineTotal in interface CommonMonetarySummation

Parameters:

lineTotal - the line total

Returns:

the common monetary summation

setTaxBasisTotal

public MonetarySummation setTaxBasisTotal(Amount taxBasisTotal)

Sets the invoice total value excluding VAT.

Example

The taxBasisTotal = netTotal + chargeTotal - allowanceTotal.

Parameters:

taxBasisTotal - the new tax basis total amount

Returns:

the trade settlement monetary summation

setTaxTotal

public MonetarySummation setTaxTotal(Amount taxTotal)

Sets the total tax amount.

Parameters:

taxTotal - the new tax total amount

Returns:

the trade settlement monetary summation

setTotalPrepaid

public MonetarySummation setTotalPrepaid(Amount totalPrepaid)

Sets the total prepaid amount.

Parameters:

totalPrepaid - the new total prepaid amount

Returns:

the trade settlement monetary summation

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object