From 7ed6c33b33345edeb35e834c2ba09141601f09fc Mon Sep 17 00:00:00 2001
From: jstaerk <jstaerk@usegroup.de>
Date: Thu, 12 Nov 2020 09:16:10 +0100
Subject: [PATCH] Javadoc amendments

---
 .../src/main/java/org/mustangproject/Invoice.java | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/library/src/main/java/org/mustangproject/Invoice.java b/library/src/main/java/org/mustangproject/Invoice.java
index b0095dae..cc398081 100644
--- a/library/src/main/java/org/mustangproject/Invoice.java
+++ b/library/src/main/java/org/mustangproject/Invoice.java
@@ -90,7 +90,10 @@ public class Invoice implements IExportableTransaction {
 	}
 
 	/***
-	 * switch type to invoice correction and refer to document number
+	 * switch type to invoice correction and refer to document number.
+	 * Please note that the quantities need to be negative, if you
+	 * e.g. delivered 100 and take 50 back the quantity should be -50 in the
+	 * corrected invoice, which will result in negative VAT and a negative payment amount
 	 * @param number the invoice number to be corrected
 	 * @return this object (fluent setter)
 	 */
@@ -186,6 +189,11 @@ public class Invoice implements IExportableTransaction {
 		return buyerOrderReferencedDocumentID;
 	}
 
+	/***
+	 * usually the order number or in case of a correction the original invoice number
+	 * @param buyerOrderReferencedDocumentID
+	 * @return
+	 */
 	public Invoice setBuyerOrderReferencedDocumentID(String buyerOrderReferencedDocumentID) {
 		this.buyerOrderReferencedDocumentID = buyerOrderReferencedDocumentID;
 		return this;
@@ -196,6 +204,11 @@ public class Invoice implements IExportableTransaction {
 		return buyerOrderReferencedDocumentIssueDateTime;
 	}
 
+	/***
+	 * when the order (or whatever reference in BuyerOrderReferencedDocumentID) was issued
+	 * @param buyerOrderReferencedDocumentIssueDateTime
+	 * @return
+	 */
 	public Invoice setBuyerOrderReferencedDocumentIssueDateTime(String buyerOrderReferencedDocumentIssueDateTime) {
 		this.buyerOrderReferencedDocumentIssueDateTime = buyerOrderReferencedDocumentIssueDateTime;
 		return this;