-
Notifications
You must be signed in to change notification settings - Fork 759
/
taxinvoice.scm
357 lines (327 loc) · 18.6 KB
/
taxinvoice.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
;; $Author: chris $ $Date: 2009/07/29 09:31:44 $ $Revision: 1.33 $
;; Modified by Dmitry Smirnov <onlyjob@member.fsf.org> 16 Feb 2012
;;
;; 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, write to the Free Software
;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
;; 02111-1307 USA
; If you want to adapt this report privately:
; - copy the report to your .gnucash directory
; - specify a different module name below (eg mytaxinvoice)
; - refer to it from .gnucash/config.user
; (see http://wiki.gnucash.org/wiki/Custom_Reports )
(define-module (gnucash report taxinvoice))
(use-modules (ice-9 local-eval)) ; for the-environment
(use-modules (gnucash utilities))
(use-modules (gnucash gnc-module))
(use-modules (gnucash gettext))
(gnc:module-load "gnucash/report/report-system" 0)
(gnc:module-load "gnucash/html" 0)
(gnc:module-load "gnucash/engine" 0)
(use-modules (gnucash report standard-reports))
(use-modules (gnucash report business-reports))
(use-modules (gnucash report eguile-utilities))
(use-modules (gnucash report eguile-html-utilities))
(use-modules (gnucash report eguile-gnc))
(use-modules (srfi srfi-13)) ; for extra string functions
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Report-specific routines
(define (taxrate taxable taxtable curr)
;; Display the tax rate applicable to an invoice line.
;; This may be e.g. "15%" or "£5.00" or "15% + £5.00" or "n/a"
;; depending on how complicated the tax table is.
;; (When called from within the eguile template, anything
;; (display)ed becomes part of the HTML string.)
(if (or (not taxable) (eq? taxtable '()))
(display " ")
(let* ((amttot (gnc:make-commodity-collector))
(pctot (gnc:make-value-collector))
(entries (gncTaxTableGetEntries taxtable))
(amt? #f) ; becomes #t if any entries are amounts
(pc? #f)) ; becomes #t if any entries are percentages
(for entry in entries do
(let ((tttype (gncTaxTableEntryGetType entry))
(ttamt (gncTaxTableEntryGetAmount entry)))
(if (equal? tttype GNC-AMT-TYPE-VALUE)
(begin
(set! amt? #t)
(amttot 'add curr ttamt))
(begin
(set! pc? #t)
(pctot 'add ttamt)))))
(if pc? (begin (display (fmtnumeric (pctot 'total #f))) (display "%")))
(if (and amt? pc?) (display " + ")) ; both - this seems unlikely in practice
(if amt?
(display-comm-coll-total amttot #f))
(if (and (not amt?) (not pc?)) (display (_ "n/a")))))) ; neither
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Define all the options
; option pages
(define headingpage (N_ "Headings 1"))
(define headingpage2 (N_ "Headings 2"))
(define notespage (N_ "Notes"))
;(define filespage (N_ "Files"))
(define displaypage (N_ "Display"))
(define elementspage (N_ "Elements"))
; option names
(define optname-col-date (N_ "column: Date"))
(define optname-col-taxrate (N_ "column: Tax Rate"))
(define optname-col-units (N_ "column: Units"))
(define optname-row-address (N_ "row: Address"))
(define optname-row-contact (N_ "row: Contact"))
(define optname-row-invoice-number (N_ "row: Invoice Number"))
(define optname-row-company-name (N_ "row: Company Name"))
(define optname-report-currency (N_ "Report Currency"))
(define optname-invoice-number-text (N_ "Invoice number text"))
(define optname-to-text (N_ "To text"))
(define optname-ref-text (N_ "Ref text"))
(define optname-jobname-text (N_ "Job Name text"))
(define optname-jobnumber-text (N_ "Job Number text"))
(define optname-jobname-show (N_ "Show Job name"))
(define optname-jobnumber-show (N_ "Show Job number"))
(define optname-netprice (N_ "Show net price"))
(define optname-invnum-next-to-title (N_ "Invoice number next to title"))
(define optname-border-collapse (N_ "table-border-collapse"))
(define optname-border-color-th (N_ "table-header-border-color"))
(define optname-border-color-td (N_ "table-cell-border-color"))
(define optname-extra-css (N_ "Embedded CSS"))
(define optname-report-title (N_ "Report title"))
(define optname-template-file (N_ "Template file"))
(define optname-css-file (N_ "CSS stylesheet file"))
(define optname-heading-font (N_ "Heading font"))
(define optname-text-font (N_ "Text font"))
(define optname-logofile (N_ "Logo filename"))
(define optname-logo-width (N_ "Logo width"))
(define optname-units (N_ "Units"))
(define optname-qty (N_ "Qty"))
(define optname-unit-price (N_ "Unit Price"))
(define optname-disc-rate (N_ "Discount Rate"))
(define optname-disc-amount (N_ "Discount Amount"))
(define optname-net-price (N_ "Net Price"))
(define optname-tax-rate (N_ "Tax Rate"))
(define optname-tax-amount (N_ "Tax Amount"))
(define optname-total-price (N_ "Total Price"))
(define optname-subtotal (N_ "Sub-total"))
(define optname-amount-due (N_ "Amount Due"))
(define optname-payment-recd (N_ "Payment received text"))
(define optname-extra-notes (N_ "Extra notes"))
; Choose only customer invoices
; (This doesn't work very nicely -- all invoices and bills
; are offered for selection, but if a non-customer invoice
; is selected, the user is dumped back to viewing the
; previous invoice (or none) with no error message)
(define (customers-only invoice)
(let* ((owner (gncInvoiceGetOwner invoice))
(endowner (gncOwnerGetEndOwner owner))
(ownertype (gncOwnerGetType endowner)))
;(gnc:debug "ownertype is ")(gnc:debug ownertype)
(if (eqv? ownertype GNC-OWNER-CUSTOMER)
(list #t invoice)
(list #f invoice))))
(define (options-generator)
;; Options
(define report-options (gnc:new-options))
(define (add-option new-option)
(gnc:register-option report-options new-option))
(add-option
(gnc:make-invoice-option ; defined in gnucash/scm/business-options.scm
gnc:pagename-general gnc:optname-invoice-number
"a" "" (lambda () '())
#f)) ;customers-only)) ;-- see above
(add-option
(gnc:make-currency-option
gnc:pagename-general optname-report-currency
"b" "" (gnc-default-report-currency)))
;; Elements page options
(add-option (gnc:make-simple-boolean-option elementspage optname-col-date "a" (N_ "Display the date?") #t))
(add-option (gnc:make-simple-boolean-option elementspage optname-col-taxrate "b" (N_ "Display the Tax Rate?") #t))
(add-option (gnc:make-simple-boolean-option elementspage optname-col-units "c" (N_ "Display the Units?") #t))
(add-option (gnc:make-simple-boolean-option elementspage optname-row-contact "d" (N_ "Display the contact?") #t))
(add-option (gnc:make-simple-boolean-option elementspage optname-row-address "e" (N_ "Display the address?") #t))
(add-option (gnc:make-simple-boolean-option elementspage optname-row-invoice-number "f" (N_ "Display the Invoice Number?") #t))
(add-option (gnc:make-simple-boolean-option elementspage optname-row-company-name "g" (N_ "Display the Company Name?") #t))
(add-option (gnc:make-simple-boolean-option elementspage optname-invnum-next-to-title "h" (N_ "Invoice Number next to title?") #f))
(add-option (gnc:make-simple-boolean-option elementspage optname-jobname-show "i" (N_ "Display Job name?") #t))
(add-option (gnc:make-simple-boolean-option elementspage optname-jobnumber-show "j" (N_ "Invoice Job number?") #f))
(add-option (gnc:make-simple-boolean-option elementspage optname-netprice "k" (N_ "Show net price?") #f))
;; Display options
(add-option (gnc:make-string-option displaypage optname-template-file "a"
(N_ "The file name of the eguile template part of this report. This file should either be in your .gnucash directory, or else in its proper place within the GnuCash installation directories.")
"taxinvoice.eguile.scm"))
(add-option (gnc:make-string-option displaypage optname-css-file "b"
(N_ "The file name of the CSS stylesheet to use with this report. This file should either be in your .gnucash directory, or else in its proper place within the GnuCash installation directories.")
"taxinvoice.css"))
(add-option (gnc:make-font-option
displaypage optname-heading-font "c"
(N_ "Font to use for the main heading.") "Sans Bold 18"))
(add-option (gnc:make-font-option
displaypage optname-text-font "d"
(N_ "Font to use for everything else.") "Sans 10"))
(add-option (gnc:make-pixmap-option
displaypage optname-logofile "e"
(N_ "Name of a file containing a logo to be used on the report.")
""))
(add-option (gnc:make-string-option
displaypage optname-logo-width "f" (N_ "Width of the logo in CSS format, e.g. 10% or 32px. Leave blank to display the logo at its natural width. The height of the logo will be scaled accordingly.") ""))
(add-option (gnc:make-simple-boolean-option displaypage optname-border-collapse "g" (N_ "Border-collapse?") #f))
(add-option (gnc:make-string-option displaypage optname-border-color-th "h" (N_ "CSS color.") "black"))
(add-option (gnc:make-string-option displaypage optname-border-color-td "i" (N_ "CSS color.") "black"))
;; Heading options
(add-option (gnc:make-string-option
; page / name / orderkey / tooltip / default
headingpage optname-report-title "a" "" (_ "Invoice")))
(add-option (gnc:make-string-option
headingpage optname-units "b" "" (_ "Units")))
(add-option (gnc:make-string-option
headingpage optname-qty "c" "" (_ "Qty")))
(add-option (gnc:make-string-option
headingpage optname-unit-price "d" "" (_ "Unit Price")))
(add-option (gnc:make-string-option
headingpage optname-disc-rate "e" "" (_ "Discount Rate")))
(add-option (gnc:make-string-option
headingpage optname-disc-amount "f" "" (_ "Discount Amount")))
(add-option (gnc:make-string-option
headingpage optname-net-price "g" "" (_ "Net Price")))
(add-option (gnc:make-string-option
headingpage optname-tax-rate "h" "" (_ "Tax Rate")))
(add-option (gnc:make-string-option
headingpage optname-tax-amount "i" "" (_ "Tax Amount")))
(add-option (gnc:make-string-option
headingpage optname-total-price "j" "" (_ "Total Price")))
(add-option (gnc:make-string-option
headingpage2 optname-subtotal "a" "" (_ "Sub-total")))
(add-option (gnc:make-string-option
headingpage2 optname-amount-due "b" "" (_ "Amount Due")))
(add-option (gnc:make-string-option
headingpage2 optname-payment-recd "c" ""
(_ "Payment received, thank you")))
(add-option (gnc:make-string-option headingpage2 optname-invoice-number-text
"d" "" (_ "Invoice number: ")))
(add-option (gnc:make-string-option headingpage2 optname-to-text
"e" "" (_ "To: ")))
(add-option (gnc:make-string-option headingpage2 optname-ref-text
"f" "" (_ "Your ref: ")))
(add-option (gnc:make-string-option headingpage2 optname-jobnumber-text
"g" "" (_ "Job number: ")))
(add-option (gnc:make-string-option headingpage2 optname-jobname-text
"h" "" (_ "Job name: ")))
(add-option (gnc:make-text-option
notespage optname-extra-notes "a"
(_ "Notes added at end of invoice -- may contain HTML markup.")
(_ "Thank you for your patronage!")))
;(N_ "(Development version -- don't rely on the numbers on this report without double-checking them.<br/>Change the 'Extra Notes' option to get rid of this message)")))
(add-option (gnc:make-text-option notespage optname-extra-css "b"
(N_ "Embedded CSS.") "h1.coyname { text-align: left; }"))
(gnc:options-set-default-section
report-options gnc:pagename-general)
report-options)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Create the report
(define (report-renderer report-obj)
;; Create and return the report as either an HTML string
;; or an <html-document>
(define (opt-value section name)
; wrapper for option routines
(define (get-opt section name)
(gnc:lookup-option (gnc:report-options report-obj) section name))
(gnc:option-value (get-opt section name)))
; Get all the options
(let* ((document (gnc:make-html-document))
(opt-invoice (opt-value gnc:pagename-general gnc:optname-invoice-number))
(opt-template-file (find-file
(opt-value displaypage optname-template-file)))
(opt-css-file (find-file
(opt-value displaypage optname-css-file)))
(opt-heading-font (font-name-to-style-info
(opt-value displaypage optname-heading-font)))
(opt-text-font (font-name-to-style-info
(opt-value displaypage optname-text-font)))
(opt-logofile (opt-value displaypage optname-logofile))
(opt-logo-width (opt-value displaypage optname-logo-width))
(opt-col-date (opt-value elementspage optname-col-date))
(opt-col-taxrate (opt-value elementspage optname-col-taxrate))
(opt-col-units (opt-value elementspage optname-col-units))
(opt-row-contact (opt-value elementspage optname-row-contact))
(opt-row-address (opt-value elementspage optname-row-address))
(opt-row-invoice-number (opt-value elementspage optname-row-invoice-number))
(opt-row-company-name (opt-value elementspage optname-row-company-name))
(opt-invnum-next-to-title (opt-value elementspage optname-invnum-next-to-title))
(opt-jobname-show (opt-value elementspage optname-jobname-show))
(opt-jobnumber-show (opt-value elementspage optname-jobnumber-show))
(opt-netprice (opt-value elementspage optname-netprice))
(opt-report-currency (opt-value gnc:pagename-general optname-report-currency))
(opt-css-border-collapse (if (opt-value displaypage optname-border-collapse) "border-collapse:collapse;"))
(opt-css-border-color-th (opt-value displaypage optname-border-color-th))
(opt-css-border-color-td (opt-value displaypage optname-border-color-td))
(opt-report-title (opt-value headingpage optname-report-title))
(opt-units-heading (opt-value headingpage optname-units))
(opt-qty-heading (opt-value headingpage optname-qty))
(opt-unit-price-heading (opt-value headingpage optname-unit-price))
(opt-disc-rate-heading (opt-value headingpage optname-disc-rate))
(opt-disc-amount-heading (opt-value headingpage optname-disc-amount))
(opt-net-price-heading (opt-value headingpage optname-net-price))
(opt-tax-rate-heading (opt-value headingpage optname-tax-rate))
(opt-tax-amount-heading (opt-value headingpage optname-tax-amount))
(opt-total-price-heading (opt-value headingpage optname-total-price))
(opt-subtotal-heading (opt-value headingpage2 optname-subtotal))
(opt-amount-due-heading (opt-value headingpage2 optname-amount-due))
(opt-payment-recd-heading (opt-value headingpage2 optname-payment-recd))
(opt-invoice-number-text (opt-value headingpage2 optname-invoice-number-text))
(opt-to-text (opt-value headingpage2 optname-to-text))
(opt-ref-text (opt-value headingpage2 optname-ref-text))
(opt-jobnumber-text (opt-value headingpage2 optname-jobnumber-text))
(opt-jobname-text (opt-value headingpage2 optname-jobname-text))
(opt-extra-css (opt-value notespage optname-extra-css))
(opt-extra-notes (opt-value notespage optname-extra-notes))
(html (eguile-file-to-string
opt-template-file
(the-environment))))
(gnc:debug "taxinvoice.scm - generated html:") (gnc:debug html)
html))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; Define the report
(gnc:define-report
'version 1
'name (N_ "Tax Invoice")
'report-guid "0769e242be474010b4acf264a5512e6e"
'menu-name (N_ "Tax Invoice")
'menu-tip (N_ "Display a customer invoice with tax columns (using eguile template)")
'menu-path (list gnc:menuname-business-reports)
'options-generator options-generator
'renderer report-renderer)
(define (au-tax-options-generator)
(define (set-opt options page name value)
(let ((option (gnc:lookup-option options page name)))
(gnc:option-set-value option value)))
(let ((options (options-generator)))
(set-opt options headingpage optname-report-title (_ "Tax Invoice"))
;(gnc:warn "title: " (gnc:option-value title-op))
(set-opt options headingpage optname-unit-price (_ "Unit"))
;(gnc:warn "unitprice: " (gnc:option-value unit-price-op))
(set-opt options headingpage optname-tax-rate (_ "GST Rate"))
(set-opt options headingpage optname-tax-amount (_ "GST Amount"))
(set-opt options headingpage2 optname-amount-due (_ "Amount Due (inc GST)"))
(set-opt options headingpage2 optname-invoice-number-text (_ "Invoice #: "))
(set-opt options headingpage2 optname-ref-text (_ "Reference: "))
(set-opt options headingpage2 optname-jobname-text (_ "Engagement: "))
(set-opt options notespage optname-extra-css "h1.coyname { text-align: right; margin-bottom: 0px ; font-size: 200%; } h2.invoice { text-align: left; margin-bottom: 0px ; font-size: 500%; }")
options))
(gnc:define-report
'version 1
'name (N_ "Australian Tax Invoice")
'report-guid "3dbbc2584da64e7a8674355bc3fbfe3d"
'menu-name (N_ "Australian Tax Invoice")
'menu-tip (N_ "Display an Australian customer invoice with tax columns (using eguile template)")
'menu-path (list gnc:menuname-business-reports)
'options-generator au-tax-options-generator
'renderer report-renderer)