io.konik.zugferd.entity.trade

Class Settlement

java.lang.Object

io.konik.zugferd.entity.trade.Settlement

All Implemented Interfaces:

CommonSettlement<TradeTax,MonetarySummation>, java.io.Serializable

public class Settlement
extends java.lang.Object
implements CommonSettlement<TradeTax,MonetarySummation>

The Trade Settlement

Contains trade specific payment and price related informations

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Settlement()

Method Summary

Modifier and Type	Method and Description
Settlement	addAllowanceCharge(SpecifiedAllowanceCharge additionalAllowanceCharge) Adds the trade allowance charge.
Settlement	addPaymentMeans(PaymentMeans newPaymentMethod) Adds the payment method.
Settlement	addPaymentTerm(PaymentTerm additionalPaymentTerm) Adds a Payment Term.
Settlement	addServiceCharge(LogisticsServiceCharge logisticsServiceCharge) Adds the specified logistics service charge.
Settlement	addTradeTax(TradeTax additionalTradeTax) Adds a trade tradeTax.
java.util.List<SpecifiedAllowanceCharge>	getAllowanceCharge() Gets the trade allowance charge.
Period	getBillingPeriod() Gets the billing specified period.
java.lang.String	getCostCenter() Gets the booking reference or cost center account.
com.neovisionaries.i18n.CurrencyCode	getCurrency() Gets the invoice currency code specifiedBookingReference
TradeParty	getInvoicee() Gets the details on the alternative invoicee.
MonetarySummation	getMonetarySummation() Gets the trade settlement monetary summation.
TradeParty	getPayee() Gets the payee.
java.util.List<PaymentMeans>	getPaymentMeans() Gets the specified trade settlement payment means.
java.lang.String	getPaymentReference() Gets the payment reference.
java.util.List<PaymentTerm>	getPaymentTerms() Gets the specified trade payment terms.
java.util.List<LogisticsServiceCharge>	getServiceCharge() Gets the specified logistics service charge.
java.util.List<TradeTax>	getTradeTax() Gets the applicable trade tradeTax.
Settlement	setBillingPeriod(Period billingPeriod) Sets the billing specified period.
Settlement	setCostCenter(java.lang.String costCenter) Sets the booking reference or cost center account.
Settlement	setCurrency(com.neovisionaries.i18n.CurrencyCode currency) Sets the invoice currency code.
Settlement	setInvoicee(TradeParty invoicee) Sets the details on the alternative invoicee.
Settlement	setMonetarySummation(MonetarySummation monetarySummation) Sets the trade settlement monetary summation.
Settlement	setPayee(TradeParty payee) Sets the payee.
Settlement	setPaymentReference(java.lang.String referenceText) Sets the payment reference or note to payee

Methods inherited from class java.lang.Object

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

Constructor Detail

Settlement

public Settlement()

Method Detail

addAllowanceCharge

@Comfort
public Settlement addAllowanceCharge(SpecifiedAllowanceCharge additionalAllowanceCharge)

Adds the trade allowance charge.

Parameters:

additionalAllowanceCharge - an additional allowance charge

Returns:

the trade settlement

addPaymentMeans

public Settlement addPaymentMeans(PaymentMeans newPaymentMethod)

Adds the payment method.

Parameters:

newPaymentMethod - the new payment method

Returns:

the trade settlement

addPaymentTerm

@Comfort
public Settlement addPaymentTerm(PaymentTerm additionalPaymentTerm)

Adds a Payment Term.

Parameters:

additionalPaymentTerm - the additional payment term

Returns:

the trade settlement

addServiceCharge

@Comfort
public Settlement addServiceCharge(LogisticsServiceCharge logisticsServiceCharge)

Adds the specified logistics service charge.

Parameters:

logisticsServiceCharge - the logistics service charge

Returns:

the trade settlement

addTradeTax

public Settlement addTradeTax(TradeTax additionalTradeTax)

Adds a trade tradeTax.

Specified by:

addTradeTax in interface CommonSettlement<TradeTax,MonetarySummation>

