Invoice (Library to write, read and validate e-invoices (Factur-X, ZUGFeRD, Order-X, XRechnung/CII) 2.11.0 API)

java.lang.Object
- org.mustangproject.Invoice

All Implemented Interfaces:

IExportableTransaction
```
public class Invoice
extends java.lang.Object
implements IExportableTransaction
```
An invoice, with fluent setters

See Also:

if you want to implement an interface instead

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.ArrayList<IZUGFeRDAllowanceCharge>`	`Allowances`
`protected java.lang.String`	`buyerOrderReferencedDocumentID`
`protected java.lang.String`	`buyerOrderReferencedDocumentIssueDateTime`
`protected java.util.ArrayList<CashDiscount>`	`cashDiscounts`
`protected java.util.ArrayList<IZUGFeRDAllowanceCharge>`	`Charges`
`protected java.lang.String`	`contractReferencedDocument`
`protected java.lang.String`	`currency`
`protected TradeParty`	`deliveryAddress`
`protected java.util.Date`	`deliveryDate`
`protected java.lang.String`	`despatchAdviceReferencedDocumentID`
`protected java.util.Date`	`detailedDeliveryDateStart`
`protected java.util.Date`	`detailedDeliveryPeriodEnd`
`protected java.lang.String`	`documentCode`
`protected java.lang.String`	`documentName`
`protected java.util.Date`	`dueDate`
`protected java.lang.String`	`invoiceReferencedDocumentID`
`protected java.util.Date`	`invoiceReferencedIssueDate`
`protected java.util.Date`	`issueDate`
`protected java.util.ArrayList<IZUGFeRDAllowanceCharge>`	`LogisticsServiceCharges`
`protected java.util.ArrayList<java.lang.String>`	`notes`
`protected java.lang.String`	`number`
`protected java.lang.String`	`ownForeignOrganisationID`
`protected java.lang.String`	`ownOrganisationFullPlaintextInfo`
`protected java.lang.String`	`ownOrganisationName`
`protected java.lang.String`	`paymentTermDescription`
`protected IZUGFeRDPaymentTerms`	`paymentTerms`
`protected TradeParty`	`recipient`
`protected java.lang.String`	`referenceNumber`
`protected java.lang.String`	`sellerOrderReferencedDocumentID`
`protected TradeParty`	`sender`
`protected java.lang.String`	`shipToCountry`
`protected java.lang.String`	`shipToLocation`
`protected java.lang.String`	`shipToOrganisationID`
`protected java.lang.String`	`shipToOrganisationName`
`protected java.lang.String`	`shipToStreet`
`protected java.lang.String`	`shipToZIP`
`protected java.lang.String`	`specifiedProcuringProjectID`
`protected java.lang.String`	`specifiedProcuringProjectName`
`protected java.math.BigDecimal`	`totalPrepaidAmount`
`protected java.lang.String`	`vatDueDateTypeCode`
`protected java.util.ArrayList<FileAttachment>`	`xmlEmbeddedFiles`
`protected java.util.ArrayList<IZUGFeRDExportableItem>`	`ZFItems`

Constructor Summary

Constructors
Constructor and Description

Invoice()

Constructors
Constructor and Description
`Invoice()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Invoice`	`addAllowance(IZUGFeRDAllowanceCharge izac)` adds a document level rebate
`Invoice`	`addCashDiscount(CashDiscount c)` Adds a cash discount (skonto)
`Invoice`	`addCharge(IZUGFeRDAllowanceCharge izac)` adds a document level addition to the price
`Invoice`	`addCustomsNote(java.lang.String content)` adds a free text paragraph, which will become an includedNote element with explicit subjectCode `SubjectCode.CUS`
`Invoice`	`addDiscountBonusNote(java.lang.String content)` adds a free text paragraph, which will become an includedNote element with explicit subjectCode `SubjectCode.AAK`
`Invoice`	`addGeneralNote(java.lang.String content)` adds a free text paragraph, which will become an includedNote element with explicit subjectCode `SubjectCode.AAI`
`Invoice`	`addIntroductionNote(java.lang.String content)` adds a free text paragraph, which will become an includedNote element with explicit subjectCode `SubjectCode.ACY`
`Invoice`	`addItem(IZUGFeRDExportableItem item)` required adds invoice "lines" :-)
`Invoice`	`addLegalNote(java.lang.String content)` adds a free text paragraph, which will become an includedNote element with explicit subjectCode `SubjectCode.ABL`
`Invoice`	`addNote(java.lang.String text)` adds a free text paragraph, which will become an includedNote element
`Invoice`	`addNotes(java.util.Collection<IncludedNote> notes)`
`Invoice`	`addRegulatoryNote(java.lang.String content)` adds a free text paragraph, which will become an includedNote element with explicit subjectCode `SubjectCode.REG`
`Invoice`	`addSellerNote(java.lang.String content)` adds a free text paragraph, which will become an includedNote element with explicit subjectCode `SubjectCode.SUR`
`Invoice`	`addTaxNote(java.lang.String content)` adds a free text paragraph, which will become an includedNote element with explicit subjectCode `SubjectCode.TXD`
`Invoice`	`embedFileInXML(FileAttachment fa)`
`FileAttachment[]`	`getAdditionalReferencedDocuments()` get additional referenced documents acccording to BG-24 XRechnung (Rechnungsbegruendende Unterlagen), i.e.
`java.lang.String`	`getBuyerOrderReferencedDocumentID()` get the ID of the BuyerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement
`java.lang.String`	`getBuyerOrderReferencedDocumentIssueDateTime()` get the issue timestamp of the BuyerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement
`IZUGFeRDCashDiscount[]`	`getCashDiscounts()`
`java.lang.String`	`getContractReferencedDocument()`
`java.lang.String`	`getCurrency()` get main invoice currency used on the invoice
`TradeParty`	`getDeliveryAddress()` delivery address, i.e. ram:ShipToTradeParty (only supported for zf2)
`java.util.Date`	`getDeliveryDate()` get delivery date
`java.lang.String`	`getDespatchAdviceReferencedDocumentID()`
`java.util.Date`	`getDetailedDeliveryPeriodFrom()` specifies the document level delivery period, will be included in a BillingSpecifiedPeriod element
`java.util.Date`	`getDetailedDeliveryPeriodTo()` specifies the document level delivery period, will be included in a BillingSpecifiedPeriod element
`java.lang.String`	`getDocumentCode()`
`java.lang.String`	`getDocumentName()` appears in /rsm:CrossIndustryDocument/rsm:HeaderExchangedDocument/ram:Name
`java.util.Date`	`getDueDate()` when the invoice is to be paid
`java.lang.String`	`getInvoiceReferencedDocumentID()` get the ID of the preceding invoice, which is e.g. to be corrected if this is a correction
`java.util.Date`	`getInvoiceReferencedIssueDate()`
`java.util.Date`	`getIssueDate()` the date when the invoice was created
`java.lang.String[]`	`getNotes()` additional text description
`java.util.List<IncludedNote>`	`getNotesWithSubjectCode()` A grouping of business terms to indicate accounting-relevant free texts including a qualification of these.
`java.lang.String`	`getNumber()` Number, typically invoice number of the invoice
`java.lang.String`	`getOwnCountry()` own two digit country code
`java.lang.String`	`getOwnForeignOrganisationID()` supplier identification assigned by the costumer
`java.lang.String`	`getOwnLocation()` own city
`java.lang.String`	`getOwnOrganisationFullPlaintextInfo()` this should be the full sender institution name, details, manager and tax registration.
`java.lang.String`	`getOwnOrganisationName()` own name
`java.lang.String`	`getOwnStreet()` own street address
`java.lang.String`	`getOwnTaxID()` Tax ID (not VAT ID) of the sender
`java.lang.String`	`getOwnVATID()` VAT ID (Umsatzsteueridentifikationsnummer) of the sender
`java.lang.String`	`getOwnZIP()` own street postal code
`java.lang.String`	`getPaymentTermDescription()` get payment term descriptional text e.g.
`IZUGFeRDPaymentTerms`	`getPaymentTerms()` get payment terms. if set, getPaymentTermDescription() and getDueDate() are ignored
`TradeParty`	`getRecipient()` the recipient
`java.lang.String`	`getReferenceNumber()` get reference document number typically used for Invoice Corrections Will be added as IncludedNote in comfort profile
`java.lang.String`	`getSellerOrderReferencedDocumentID()` get the ID of the SellerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement/ApplicableHeaderTradeAgreement
`TradeParty`	`getSender()` the sender of the invoice
`java.lang.String`	`getShipToCountry()` consignee two digit country code (country code of the organisation the goods are shipped to)
`java.lang.String`	`getShipToLocation()` consignee city (city of the organisation the goods are shipped to)
`java.lang.String`	`getShipToOrganisationID()` consignee identification (identification of the organisation the goods are shipped to [assigned by the costumer])
`java.lang.String`	`getShipToOrganisationName()` consignee name (name of the organisation the goods are shipped to)
`java.lang.String`	`getShipToStreet()` consignee street address (street of the organisation the goods are shipped to)
`java.lang.String`	`getShipToZIP()` consignee street postal code (postal code of the organisation the goods are shipped to)
`java.lang.String`	`getSpecifiedProcuringProjectID()`
`java.lang.String`	`getSpecifiedProcuringProjectName()`
`java.math.BigDecimal`	`getTotalPrepaidAmount()` get the TotalPrepaidAmount located in SpecifiedTradeSettlementMonetarySummation (v1) or SpecifiedTradeSettlementHeaderMonetarySummation (v2)
`IZUGFeRDTradeSettlement[]`	`getTradeSettlement()` the payment information for any payment means
`java.lang.String`	`getVATDueDateTypeCode()`
`IZUGFeRDAllowanceCharge[]`	`getZFAllowances()`
`IZUGFeRDAllowanceCharge[]`	`getZFCharges()`
`IZUGFeRDExportableItem[]`	`getZFItems()`
`IZUGFeRDAllowanceCharge[]`	`getZFLogisticsServiceCharges()`
`boolean`	`isValid()` checks if all required items are set in order to be able to export it
`Invoice`	`setBuyerOrderReferencedDocumentID(java.lang.String buyerOrderReferencedDocumentID)` usually the order number
`Invoice`	`setBuyerOrderReferencedDocumentIssueDateTime(java.lang.String buyerOrderReferencedDocumentIssueDateTime)` when the order (or whatever reference in BuyerOrderReferencedDocumentID) was issued (@todo switch to date?)
`Invoice`	`setContractReferencedDocument(java.lang.String s)` adds the ID of a contract referenced in the invoice
`Invoice`	`setCorrection(java.lang.String number)` switch type to invoice correction and refer to document number.
`Invoice`	`setCreditNote()`
`Invoice`	`setCurrency(java.lang.String currency)`
`Invoice`	`setDeliveryAddress(TradeParty deliveryAddress)` if the delivery address is not the recipient address, it can be specified here
`Invoice`	`setDeliveryDate(java.util.Date deliveryDate)`
`Invoice`	`setDespatchAdviceReferencedDocumentID(java.lang.String despatchAdviceReferencedDocumentID)`
`Invoice`	`setDetailedDeliveryPeriod(java.util.Date start, java.util.Date end)` sets a document level delivery period, which is optional additional to the mandatory deliverydate and which will become a BillingSpecifiedPeriod-Element
`Invoice`	`setDocumentCode(java.lang.String documentCode)`
`Invoice`	`setDocumentName(java.lang.String documentName)`
`Invoice`	`setDueDate(java.util.Date dueDate)`
`Invoice`	`setInvoiceReferencedDocumentID(java.lang.String invoiceReferencedDocumentID)` usually in case of a correction the original invoice number
`Invoice`	`setInvoiceReferencedIssueDate(java.util.Date issueDate)`
`Invoice`	`setIssueDate(java.util.Date issueDate)`
`Invoice`	`setNumber(java.lang.String number)`
`Invoice`	`setOwnContact(Contact ownContact)` Deprecated. use setSender
`Invoice`	`setOwnForeignOrganisationID(java.lang.String ownForeignOrganisationID)` Deprecated.
`Invoice`	`setOwnOrganisationFullPlaintextInfo(java.lang.String ownOrganisationFullPlaintextInfo)`
`Invoice`	`setOwnOrganisationName(java.lang.String ownOrganisationName)` Deprecated.
`Invoice`	`setOwnTaxID(java.lang.String ownTaxID)` Deprecated.
`Invoice`	`setOwnVATID(java.lang.String ownVATID)` Deprecated.
`Invoice`	`setPaymentTermDescription(java.lang.String paymentTermDescription)`
`Invoice`	`setPaymentTerms(IZUGFeRDPaymentTerms paymentTerms)`
`Invoice`	`setRecipient(TradeParty recipient)` required.
`Invoice`	`setReferenceNumber(java.lang.String referenceNumber)`
`Invoice`	`setSellerOrderReferencedDocumentID(java.lang.String sellerOrderReferencedDocumentID)`
`Invoice`	`setSender(TradeParty sender)` required.
`Invoice`	`setShipToCountry(java.lang.String shipToCountry)`
`Invoice`	`setShipToLocation(java.lang.String shipToLocation)`
`Invoice`	`setShipToOrganisationID(java.lang.String shipToOrganisationID)`
`Invoice`	`setShipToOrganisationName(java.lang.String shipToOrganisationName)`
`Invoice`	`setShipToStreet(java.lang.String shipToStreet)`
`Invoice`	`setShipToZIP(java.lang.String shipToZIP)`
`Invoice`	`setSpecifiedProcuringProjectID(java.lang.String specifiedProcuringProjectID)`
`Invoice`	`setSpecifiedProcuringProjectName(java.lang.String specifiedProcuringProjectName)`
`Invoice`	`setTotalPrepaidAmount(java.math.BigDecimal prepaid)` allow to set a amount which has already been paid
`Invoice`	`setVATDueDateTypeCode(java.lang.String vatDueDateTypeCode)` Decide when the VAT should be collected.
`void`	`setZFItems(java.util.ArrayList<IZUGFeRDExportableItem> ims)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mustangproject.ZUGFeRD.IExportableTransaction
getSubjectNote, getTradeSettlementPayment, rebateAgreementExists

