r21575 - gnucash/trunk/src/report/business-reports - Adapt printable invoice report for credit notes

Geert Janssens gjanssens at code.gnucash.org
Thu Nov 17 17:24:32 EST 2011


Author: gjanssens
Date: 2011-11-17 17:24:31 -0500 (Thu, 17 Nov 2011)
New Revision: 21575
Trac: http://svn.gnucash.org/trac/changeset/21575

Modified:
   gnucash/trunk/src/report/business-reports/invoice.scm
Log:
Adapt printable invoice report for credit notes

Modified: gnucash/trunk/src/report/business-reports/invoice.scm
===================================================================
--- gnucash/trunk/src/report/business-reports/invoice.scm	2011-11-17 22:24:22 UTC (rev 21574)
+++ gnucash/trunk/src/report/business-reports/invoice.scm	2011-11-17 22:24:31 UTC (rev 21575)
@@ -126,11 +126,21 @@
 
 (define (make-account-hash) (make-hash-table 23))
 
-(define (update-account-hash hash values)
+;; Internally invoice values are positive and credit-note values are negative
+;; However on the invoice/cn document they are always displayed as positive
+;; So depending on the document type the internal values have to be reversed
+;; before they are printed on the document. This function handles that.
+;; It should be called for each internal value that is to be displayed on the document.
+(define (inv-or-cn-value value credit-note?)
+  (if (not credit-note?)
+	value
+	(gnc-numeric-neg value)))
+
+(define (update-account-hash hash values credit-note?)
   (for-each
    (lambda (item)
      (let* ((acct (car item))
-	    (val (cdr item))
+	    (val (inv-or-cn-value(cdr item) credit-note?))
 	    (ref (hash-ref hash acct)))
 
        (hash-set! hash acct (if ref (gnc-numeric-add-fixed ref val) val))))
@@ -154,14 +164,14 @@
 	table)
       (gnc:make-gnc-monetary currency numeric)))
 
