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

All Known Implementing Classes:

Invoice
```
public interface IExportableTransaction
```
the interface of an transaction, e.g. an invoice, you want to create xml (potentially to be added to a PDF) for

See Also:

Invoice

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default FileAttachment[]`	`getAdditionalReferencedDocuments()` get additional referenced documents acccording to BG-24 XRechnung (Rechnungsbegruendende Unterlagen), i.e.
`default java.lang.String`	`getBuyerOrderReferencedDocumentID()` get the ID of the BuyerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement
`default java.lang.String`	`getBuyerOrderReferencedDocumentIssueDateTime()` get the issue timestamp of the BuyerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement
`default java.lang.String`	`getContractReferencedDocument()`
`default java.lang.String`	`getCurrency()` get main invoice currency used on the invoice
`default IZUGFeRDExportableTradeParty`	`getDeliveryAddress()` delivery address, i.e. ram:ShipToTradeParty (only supported for zf2)
`java.util.Date`	`getDeliveryDate()` get delivery date
`default java.lang.String`	`getDespatchAdviceReferencedDocumentID()`
`default java.util.Date`	`getDetailedDeliveryPeriodFrom()` specifies the document level delivery period, will be included in a BillingSpecifiedPeriod element
`default java.util.Date`	`getDetailedDeliveryPeriodTo()` specifies the document level delivery period, will be included in a BillingSpecifiedPeriod element
`default java.lang.String`	`getDocumentCode()`
`default java.lang.String`	`getDocumentName()` appears in /rsm:CrossIndustryDocument/rsm:HeaderExchangedDocument/ram:Name
`default java.util.Date`	`getDueDate()` when the invoice is to be paid
`default java.lang.String`	`getInvoiceReferencedDocumentID()` get the ID of the preceding invoice, which is e.g. to be corrected if this is a correction
`default java.util.Date`	`getInvoiceReferencedIssueDate()`
`default java.util.Date`	`getIssueDate()` the date when the invoice was created
`default java.lang.String[]`	`getNotes()` additional text description
`default java.lang.String`	`getNumber()` Number, typically invoice number of the invoice
`default java.lang.String`	`getOwnCountry()` own two digit country code
`default java.lang.String`	`getOwnForeignOrganisationID()` supplier identification assigned by the costumer
`default java.lang.String`	`getOwnLocation()` own city
`default java.lang.String`	`getOwnOrganisationFullPlaintextInfo()` this should be the full sender institution name, details, manager and tax registration.
`default java.lang.String`	`getOwnOrganisationName()` own name
`default java.lang.String`	`getOwnStreet()` own street address
`default java.lang.String`	`getOwnTaxID()` Tax ID (not VAT ID) of the sender
`default java.lang.String`	`getOwnVATID()` VAT ID (Umsatzsteueridentifikationsnummer) of the sender
`default java.lang.String`	`getOwnZIP()` own street postal code
`default java.lang.String`	`getPaymentTermDescription()` get payment term descriptional text e.g.
`default IZUGFeRDPaymentTerms`	`getPaymentTerms()` get payment terms. if set, getPaymentTermDescription() and getDueDate() are ignored
`IZUGFeRDExportableTradeParty`	`getRecipient()` the recipient
`default java.lang.String`	`getReferenceNumber()` get reference document number typically used for Invoice Corrections Will be added as IncludedNote in comfort profile
`default java.lang.String`	`getSellerOrderReferencedDocumentID()` get the ID of the SellerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement/ApplicableHeaderTradeAgreement
`default IZUGFeRDExportableTradeParty`	`getSender()` the sender of the invoice
`default java.lang.String`	`getShipToCountry()` consignee two digit country code (country code of the organisation the goods are shipped to)
`default java.lang.String`	`getShipToLocation()` consignee city (city of the organisation the goods are shipped to)
`default java.lang.String`	`getShipToOrganisationID()` consignee identification (identification of the organisation the goods are shipped to [assigned by the costumer])
`default java.lang.String`	`getShipToOrganisationName()` consignee name (name of the organisation the goods are shipped to)
`default java.lang.String`	`getShipToStreet()` consignee street address (street of the organisation the goods are shipped to)
`default java.lang.String`	`getShipToZIP()` consignee street postal code (postal code of the organisation the goods are shipped to)
`default java.lang.String`	`getSpecifiedProcuringProjectID()`
`default java.lang.String`	`getSpecifiedProcuringProjectName()`
`default java.lang.String`	`getSubjectNote()` subject of the document e.g. invoice and order number as human readable text
`default java.math.BigDecimal`	`getTotalPrepaidAmount()` get the TotalPrepaidAmount located in SpecifiedTradeSettlementMonetarySummation (v1) or SpecifiedTradeSettlementHeaderMonetarySummation (v2)
`default IZUGFeRDTradeSettlement[]`	`getTradeSettlement()` the payment information for any payment means
`default IZUGFeRDTradeSettlementPayment[]`	`getTradeSettlementPayment()` Deprecated. use getTradeSettlement
`default java.lang.String`	`getVATDueDateTypeCode()`
`default IZUGFeRDAllowanceCharge[]`	`getZFAllowances()`
`default IZUGFeRDAllowanceCharge[]`	`getZFCharges()`
`IZUGFeRDExportableItem[]`	`getZFItems()`
`default IZUGFeRDAllowanceCharge[]`	`getZFLogisticsServiceCharges()`
`default boolean`	`rebateAgreementExists()` returns if a rebate agreements exists

- Method Detail
  - getDocumentName
```
default java.lang.String getDocumentName()
```
    appears in /rsm:CrossIndustryDocument/rsm:HeaderExchangedDocument/ram:Name
    
    Returns:
    
    Name of document
  - getDocumentCode
```
default java.lang.String getDocumentCode()
```
    Returns:
    
    Code number of Document type, e.g. "380" for invoiceF
  - getNumber
```
default java.lang.String getNumber()
```
    Number, typically invoice number of the invoice
    
    Returns:
    
    invoice number
  - getIssueDate
```
default java.util.Date getIssueDate()
```
    the date when the invoice was created
    
    Returns:
    
    when the invoice was created
  - getOwnOrganisationFullPlaintextInfo
```
default java.lang.String getOwnOrganisationFullPlaintextInfo()
```
    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
    
    Returns:
    
    null or full sender institution name, details, manager and tax registration
  - getDueDate
```
default java.util.Date getDueDate()
```
    when the invoice is to be paid
    
    Returns:
    
    when the invoice is to be paid
  - getContractReferencedDocument
```
default java.lang.String getContractReferencedDocument()
```
  - getSender
```
default IZUGFeRDExportableTradeParty getSender()
```
    the sender of the invoice
    
    Returns:
    
    the contact person at the supplier side
  - getSubjectNote
```
default java.lang.String getSubjectNote()
```
    subject of the document e.g. invoice and order number as human readable text
    
    Returns:
    
    string with document subject
  - getZFAllowances
```
default IZUGFeRDAllowanceCharge[] getZFAllowances()
```
  - getZFCharges
```
default IZUGFeRDAllowanceCharge[] getZFCharges()
```
  - getZFLogisticsServiceCharges
```
default IZUGFeRDAllowanceCharge[] getZFLogisticsServiceCharges()
```
  - getZFItems
```
IZUGFeRDExportableItem[] getZFItems()
```
  - getRecipient
```
IZUGFeRDExportableTradeParty getRecipient()
```
    the recipient
    
    Returns:
    
    the recipient of the invoice
  - getTradeSettlementPayment
```
@Deprecated
default IZUGFeRDTradeSettlementPayment[] getTradeSettlementPayment()
```
    Deprecated. use getTradeSettlement
    
    the creditors payment informations
    
    Returns:
    
    an array of IZUGFeRDTradeSettlementPayment
  - getTradeSettlement
```
default IZUGFeRDTradeSettlement[] getTradeSettlement()
```
    the payment information for any payment means
    
    Returns:
    
    an array of IZUGFeRDTradeSettlement
  - getOwnTaxID
```
default java.lang.String getOwnTaxID()
```
    Tax ID (not VAT ID) of the sender
    
    Returns:
    
    Tax ID (not VAT ID) of the sender
  - getOwnVATID
```
default java.lang.String getOwnVATID()
```
    VAT ID (Umsatzsteueridentifikationsnummer) of the sender
    
    Returns:
    
    VAT ID (Umsatzsteueridentifikationsnummer) of the sender
  - getOwnForeignOrganisationID
```
default java.lang.String getOwnForeignOrganisationID()
```
    supplier identification assigned by the costumer
    
    Returns:
    
    the sender's identification
  - getOwnOrganisationName
```
default java.lang.String getOwnOrganisationName()
```
    own name
    
    Returns:
    
    the sender's organisation name
  - getOwnStreet
```
default java.lang.String getOwnStreet()
```
    own street address
    
    Returns:
    
    sender street address
  - getOwnZIP
```
default java.lang.String getOwnZIP()
```
    own street postal code
    
    Returns:
    
    sender postal code
  - getOwnLocation
```
default java.lang.String getOwnLocation()
```
    own city
    
    Returns:
    
    the invoice sender's city
  - getOwnCountry
```
default java.lang.String getOwnCountry()
```
    own two digit country code
    
    Returns:
    
    the invoice senders two character country iso code
  - getDeliveryDate
```
java.util.Date getDeliveryDate()
```
    get delivery date
    
    Returns:
    
    the day the goods have been delivered
  - getCurrency
```
default java.lang.String getCurrency()
```
    get main invoice currency used on the invoice
    
    Returns:
    
    three character currency of this invoice
  - getPaymentTermDescription
```
default java.lang.String getPaymentTermDescription()
```
    get payment term descriptional text e.g. Bis zum 22.10.2015 ohne Abzug
    
    Returns:
    
    get payment terms
  - getPaymentTerms
```
default IZUGFeRDPaymentTerms getPaymentTerms()
```
    get payment terms. if set, getPaymentTermDescription() and getDueDate() are ignored
    
    Returns:
    
    the IZUGFeRDPaymentTerms of the invoice
  - rebateAgreementExists
```
default boolean rebateAgreementExists()
```
    returns if a rebate agreements exists
    
    Returns:
    
    true if a agreement exists
  - getReferenceNumber
```
default java.lang.String getReferenceNumber()
```
    get reference document number typically used for Invoice Corrections Will be added as IncludedNote in comfort profile
    
    Returns:
    
    the ID of the document this document refers to
  - getShipToOrganisationID
```
default java.lang.String getShipToOrganisationID()
```
    consignee identification (identification of the organisation the goods are shipped to [assigned by the costumer])
    
    Returns:
    
    the sender's identification
  - getShipToOrganisationName
```
default java.lang.String getShipToOrganisationName()
```
    consignee name (name of the organisation the goods are shipped to)
    
    Returns:
    
    the consignee's organisation name
  - getShipToStreet
```
default java.lang.String getShipToStreet()
```
    consignee street address (street of the organisation the goods are shipped to)
    
    Returns:
    
    consignee street address
  - getShipToZIP
```
default java.lang.String getShipToZIP()
```
    consignee street postal code (postal code of the organisation the goods are shipped to)
    
    Returns:
    
    consignee postal code
  - getShipToLocation
```
default java.lang.String getShipToLocation()
```
    consignee city (city of the organisation the goods are shipped to)
    
    Returns:
    
    the consignee's city
  - getShipToCountry
```
default java.lang.String getShipToCountry()
```
    consignee two digit country code (country code of the organisation the goods are shipped to)
    
    Returns:
    
    the consignee's two character country iso code
  - getSellerOrderReferencedDocumentID
```
default java.lang.String getSellerOrderReferencedDocumentID()
```
    get the ID of the SellerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement/ApplicableHeaderTradeAgreement
    
    Returns:
    
    the ID of the document
  - getBuyerOrderReferencedDocumentID
```
default java.lang.String getBuyerOrderReferencedDocumentID()
```
    get the ID of the BuyerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement
    
    Returns:
    
    the ID of the document
  - getInvoiceReferencedDocumentID
```
default java.lang.String getInvoiceReferencedDocumentID()
```
    get the ID of the preceding invoice, which is e.g. to be corrected if this is a correction
    
    Returns:
    
    the ID of the document
  - getInvoiceReferencedIssueDate
```
default java.util.Date getInvoiceReferencedIssueDate()
```
  - getBuyerOrderReferencedDocumentIssueDateTime
```
default java.lang.String getBuyerOrderReferencedDocumentIssueDateTime()
```
    get the issue timestamp of the BuyerOrderReferencedDocument, which sits in the ApplicableSupplyChainTradeAgreement
    
    Returns:
    
    the IssueDateTime in format CCYY-MM-DDTHH:MM:SS
  - getTotalPrepaidAmount
```
default java.math.BigDecimal getTotalPrepaidAmount()
```
    get the TotalPrepaidAmount located in SpecifiedTradeSettlementMonetarySummation (v1) or SpecifiedTradeSettlementHeaderMonetarySummation (v2)
    
    Returns:
    
    the total sum (incl. VAT) of prepayments, i.e. the difference between GrandTotalAmount and DuePayableAmount
  - getDeliveryAddress
```
default IZUGFeRDExportableTradeParty getDeliveryAddress()
```
    delivery address, i.e. ram:ShipToTradeParty (only supported for zf2)
    
    Returns:
    
    the IZUGFeRDExportableTradeParty delivery address
  - getDetailedDeliveryPeriodFrom
```
default java.util.Date getDetailedDeliveryPeriodFrom()
```
    specifies the document level delivery period, will be included in a BillingSpecifiedPeriod element
    
    Returns:
    
    the beginning of the delivery period
  - getDetailedDeliveryPeriodTo
```
default java.util.Date getDetailedDeliveryPeriodTo()
```
    specifies the document level delivery period, will be included in a BillingSpecifiedPeriod element
    
    Returns:
    
    the end of the delivery period
  - getAdditionalReferencedDocuments
```
default FileAttachment[] getAdditionalReferencedDocuments()
```
    get additional referenced documents acccording to BG-24 XRechnung (Rechnungsbegruendende Unterlagen), i.e. ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument
    
    Returns:
    
    a array of objects from class FileAttachment
  - getDespatchAdviceReferencedDocumentID
```
default java.lang.String getDespatchAdviceReferencedDocumentID()
```
  - getNotes
```
default java.lang.String[] getNotes()
```
    additional text description
    
    Returns:
    
    an array of strings of document wide "includedNotes" (descriptive text values)
  - getSpecifiedProcuringProjectName
```
default java.lang.String getSpecifiedProcuringProjectName()
```
  - getSpecifiedProcuringProjectID
```
default java.lang.String getSpecifiedProcuringProjectID()
```
  - getVATDueDateTypeCode
```
default java.lang.String getVATDueDateTypeCode()
```

Interface IExportableTransaction

Method Summary

Method Detail

getDocumentName

getDocumentCode

getNumber

getIssueDate

getOwnOrganisationFullPlaintextInfo

getDueDate

getContractReferencedDocument

getSender

getSubjectNote

getZFAllowances

getZFCharges

getZFLogisticsServiceCharges

getZFItems

getRecipient

getTradeSettlementPayment

getTradeSettlement

getOwnTaxID

getOwnVATID

getOwnForeignOrganisationID

getOwnOrganisationName

getOwnStreet

getOwnZIP

getOwnLocation

getOwnCountry

getDeliveryDate

getCurrency

getPaymentTermDescription

getPaymentTerms

rebateAgreementExists

getReferenceNumber

getShipToOrganisationID

getShipToOrganisationName

getShipToStreet

getShipToZIP

getShipToLocation

getShipToCountry

getSellerOrderReferencedDocumentID

getBuyerOrderReferencedDocumentID

getInvoiceReferencedDocumentID

getInvoiceReferencedIssueDate

getBuyerOrderReferencedDocumentIssueDateTime

getTotalPrepaidAmount

getDeliveryAddress

getDetailedDeliveryPeriodFrom

getDetailedDeliveryPeriodTo

getAdditionalReferencedDocuments

getDespatchAdviceReferencedDocumentID

getNotes

getSpecifiedProcuringProjectName

getSpecifiedProcuringProjectID

getVATDueDateTypeCode