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

java.lang.Object
- org.mustangproject.ZUGFeRD.ZUGFeRDImporter

Direct Known Subclasses:

XRechnungImporter, ZUGFeRDInvoiceImporter
```
public class ZUGFeRDImporter
extends java.lang.Object
```

Field Summary

Fields
Modifier and Type Field and Description

protected boolean containsMeta
if metadata has been found

Fields
Modifier and Type	Field and Description
`protected boolean`	`containsMeta` if metadata has been found

Constructor Summary

Constructors
Modifier Constructor and Description

protected ZUGFeRDImporter()

ZUGFeRDImporter(java.io.InputStream pdfStream)

ZUGFeRDImporter(java.lang.String pdfFilename)

Constructors
Modifier	Constructor and Description
`protected`	`ZUGFeRDImporter()`
	`ZUGFeRDImporter(java.io.InputStream pdfStream)`
	`ZUGFeRDImporter(java.lang.String pdfFilename)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canParse()` will return true if the metadata (just extract-ed or set with setMeta) contains ZUGFeRD XML
`boolean`	`containsMeta()`
`protected java.lang.String`	`extractString(java.lang.String xpathStr)`
`java.util.HashMap<java.lang.String,byte[]>`	`getAdditionalData()`
`java.lang.String`	`getAmount()`
`java.lang.String`	`getBankName()`
`java.lang.String`	`getBIC()`
`PostalTradeAddress`	`getBuyerTradePartyAddress()` returns an instance of PostalTradeAddress for SellerTradeParty section
`java.lang.String`	`getBuyerTradePartyGlobalID()`
`java.lang.String`	`getBuyerTradePartyID()`
`java.lang.String`	`getBuyerTradePartyName()`
`java.lang.String`	`getBuyertradePartySpecifiedTaxRegistrationID()`
`java.lang.String`	`getContractOrderReferencedDocumentIssuerAssignedID()`
`PostalTradeAddress`	`getDeliveryTradePartyAddress()` returns an instance of PostalTradeAddress for ShipToTradeParty section
`java.lang.String`	`getDeliveryTradePartyName()`
`java.util.Date`	`getDetailedDeliveryPeriodFrom()`
`java.util.Date`	`getDetailedDeliveryPeriodTo()`
`protected org.w3c.dom.Document`	`getDocument()`
`java.lang.String`	`getDocumentCode()`
`java.lang.String`	`getDueDate()`
`java.lang.String`	`getForeignReference()`
`java.lang.String`	`getHolder()`
`java.lang.String`	`getIBAN()`
`java.lang.String`	`getIncludedNote()`
`java.lang.String`	`getInvoiceCurrencyCode()`
`java.lang.String`	`getInvoiceID()`
`java.lang.String`	`getIssueDate()`
`java.lang.String`	`getIssuerAssignedID()`
`java.util.List<Item>`	`getLineItemList()` returns a list of LineItems
`java.util.List<org.w3c.dom.Node>`	`getLineItemNodes()` returns a List of LineItem Nodes from ZUGFeRD XML
`java.lang.String`	`getLineTotalAmount()`
`java.lang.String`	`getMeta()`
`org.w3c.dom.NodeList`	`getNodeListByPath(java.lang.String path)` Get a NodeList by providing an path
`java.lang.String`	`getPaidAmount()`
`java.lang.String`	`getPaymentTerms()`
`byte[]`	`getRawXML()` Returns the raw XML data as extracted from the ZUGFeRD PDF file.
`java.lang.String`	`getReference()`
`java.lang.String`	`getRoundingAmount()`
`java.lang.String`	`getSellerOrderReferencedDocumentIssuerAssignedID()`
`PostalTradeAddress`	`getSellerTradePartyAddress()` returns an instance of PostalTradeAddress for SellerTradeParty section
`java.lang.String`	`getSellerTradePartyGlobalID()`
`EStandard`	`getStandard()`
`java.lang.String`	`getTaxBasisTotalAmount()`
`java.lang.String`	`getTaxPointDate()`
`java.lang.String`	`getTaxTotalAmount()`
`java.lang.String`	`getUTF8()`
`int`	`getVersion()`
`java.lang.String`	`getXMP()` get xmp metadata of the PDF, null if not available
`java.lang.String`	`getZUGFeRDProfil()`
`void`	`setMeta(java.lang.String meta)`
`void`	`setRawXML(byte[] rawXML)`
`java.lang.String`	`wExtractString(java.lang.String xpathStr)` Wrapper for protected method extractString

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

- Field Detail
  - containsMeta
```
protected boolean containsMeta
```
    if metadata has been found
- Constructor Detail
  - ZUGFeRDImporter