- Field Detail
  - documentName
```
protected java.lang.String documentName
```
  - documentCode
```
protected java.lang.String documentCode
```
  - number
```
protected java.lang.String number
```
  - ownOrganisationFullPlaintextInfo
```
protected java.lang.String ownOrganisationFullPlaintextInfo
```
  - referenceNumber
```
protected java.lang.String referenceNumber
```
  - shipToOrganisationID
```
protected java.lang.String shipToOrganisationID
```
  - shipToOrganisationName
```
protected java.lang.String shipToOrganisationName
```
  - shipToStreet
```
protected java.lang.String shipToStreet
```
  - shipToZIP
```
protected java.lang.String shipToZIP
```
  - shipToLocation
```
protected java.lang.String shipToLocation
```
  - shipToCountry
```
protected java.lang.String shipToCountry
```
  - buyerOrderReferencedDocumentID
```
protected java.lang.String buyerOrderReferencedDocumentID
```
  - invoiceReferencedDocumentID
```
protected java.lang.String invoiceReferencedDocumentID
```
  - buyerOrderReferencedDocumentIssueDateTime
```
protected java.lang.String buyerOrderReferencedDocumentIssueDateTime
```
  - ownForeignOrganisationID
```
protected java.lang.String ownForeignOrganisationID
```
  - ownOrganisationName
