Interface IZUGFeRDExportableTradeParty

  • All Known Implementing Classes:
    TradeParty

    public interface IZUGFeRDExportableTradeParty
    Mustangproject's ZUGFeRD implementation neccessary interface for ZUGFeRD exporter Licensed under the APLv2
    Version:
    2.0.0 dated 2020-09-12
    Author:
    jstaerk
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default java.lang.String getAdditionalAddress()
      returns additional address information which is display in xml tag "LineTwo" e.g.
      default java.lang.String getAdditionalAddressExtension()
      returns additional address information which is display in xml tag "LineThree" e.g.
      default IZUGFeRDExportableContact getContact()
      the named contact person for inquiries
      java.lang.String getCountry()
      two-letter country code of the contact
      default java.lang.String getDescription()  
      default java.lang.String getEmail()
      gets the email of the organization (not the one of the contact person) will return null if not set or if the provided UriUniversalCommunicationID is not a email address
      default java.lang.String getGlobalID()
      customer global identification assigned by the seller
      default java.lang.String getGlobalIDScheme()
      customer global identification scheme
      default java.lang.String getID()
      customer identification assigned by the seller
      default IZUGFeRDLegalOrganisation getLegalOrganisation()
      gets the official representation
      java.lang.String getLocation()
      Returns the city of the contact
      java.lang.String getName()
      e.g. first and last name of the owner
      java.lang.String getStreet()
      Returns the street address (street+number) of the contact
      default java.lang.String getTaxID()
      obligatory for sender but not for recipient
      default java.lang.String getUriUniversalCommunicationID()
      The URIID of URIUniversalCommunicationID (e.g. email address) It is used by some countries, i.e.
      default java.lang.String getUriUniversalCommunicationIDScheme()
      URIUniversalCommunication scheme (see EAS code list of the ZUGFeRD documentation) I believe EM for Email
      default java.lang.String getVATID()
      VAT ID (Umsatzsteueridentifikationsnummer) of the contact
      java.lang.String getZIP()
      Postal code of the recipient
    • Method Detail

      • getID

        default java.lang.String getID()
        customer identification assigned by the seller
        Returns:
        customer identification
      • getGlobalID

        default java.lang.String getGlobalID()
        customer global identification assigned by the seller
        Returns:
        customer identification
      • getLegalOrganisation

        default IZUGFeRDLegalOrganisation getLegalOrganisation()
        gets the official representation
        Returns:
        the interface with the attributes of the legal organisation
      • getGlobalIDScheme

        default java.lang.String getGlobalIDScheme()
        customer global identification scheme
        Returns:
        customer identification
      • getUriUniversalCommunicationIDScheme

        default java.lang.String getUriUniversalCommunicationIDScheme()
        URIUniversalCommunication scheme (see EAS code list of the ZUGFeRD documentation) I believe EM for Email
        Returns:
        String with code
      • getUriUniversalCommunicationID

        default java.lang.String getUriUniversalCommunicationID()
        The URIID of URIUniversalCommunicationID (e.g. email address) It is used by some countries, i.e. Luxembourg, Peppol
        Returns:
        the URI as string
      • getEmail

        default java.lang.String getEmail()
        gets the email of the organization (not the one of the contact person) will return null if not set or if the provided UriUniversalCommunicationID is not a email address
        Returns:
        String the email, or null
      • getName

        java.lang.String getName()
        e.g. first and last name of the owner
        Returns:
        full name of the party
      • getDescription

        default java.lang.String getDescription()
        Returns:
        description, e.g. if it's a small company
      • getZIP

        java.lang.String getZIP()
        Postal code of the recipient
        Returns:
        Postal code of the recipient
      • getVATID

        default java.lang.String getVATID()
        VAT ID (Umsatzsteueridentifikationsnummer) of the contact
        Returns:
        VAT ID (Umsatzsteueridentifikationsnummer) of the contact
      • getCountry

        java.lang.String getCountry()
        two-letter country code of the contact
        Returns:
        two-letter iso country code of the contact
      • getLocation

        java.lang.String getLocation()
        Returns the city of the contact
        Returns:
        Returns the city of the recipient
      • getStreet

        java.lang.String getStreet()
        Returns the street address (street+number) of the contact
        Returns:
        street address (street+number) of the contact
      • getAdditionalAddress

        default java.lang.String getAdditionalAddress()
        returns additional address information which is display in xml tag "LineTwo" e.g. "Rear building"
        Returns:
        additional address information
      • getAdditionalAddressExtension

        default java.lang.String getAdditionalAddressExtension()
        returns additional address information which is display in xml tag "LineThree" e.g. "Second floor" if LineTwo is already used, e.g. "Rear Building". This attribute could sometimes be BT-165?
        Returns:
        additional address information
      • getTaxID

        default java.lang.String getTaxID()
        obligatory for sender but not for recipient
        Returns:
        the tax id as string