```
protected ZUGFeRDImporter()
```
  - ZUGFeRDImporter
```
public ZUGFeRDImporter(java.lang.String pdfFilename)
```
  - ZUGFeRDImporter
```
public ZUGFeRDImporter(java.io.InputStream pdfStream)
```
- Method Detail
  - getDocument
```
protected org.w3c.dom.Document getDocument()
```
  - setRawXML
```
public void setRawXML(byte[] rawXML)
               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - extractString
```
protected java.lang.String extractString(java.lang.String xpathStr)
```
  - wExtractString
```
public java.lang.String wExtractString(java.lang.String xpathStr)
```
    Wrapper for protected method extractString
    
    Parameters:
    
    xpathStr - the xpath expression to be evaluated
    
    Returns:
    
    the extracted String for the specific path in the document
  - getForeignReference
```
public java.lang.String getForeignReference()
```
    Returns:
    
    the reference (purpose) the sender specified for this invoice
  - getZUGFeRDProfil
```
public java.lang.String getZUGFeRDProfil()
```
    Returns:
    
    the ZUGFeRD Profile
  - getInvoiceCurrencyCode
```
public java.lang.String getInvoiceCurrencyCode()
```
    Returns:
    
    the Invoice Currency Code
  - getIssuerAssignedID
```
public java.lang.String getIssuerAssignedID()
```
    Returns:
    
    the IssuerAssigned ID
  - getSellerOrderReferencedDocumentIssuerAssignedID
```
public java.lang.String getSellerOrderReferencedDocumentIssuerAssignedID()
```
    Returns:
    
    the SellerOrderReferencedDocument IssuerAssigned ID
  - getContractOrderReferencedDocumentIssuerAssignedID
```
public java.lang.String getContractOrderReferencedDocumentIssuerAssignedID()
```
    Returns:
    
    the IssuerAssigned ID
  - getBuyerTradePartyID
```
public java.lang.String getBuyerTradePartyID()
```
    Returns:
    
    the BuyerTradeParty ID
  - getIssueDate
```
public java.lang.String getIssueDate()
```
    Returns:
    
    the Issue Date()
  - getDetailedDeliveryPeriodFrom
```
public java.util.Date getDetailedDeliveryPeriodFrom()
```
  - getDetailedDeliveryPeriodTo
```
public java.util.Date getDetailedDeliveryPeriodTo()
```
  - getTaxBasisTotalAmount
```
public java.lang.String getTaxBasisTotalAmount()
```
    Returns:
    
    the TaxBasisTotalAmount
  - getTaxTotalAmount
```
public java.lang.String getTaxTotalAmount()
```
    Returns:
    
    the TaxTotalAmount
  - getRoundingAmount
```
public java.lang.String getRoundingAmount()
```
    Returns:
    
    the RoundingAmount
  - getPaidAmount
```
public java.lang.String getPaidAmount()
```
    Returns:
    
    the TotalPrepaidAmount
  - getSellerTradePartyGlobalID
```
public java.lang.String getSellerTradePartyGlobalID()
```
    Returns:
    
    SellerTradeParty GlobalID
  - getBuyerTradePartyGlobalID
```
public java.lang.String getBuyerTradePartyGlobalID()
```
    Returns:
    
    the BuyerTradeParty GlobalID
  - getBuyertradePartySpecifiedTaxRegistrationID
```
public java.lang.String getBuyertradePartySpecifiedTaxRegistrationID()
```
    Returns:
    
    the BuyerTradeParty SpecifiedTaxRegistration ID
  - getIncludedNote
```
public java.lang.String getIncludedNote()
```
    Returns:
    
    the IncludedNote
  - getBuyerTradePartyName
```
public java.lang.String getBuyerTradePartyName()
```
    Returns:
    
    the BuyerTradeParty Name
  - getDeliveryTradePartyName
```
public java.lang.String getDeliveryTradePartyName()
```
    Returns:
    
    the BuyerTradeParty Name
  - getLineTotalAmount
```
public java.lang.String getLineTotalAmount()
```
    Returns:
    
    the line Total Amount
  - getPaymentTerms
```
public java.lang.String getPaymentTerms()
```
    Returns:
    
    the Payment Terms
  - getTaxPointDate
```
public java.lang.String getTaxPointDate()
```
    Returns:
    
    the Taxpoint Date
  - getInvoiceID
```
public java.lang.String getInvoiceID()
```
    Returns:
    
    the Invoice ID
  - getDocumentCode
```
public java.lang.String getDocumentCode()
```
    Returns:
    
    the document code
  - getReference
```
public java.lang.String getReference()
```
    Returns:
    
    the referred document
  - getBIC
```
public java.lang.String getBIC()
```
    Returns:
    
    the sender's bank's BIC code
  - getBankName
```
public java.lang.String getBankName()
```
    Returns:
    
    the sender's bank name
  - getIBAN
```
public java.lang.String getIBAN()
```
    Returns:
    
    the sender's account IBAN code
  - getHolder
```
public java.lang.String getHolder()
```
  - getAmount
```
public java.lang.String getAmount()
```
    Returns:
    
    the total payable amount
  - getDueDate
```
public java.lang.String getDueDate()
```
    Returns:
    
    when the payment is due
  - getAdditionalData
```
public java.util.HashMap<java.lang.String,byte[]> getAdditionalData()
```
  - getXMP
```
public java.lang.String getXMP()
```
    get xmp metadata of the PDF, null if not available
    
    Returns:
    
    string
  - containsMeta
```
public boolean containsMeta()
```
    Returns:
    
    if export found parseable ZUGFeRD data
  - setMeta
```
public void setMeta(java.lang.String meta)
             throws java.io.IOException