```
protected java.lang.String ownOrganisationName
```
  - currency
```
protected java.lang.String currency
```
  - paymentTermDescription
```
protected java.lang.String paymentTermDescription
```
  - issueDate
```
protected java.util.Date issueDate
```
  - dueDate
```
protected java.util.Date dueDate
```
  - deliveryDate
```
protected java.util.Date deliveryDate
```
  - sender
```
protected TradeParty sender
```
  - recipient
```
protected TradeParty recipient
```
  - deliveryAddress
```
protected TradeParty deliveryAddress
```
  - cashDiscounts
```
protected java.util.ArrayList<CashDiscount> cashDiscounts
```
  - ZFItems
```
protected java.util.ArrayList<IZUGFeRDExportableItem> ZFItems
```
  - notes
```
protected java.util.ArrayList<java.lang.String> notes
```
  - sellerOrderReferencedDocumentID
```
protected java.lang.String sellerOrderReferencedDocumentID
```
  - contractReferencedDocument
```
protected java.lang.String contractReferencedDocument
```
  - xmlEmbeddedFiles
```
protected java.util.ArrayList<FileAttachment> xmlEmbeddedFiles
```
  - totalPrepaidAmount
```
protected java.math.BigDecimal totalPrepaidAmount
```
  - detailedDeliveryDateStart
```
protected java.util.Date detailedDeliveryDateStart
```
  - detailedDeliveryPeriodEnd
```
protected java.util.Date detailedDeliveryPeriodEnd
```
  - Allowances
```
protected java.util.ArrayList<IZUGFeRDAllowanceCharge> Allowances
```
  - Charges
```
protected java.util.ArrayList<IZUGFeRDAllowanceCharge> Charges
```
  - LogisticsServiceCharges
```
protected java.util.ArrayList<IZUGFeRDAllowanceCharge> LogisticsServiceCharges
```
  - paymentTerms
