POD Ergänzungen

[kivitendo-erp.git] / SL / Controller / BankTransaction.pm

diff --git a/SL/Controller/BankTransaction.pm b/SL/Controller/BankTransaction.pm
index 370ac954c9b2dfcbcf4f6fda735b65722e7e9692..591ee7c9e77036fe901f9e93a3b856f695e512a2 100644 (file)
--- a/SL/Controller/BankTransaction.pm
+++ b/SL/Controller/BankTransaction.pm
@@ -959,6 +959,19 @@ tries to post its amount to a certain number of invoices (parameter
 C<invoice_ids>, an array ref of database IDs to purchase or sales
 invoice objects).
 
+This method cannot handle already partly assigned bank transactions, i.e.
+a bank transaction that has a invoice_amount <> 0 but not the fully
+transaction amount (invoice_amount == amount).
+Currently this state is impossible from the point of the user interface,
+but for double safety and further reliance posting an bank_transaction
+where some invoice_amount is already assigned or a RecordLink from
+bank to document exists will not be accepted.
+
+If the amount of the bank transaction is higher than the sum of
+the assigned invoices (1 .. n) the last invoice will be overpayed.
+
+Therefore this function implements not all valid uses cases.
+
 The whole function is wrapped in a database transaction. If an
 exception occurs the bank transaction is not posted at all. The same
 is true if the code detects an error during the execution, e.g. a bank