io.konik.zugferd.entity

Class Header

java.lang.Object

io.konik.zugferd.entity.Header

All Implemented Interfaces:

java.io.Serializable

public class Header
extends java.lang.Object
implements java.io.Serializable

The Invoice Document Header

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Header()

Method Summary

Modifier and Type	Method and Description
void	addLanguage(com.neovisionaries.i18n.LanguageCode language) Adds the language.
Header	addNote(Note... additionalNote) Adds a invoice header note.
DocumentCode	getCode() Gets UNCL 1001 Document Name Code.
ZfDate	getContractualDueDate() Gets contractual due date of the invoice.
java.lang.String	getInvoiceNumber() Gets the invoice number.
ZfDate	getIssued() Gets the invoice issue date time.
java.util.List<com.neovisionaries.i18n.LanguageCode>	getLanguages() Gets the languages.
java.lang.String	getName() Gets the free text invoice name.
java.util.List<Note>	getNotes() Gets the invoice header notes.
boolean	isCopy() Checks if is copy.
Header	setCode(DocumentCode code) Sets the UNCL 1001 Document Name Code.
Header	setContractualDueDate(ZfDate contractualDueDate) Sets contractual due date of the invoice.
void	setCopy(boolean copy) Sets the copy.
Header	setInvoiceNumber(java.lang.String invoiceNumber) Sets the invoice number.
Header	setIssued(ZfDate issued) Sets the invoice issue date time.
Header	setName(java.lang.String name) Adds a free text invoice name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Header

public Header()

Method Detail

addLanguage

public void addLanguage(com.neovisionaries.i18n.LanguageCode language)

Adds the language.

Parameters:

language - the language

addNote

public Header addNote(Note... additionalNote)

Adds a invoice header note.

Example

• note content: Invoice like agreed on the telephone with Mr.X. -

• note subject code as UNCL 4451: AAK

Parameters:

additionalNote - the additional note

Returns:

the header

getCode

@Basic
 @NotNull
public DocumentCode getCode()

Gets UNCL 1001 Document Name Code.

Example

380, 381, 383, 389, 261

Returns:

the document name code

See Also:

UN/EDIFACT 1001 Document name coe

getContractualDueDate

@Extended
public ZfDate getContractualDueDate()

Gets contractual due date of the invoice.

Remark: Should only be used, if the contractual due date is different to the payment due date (e.g. with SEPA credit transfers).

Returns:

the contractual due date

getInvoiceNumber

@Basic
 @NotBlank
public java.lang.String getInvoiceNumber()

Gets the invoice number.

Example

2012-12345

Returns:

the invoice number

getIssued

@Basic
 @NotNull
public ZfDate getIssued()

Gets the invoice issue date time.

Returns:

the issue date time

getLanguages

@Extended
public java.util.List<com.neovisionaries.i18n.LanguageCode> getLanguages()

Gets the languages.

Returns:

the languages

getName

@Basic
 @NotBlank
public java.lang.String getName()

Gets the free text invoice name.

Example

invoice, credit advice, debit note, pro forma invoice

Returns:

the invoice name

getNotes

@Basic
public java.util.List<Note> getNotes()

Gets the invoice header notes.

Example

• note content: Invoice like agreed on the telephone with Mr.X. -

• note subject code as UNCL 4451: AAK

Returns:

the included note

isCopy

@Extended
public boolean isCopy()

Checks if is copy.

Returns:

the indicator

setCode

public Header setCode(DocumentCode code)

Sets the UNCL 1001 Document Name Code.

Example

380, 381, 383, 389, 261

Parameters:

code - the new document name code

Returns:

the header document

See Also:

UN/EDIFACT 1001 Document name coe

setContractualDueDate

public Header setContractualDueDate(ZfDate contractualDueDate)

Sets contractual due date of the invoice.

Remark: Should only be used, if the contractual due date is different to the payment due date (e.g. with SEPA credit transfers).

Parameters:

contractualDueDate - the contractual due date

Returns:

the header

setCopy

public void setCopy(boolean copy)

Sets the copy.

Parameters:

copy - the new copy

setInvoiceNumber

public Header setInvoiceNumber(java.lang.String invoiceNumber)

Sets the invoice number.

Example

2012-12345

Parameters:

invoiceNumber - the invoice number

Returns:

the header document

setIssued

public Header setIssued(ZfDate issued)

Sets the invoice issue date time.

Parameters:

issued - the new issue date time

Returns:

the exchanged document

setName

public Header setName(java.lang.String name)

Adds a free text invoice name.

Example

invoice, credit advice, debit note, pro forma invoice

Parameters:

name - the new name

Returns:

the exchanged document

See Also:

getName()