```
protected IZUGFeRDPaymentTerms paymentTerms
```
  - invoiceReferencedIssueDate
```
protected java.util.Date invoiceReferencedIssueDate
```
  - specifiedProcuringProjectID
```
protected java.lang.String specifiedProcuringProjectID
```
  - specifiedProcuringProjectName
```
protected java.lang.String specifiedProcuringProjectName
```
  - despatchAdviceReferencedDocumentID
```
protected java.lang.String despatchAdviceReferencedDocumentID
```
  - vatDueDateTypeCode
```
protected java.lang.String vatDueDateTypeCode
```
- Constructor Detail
  - Invoice
```
public Invoice()
```
- Method Detail
  - getDocumentName
```
public java.lang.String getDocumentName()
```
    Description copied from interface: IExportableTransaction
    
    appears in /rsm:CrossIndustryDocument/rsm:HeaderExchangedDocument/ram:Name
    
    Specified by:
    
    getDocumentName in interface IExportableTransaction
    
    Returns:
    
    Name of document
  - getContractReferencedDocument
```
public java.lang.String getContractReferencedDocument()
```
    Specified by:
    
    getContractReferencedDocument in interface IExportableTransaction
  - setDocumentName
```
public Invoice setDocumentName(java.lang.String documentName)
```
  - getDocumentCode
```
public java.lang.String getDocumentCode()
```
    Specified by:
    
    getDocumentCode in interface IExportableTransaction
    
    Returns:
    
    Code number of Document type, e.g. "380" for invoiceF
  - setDocumentCode
```
public Invoice setDocumentCode(java.lang.String documentCode)
```
  - embedFileInXML
```
public Invoice embedFileInXML(FileAttachment fa)
```
  - getAdditionalReferencedDocuments
```
public FileAttachment[] getAdditionalReferencedDocuments()
```
    Description copied from interface: IExportableTransaction
    
    get additional referenced documents acccording to BG-24 XRechnung (Rechnungsbegruendende Unterlagen), i.e. ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument
    
    Specified by:
    
    getAdditionalReferencedDocuments in interface IExportableTransaction
    
    Returns:
    
    a array of objects from class FileAttachment
  - getCashDiscounts
```
public IZUGFeRDCashDiscount[] getCashDiscounts()
```
    Specified by:
    
    getCashDiscounts in interface IExportableTransaction
  - getNumber
```
public java.lang.String getNumber()
```
    Description copied from interface: IExportableTransaction
    
    Number, typically invoice number of the invoice
    
    Specified by:
    
    getNumber in interface IExportableTransaction
    
    Returns:
    
    invoice number
  - setNumber
```
public Invoice setNumber(java.lang.String number)
```
  - setCorrection
```
public Invoice setCorrection(java.lang.String number)
```
    switch type to invoice correction and refer to document number. Please note that the quantities need to be negative, if you e.g. delivered 100 and take 50 back the quantity should be -50 in the corrected invoice, which will result in negative VAT and a negative payment amount
    
    Parameters:
    
    number - the invoice number to be corrected
    
    Returns:
    
    this object (fluent setter)
  - setCreditNote
```
public Invoice setCreditNote()
```
  - getOwnOrganisationFullPlaintextInfo
```
public java.lang.String getOwnOrganisationFullPlaintextInfo()
```
    Description copied from interface: IExportableTransaction
    
    this should be the full sender institution name, details, manager and tax registration. It is one of the few functions which may return null. e.g. Lieferant GmbH Lieferantenstraße 20 80333 München Deutschland Geschäftsführer: Hans Muster Handelsregisternummer: H A 123 It is written as an includedNode with subjectCode SubjectCode.REG. See also IExportableTransaction.getNotesWithSubjectCode()
    
    Specified by:
    
    getOwnOrganisationFullPlaintextInfo in interface IExportableTransaction
    
    Returns:
    
    null or full sender institution name, details, manager and tax registration
  - setOwnOrganisationFullPlaintextInfo
```
public Invoice setOwnOrganisationFullPlaintextInfo(java.lang.String ownOrganisationFullPlaintextInfo)
```
  - getReferenceNumber
```
public java.lang.String getReferenceNumber()
```
    Description copied from interface: IExportableTransaction
    
    get reference document number typically used for Invoice Corrections Will be added as IncludedNote in comfort profile
    
    Specified by:
    
    getReferenceNumber in interface IExportableTransaction
    
    Returns:
    
    the ID of the document this document refers to
  - setReferenceNumber
```
public Invoice setReferenceNumber(java.lang.String referenceNumber)
```
  - getShipToOrganisationID
```
public java.lang.String getShipToOrganisationID()
```
    Description copied from interface: IExportableTransaction
    
    consignee identification (identification of the organisation the goods are shipped to [assigned by the costumer])
    
    Specified by:
    
    getShipToOrganisationID in interface IExportableTransaction
    
    Returns:
    
    the sender's identification
  - setShipToOrganisationID
```
public Invoice setShipToOrganisationID(java.lang.String shipToOrganisationID)
```
  - getShipToOrganisationName
```
public java.lang.String getShipToOrganisationName()
```
    Description copied from interface: IExportableTransaction
    
    consignee name (name of the organisation the goods are shipped to)
    
    Specified by:
    
    getShipToOrganisationName in interface IExportableTransaction
    
    Returns:
    
    the consignee's organisation name
  - setShipToOrganisationName
```
public Invoice setShipToOrganisationName(java.lang.String shipToOrganisationName)
```
  - getShipToStreet
```
public java.lang.String getShipToStreet()
```
    Description copied from interface: IExportableTransaction
    
    consignee street address (street of the organisation the goods are shipped to)
    
    Specified by:
    
    getShipToStreet in interface IExportableTransaction
    
    Returns:
    
    consignee street address
  - setShipToStreet
```
public Invoice setShipToStreet(java.lang.String shipToStreet)
```
  - getShipToZIP
