io.konik.zugferd.entity.trade

Class TradeTax

java.lang.Object

io.konik.zugferd.entity.trade.TradeTax

All Implemented Interfaces:

Tax, SpecifiedTax, java.io.Serializable

public class TradeTax
extends java.lang.Object
implements SpecifiedTax

The tax applied to a trade.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TradeTax()

Method Summary

Modifier and Type	Method and Description
Amount	getAllowanceCharge() Gets the allowance charge.
Amount	getBasis() Gets the basis amount for tax calculation.
Amount	getCalculated() Sets the calculated amount.
TaxCategory	getCategory() Gets the tax category.
java.lang.String	getExemptionReason() Gets the tax exemption reason.
Amount	getLineTotal() Gets the line total.
java.math.BigDecimal	getPercentage() Gets the applicable tax percentage.
TaxCode	getType() Gets the UNCL 5153 tax type code.
void	setAllowanceCharge(Amount allowanceCharge) Sets the allowance charge.
TradeTax	setBasis(Amount basisAmount) Sets the basis amount for tax calculation.
TradeTax	setCalculated(Amount calculatedAmount) Set the calculated amount.
TradeTax	setCategory(TaxCategory taxCategory) Sets the tax category.
TradeTax	setExemptionReason(java.lang.String exemptionReason) Sets the tax exemption reason.
void	setLineTotal(Amount lineTotal) Sets the line total.
TradeTax	setPercentage(java.math.BigDecimal applicablePercentage) Sets the applicable tax percentage.
TradeTax	setType(TaxCode taxTypeCode) Sets the UNCL 5153 tax type code.

Methods inherited from class java.lang.Object

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

Constructor Detail

TradeTax

public TradeTax()

Method Detail

getAllowanceCharge

@Extended
public Amount getAllowanceCharge()

Gets the allowance charge.

Returns:

the allowance charge

getBasis

@Basic
 @NotNull
public Amount getBasis()

Gets the basis amount for tax calculation.

Returns:

the basis amount

getCalculated

@Basic
 @NotNull
public Amount getCalculated()

Description copied from interface: SpecifiedTax

Sets the calculated amount.

Specified by:

getCalculated in interface SpecifiedTax

Returns:

the calculated amount

getCategory

@Comfort
public TaxCategory getCategory()

Description copied from interface: Tax

Gets the tax category.

Specified by:

getCategory in interface Tax

Returns:

the category code

getExemptionReason

public java.lang.String getExemptionReason()

Description copied from interface: SpecifiedTax

Gets the tax exemption reason.

Specified by:

getExemptionReason in interface SpecifiedTax

Returns:

the exemption reason

getLineTotal

@Extended
public Amount getLineTotal()

Gets the line total.

Returns:

the line total

getPercentage

@Basic
 @NotNull
public java.math.BigDecimal getPercentage()

Description copied from interface: Tax

Gets the applicable tax percentage.

Specified by:

getPercentage in interface Tax

Returns:

the applicable tax percentage

getType

@Basic
 @NotNull
public TaxCode getType()

Description copied from interface: Tax

Gets the UNCL 5153 tax type code.

Specified by:

getType in interface Tax

Returns:

the type code

setAllowanceCharge

public void setAllowanceCharge(Amount allowanceCharge)

Sets the allowance charge.

Parameters:

allowanceCharge - the new allowance charge

setBasis

public TradeTax setBasis(Amount basisAmount)

Sets the basis amount for tax calculation.

Parameters:

basisAmount - the new basis amount

Returns:

the tax

setCalculated

public TradeTax setCalculated(Amount calculatedAmount)

Description copied from interface: SpecifiedTax

Set the calculated amount.

Specified by:

setCalculated in interface SpecifiedTax

Returns:

the tax

setCategory

public TradeTax setCategory(TaxCategory taxCategory)

Description copied from interface: Tax

Sets the tax category.

Specified by:

setCategory in interface Tax

Parameters:

taxCategory - the new tax category code

Returns:

the tax

setExemptionReason

public TradeTax setExemptionReason(java.lang.String exemptionReason)

Description copied from interface: SpecifiedTax

Sets the tax exemption reason.

Specified by:

setExemptionReason in interface SpecifiedTax

Parameters:

exemptionReason - the new exemption reason

Returns:

the tax

setLineTotal

public void setLineTotal(Amount lineTotal)

Sets the line total.

Parameters:

lineTotal - the new line total

setPercentage

public TradeTax setPercentage(java.math.BigDecimal applicablePercentage)

Description copied from interface: Tax

Sets the applicable tax percentage.

Specified by:

setPercentage in interface Tax

Parameters:

applicablePercentage - the new applicable tax percentage

Returns:

the tax

setType

public TradeTax setType(TaxCode taxTypeCode)

Description copied from interface: Tax

Sets the UNCL 5153 tax type code.

Specified by:

setType in interface Tax

Parameters:

taxTypeCode - the tax type code

Returns:

the tax

See Also:

href="http://www.unece.org/trade/untdid/d98b/uncl/uncl5153.htm">UNCL 5153</a>