/
job-profit-loss-report.scm
1309 lines (1162 loc) · 52.6 KB
/
job-profit-loss-report.scm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;; -*-scheme-*-
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of
;; the License, or (at your option) any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, contact:
;;
;; Free Software Foundation Voice: +1-617-542-5942
;; 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652
;; Boston, MA 02110-1301, USA gnu@gnu.org
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; This is a sample guile report generator for GnuCash.
;; It illustrates the basic techniques used to create
;; new reports for GnuCash.
;; ------------------------------------------------------------------
;; Top-level definitions
;; ------------------------------------------------------------------
(define-module (gnucash reports example my-sample-report))
(use-modules (gnucash engine))
(use-modules (gnucash utilities))
(use-modules (gnucash core-utils))
(use-modules (gnucash app-utils))
(use-modules (gnucash report))
(use-modules (gnucash html))
(debug-enable 'backtrace)
;; -*-scheme-*-
;; owner-report.scm -- Print out a detailed owner report, which is a
;; summary of invoices and payments for a particular
;; company (the owner) applied to an account.
;;
;; Created by: Derek Atkins <warlord@MIT.EDU>
;; Copyright (c) 2002, 2003 Derek Atkins <warlord@MIT.EDU>
;; Modified by AMM to show tax figures of invoice.
;; Modified by Christopher Lam to combine job/owner-report
;;
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation; either version 2 of
;; the License, or (at your option) any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, contact:
;;
;; Free Software Foundation Voice: +1-617-542-5942
;; 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652
;; Boston, MA 02110-1301, USA gnu@gnu.org
(define-module (gnucash reports standard new-owner-report))
(use-modules (srfi srfi-1))
(use-modules (srfi srfi-2))
(use-modules (srfi srfi-8))
(use-modules (srfi srfi-9))
(use-modules (srfi srfi-11)) ;for let-values
(use-modules (ice-9 match))
(use-modules (gnucash engine))
(use-modules (gnucash utilities)) ; for gnc:debug
(use-modules (gnucash core-utils))
(use-modules (gnucash app-utils))
(use-modules (gnucash report))
;; Option names
(define optname-from-date (N_ "From"))
(define optname-to-date (N_ "To"))
(define optname-date-driver (N_ "Due or Post Date"))
(define owner-page gnc:pagename-general)
(define date-header (N_ "Date"))
(define due-date-header (N_ "Due Date"))
(define reference-header (N_ "Reference"))
(define type-header (N_ "Type"))
(define desc-header (N_ "Description"))
(define sale-header (N_ "Sale"))
(define tax-header (N_ "Tax"))
(define credit-header (N_ "Credits"))
(define debit-header (N_ "Debits"))
(define balance-header (N_ "Balance"))
(define doclink-header (N_ "Document Links"))
(define linked-txns-header (N_ "Transaction Links"))
(define javascript "
<script>
function getID(cell) { return cell.getAttribute('link-id'); }
function clicky() {
var id = getID(this);
var ishighlighted = this.classList.contains('highlight');
TDs.forEach (function (item, idx) {
item.classList.remove('highlight')});
if (ishighlighted) return;
TDs.forEach (function (item, idx) {
if (getID(item) == id)
item.classList.add('highlight')})}
var TDs = document.getElementsByTagName('td');
TDs = Array.prototype.slice.call (TDs);
TDs = TDs.filter (getID);
TDs.forEach(function (item, idx) {
item.addEventListener('click', clicky)});
</script>
")
;; Depending on the report type we want to set up some lists/cases
;; with strings to ease overview and translation
(define owner-string-alist
(list
(list GNC-OWNER-JOB
(N_ "Job Profit/Loss")
(G_ "No valid job selected.")
(G_ "This report requires a job to be selected."))))
(define (get-info key)
(assv-ref owner-string-alist key))
(define-record-type :link-data
(make-link-data date ref type desc partial-amount amount rhs-class)
link-data?
(date link-data-date)
(ref link-data-ref)
(type link-data-type)
(desc link-data-desc)
(partial-amount link-data-partial-amount)
(amount link-data-amount)
(rhs-class link-data-rhs-class))
(define-record-type :link-desc-amount
(make-link-desc-amount desc amount rhs-class)
link-desc-amount?
(desc link-desc-amount-desc)
(amount link-desc-amount-amount)
(rhs-class link-desc-amount-rhs-class))
(define-record-type :link-blank
(make-link-blank)
link-blank?)
;; Names in Option panel (Untranslated! Because it is used for option
;; naming and lookup only, and the display of the option name will be
;; translated somewhere else.)
(define (owner-string owner-type)
(car (get-info owner-type)))
(define (date-col columns-used)
(vector-ref columns-used 0))
(define (date-due-col columns-used)
(vector-ref columns-used 1))
(define (ref-col columns-used)
(vector-ref columns-used 2))
(define (type-col columns-used)
(vector-ref columns-used 3))
(define (desc-col columns-used)
(vector-ref columns-used 4))
(define (sale-col columns-used)
(vector-ref columns-used 5))
(define (tax-col columns-used)
(vector-ref columns-used 6))
(define (debit-col columns-used)
(vector-ref columns-used 7))
(define (credit-col columns-used)
(vector-ref columns-used 8))
(define (bal-col columns-used)
(vector-ref columns-used 9))
(define (doclink-col columns-used)
(vector-ref columns-used 10))
(define (num-cols columns-used section)
(let* ((date? (date-col columns-used))
(due? (date-due-col columns-used))
(ref? (ref-col columns-used))
(type? (type-col columns-used))
(desc? (desc-col columns-used))
(sale? (sale-col columns-used))
(tax? (tax-col columns-used))
(credit? (credit-col columns-used))
(debit? (debit-col columns-used))
(bal? (bal-col columns-used))
(doclink? (doclink-col columns-used))
(spacer? (or date? type? ref? desc? debit? credit?))
(amt? (or credit? debit?))
(cols-alist
(list
(list 'lhs-cols date? due? ref? type? desc? sale? tax? credit? debit? bal?
doclink?)
(list 'ptt-span date? due? ref? type? desc? doclink?)
(list 'mid-spac spacer?)
(list 'rhs-cols date? ref? type? desc? amt? amt?)
(list 'rhs-span date? ref? type? desc?)))
(cols-list (assq-ref cols-alist section)))
(count identity cols-list)))
(define (build-column-used options)
(define (opt-val name)
(gnc-optiondb-lookup-value options "Display Columns" name))
(list->vector
(map opt-val
(list date-header due-date-header reference-header type-header
desc-header sale-header tax-header debit-header credit-header
balance-header doclink-header))))
(define (make-heading-list column-vector link-option)
(let ((heading-list '()))
(if (date-col column-vector)
(addto! heading-list (G_ date-header)))
(if (date-due-col column-vector)
(addto! heading-list (G_ due-date-header)))
(if (ref-col column-vector)
(addto! heading-list (G_ reference-header)))
(if (type-col column-vector)
(addto! heading-list (G_ type-header)))
(if (desc-col column-vector)
(addto! heading-list (G_ desc-header)))
(if (doclink-col column-vector)
(addto! heading-list (C_ "Column header for 'Document Link'" "L")))
(if (sale-col column-vector)
(addto! heading-list (G_ sale-header)))
(if (tax-col column-vector)
(addto! heading-list (G_ tax-header)))
(if (debit-col column-vector)
(addto! heading-list (G_ debit-header)))
(if (credit-col column-vector)
(addto! heading-list (G_ credit-header)))
(if (bal-col column-vector)
(addto! heading-list (G_ balance-header)))
(case link-option
((simple)
(addto! heading-list (G_ linked-txns-header)))
((detailed)
(if (< 0 (num-cols column-vector 'mid-spac)) (addto! heading-list #f))
(if (date-col column-vector) (addto! heading-list (G_ "Date")))
(if (ref-col column-vector) (addto! heading-list (G_ "Reference")))
(if (type-col column-vector) (addto! heading-list (G_ "Type")))
(if (desc-col column-vector) (addto! heading-list (G_ "Description")))
(if (or (debit-col column-vector) (credit-col column-vector))
(addto! heading-list (G_ "Partial Amount")))
(if (or (debit-col column-vector) (credit-col column-vector))
(addto! heading-list (G_ "Amount")))))
(reverse heading-list)))
(define num-buckets 6)
(define (sign-equal? a b)
(or (= 0 a b) (< 0 (* a b))))
(define (lot-split->posting-split split)
(let* ((lot (xaccSplitGetLot split))
(invoice (gncInvoiceGetInvoiceFromLot lot))
(post-txn (gncInvoiceGetPostedTxn invoice)))
(and (not (null? lot))
(not (null? invoice))
(not (null? post-txn))
(find (lambda (split) (equal? (xaccSplitGetParent split) post-txn))
(gnc-lot-get-split-list lot)))))
(define (txn-is-invoice? txn)
(eqv? (xaccTransGetTxnType txn) TXN-TYPE-INVOICE))
(define (txn-is-payment? txn)
(eqv? (xaccTransGetTxnType txn) TXN-TYPE-PAYMENT))
(define (txn-is-link? txn)
(eqv? (xaccTransGetTxnType txn) TXN-TYPE-LINK))
(define (split-is-payment? split)
(txn-is-payment? (xaccSplitGetParent split)))
(define (invoice->anchor inv)
(gnc:html-markup-anchor
(gnc:invoice-anchor-text inv)
(gncInvoiceGetID inv)))
(define (split->reference split)
(let* ((txn (xaccSplitGetParent split))
(type (xaccTransGetTxnType txn)))
(cond
((memv type (list TXN-TYPE-LINK TXN-TYPE-PAYMENT))
(let ((ref (gnc-get-num-action txn split)))
(gnc:make-html-text
(gnc:html-markup-anchor
(gnc:split-anchor-text split) ref))))
((eqv? type TXN-TYPE-INVOICE)
(let ((inv (gncInvoiceGetInvoiceFromLot (xaccSplitGetLot split))))
(gnc:make-html-text (invoice->anchor inv)))))))
(define (split->type-str split payable?)
(let* ((txn (xaccSplitGetParent split))
(amt (xaccSplitGetAmount split))
(refund? (if payable? (< amt 0) (> amt 0)))
(invoice (gncInvoiceGetInvoiceFromTxn txn)))
(cond
((txn-is-invoice? txn) (gncInvoiceGetTypeString invoice))
((txn-is-payment? txn) (if refund? (G_ "Refund") (G_ "Payment")))
((txn-is-link? txn) (G_ "Link"))
(else (G_ "Unknown")))))
;; input: list of html-text elements
;; output: a cell with html-text interleaved with <br> tags
(define* (list->cell lst #:optional skip-empty?)
(let lp ((lst lst) (result '()))
(match lst
(() (apply gnc:make-html-text result))
(("" . rest) (=> fail) (if skip-empty? (lp rest result) (fail)))
((elt . rest) (lp rest (cons* elt (gnc:html-markup-br) result))))))
(define* (splits->desc splits #:optional skip-empty?)
(list->cell (map (compose gnc:html-string-sanitize xaccSplitGetMemo) splits)
skip-empty?))
;; addif is a macro; a simple procedure will always evaluate the
;; arguments pred? and elt which is not desirable; a macro will ensure
;; elt is only evaluated if pred? is not #f
(define-syntax-rule (addif pred? elt)
(if pred? (list elt) '()))
(define (make-section-heading-list column-vector owner-desc)
(define (make-heading cols str)
(gnc:make-html-table-cell/size/markup 1 cols "th" str))
(let ((lhs (num-cols column-vector 'lhs-cols))
(mid (num-cols column-vector 'mid-spac))
(rhs (num-cols column-vector 'rhs-cols)))
(append
;; Translators: ~a History refers to main details table in owner
;; report. ~a will be replaced with Customer, Vendor or Employee.
(addif (< 0 lhs) (make-heading lhs (format #f (G_ "~a History") owner-desc)) )
(addif (< 0 mid) (make-heading mid #f))
(addif (< 0 rhs) (make-heading rhs (G_ "Linked Details"))))))
;;
;; Make a row list based on the visible columns
;;
(define (add-row table odd-row? column-vector date due-date ref type-str
desc doclink-invoice currency amt debit credit sale tax lhs-class
link-option link-rows)
(define nrows (if link-rows (length link-rows) 1))
(define (link-data->cols link-data)
(cond
((link-data? link-data)
(append
(map
(lambda (str)
(let ((cell (gnc:make-html-table-cell str))
(rhs-class (link-data-rhs-class link-data)))
(when rhs-class
(gnc:html-table-cell-set-style!
cell "td" 'attribute (list "link-id" rhs-class)))
cell))
(append
(addif (date-col column-vector) (link-data-date link-data))
(addif (ref-col column-vector) (link-data-ref link-data))
(addif (type-col column-vector) (link-data-type link-data))
(addif (desc-col column-vector) (link-data-desc link-data))))
(map
(lambda (str)
(let ((cell (gnc:make-html-table-cell/markup "number-cell" str))
(rhs-class (link-data-rhs-class link-data)))
(when rhs-class
(gnc:html-table-cell-set-style!
cell "number-cell" 'attribute (list "link-id" rhs-class)))
cell))
(append
(addif (or (debit-col column-vector) (credit-col column-vector))
(link-data-partial-amount link-data))
(addif (or (debit-col column-vector) (credit-col column-vector))
(link-data-amount link-data))))))
((link-desc-amount? link-data)
(let ((cols (num-cols column-vector 'rhs-span)))
(append
(map
(lambda (str)
(let ((cell (gnc:make-html-table-cell/size 1 cols str))
(rhs-class (link-desc-amount-rhs-class link-data)))
(when rhs-class
(gnc:html-table-cell-set-style!
cell "td" 'attribute (list "link-id" rhs-class)))
cell))
(addif (< 0 cols) (link-desc-amount-desc link-data)))
(map
(lambda (str)
(let ((cell (gnc:make-html-table-cell/size/markup 1 2 "number-cell" str))
(rhs-class (link-desc-amount-rhs-class link-data)))
(when rhs-class
(gnc:html-table-cell-set-style!
cell "number-cell" 'attribute (list "link-id" rhs-class)))
cell))
(addif (or (debit-col column-vector) (credit-col column-vector))
(link-desc-amount-amount link-data))))))
((link-blank? link-data)
(make-list (num-cols column-vector 'rhs-cols) #f))
(else link-data)))
(define (cell amt)
(and amt (gnc:make-gnc-monetary currency amt)))
(define cell-nohoriz
(let ((cell (gnc:make-html-table-cell/size nrows 1 #f)))
(gnc:html-table-cell-set-style!
cell "td" 'attribute '("style" "border-bottom: none; border-top: none;"))
cell))
(define mid-span
(if (eq? link-option 'detailed) (num-cols column-vector 'mid-spac) 0))
(let lp ((link-rows link-rows)
(first-row? #t))
(unless (null? link-rows)
(if first-row?
(gnc:html-table-append-row/markup!
table (if odd-row? "normal-row" "alternate-row")
(append
(map
(lambda (str)
(let ((cell (gnc:make-html-table-cell/size nrows 1 str)))
(when lhs-class
(gnc:html-table-cell-set-style!
cell "td" 'attribute (list "link-id" lhs-class)))
cell))
(append
(addif (date-col column-vector) (qof-print-date date))
(addif (date-due-col column-vector)
(and due-date (qof-print-date due-date)))
(addif (ref-col column-vector) ref)
(addif (type-col column-vector) type-str)
(addif (desc-col column-vector) desc)
(addif (doclink-col column-vector)
(and doclink-invoice
(gnc:html-invoice-doclink-anchor
doclink-invoice
(C_ "Column header for 'Document Link'" "L"))))))
(map
(lambda (str)
(let ((cell (gnc:make-html-table-cell/size/markup
nrows 1 "number-cell" str)))
(when lhs-class
(gnc:html-table-cell-set-style!
cell "number-cell" 'attribute (list "link-id" lhs-class)))
cell))
(append
(addif (sale-col column-vector) (cell sale))
(addif (tax-col column-vector) (cell tax))
(addif (debit-col column-vector) debit)
(addif (credit-col column-vector) credit)))
(addif (bal-col column-vector)
(gnc:make-html-table-cell/size/markup
nrows 1 "number-cell" (cell amt)))
(addif (< 0 mid-span) cell-nohoriz)
(link-data->cols (car link-rows))))
(gnc:html-table-append-row/markup!
table (if odd-row? "normal-row" "alternate-row")
(link-data->cols (car link-rows))))
(lp (cdr link-rows) #f))))
(define (add-owner-table table splits acc start-date end-date date-type
used-columns payable? link-option)
(define (AP-negate num)
(if payable? (- num) num))
(define currency (xaccAccountGetCommodity acc))
(define rhs-cols (assq-ref `((none . 0)
(simple . 1)
(detailed . ,(num-cols used-columns 'rhs-cols)))
link-option))
(define mid-span
(if (eq? link-option 'detailed) (num-cols used-columns 'mid-spac) 0))
(define add-derived-amounts-disclaimer? #f)
(define (split->anchor split negate?)
(gnc:html-markup-anchor
(gnc:split-anchor-text split)
(gnc:make-gnc-monetary
(xaccAccountGetCommodity (xaccSplitGetAccount split))
((if negate? - +)
(AP-negate (xaccSplitGetAmount split))))))
(define (print-totals total debit credit tax sale invalid-splits)
(define (total-cell cell)
(gnc:make-html-table-cell/markup "total-number-cell" cell))
(define (make-cell amt)
(total-cell (gnc:make-gnc-monetary currency amt)))
(define period-span (num-cols used-columns 'ptt-span))
(define grand-span (num-cols used-columns 'lhs-cols))
;; print period totals
(if (or (sale-col used-columns) (tax-col used-columns)
(credit-col used-columns) (debit-col used-columns))
(gnc:html-table-append-row/markup!
table "grand-total"
(append
(addif (< 0 period-span) (gnc:make-html-table-cell/markup
"total-label-cell" (G_ "Period Totals")))
(addif (< 1 period-span) (gnc:make-html-table-cell/size
1 (1- period-span) #f))
(addif (sale-col used-columns) (make-cell sale))
(addif (tax-col used-columns) (make-cell tax))
(addif (debit-col used-columns) (make-cell debit))
(addif (credit-col used-columns) (make-cell credit))
(addif (bal-col used-columns) (make-cell total))
(addif (< 0 rhs-cols)
(gnc:make-html-table-cell/size
1 (+ mid-span rhs-cols)
(and add-derived-amounts-disclaimer?
(gnc:make-html-text
(G_ "* Amounts denoted thus are derived from, \
and do not match the transaction."))))))))
;; print grand total
(if (bal-col used-columns)
(gnc:html-table-append-row/markup!
table "grand-total"
(append
(addif (< 1 grand-span)
(gnc:make-html-table-cell/markup
"total-label-cell"
(if (negative? total)
(G_ "Total Credit")
(G_ "Total Due"))))
(addif (< 1 grand-span)
(gnc:make-html-table-cell/size/markup
1 (1- grand-span)
"total-number-cell"
(gnc:make-gnc-monetary currency total)))
(addif (< 0 rhs-cols)
(gnc:make-html-table-cell/size 1 (+ mid-span rhs-cols) #f)))))
(unless (null? invalid-splits)
(gnc:html-table-append-row/markup!
table "grand-total"
(list (gnc:make-html-table-cell/size
1 (+ grand-span mid-span rhs-cols)
(gnc:make-html-text
(G_ "Please note some transactions were not processed")
(gnc:html-markup-ol
(map
(match-lambda
((split txt)
(gnc:html-markup-anchor (gnc:split-anchor-text split) txt)))
invalid-splits))))))))
(define (add-balance-row odd-row? total)
(add-row table odd-row? used-columns start-date #f "" (G_ "Balance") "" #f
currency total #f #f #f #f #f
link-option (case link-option
((none) '(()))
((simple) '((#f)))
((detailed) (list (make-link-blank))))))
(define (make-invoice->payments-table invoice)
(let ((lot (gncInvoiceGetPostedLot invoice)))
(let lp ((lot-splits (gnc-lot-get-split-list lot))
(result '()))
(cond
;; Finished result rows. Display them, and add Outstanding if
;; invoice still not completely paid.
((null? lot-splits)
(reverse
(if (gncInvoiceIsPaid invoice)
result
(cons (make-link-desc-amount
(G_ "UNPAID")
(gnc:make-gnc-monetary
currency (AP-negate (gnc-lot-get-balance lot)))
(gncInvoiceReturnGUID invoice))
result))))
;; this is invoice posting split. skip. has no payment data.
((equal? (xaccSplitGetParent (car lot-splits))
(gncInvoiceGetPostedTxn invoice))
(lp (cdr lot-splits) result))
;; this is an invoice payment split (reduces the lot).
(else
(let* ((lot-split (car lot-splits))
(lot-txn (xaccSplitGetParent lot-split)))
;; each invoice payment split's peer splits are analysed.
(let lp1 ((lot-txn-splits (xaccTransGetSplitList lot-txn))
(non-document '())
(result result))
(cond
;; finished. loop up, adding single row with non-document
((null? lot-txn-splits)
(lp (cdr lot-splits)
(if (null? non-document)
result
(cons (make-link-data
(qof-print-date (xaccTransGetDate lot-txn))
(split->reference lot-split)
(split->type-str lot-split payable?)
(splits->desc non-document)
(gnc:make-html-text (split->anchor lot-split #f))
(list->cell
(map (lambda (s) (split->anchor s #t)) non-document))
(gncTransGetGUID lot-txn))
result))))
;; this payment's peer split has same sign as the
;; payment split. ignore.
((sign-equal? (xaccSplitGetAmount (car lot-txn-splits))
(xaccSplitGetAmount lot-split))
(lp1 (cdr lot-txn-splits) non-document result))
;; this payment's peer APAR split is a document lot
;; reducing split.
((lot-split->posting-split (car lot-txn-splits)) =>
(lambda (posting-split)
(let* ((lot-txn-split (car lot-txn-splits))
(posting-txn (xaccSplitGetParent posting-split))
(document (gncInvoiceGetInvoiceFromTxn posting-txn)))
(lp1 (cdr lot-txn-splits)
non-document
(cons (make-link-data
(qof-print-date (xaccTransGetDate posting-txn))
(split->reference posting-split)
(split->type-str posting-split payable?)
(splits->desc (list posting-split))
(gnc:make-html-text (split->anchor lot-split #f))
(gnc:make-html-text (split->anchor posting-split #f))
(gncInvoiceReturnGUID document))
result)))))
;; this payment's peer split can't find document. this
;; is a regular payment or an old link txn. accumulate.
(else
(lp1 (cdr lot-txn-splits)
(cons (car lot-txn-splits) non-document)
result))))))))))
(define (make-payment->invoices-list txn)
(list
(list
(apply
gnc:make-html-text
(map
(lambda (inv-split-pair)
(invoice->anchor (car inv-split-pair)))
(vector-ref (gnc:payment-txn->payment-info txn) 0))))))
(define (make-payment->payee-table txn payable?)
(define (invoices-list invoice-split-pairs)
(let lp ((invoice-split-pairs invoice-split-pairs)
(result '()))
(match invoice-split-pairs
(() (reverse result))
(((inv . APAR-split) . rest)
(let* ((posting-split (lot-split->posting-split APAR-split)))
(lp rest
(cons (make-link-data
(qof-print-date (gncInvoiceGetDatePosted inv))
(gnc:make-html-text (invoice->anchor inv))
(gncInvoiceGetTypeString inv)
(splits->desc (list APAR-split))
(gnc:make-html-text (split->anchor APAR-split #t))
(gnc:make-html-text (split->anchor posting-split #f))
(gncInvoiceReturnGUID inv))
result)))))))
(define (payments-list opposing-splits)
(let lp1 ((opposing-splits opposing-splits)
(pmt-list '()))
(match opposing-splits
(() (reverse pmt-list))
(((s partial-amount derived?). rest)
(when derived?
(set! add-derived-amounts-disclaimer? #t))
(lp1 rest
(cons
(make-link-data
(qof-print-date (xaccTransGetDate (xaccSplitGetParent s)))
(split->reference s)
(split->type-str s payable?)
(splits->desc (list s))
(gnc:make-html-text
(if derived? "* " "")
(gnc:html-markup-anchor
(gnc:split-anchor-text s)
(gnc:monetary->string
(gnc:make-gnc-monetary currency partial-amount))))
(gnc:make-html-text (split->anchor s #f))
(gncTransGetGUID (xaccSplitGetParent s)))
pmt-list))))))
(define (overpayment-list overpayment)
(if (zero? overpayment)
'()
(list (make-link-desc-amount
(G_ "Pre-Payment")
(gnc:make-html-text
(gnc:monetary->string
(gnc:make-gnc-monetary
currency ((if payable? + -) overpayment))))
(gncTransGetGUID txn)))))
(let* ((payment-info (gnc:payment-txn->payment-info txn))
(invoices-result (invoices-list (vector-ref payment-info 0)))
(payment-result (payments-list (vector-ref payment-info 1)))
(overpayment-result (overpayment-list (vector-ref payment-info 2))))
(append invoices-result payment-result overpayment-result)))
(define (amount->anchor split amount)
(gnc:make-html-text
(gnc:html-markup-anchor
(gnc:split-anchor-text split)
(gnc:make-gnc-monetary currency amount))))
(define seen-txns (make-hash-table))
(let lp ((printed? #f)
(odd-row? #t)
(splits splits)
(invalid-splits '())
(total 0)
(debit 0)
(credit 0)
(tax 0)
(sale 0))
(cond
((null? splits)
;;Balance row may not have been added if all transactions were before
;;start-date (and no other rows would be added either) so add it now
(when (and (not printed?) (bal-col used-columns) (not (zero? total)))
(add-balance-row odd-row? total))
(print-totals total debit credit tax sale invalid-splits)
(gnc:html-table-set-style!
table "table"
'attribute (list "border" 1)
'attribute (list "cellspacing" 0)
'attribute (list "cellpadding" 4))
table)
((hash-ref seen-txns (xaccSplitGetParent (car splits)))
(lp printed? odd-row? (cdr splits) invalid-splits total debit credit tax sale))
;; not an invoice/payment. skip transaction.
((not (or (txn-is-invoice? (xaccSplitGetParent (car splits)))
(txn-is-payment? (xaccSplitGetParent (car splits)))))
(lp printed? odd-row? (cdr splits) invalid-splits total debit credit tax sale))
;; invalid case: txn-type-invoice but no associated invoice, nor lot
((let* ((txn (xaccSplitGetParent (car splits)))
(invoice (gncInvoiceGetInvoiceFromTxn txn)))
(and (txn-is-invoice? txn)
(or (null? invoice)
(null? (gncInvoiceGetPostedLot invoice)))))
(gnc:warn "sanity check fail " (gnc:strify (car splits)))
(lp printed? odd-row? (cdr splits)
(cons (list (car splits) "Transaction has type invoice but no owner or lot")
invalid-splits)
total debit credit tax sale))
;; txn-date < start-date. skip display, accumulate amounts
((< (xaccTransGetDate (xaccSplitGetParent (car splits))) start-date)
(let* ((txn (xaccSplitGetParent (car splits)))
(value (AP-negate (xaccTransGetAccountAmount txn acc))))
(hash-set! seen-txns txn #t)
(lp printed? odd-row? (cdr splits) invalid-splits (+ total value)
debit credit tax sale)))
;; if balance row hasn't been rendered, consider
;; adding here. skip if value=0.
((not printed?)
(let ((print? (and (bal-col used-columns) (not (zero? total)))))
(if print? (add-balance-row odd-row? total))
(lp #t (not print?) splits invalid-splits total debit credit tax sale)))
;; start printing txns.
((txn-is-invoice? (xaccSplitGetParent (car splits)))
(hash-set! seen-txns (xaccSplitGetParent (car splits)) #t)
(let* ((split (car splits))
(txn (xaccSplitGetParent split))
(date (xaccTransGetDate txn))
(orig-value (xaccTransGetAccountAmount txn acc))
(value (AP-negate orig-value))
(invoice (gncInvoiceGetInvoiceFromTxn txn)))
(define (CN-negate fn)
(if (gncInvoiceGetIsCreditNote invoice) (- (fn invoice)) (fn invoice)))
(add-row
table odd-row? used-columns date (gncInvoiceGetDateDue invoice)
(split->reference split)
(split->type-str split payable?)
(splits->desc (list split))
(and (not (string-null? (gncInvoiceGetDocLink invoice))) invoice)
currency (+ total value)
(and (>= orig-value 0) (amount->anchor split orig-value))
(and (< orig-value 0) (amount->anchor split (- orig-value)))
(CN-negate gncInvoiceGetTotalSubtotal) (CN-negate gncInvoiceGetTotalTax)
(gncInvoiceReturnGUID invoice)
link-option
(case link-option
((simple) (list (list (and (gncInvoiceIsPaid invoice) (G_ "Paid")))))
((detailed) (make-invoice->payments-table invoice))
(else '(()))))
(lp printed? (not odd-row?) (cdr splits) invalid-splits (+ total value)
(if (< 0 orig-value) (+ debit orig-value) debit)
(if (< 0 orig-value) credit (- credit orig-value))
(+ tax (CN-negate gncInvoiceGetTotalTax))
(+ sale (CN-negate gncInvoiceGetTotalSubtotal)))))
((txn-is-payment? (xaccSplitGetParent (car splits)))
(hash-set! seen-txns (xaccSplitGetParent (car splits)) #t)
(let* ((split (car splits))
(txn (xaccSplitGetParent split))
(date (xaccTransGetDate txn))
(amt/next-pair
(let lp1 ((splits splits) (acc 0) (non-txn '()))
(match splits
(() (cons acc (reverse non-txn)))
(((? (lambda (s) (equal? (xaccSplitGetParent s) txn)) head) . tail)
(lp1 tail (+ (xaccSplitGetAmount head) acc) non-txn))
((head . tail) (lp1 tail acc (cons head non-txn))))))
(orig-value (car amt/next-pair))
(value (AP-negate orig-value)))
(add-row
table odd-row? used-columns date #f
(split->reference split)
(split->type-str split payable?)
(splits->desc (xaccTransGetAPARAcctSplitList txn #t) #t)
#f currency (+ total value)
(and (>= orig-value 0) (amount->anchor split orig-value))
(and (< orig-value 0) (amount->anchor split (- orig-value)))
#f #f
(gncTransGetGUID txn)
link-option
(case link-option
((simple) (make-payment->invoices-list txn))
((detailed) (make-payment->payee-table txn payable?))
(else '(()))))
(lp printed? (not odd-row?) (cdr amt/next-pair) invalid-splits (+ total value)
(if (< 0 orig-value) (+ debit orig-value) debit)
(if (< 0 orig-value) credit (- credit orig-value))
tax
sale))))))
(define (options-generator owner-type)
(let ((options (gnc-new-optiondb)))
(gnc-register-owner-option options
owner-page (owner-string owner-type) "v"
(N_ "The company for this report.") '() owner-type)
(gnc:options-add-date-interval!
options gnc:pagename-general
optname-from-date optname-to-date "a")
;; Use a default report date of 'today'
(GncOption-set-default-value
(gnc-lookup-option options gnc:pagename-general optname-to-date)
(cons 'relative 'today))
(gnc-register-simple-boolean-option options
(N_ "Display Columns") date-header
"b" (N_ "Display the transaction date?") #t)
(gnc-register-simple-boolean-option options
(N_ "Display Columns") due-date-header
"c" (N_ "Display the transaction date?") #t)
(gnc-register-simple-boolean-option options
(N_ "Display Columns") reference-header
"d" (N_ "Display the transaction reference?") #t)
(gnc-register-simple-boolean-option options
(N_ "Display Columns") type-header
"g" (N_ "Display the transaction type?") #t)
(gnc-register-simple-boolean-option options
(N_ "Display Columns") desc-header
"ha" (N_ "Display the transaction description?") #t)
(gnc-register-simple-boolean-option options
(N_ "Display Columns") sale-header
"haa" (N_ "Display the sale amount column?") #f)
(gnc-register-simple-boolean-option options
(N_ "Display Columns") tax-header
"hab" (N_ "Display the tax column?") #f)
(gnc-register-simple-boolean-option options
(N_ "Display Columns") debit-header
"hac" (N_ "Display the period debits column?") #t)
(gnc-register-simple-boolean-option options
(N_ "Display Columns") credit-header
"had" (N_ "Display the period credits column?") #t)
(gnc-register-simple-boolean-option options
(N_ "Display Columns") balance-header
"hb" (N_ "Display a running balance?") #t)
(gnc-register-multichoice-option options
(N_ "Display Columns") linked-txns-header
"hc"
(string-join
(list
(G_ "Show linked transactions")
(G_ "Linked transactions are hidden.")
(G_ "Invoices show if paid, payments show invoice numbers.")
(G_ "Invoices show list of payments, payments show list of invoices and amounts."))
"\n* ")
"none"
(list (vector 'none (N_ "Disabled"))
(vector 'simple (N_ "Simple"))
(vector 'detailed (N_ "Detailed"))))
(gnc-register-simple-boolean-option options
(N_ "Display Columns") doclink-header
"hd" (N_ "Display document link?") #f)
(gnc-register-multichoice-option options
gnc:pagename-general optname-date-driver "k"
(N_ "Leading date.") "duedate"
(list
(vector 'duedate (N_ "Due Date"))
(vector 'postdate (N_ "Post Date"))))
(gnc:options-set-default-section options "General")
options))
(define (setup-query q owner accounts end-date job?)
(let ((guid (gncOwnerReturnGUID (if job? owner (gncOwnerGetEndOwner owner))))
(last-param (if job? QOF-PARAM-GUID OWNER-PARENTG)))
(qof-query-add-guid-match
q (list SPLIT-TRANS INVOICE-FROM-TXN INVOICE-BILLTO last-param)
guid QOF-QUERY-OR)
(qof-query-add-guid-match
q (list SPLIT-LOT OWNER-FROM-LOT last-param)
guid QOF-QUERY-OR)
(qof-query-add-guid-match
q (list SPLIT-LOT INVOICE-FROM-LOT INVOICE-BILLTO last-param)
guid QOF-QUERY-OR)
(xaccQueryAddAccountMatch q accounts QOF-GUID-MATCH-ANY QOF-QUERY-AND)
(xaccQueryAddDateMatchTT q #f end-date #t end-date QOF-QUERY-AND)
(qof-query-set-book q (gnc-get-current-book))
(qof-query-set-sort-order q (list SPLIT-TRANS TRANS-DATE-POSTED) '() '())
q))
(define (setup-query2 q owner accounts end-date invoice-type)
(let ((guid (gncOwnerReturnGUID owner))
(last-param QOF-PARAM-GUID))
(qof-query-add-guid-match
q (list SPLIT-TRANS INVOICE-FROM-TXN invoice-type last-param)
guid QOF-QUERY-OR)
(qof-query-add-guid-match
q (list SPLIT-LOT OWNER-FROM-LOT last-param)
guid QOF-QUERY-OR)
(qof-query-add-guid-match
q (list SPLIT-LOT INVOICE-FROM-LOT invoice-type last-param)
guid QOF-QUERY-OR)
(xaccQueryAddAccountMatch q accounts QOF-GUID-MATCH-ANY QOF-QUERY-AND)
(xaccQueryAddDateMatchTT q #f end-date #t end-date QOF-QUERY-AND)
(qof-query-set-book q (gnc-get-current-book))
(qof-query-set-sort-order q (list SPLIT-TRANS TRANS-DATE-POSTED) '() '())
q))
(define (make-owner-table owner)
(let ((table (gnc:make-html-table)))
(gnc:html-table-set-style!
table "table"
'attribute (list "border" 0)
'attribute (list "cellspacing" 0)
'attribute (list "cellpadding" 0)
'attribute (list "valign" "top"))
(gnc:html-table-append-row!
table (gnc:multiline-to-html-text (gnc:owner-get-name-and-address-dep owner)))
table))
(define (make-myname-table book date-format)
(let*
((table (gnc:make-html-table))
(name (gnc:company-info book gnc:*company-name*))
(addy (gnc:company-info book gnc:*company-addy*)))
(gnc:html-table-set-style!
table "table"
'attribute (list "border" 0)
'attribute (list "align" "right")
'attribute (list "valign" "top")
'attribute (list "cellspacing" 0)