```
public java.lang.String getShipToZIP()
```
    Description copied from interface: IExportableTransaction
    
    consignee street postal code (postal code of the organisation the goods are shipped to)
    
    Specified by:
    
    getShipToZIP in interface IExportableTransaction
    
    Returns:
    
    consignee postal code
  - setShipToZIP
```
public Invoice setShipToZIP(java.lang.String shipToZIP)
```
  - getShipToLocation
```
public java.lang.String getShipToLocation()
```
    Description copied from interface: IExportableTransaction
    
    consignee city (city of the organisation the goods are shipped to)
    
    Specified by:
    
    getShipToLocation in interface IExportableTransaction
    
    Returns:
    
    the consignee's city
  - setShipToLocation
```
public Invoice setShipToLocation(java.lang.String shipToLocation)
```
  - getShipToCountry
```
public java.lang.String getShipToCountry()
```
    Description copied from interface: IExportableTransaction
    
    consignee two digit country code (country code of the organisation the goods are shipped to)
    
    Specified by:
    
    getShipToCountry in interface IExportableTransaction
    
    Returns:
    
    the consignee's two character country iso code
  - setShipToCountry
```
public Invoice setShipToCountry(java.lang.String shipToCountry)
```
  - getBuyerOrderReferencedDocumentID
```
public java.lang.String getBuyerOrderReferencedDocumentID()
```
    Description copied from interface: IExportableTransaction
    
    get the ID of the BuyerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement
    
    Specified by:
    
    getBuyerOrderReferencedDocumentID in interface IExportableTransaction
    
    Returns:
    
    the ID of the document
  - getSellerOrderReferencedDocumentID
```
public java.lang.String getSellerOrderReferencedDocumentID()
```
    Description copied from interface: IExportableTransaction
    
    get the ID of the SellerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement/ApplicableHeaderTradeAgreement
    
    Specified by:
    
    getSellerOrderReferencedDocumentID in interface IExportableTransaction
    
    Returns:
    
    the ID of the document
  - setSellerOrderReferencedDocumentID
```
public Invoice setSellerOrderReferencedDocumentID(java.lang.String sellerOrderReferencedDocumentID)
```
  - setBuyerOrderReferencedDocumentID
```
public Invoice setBuyerOrderReferencedDocumentID(java.lang.String buyerOrderReferencedDocumentID)
```
    usually the order number
    
    Parameters:
    
    buyerOrderReferencedDocumentID - string with number
    
    Returns:
    
    fluent setter
  - setInvoiceReferencedDocumentID
```
public Invoice setInvoiceReferencedDocumentID(java.lang.String invoiceReferencedDocumentID)
```
    usually in case of a correction the original invoice number
    
    Parameters:
    
    invoiceReferencedDocumentID - string with number
    
    Returns:
    
    fluent setter
  - getInvoiceReferencedDocumentID
```
public java.lang.String getInvoiceReferencedDocumentID()
```
    Description copied from interface: IExportableTransaction
    
    get the ID of the preceding invoice, which is e.g. to be corrected if this is a correction
    
    Specified by:
    
    getInvoiceReferencedDocumentID in interface IExportableTransaction
    
    Returns:
    
    the ID of the document
  - getInvoiceReferencedIssueDate
```
public java.util.Date getInvoiceReferencedIssueDate()
```
    Specified by:
    
    getInvoiceReferencedIssueDate in interface IExportableTransaction
  - setInvoiceReferencedIssueDate
```
public Invoice setInvoiceReferencedIssueDate(java.util.Date issueDate)
```
  - getBuyerOrderReferencedDocumentIssueDateTime
```
public java.lang.String getBuyerOrderReferencedDocumentIssueDateTime()
```
    Description copied from interface: IExportableTransaction
    
    get the issue timestamp of the BuyerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement
    
    Specified by:
    
    getBuyerOrderReferencedDocumentIssueDateTime in interface IExportableTransaction
    
    Returns:
    
    the IssueDateTime in format CCYY-MM-DDTHH:MM:SS
  - setTotalPrepaidAmount
```
public Invoice setTotalPrepaidAmount(java.math.BigDecimal prepaid)
```
    allow to set a amount which has already been paid
    
    Parameters:
    
    prepaid - null is possible to omit
    
    Returns:
    
    fluent setter
  - getTotalPrepaidAmount
```
public java.math.BigDecimal getTotalPrepaidAmount()
```
    Description copied from interface: IExportableTransaction
    
    get the TotalPrepaidAmount located in SpecifiedTradeSettlementMonetarySummation (v1) or SpecifiedTradeSettlementHeaderMonetarySummation (v2)
    
    Specified by:
    
    getTotalPrepaidAmount in interface IExportableTransaction
    
    Returns:
    
    the total sum (incl. VAT) of prepayments, i.e. the difference between GrandTotalAmount and DuePayableAmount
  - setBuyerOrderReferencedDocumentIssueDateTime
```
public Invoice setBuyerOrderReferencedDocumentIssueDateTime(java.lang.String buyerOrderReferencedDocumentIssueDateTime)
```
    when the order (or whatever reference in BuyerOrderReferencedDocumentID) was issued (@todo switch to date?)
    
    Parameters:
    
    buyerOrderReferencedDocumentIssueDateTime - IssueDateTime in format CCYY-MM-DDTHH:MM:SS
    
    Returns:
    
    fluent setter
  - getOwnTaxID
```
public java.lang.String getOwnTaxID()
```
    Description copied from interface: IExportableTransaction
    
    Tax ID (not VAT ID) of the sender
    
    Specified by:
    
    getOwnTaxID in interface IExportableTransaction
    
    Returns:
    
    Tax ID (not VAT ID) of the sender
  - setOwnTaxID
```
@Deprecated
public Invoice setOwnTaxID(java.lang.String ownTaxID)
```
    Deprecated.
  - getOwnVATID