```
    Parameters:
    
    meta - raw XML to be set
    
    Throws:
    
    java.io.IOException - if raw can not be set
  - getMeta
```
public java.lang.String getMeta()
```
    Returns:
    
    raw XML of the invoice
  - getStandard
```
public EStandard getStandard()
                      throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getVersion
```
public int getVersion()
               throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getUTF8
```
public java.lang.String getUTF8()
```
    Returns:
    
    return UTF8 XML (without BOM) of the invoice
  - getRawXML
```
public byte[] getRawXML()
```
    Returns the raw XML data as extracted from the ZUGFeRD PDF file.
    
    Returns:
    
    the raw ZUGFeRD XML data
  - canParse
```
public boolean canParse()
```
    will return true if the metadata (just extract-ed or set with setMeta) contains ZUGFeRD XML
    
    Returns:
    
    true if the invoice contains ZUGFeRD XML
  - getBuyerTradePartyAddress
```
public PostalTradeAddress getBuyerTradePartyAddress()
```
    returns an instance of PostalTradeAddress for SellerTradeParty section
    
    Returns:
    
    an instance of PostalTradeAddress
  - getSellerTradePartyAddress
```
public PostalTradeAddress getSellerTradePartyAddress()
```
    returns an instance of PostalTradeAddress for SellerTradeParty section
    
    Returns:
    
    an instance of PostalTradeAddress
  - getDeliveryTradePartyAddress
```
public PostalTradeAddress getDeliveryTradePartyAddress()
```
    returns an instance of PostalTradeAddress for ShipToTradeParty section
    
    Returns:
    
    an instance of PostalTradeAddress
  - getLineItemList
```
public java.util.List<Item> getLineItemList()
```
    returns a list of LineItems
    
    Returns:
    
    a List of LineItem instances
  - getLineItemNodes
```
public java.util.List<org.w3c.dom.Node> getLineItemNodes()
```
    returns a List of LineItem Nodes from ZUGFeRD XML
    
    Returns:
    
    a List of Node instances
  - getNodeListByPath
```
public org.w3c.dom.NodeList getNodeListByPath(java.lang.String path)
```
    Get a NodeList by providing an path
    
    Parameters:
    
    path - a compliable Path
    
    Returns:
    
    a Nodelist or null, if an error occurs

Class ZUGFeRDImporter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

containsMeta

Constructor Detail

ZUGFeRDImporter

ZUGFeRDImporter

ZUGFeRDImporter

Method Detail

getDocument

setRawXML

extractString

wExtractString

getForeignReference

getZUGFeRDProfil

getInvoiceCurrencyCode

getIssuerAssignedID

getSellerOrderReferencedDocumentIssuerAssignedID

getContractOrderReferencedDocumentIssuerAssignedID

getBuyerTradePartyID

getIssueDate

getDetailedDeliveryPeriodFrom

getDetailedDeliveryPeriodTo

getTaxBasisTotalAmount

getTaxTotalAmount

getRoundingAmount

getPaidAmount

getSellerTradePartyGlobalID

getBuyerTradePartyGlobalID

getBuyertradePartySpecifiedTaxRegistrationID

getIncludedNote

getBuyerTradePartyName

getDeliveryTradePartyName

getLineTotalAmount

getPaymentTerms

getTaxPointDate

getInvoiceID

getDocumentCode

getReference

getBIC

getBankName

getIBAN

getHolder

getAmount

getDueDate

getAdditionalData

getXMP

containsMeta

setMeta

getMeta

getStandard

getVersion

getUTF8

getRawXML

canParse

getBuyerTradePartyAddress

getSellerTradePartyAddress

getDeliveryTradePartyAddress

getLineItemList

getLineItemNodes

getNodeListByPath