Parameters:

additionalTradeTax - the additional trade tradeTax

Returns:

the trade settlement

getAllowanceCharge

@Comfort
public java.util.List<SpecifiedAllowanceCharge> getAllowanceCharge()

Gets the trade allowance charge.

Returns:

the specified trade allowance charge

getBillingPeriod

@Comfort
public Period getBillingPeriod()

Gets the billing specified period.

Specified by:

getBillingPeriod in interface CommonSettlement<TradeTax,MonetarySummation>

Returns:

the billing specified period

getCostCenter

@Extended
public java.lang.String getCostCenter()

Gets the booking reference or cost center account.

Returns:

the account of the booking reference

getCurrency

@Basic
 @NotNull
public com.neovisionaries.i18n.CurrencyCode getCurrency()

Gets the invoice currency code specifiedBookingReference

Returns:

the ISO 4217 3A currency code

getInvoicee

@Comfort
public TradeParty getInvoicee()

Gets the details on the alternative invoicee.

Additional role, if different from Buyer

Returns:

the invoicee trade party

getMonetarySummation

@Basic
 @NotNull
public MonetarySummation getMonetarySummation()

Gets the trade settlement monetary summation.

Specified by:

getMonetarySummation in interface CommonSettlement<TradeTax,MonetarySummation>

Returns:

the specified trade settlement monetary summation

getPayee

@Extended
public TradeParty getPayee()

Gets the payee.

Returns:

the payee

getPaymentMeans

public java.util.List<PaymentMeans> getPaymentMeans()

Gets the specified trade settlement payment means.

Returns:

the specified trade settlement payment means

getPaymentReference

@Basic
public java.lang.String getPaymentReference()

Gets the payment reference.

Can be same as invoice number.

Returns:

the payment reference

getPaymentTerms

@Comfort
public java.util.List<PaymentTerm> getPaymentTerms()

Gets the specified trade payment terms.

Returns:

the specified trade payment terms

getServiceCharge

@Comfort
public java.util.List<LogisticsServiceCharge> getServiceCharge()

Gets the specified logistics service charge.

Returns:

the specified logistics service charge

getTradeTax

public java.util.List<TradeTax> getTradeTax()

Gets the applicable trade tradeTax.

Specified by:

getTradeTax in interface CommonSettlement<TradeTax,MonetarySummation>

Returns:

the applicable trade tradeTax

setBillingPeriod

public Settlement setBillingPeriod(Period billingPeriod)

Sets the billing specified period.

Specified by:

setBillingPeriod in interface CommonSettlement<TradeTax,MonetarySummation>

Parameters:

billingPeriod - the new billing specified period

Returns:

the trade settlement

setCostCenter

public Settlement setCostCenter(java.lang.String costCenter)

Sets the booking reference or cost center account.

Parameters:

costCenter - the booking reference or cost center account.

Returns:

the trade settlement

setCurrency

public Settlement setCurrency(com.neovisionaries.i18n.CurrencyCode currency)

Sets the invoice currency code.

Parameters:

currency - the new currency

Returns:

the trade settlement

setInvoicee

public Settlement setInvoicee(TradeParty invoicee)

Sets the details on the alternative invoicee.

Additional role, if different from Buyer

Parameters:

invoicee - the new invoicee trade party

Returns:

the trade settlement

setMonetarySummation

@Basic
public Settlement setMonetarySummation(MonetarySummation monetarySummation)

Sets the trade settlement monetary summation.

Specified by:

setMonetarySummation in interface CommonSettlement<TradeTax,MonetarySummation>

Parameters:

monetarySummation - the new monetary summation

Returns:

the trade settlement

setPayee

public Settlement setPayee(TradeParty payee)

Sets the payee.

Parameters:

payee - the payee

Returns:

the trade settlement

setPaymentReference

public Settlement setPaymentReference(java.lang.String referenceText)

Sets the payment reference or note to payee

Can be same as invoice number.

Parameters:

referenceText - the reference text

Returns:

the trade settlement