```
public java.lang.String getOwnVATID()
```
    Description copied from interface: IExportableTransaction
    
    VAT ID (Umsatzsteueridentifikationsnummer) of the sender
    
    Specified by:
    
    getOwnVATID in interface IExportableTransaction
    
    Returns:
    
    VAT ID (Umsatzsteueridentifikationsnummer) of the sender
  - setOwnVATID
```
@Deprecated
public Invoice setOwnVATID(java.lang.String ownVATID)
```
    Deprecated.
  - getOwnForeignOrganisationID
```
public java.lang.String getOwnForeignOrganisationID()
```
    Description copied from interface: IExportableTransaction
    
    supplier identification assigned by the costumer
    
    Specified by:
    
    getOwnForeignOrganisationID in interface IExportableTransaction
    
    Returns:
    
    the sender's identification
  - setOwnForeignOrganisationID
```
@Deprecated
public Invoice setOwnForeignOrganisationID(java.lang.String ownForeignOrganisationID)
```
    Deprecated.
  - getOwnOrganisationName
```
public java.lang.String getOwnOrganisationName()
```
    Description copied from interface: IExportableTransaction
    
    own name
    
    Specified by:
    
    getOwnOrganisationName in interface IExportableTransaction
    
    Returns:
    
    the sender's organisation name
  - setOwnOrganisationName
```
@Deprecated
public Invoice setOwnOrganisationName(java.lang.String ownOrganisationName)
```
    Deprecated.
  - getOwnStreet
```
public java.lang.String getOwnStreet()
```
    Description copied from interface: IExportableTransaction
    
    own street address
    
    Specified by:
    
    getOwnStreet in interface IExportableTransaction
    
    Returns:
    
    sender street address
  - getOwnZIP
```
public java.lang.String getOwnZIP()
```
    Description copied from interface: IExportableTransaction
    
    own street postal code
    
    Specified by:
    
    getOwnZIP in interface IExportableTransaction
    
    Returns:
    
    sender postal code
  - getOwnLocation
```
public java.lang.String getOwnLocation()
```
    Description copied from interface: IExportableTransaction
    
    own city
    
    Specified by:
    
    getOwnLocation in interface IExportableTransaction
    
    Returns:
    
    the invoice sender's city
  - getOwnCountry
```
public java.lang.String getOwnCountry()
```
    Description copied from interface: IExportableTransaction
    
    own two digit country code
    
    Specified by:
    
    getOwnCountry in interface IExportableTransaction
    
    Returns:
    
    the invoice senders two character country iso code
  - getNotes
```
public java.lang.String[] getNotes()
```
    Description copied from interface: IExportableTransaction
    
    additional text description
    
    Specified by:
    
    getNotes in interface IExportableTransaction
    
    Returns:
    
    an array of strings of document wide "includedNotes" (descriptive text values)
  - getNotesWithSubjectCode
```
public java.util.List<IncludedNote> getNotesWithSubjectCode()
```
    Description copied from interface: IExportableTransaction
    
    A grouping of business terms to indicate accounting-relevant free texts including a qualification of these. The information are written to the same xml nodes like IExportableTransaction.getNotes() but with explicit subjectCode.
    
    Specified by:
    
    getNotesWithSubjectCode in interface IExportableTransaction
    
    Returns:
    
    list of the notes
  - getCurrency
```
public java.lang.String getCurrency()
```
    Description copied from interface: IExportableTransaction
    
    get main invoice currency used on the invoice
    
    Specified by:
    
    getCurrency in interface IExportableTransaction
    
    Returns:
    
    three character currency of this invoice
  - setCurrency
```
public Invoice setCurrency(java.lang.String currency)
```
  - getPaymentTermDescription
```
public java.lang.String getPaymentTermDescription()
```
    Description copied from interface: IExportableTransaction
    
    get payment term descriptional text e.g. Bis zum 22.10.2015 ohne Abzug
    
    Specified by:
    
    getPaymentTermDescription in interface IExportableTransaction
    
    Returns:
    
    get payment terms
  - setPaymentTermDescription
```
public Invoice setPaymentTermDescription(java.lang.String paymentTermDescription)
```
  - getIssueDate
```
public java.util.Date getIssueDate()
```
    Description copied from interface: IExportableTransaction
    
    the date when the invoice was created
    
    Specified by:
    
    getIssueDate in interface IExportableTransaction
    
    Returns:
    
    when the invoice was created
  - setIssueDate
```
public Invoice setIssueDate(java.util.Date issueDate)
```
  - getDueDate
```
public java.util.Date getDueDate()
```
    Description copied from interface: IExportableTransaction
    
    when the invoice is to be paid
    
    Specified by:
    
    getDueDate in interface IExportableTransaction
    
    Returns:
    
    when the invoice is to be paid
  - setDueDate
```
public Invoice setDueDate(java.util.Date dueDate)
```
  - getDeliveryDate
```
public java.util.Date getDeliveryDate()
```
    Description copied from interface: IExportableTransaction
    
    get delivery date
    
    Specified by:
    
    getDeliveryDate in interface IExportableTransaction
    
    Returns:
    
    the day the goods have been delivered
  - setDeliveryDate
```
public Invoice setDeliveryDate(java.util.Date deliveryDate)
```
  - getSender
```
public TradeParty getSender()
```
    Description copied from interface: IExportableTransaction
    
    the sender of the invoice
    
    Specified by:
    
    getSender in interface IExportableTransaction
    
    Returns:
    
    the contact person at the supplier side
  - setOwnContact
```
@Deprecated
public Invoice setOwnContact(Contact ownContact)
```
    Deprecated. use setSender
    
    sets a named sender contact
    
    Parameters:
    
    ownContact - the sender contact
    
    Returns:
    
    fluent setter
    
    See Also:
    
    Contact
  - getRecipient
```
public TradeParty getRecipient()
```
    Description copied from interface: IExportableTransaction
    
    the recipient
    
    Specified by:
    
    getRecipient in interface IExportableTransaction
    
    Returns:
    
    the recipient of the invoice
  - setRecipient
