org.mustangproject.ZUGFeRD.IExportableTransaction Maven / Gradle / Ivy
Show all versions of library Show documentation
/**
* *********************************************************************
*
* Copyright 2018 Jochen Staerk
*
* Use is subject to license terms.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
* See the License for the specific language governing permissions and
* limitations under the License.
*
* **********************************************************************
*/
package org.mustangproject.ZUGFeRD;
/**
* Mustangproject's ZUGFeRD implementation
* Neccessary interface for ZUGFeRD exporter
* Licensed under the APLv2
* @date 2014-05-10 to 2020-11-12
* @version 2.0.0
* @author jstaerk
* */
import java.math.BigDecimal;
import java.util.Date;
import java.util.List;
import org.mustangproject.FileAttachment;
import org.mustangproject.IncludedNote;
import org.mustangproject.ZUGFeRD.model.DocumentCodeTypeConstants;
/***
* the interface of an transaction, e.g. an invoice, you want to create xml
* (potentially to be added to a PDF) for
*
* @see org.mustangproject.Invoice
*/
public interface IExportableTransaction {
/**
* appears in /rsm:CrossIndustryDocument/rsm:HeaderExchangedDocument/ram:Name
*
* @return Name of document
*/
default String getDocumentName() {
return "RECHNUNG";
}
/**
*
*
* @return Code number of Document type, e.g. "380" for invoiceF
*/
default String getDocumentCode() {
return DocumentCodeTypeConstants.INVOICE;
}
/**
* Number, typically invoice number of the invoice
*
* @return invoice number
*/
default String getNumber() {
return null;
}
/**
* the date when the invoice was created
*
* @return when the invoice was created
*/
default Date getIssueDate() {
return null;
}
/**
* 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 {@link org.mustangproject.SubjectCode#REG}. See also
* {@link #getNotesWithSubjectCode()}
* @return null or full sender institution name, details, manager and tax
* registration
*/
default String getOwnOrganisationFullPlaintextInfo() {
return null;
}
/**
* when the invoice is to be paid
*
* @return when the invoice is to be paid
*/
default Date getDueDate() {
return null;
}
default String getContractReferencedDocument() {
return null;
}
/**
* the sender of the invoice
*
* @return the contact person at the supplier side
*/
default IZUGFeRDExportableTradeParty getSender() {
return null;
}
/**
* subject of the document e.g. invoice and order number as human readable text
*
* @return string with document subject
*/
default String getSubjectNote() {
return null;
}
default IZUGFeRDAllowanceCharge[] getZFAllowances() {
return null;
}
default IZUGFeRDAllowanceCharge[] getZFCharges() {
return null;
}
default IZUGFeRDAllowanceCharge[] getZFLogisticsServiceCharges() {
return null;
}
default IZUGFeRDCashDiscount[] getCashDiscounts() { return null; }
/***
* @return the invoice line items with the positions
*/
IZUGFeRDExportableItem[] getZFItems();
/**
* the recipient
*
* @return the recipient of the invoice
*/
IZUGFeRDExportableTradeParty getRecipient();
/**
* the creditors payment informations
*
* @deprecated use getTradeSettlement
* @return an array of IZUGFeRDTradeSettlementPayment
*/
@Deprecated
default IZUGFeRDTradeSettlementPayment[] getTradeSettlementPayment() {
return null;
}
/**
* the payment information for any payment means
*
* @return an array of IZUGFeRDTradeSettlement
*/
default IZUGFeRDTradeSettlement[] getTradeSettlement() {
return null;
}
/**
* Tax ID (not VAT ID) of the sender
*
* @return Tax ID (not VAT ID) of the sender
*/
default String getOwnTaxID() {
if (getSender() != null) {
return getSender().getTaxID();
} else {
return null;
}
}
/**
* VAT ID (Umsatzsteueridentifikationsnummer) of the sender
*
* @return VAT ID (Umsatzsteueridentifikationsnummer) of the sender
*/
default String getOwnVATID() {
if (getSender() != null) {
return getSender().getVATID();
} else {
return null;
}
}
/**
* supplier identification assigned by the costumer
*
* @return the sender's identification
*/
default String getOwnForeignOrganisationID() {
return null;
}
/**
* own name
*
* @return the sender's organisation name
*/
default String getOwnOrganisationName() {
if (getSender() != null) {
return getSender().getName();
} else {
return null;
}
}
/**
* own street address
*
* @return sender street address
*/
default String getOwnStreet() {
if (getSender() != null) {
return getSender().getStreet();
} else {
return null;
}
}
/**
* own street postal code
*
* @return sender postal code
*/
default String getOwnZIP() {
if (getSender() != null) {
return getSender().getZIP();
} else {
return null;
}
}
/**
* own city
*
* @return the invoice sender's city
*/
default String getOwnLocation() {
if (getSender() != null) {
return getSender().getLocation();
} else {
return null;
}
}
/**
* own two digit country code
*
* @return the invoice senders two character country iso code
*/
default String getOwnCountry() {
if (getSender() != null) {
return getSender().getCountry();
} else {
return null;
}
}
/**
* get delivery date
*
* @return the day the goods have been delivered
*/
Date getDeliveryDate();
/**
* get main invoice currency used on the invoice
*
* @return three character currency of this invoice
*/
default String getCurrency() {
return "EUR";
}
/**
* get payment term descriptional text e.g. Bis zum 22.10.2015 ohne Abzug
*
* @return get payment terms
*/
default String getPaymentTermDescription() {
return null;
}
/**
* get payment terms. if set, getPaymentTermDescription() and getDueDate() are
* ignored
*
* @return the IZUGFeRDPaymentTerms of the invoice
*/
default IZUGFeRDPaymentTerms getPaymentTerms() {
return null;
}
/**
* returns if a rebate agreements exists
*
* @return true if a agreement exists
*/
default boolean rebateAgreementExists() {
return false;
}
/**
* supplier identification assigned by the costumer
*
* @return the sender's identification
*/
default BigDecimal getRoundingAmount() {
return null;
}
/**
* get reference document number typically used for Invoice Corrections Will be
* added as IncludedNote in comfort profile
*
* @return the ID of the document this document refers to
*/
default String getReferenceNumber() {
return null;
}
/**
* consignee identification (identification of the organisation the goods are
* shipped to [assigned by the costumer])
*
* @return the sender's identification
*/
default String getShipToOrganisationID() {
return null;
}
/**
* consignee name (name of the organisation the goods are shipped to)
*
* @return the consignee's organisation name
*/
default String getShipToOrganisationName() {
return null;
}
/**
* consignee street address (street of the organisation the goods are shipped
* to)
*
* @return consignee street address
*/
default String getShipToStreet() {
return null;
}
/**
* consignee street postal code (postal code of the organisation the goods are
* shipped to)
*
* @return consignee postal code
*/
default String getShipToZIP() {
return null;
}
/**
* consignee city (city of the organisation the goods are shipped to)
*
* @return the consignee's city
*/
default String getShipToLocation() {
return null;
}
/**
* consignee two digit country code (country code of the organisation the goods
* are shipped to)
*
* @return the consignee's two character country iso code
*/
default String getShipToCountry() {
return null;
}
/**
* get the ID of the SellerOrderReferencedDocument, which sits in the
* ApplicableSupplyChainTradeAgreement/ApplicableHeaderTradeAgreement
*
* @return the ID of the document
*/
default String getSellerOrderReferencedDocumentID() {
return null;
}
/**
* get the ID of the BuyerOrderReferencedDocument, which sits in the
* ApplicableSupplyChainTradeAgreement
*
* @return the ID of the document
*/
default String getBuyerOrderReferencedDocumentID() {
return null;
}
/**
* get the ID of the preceding invoice, which is e.g. to be corrected if this is
* a correction
*
* @return the ID of the document
*/
default String getInvoiceReferencedDocumentID() {
return null;
}
default Date getInvoiceReferencedIssueDate() {
return null;
}
/**
* get the issue timestamp of the BuyerOrderReferencedDocument, which sits in
* the ApplicableSupplyChainTradeAgreement
*
* @return the IssueDateTime in format CCYY-MM-DDTHH:MM:SS
*/
default String getBuyerOrderReferencedDocumentIssueDateTime() {
return null;
}
/**
* get the TotalPrepaidAmount located in
* SpecifiedTradeSettlementMonetarySummation (v1) or
* SpecifiedTradeSettlementHeaderMonetarySummation (v2)
*
* @return the total sum (incl. VAT) of prepayments, i.e. the difference between
* GrandTotalAmount and DuePayableAmount
*/
default BigDecimal getTotalPrepaidAmount() {
return BigDecimal.ZERO;
}
/***
* delivery address, i.e. ram:ShipToTradeParty (only supported for zf2)
*
* @return the IZUGFeRDExportableTradeParty delivery address
*/
default IZUGFeRDExportableTradeParty getDeliveryAddress() {
return null;
}
/***
* payee / payment receiver, if different from seller, ram:Payee (only supported for zf2)
*
* @return the IZUGFeRDExportableTradeParty payment receiver, if different from sellver
*/
default IZUGFeRDExportableTradeParty getPayee() {
return null;
}
/***
* specifies the document level delivery period, will be included in a
* BillingSpecifiedPeriod element
*
* @return the beginning of the delivery period
*/
default Date getDetailedDeliveryPeriodFrom() {
return null;
}
/***
* specifies the document level delivery period, will be included in a
* BillingSpecifiedPeriod element
*
* @return the end of the delivery period
*/
default Date getDetailedDeliveryPeriodTo() {
return null;
}
/**
* get additional referenced documents acccording to BG-24 XRechnung
* (Rechnungsbegruendende Unterlagen), i.e.
* ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument
*
* @return a array of objects from class FileAttachment
*/
default FileAttachment[] getAdditionalReferencedDocuments() {
return null;
}
default String getDespatchAdviceReferencedDocumentID() {
return null;
}
/***
* additional text description
*
* @return an array of strings of document wide "includedNotes" (descriptive
* text values)
*/
default String[] getNotes() {
return null;
}
/**
* 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 {@link #getNotes()} but with explicit subjectCode.
* @return list of the notes
*/
default List getNotesWithSubjectCode() {
return null;
}
default String getSpecifiedProcuringProjectName() {
return null;
}
default String getSpecifiedProcuringProjectID() {
return null;
}
default String getVATDueDateTypeCode() {
return null;
}
default String getCreditorReferenceID() {
return null;
}
}