-(define (add-entry-row table currency entry column-vector row-style invoice?)
+(define (add-entry-row table currency entry column-vector row-style cust-doc? credit-note?)
   (let* ((row-contents '())
 	 (entry-value (gnc:make-gnc-monetary
 		       currency
-		       (gncEntryReturnValue entry invoice?)))
+		       (inv-or-cn-value (gncEntryReturnValue entry cust-doc?) credit-note?)))
 	 (entry-tax-value (gnc:make-gnc-monetary
 			   currency
-			   (gncEntryReturnTaxValue entry invoice?))))
+			   (inv-or-cn-value (gncEntryReturnTaxValue entry cust-doc?) credit-note?))))
 
     (if (date-col column-vector)
         (addto! row-contents
@@ -179,19 +189,19 @@
 	(addto! row-contents
 		(gnc:make-html-table-cell/markup
 		 "number-cell"
-		 (gncEntryGetQuantity entry))))
+		 (inv-or-cn-value (gncEntryGetQuantity entry) credit-note?))))
 
     (if (price-col column-vector)
 	(addto! row-contents
 		(gnc:make-html-table-cell/markup
 		 "number-cell"
 		 (gnc:make-gnc-monetary
-		  currency (if invoice? (gncEntryGetInvPrice entry)
+		  currency (if cust-doc? (gncEntryGetInvPrice entry)
 			       (gncEntryGetBillPrice entry))))))
 
     (if (discount-col column-vector)
 	(addto! row-contents
-		(if invoice?
+		(if cust-doc?
 		    (gnc:make-html-table-cell/markup
 		     "number-cell"
 		     (monetary-or-percent (gncEntryGetInvDiscount entry)
@@ -201,7 +211,7 @@
 
     (if (tax-col column-vector)
 	(addto! row-contents
-		(if (if invoice?
+		(if (if cust-doc?
 			(and (gncEntryGetInvTaxable entry)
 			     (gncEntryGetInvTaxTable entry))
 			(and (gncEntryGetBillTaxable entry)
@@ -321,7 +331,7 @@
   (gnc:register-inv-option
    (gnc:make-simple-boolean-option
     (N_ "Display") (N_ "Payments")
-    "tc" (N_ "Display the payments applied to this invoice?") #f))
+    "tc" (N_ "Display the payments applied to this cust-doc?") #f))
 
   (gnc:register-inv-option
    (gnc:make-text-option
@@ -340,7 +350,7 @@
   gnc:*report-options*)
 
 
-(define (make-entry-table invoice options add-order invoice?)
+(define (make-entry-table invoice options add-order cust-doc? credit-note?)
   (define (opt-val section name)
     (gnc:option-value
      (gnc:lookup-option options section name)))
@@ -349,7 +359,8 @@
 	(display-all-taxes (opt-val "Display" "Individual Taxes"))
 	(lot (gncInvoiceGetPostedLot invoice))
 	(txn (gncInvoiceGetPostedTxn invoice))
-	(currency (gncInvoiceGetCurrency invoice)))
+	(currency (gncInvoiceGetCurrency invoice))
+	(reverse-payments? (not (gncInvoiceAmountPositive invoice))))
 
     (define (colspan monetary used-columns)
       (cond
@@ -385,35 +396,23 @@
 				    (display-subtotal currency used-columns))))))
 		  currency-totals)))
 
-    (define (add-payment-row table used-columns split total-collector)
+    (define (add-payment-row table used-columns split total-collector reverse-payments?)
       (let* ((t (xaccSplitGetParent split))
 	     (currency (xaccTransGetCurrency t))
 	     (invoice (opt-val invoice-page invoice-name))
 	     (owner '())
-	     ;; XXX Need to know when to reverse the value
-	     (amt (gnc:make-gnc-monetary currency (xaccSplitGetValue split)))
+	     ;; Depending on the document type, the payments may need to be sign-reversed
+	     (amt (gnc:make-gnc-monetary currency
+		    (if reverse-payments?
+			(gnc-numeric-neg(xaccSplitGetValue split))
+			(xaccSplitGetValue split))))
 	     (payment-style "grand-total")
 	     (row '()))
 
-	; Update to fix bug 564380, payment on bill doubles bill Mike Evans <mikee at saxicola.co.uk>
-	;; Reverse the value when needed
-	(if (not (null? invoice))
-	    (begin
-		 (set! owner (gncInvoiceGetOwner invoice))
-		 (let ((type (gncOwnerGetType
-				(gncOwnerGetEndOwner owner))))
-		      (cond
-			((eqv? type GNC-OWNER-CUSTOMER)
-			 (total-collector 'add
-			    (gnc:gnc-monetary-commodity amt)
-			    (gnc:gnc-monetary-amount amt)))
-			((eqv? type GNC-OWNER-VENDOR)
-			 (total-collector 'add
-			    (gnc:gnc-monetary-commodity amt)
-			    (gnc:gnc-monetary-amount (gnc:monetary-neg amt))))
-	))))
+	(total-collector 'add
+	    (gnc:gnc-monetary-commodity amt)
+	    (gnc:gnc-monetary-amount amt))
 
-
 	(if (date-col used-columns)
 	    (addto! row
 		    (gnc-print-date (gnc-transaction-get-date-posted t))))
@@ -473,7 +472,7 @@
 		   (lambda (split)
 		     (if (not (equal? (xaccSplitGetParent split) txn))
 			 (add-payment-row table used-columns
-					  split total-collector)))
+					  split total-collector reverse-payments?)))
 		   splits)))
 
 	    (add-subtotal-row table used-columns total-collector
@@ -492,10 +491,10 @@
 					      current
 					      used-columns
 					      current-row-style
-					      invoice?)))
+					      cust-doc? credit-note?)))
 
 	    (if display-all-taxes
-		(let ((tax-list (gncEntryReturnTaxValues current invoice?)))
+		(let ((tax-list (gncEntryReturnTaxValues current cust-doc?)))
 		  (update-account-hash acct-hash tax-list))
 		(tax-collector 'add
 			       (gnc:gnc-monetary-commodity (cdr entry-values))
@@ -663,7 +662,8 @@
 	 (default-title (_ "Invoice"))
 	 (custom-title (opt-val invoice-page "Custom Title"))
 	 (title "")
-	 (invoice? #f))
+	 (cust-doc? #f)
+	 (credit-note? #f))
 
     (define (add-order o)
       (if (and references? (not (member o orders)))
@@ -671,18 +671,29 @@
 
     (if (not (null? invoice))
 	(begin
-	  (set! owner (gncInvoiceGetOwner invoice))
-	  (let ((type (gncOwnerGetType
-                       (gncOwnerGetEndOwner owner))))
+	  (let ((type (gncInvoiceGetType invoice)))
 	    (cond
-	      ((eqv? type GNC-OWNER-CUSTOMER)
-	       (set! invoice? #t))
-	      ((eqv? type GNC-OWNER-VENDOR)
+	      ((eqv? type GNC-INVOICE-CUST-INVOICE)
+	       (set! cust-doc? #t))
+	      ((eqv? type GNC-INVOICE-VEND-INVOICE)
 	       (set! default-title (_ "Bill")))
-	      ((eqv? type GNC-OWNER-EMPLOYEE)
-	       (set! default-title (_ "Expense Voucher")))))))
+	      ((eqv? type GNC-INVOICE-EMPL-INVOICE)
+	       (set! default-title (_ "Expense Voucher")))
+	      ((eqv? type GNC-INVOICE-CUST-CREDIT-NOTE)
+	       (begin
+	        (set! cust-doc? #t)
+	        (set! credit-note? #t)
+	        (set! default-title (_ "Credit Note"))))
+	      ((eqv? type GNC-INVOICE-VEND-CREDIT-NOTE)
+	       (begin
+	        (set! credit-note? #t)
+	        (set! default-title (_ "Credit Note"))))
+	      ((eqv? type GNC-INVOICE-EMPL-CREDIT-NOTE)
+	       (begin
+	        (set! credit-note? #t)
+	        (set! default-title (_ "Credit Note"))))))
 
-    (set! title (title-string default-title custom-title))
+    (set! title (title-string default-title custom-title))))
 
     (gnc:html-document-set-title! document (sprintf #f (_"%s #%d") title
 						    (gncInvoiceGetID invoice)))
@@ -691,7 +702,7 @@
 	(let ((book (gncInvoiceGetBook invoice)))
 	  (set! table (make-entry-table invoice
 					(gnc:report-options report-obj)
-					add-order invoice?))
+					add-order cust-doc? credit-note?))
 
 	  (gnc:html-table-set-style!
 	   table "table"



More information about the gnucash-changes mailing list