```
public Invoice setRecipient(TradeParty recipient)
```
    required. sets the invoice receiving institution = invoicee
    
    Parameters:
    
    recipient - the invoicee organisation
    
    Returns:
    
    fluent setter
  - setSender
```
public Invoice setSender(TradeParty sender)
```
    required. sets the invoicing institution = invoicer
    
    Parameters:
    
    sender - the invoicer
    
    Returns:
    
    fluent setter
  - getZFAllowances
```
public IZUGFeRDAllowanceCharge[] getZFAllowances()
```
    Specified by:
    
    getZFAllowances in interface IExportableTransaction
  - getZFCharges
```
public IZUGFeRDAllowanceCharge[] getZFCharges()
```
    Specified by:
    
    getZFCharges in interface IExportableTransaction
  - getZFLogisticsServiceCharges
```
public IZUGFeRDAllowanceCharge[] getZFLogisticsServiceCharges()
```
    Specified by:
    
    getZFLogisticsServiceCharges in interface IExportableTransaction
  - getTradeSettlement
```
public IZUGFeRDTradeSettlement[] getTradeSettlement()
```
    Description copied from interface: IExportableTransaction
    
    the payment information for any payment means
    
    Specified by:
    
    getTradeSettlement in interface IExportableTransaction
    
    Returns:
    
    an array of IZUGFeRDTradeSettlement
  - getPaymentTerms
```
public IZUGFeRDPaymentTerms getPaymentTerms()
```
    Description copied from interface: IExportableTransaction
    
    get payment terms. if set, getPaymentTermDescription() and getDueDate() are ignored
    
    Specified by:
    
    getPaymentTerms in interface IExportableTransaction
    
    Returns:
    
    the IZUGFeRDPaymentTerms of the invoice
  - setPaymentTerms
```
public Invoice setPaymentTerms(IZUGFeRDPaymentTerms paymentTerms)
```
  - getDeliveryAddress
```
public TradeParty getDeliveryAddress()
```
    Description copied from interface: IExportableTransaction
    
    delivery address, i.e. ram:ShipToTradeParty (only supported for zf2)
    
    Specified by:
    
    getDeliveryAddress in interface IExportableTransaction
    
    Returns:
    
    the IZUGFeRDExportableTradeParty delivery address
  - setDeliveryAddress
```
public Invoice setDeliveryAddress(TradeParty deliveryAddress)
```
    if the delivery address is not the recipient address, it can be specified here
    
    Parameters:
    
    deliveryAddress - the goods receiving organisation
    
    Returns:
    
    fluent setter
  - addCashDiscount
```
public Invoice addCashDiscount(CashDiscount c)
```
    Adds a cash discount (skonto)
    
    Parameters:
    
    c - the CashDiscount percent/period combination
    
    Returns:
    
    fluent setter
  - getZFItems
```
public IZUGFeRDExportableItem[] getZFItems()
```
    Specified by:
    
    getZFItems in interface IExportableTransaction
    
    Returns:
    
    the invoice line items with the positions
  - setZFItems
```
public void setZFItems(java.util.ArrayList<IZUGFeRDExportableItem> ims)
```
  - addItem
```
public Invoice addItem(IZUGFeRDExportableItem item)
```
    required adds invoice "lines" :-)
    
    Parameters:
    
    item - the invoice line
    
    Returns:
    
    fluent setter
    
    See Also:
    
    Item
  - isValid
```
public boolean isValid()
```
    checks if all required items are set in order to be able to export it
    
    Returns:
    
    true if all required items are set
  - addCharge
```
public Invoice addCharge(IZUGFeRDAllowanceCharge izac)
```
    adds a document level addition to the price
    
    Parameters:
    
    izac - the charge to be applied
    
    Returns:
    
    fluent setter
    
    See Also:
    
    Charge
  - addAllowance
```
public Invoice addAllowance(IZUGFeRDAllowanceCharge izac)
```
    adds a document level rebate
    
    Parameters:
    
    izac - the allowance to be applied
    
    Returns:
    
    fluent setter
    
    See Also:
    
    Allowance
  - setContractReferencedDocument
```
public Invoice setContractReferencedDocument(java.lang.String s)
```
    adds the ID of a contract referenced in the invoice
    
    Parameters:
    
    s - the contract number
    
    Returns:
    
    fluent setter
  - setDetailedDeliveryPeriod
```
public Invoice setDetailedDeliveryPeriod(java.util.Date start,
                                         java.util.Date end)
```
    sets a document level delivery period, which is optional additional to the mandatory deliverydate and which will become a BillingSpecifiedPeriod-Element
    
    Parameters:
    
    start - the date of first delivery
    
    end - the date of last delivery
    
    Returns:
    
    fluent setter
  - getDetailedDeliveryPeriodFrom
```
public java.util.Date getDetailedDeliveryPeriodFrom()
```
    Description copied from interface: IExportableTransaction
    
    specifies the document level delivery period, will be included in a BillingSpecifiedPeriod element
    
    Specified by:
    
    getDetailedDeliveryPeriodFrom in interface IExportableTransaction
    
    Returns:
    
    the beginning of the delivery period
  - getDetailedDeliveryPeriodTo
```
public java.util.Date getDetailedDeliveryPeriodTo()
```
    Description copied from interface: IExportableTransaction
    
    specifies the document level delivery period, will be included in a BillingSpecifiedPeriod element
    
    Specified by:
    
    getDetailedDeliveryPeriodTo in interface IExportableTransaction
    
    Returns:
    
    the end of the delivery period
  - addNote
```
public Invoice addNote(java.lang.String text)
```
    adds a free text paragraph, which will become an includedNote element
    
    Parameters:
    
    text - freeform UTF8 plain text
    
    Returns:
    
    fluent setter
  - addNotes
