Package org.mustangproject.ZUGFeRD

Interface IExportableTransaction

  • All Known Implementing Classes:
    CalculatedInvoice, 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 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 It is written as an includedNode with subjectCode SubjectCode.REG. See also getNotesWithSubjectCode()
        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()

      • 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

      • 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

      • getTenderReferencedDocument

        default IReferencedDocument getTenderReferencedDocument()
        BT-17 tender or lot reference
        Returns:
        mandatory ID, optional Date

      • 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

      • getPaymentReference

        default java.lang.String getPaymentReference()

      • getExtendedPaymentTerms

        default IZUGFeRDPaymentTerms[] getExtendedPaymentTerms()
        Get payment terms for the EXTENDED profile (multiple terms are allowed)
        Returns:

      • rebateAgreementExists

        default boolean rebateAgreementExists()
        returns if a rebate agreements exists
        Returns:
        true if a agreement exists

      • getRoundingAmount

        default java.math.BigDecimal getRoundingAmount()
        get the rounding amount (only to be usef for NL whose currency requires a rounding to 5ct)
        Returns:
        the Bigdecimal

      • getReferenceNumber

        default java.lang.String getReferenceNumber()
        get BuyerReference (BT-10) an identifier assigned by the buyer and used for internal routing. Used for the Leitweg-ID.
        Returns:
        the BuyerReference of this document

      • 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

        @Deprecated
default java.lang.String getInvoiceReferencedDocumentID()
        Deprecated.
        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

        @Deprecated
default java.util.Date getInvoiceReferencedIssueDate()
        Deprecated.

      • getInvoiceReferencedDocuments

        default java.util.ArrayList<ReferencedDocument> getInvoiceReferencedDocuments()
        Getter for BG-3
        Returns:
        list of documents

      • 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

      • getPayee

        default IZUGFeRDExportableTradeParty getPayee()
        payee / payment receiver, if different from seller, ram:Payee (only supported for zf2)
        Returns:
        the IZUGFeRDExportableTradeParty payment receiver, if different from sellver

      • 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)

      • getNotesWithSubjectCode

        default java.util.List<IncludedNote> getNotesWithSubjectCode()
        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 getNotes() but with explicit subjectCode.
        Returns:
        list of the notes

      • getSpecifiedProcuringProjectName

        default java.lang.String getSpecifiedProcuringProjectName()

      • getSpecifiedProcuringProjectID

        default java.lang.String getSpecifiedProcuringProjectID()

      • getVATDueDateTypeCode

        default java.lang.String getVATDueDateTypeCode()

      • getCreditorReferenceID

        default java.lang.String getCreditorReferenceID()