```
public Invoice addNotes(java.util.Collection<IncludedNote> notes)
```
  - addGeneralNote
```
public Invoice addGeneralNote(java.lang.String content)
```
    adds a free text paragraph, which will become an includedNote element with explicit subjectCode SubjectCode.AAI
    
    Parameters:
    
    content - freeform UTF8 plain text
    
    Returns:
    
    fluent setter
  - addRegulatoryNote
```
public Invoice addRegulatoryNote(java.lang.String content)
```
    adds a free text paragraph, which will become an includedNote element with explicit subjectCode SubjectCode.REG
    
    Parameters:
    
    content - freeform UTF8 plain text
    
    Returns:
    
    fluent setter
  - addLegalNote
```
public Invoice addLegalNote(java.lang.String content)
```
    adds a free text paragraph, which will become an includedNote element with explicit subjectCode SubjectCode.ABL
    
    Parameters:
    
    content - freeform UTF8 plain text
    
    Returns:
    
    fluent setter
  - addCustomsNote
```
public Invoice addCustomsNote(java.lang.String content)
```
    adds a free text paragraph, which will become an includedNote element with explicit subjectCode SubjectCode.CUS
    
    Parameters:
    
    content - freeform UTF8 plain text
    
    Returns:
    
    fluent setter
  - addSellerNote
```
public Invoice addSellerNote(java.lang.String content)
```
    adds a free text paragraph, which will become an includedNote element with explicit subjectCode SubjectCode.SUR
    
    Parameters:
    
    content - freeform UTF8 plain text
    
    Returns:
    
    fluent setter
  - addTaxNote
```
public Invoice addTaxNote(java.lang.String content)
```
    adds a free text paragraph, which will become an includedNote element with explicit subjectCode SubjectCode.TXD
    
    Parameters:
    
    content - freeform UTF8 plain text
    
    Returns:
    
    fluent setter
  - addIntroductionNote
```
public Invoice addIntroductionNote(java.lang.String content)
```
    adds a free text paragraph, which will become an includedNote element with explicit subjectCode SubjectCode.ACY
    
    Parameters:
    
    content - freeform UTF8 plain text
    
    Returns:
    
    fluent setter
  - addDiscountBonusNote
```
public Invoice addDiscountBonusNote(java.lang.String content)
```
    adds a free text paragraph, which will become an includedNote element with explicit subjectCode SubjectCode.AAK
    
    Parameters:
    
    content - freeform UTF8 plain text
    
    Returns:
    
    fluent setter
  - getSpecifiedProcuringProjectID
```
public java.lang.String getSpecifiedProcuringProjectID()
```
    Specified by:
    
    getSpecifiedProcuringProjectID in interface IExportableTransaction
  - setSpecifiedProcuringProjectID
```
public Invoice setSpecifiedProcuringProjectID(java.lang.String specifiedProcuringProjectID)
```
  - getDespatchAdviceReferencedDocumentID
```
public java.lang.String getDespatchAdviceReferencedDocumentID()
```
    Specified by:
    
    getDespatchAdviceReferencedDocumentID in interface IExportableTransaction
  - setDespatchAdviceReferencedDocumentID
```
public Invoice setDespatchAdviceReferencedDocumentID(java.lang.String despatchAdviceReferencedDocumentID)
```
  - getSpecifiedProcuringProjectName
```
public java.lang.String getSpecifiedProcuringProjectName()
```
    Specified by:
    
    getSpecifiedProcuringProjectName in interface IExportableTransaction
  - setSpecifiedProcuringProjectName
```
public Invoice setSpecifiedProcuringProjectName(java.lang.String specifiedProcuringProjectName)
```
  - getVATDueDateTypeCode
```
public java.lang.String getVATDueDateTypeCode()
```
    Specified by:
    
    getVATDueDateTypeCode in interface IExportableTransaction
  - setVATDueDateTypeCode
```
public Invoice setVATDueDateTypeCode(java.lang.String vatDueDateTypeCode)
```
    Decide when the VAT should be collected.
    
    Parameters:
    
    vatDueDateTypeCode - use EventTimeCodeTypeConstants
    
    Returns:
    
    fluent setter

Class Invoice

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.mustangproject.ZUGFeRD.IExportableTransaction

Field Detail

documentName

documentCode

number

ownOrganisationFullPlaintextInfo

referenceNumber

shipToOrganisationID

shipToOrganisationName

shipToStreet

shipToZIP

shipToLocation

shipToCountry

buyerOrderReferencedDocumentID

invoiceReferencedDocumentID

buyerOrderReferencedDocumentIssueDateTime

ownForeignOrganisationID

ownOrganisationName

currency

paymentTermDescription

issueDate

dueDate

deliveryDate

sender

recipient

deliveryAddress

cashDiscounts

ZFItems

notes

sellerOrderReferencedDocumentID

contractReferencedDocument

xmlEmbeddedFiles

totalPrepaidAmount

detailedDeliveryDateStart

detailedDeliveryPeriodEnd

Allowances

Charges

LogisticsServiceCharges

paymentTerms

invoiceReferencedIssueDate

specifiedProcuringProjectID

specifiedProcuringProjectName

despatchAdviceReferencedDocumentID

vatDueDateTypeCode

Constructor Detail

Invoice

Method Detail

getDocumentName

getContractReferencedDocument

setDocumentName

getDocumentCode

setDocumentCode

embedFileInXML

getAdditionalReferencedDocuments

getCashDiscounts

getNumber

setNumber

setCorrection

setCreditNote

getOwnOrganisationFullPlaintextInfo

setOwnOrganisationFullPlaintextInfo

getReferenceNumber

setReferenceNumber

getShipToOrganisationID

setShipToOrganisationID

getShipToOrganisationName

setShipToOrganisationName

getShipToStreet

setShipToStreet

getShipToZIP

setShipToZIP

getShipToLocation

setShipToLocation

getShipToCountry

setShipToCountry