ERPNext Sales invoice custom Print Format

I have been working on/with ERPNext for some time now, but had never tried to change much in terms of the output formatting – mostly because I was too afraid to mess anything up. I only made minor changes with the format builder/GUI tool, which, I must say – is not intuitive, and which I personally found a bit frustrating.
Anyway – it turns out that setting up custom formatting using Jinja2 is not as terrifying as I thought.

Here’s my 2nd attempt/updated 1st attempt (no longer hard-coded tax-rate), with some commenting within the code to explain what I am doing, and also where/why. The biggest difference between my version and the default, is that I show the excl-VAT, VAT and incl-VAT values separately.

<style>
   /* My personal syle abbreviations to use minimal characters while coding the HTML portions*/
   /*.bd0 {   border: 1px dotted red;   padding: 0px;}*/
   .lf  {   text-align: left;}
   .cn  {   text-align: center;}
   .rt  {   text-align: right;}
   .vt  {   vertical-align: top;}
   .vc  {   vertical-align: middle;}
   .vb  {   vertical-align: bottom;}
   .xs  {   font-size: x-small;}
   .sm  {   font-size: small;}
   .md  {   font-size: medium;}
   .lg  {   font-size: large;}
   .xl  {   font-size: x-large;}
   .xxl {   font-size: xx-large;}
   .b   {   font-weight: bold;}
   .bb  {   font-weight: bolder;}
   .i   {   font-style: italic;}
   .u   {   text-decoration: underline;}
   .bd0 {   border: 1px dashed;}
   .bd1 {   border: 1px dotted;}
   .bd2 {   border: 2px solid;}
   .blk {   color: black;}
   .lgr {   color: lightgrey;}
   .lblu{   color: lightblue;}
   .blu {   color: blue;}
   .grn {   color: green;}
   .red {   color: red;}
   .ylw {   color: yellow;}
   .org {   color: orange;}
   .ord {   color: orangered;}
   .prp {   color: purple;}
   .lim {   color: lime;}
   .spacer {   color: white;   font-weight: bold;}

   .print-format table, .print-format tr, 
   .print-format td, .print-format div, .print-format p {
      //font-family: Monospace;
      vertical-align: middle;
      font-family: "Roboto", Helvetica, Arial, sans-serif;
      -webkit-font-smoothing: antialiased;
      -moz-osx-font-smoothing: grayscale;
      padding: 0px;
      z-index: 10;
   }
   @media screen {
      .print-format {
         padding: 10mm;
      }
   }
</style>

{# NOTE: default is to use looked up company name from ERPNext, but that doesn't suit us, so I hardcoded it #}
{# {{ doc.company }}<br> #}
<h3 class="cn b">{{ _("Company Name") }}</h3>
<div class="cn">{{ _("VAT No: ")  }}{{ _("777777777")  }}</div>
<br>
{# NOTE: conditional date type based on SINV status #}
<div class="cn">  {% if doc.docstatus == 0 %}     {{ doc.status + " " + (doc.select_print_heading or _("Tax Invoice: ")) }}     {% else %}     {{ doc.select_print_heading or _("Tax Invoice: ") }}     {% endif %} {{ doc.name }} </div>
<br>
<table class="table-condensed no-border">
   <tr>
      <td class="rt b">
         {{ _("Date") }}:
      </td>
      <td class="lf">
              {% if doc.docstatus == 0 %}     {{ doc.get_formatted("posting_date") }}     {% else %}     {{ doc.get_formatted("invoice_date") }}     {% endif %}     
      </td>
      <td class="rt b">
        {{ _("Time") }}:
      </td>
      <td class="lf">
        {{ frappe.utils.get_datetime().strftime('%H:%M:%S') }}
      </td>
   </tr>
   <tr>
      <td class="rt b">
         {{ _("Customer: ") }}<br>
         {{ _("VAT No: ") }}<br>
         {{ _("Contact: ") }}
      </td>
      <td class="lf">
         {{ doc.customer_name }}<br>
         {{ doc.tax_id }}<br>
         {{ doc.contact_display }}<br>{{ doc.contact_mobile }}
      </td>
      <td class="rt b">
         {{ _("Address") }}
      </td>
      <td class="lf">
         {{ doc.address_display }} 
      </td>
   </tr>
</table>

<table class="table table-condensed table-bordered">
{# <table class="table table-condensed cart no-border"> #}
	<thead>
		<tr>
			<th>Row</th>
			<th>Code/Item</th>
			<th class="cn">ea.<br>exc</th>
         <th class="cn">ea.<br>VAT</th>
         <th class="cn">ea.<br>inc</th>
			<th class="cn">qty*ea.</th>
			<th class="cn">amt<br>inc</th>
		</tr>
	</thead>
	<tbody>

{# Get the tax/VAT rate for THIS.document #}
{% set this_docs_vat_rate = frappe.db.get_value("Sales Taxes and Charges", {"parent": doc.name}, "rate") %}
{# This matches doc.name [parent= THIS.SalesInvoice] to ONE db row, and then extracts ONE/relevant column [RATE] #}
		{%- for row in doc.items -%}
		<tr>
			<td style="width: 3%;">{{ row.idx }}</td>
			<td><small>
				{{ row.item_code }}</small><br>
				{% if row.item_code != row.item_name -%} {{ row.item_name}} {%- endif %}
			</td>
			<td class="rt sm" style="width: 10%;">{{ "%.2f"|format(row.rate) }}</td>
			<td class="rt sm" style="width: 10%;">{{ "%.2f"|format(row.rate * (this_docs_vat_rate/100)  )}}</td>
         {# <br><small>@{{ (this_docs_vat_rate) }}%</small> #}
			<td class="rt sm" style="width: 10%;">{{ "%.2f"|format(row.rate * (1+(this_docs_vat_rate/100)) ) }}</td>
			<td class="rt" style="width: 15%;">{{ row.qty }}<small> @ </small>{{ "%.2f"|format(row.rate * (1+(this_docs_vat_rate/100)) ) }}</td>
			<td class="rt vb" style="width: 10%;">{{ "%.2f"|format(row.amount * (1+ (this_docs_vat_rate/100)) ) }}</td>
		</tr>
		{%- endfor -%}
	</tbody>
</table>

<table>
   <tr>
      <td style="width:65%"></td>
      <td>
         {# Totals subsection #}
         <table class="table table-condensed no-border">
            <tbody>
               <tr>
                  {% if doc.flags.show_inclusive_tax_in_print %}
                     <td class="rt b" style="width: 50%">{{ _("Total Excl. Tax") }}</td>
                     {# <td class="rt">{{ doc.get_formatted("net_total", doc) }}</td> #}
                     <td class="rt">{{ "R {:,.2f}".format(doc.net_total) }}</td>
                  {% else %}
                     <td class="rt b" style="width: 50%">{{ _("SubTotal (Excl)") }}</td>
                     <td class="rt">{{ "R {:,.2f}".format(doc.total) }}</td>
                  {% endif %}
               </tr>
               {%- for row in doc.taxes -%}
                  {%- if not row.included_in_print_rate or doc.flags.show_inclusive_tax_in_print -%}
                     <tr>
                        <td class="rt b" style="width: 50%">{{ row.description }}</td>
                        <td class="rt">{{ "R {:,.2f}".format(row.tax_amount) }}</td>
                     <tr>
                  {%- endif -%}
               {%- endfor -%}

               {%- if doc.discount_amount -%}
                  <tr>
                     <td class="rt b" style="width: 50%">{{ _("Discount") }}</td>
                     {# <td class="rt">{{ doc.get_formatted("discount_amount") }}</td> #}
                     <td class="rt">{{ "R {:,.2f}".format(doc.discount_amount) }}</td>
                  </tr>
               {%- endif -%}
               <tr>
                  <td class="rt b" style="width: 50%">{{ _("Grand Total (Incl)") }}</td>
                  <td class="rt lg">{{ "R {:,.2f}".format(doc.grand_total) }}</td>
               </tr>
            </tbody>
         </table>
      </td>
   </tr>
</table>
<hr>
<p>{{ doc.terms or "" }}</p>
<p class="cn b">{{ _("Thank you for your business.") }}</p>
<table>
   <tr>
      <td class="lf">{{ _("www.example.com<br>info@example.com<br>+27 11 555 5555<br>+27 xx xxx xxxx<br>GPS: -XX.xxxxxx, YY.yyyyyy") }}</td>
      <td class="rt">{{ _("Address Line 1, Line 2<br>Building Name<br>cnr Street 1/Street 2<br>Suburb<br>PostCode") }}</td>
   </tr>
</table>
x
 
1
<style>
2
   /* My personal syle abbreviations to use minimal characters while coding the HTML portions*/
3
   /*.bd0 {   border: 1px dotted red;   padding: 0px;}*/
4
   .lf  {   text-align: left;}
5
   .cn  {   text-align: center;}
6
   .rt  {   text-align: right;}
7
   .vt  {   vertical-align: top;}
8
   .vc  {   vertical-align: middle;}
9
   .vb  {   vertical-align: bottom;}
10
   .xs  {   font-size: x-small;}
11
   .sm  {   font-size: small;}
12
   .md  {   font-size: medium;}
13
   .lg  {   font-size: large;}
14
   .xl  {   font-size: x-large;}
15
   .xxl {   font-size: xx-large;}
16
   .b   {   font-weight: bold;}
17
   .bb  {   font-weight: bolder;}
18
   .i   {   font-style: italic;}
19
   .u   {   text-decoration: underline;}
20
   .bd0 {   border: 1px dashed;}
21
   .bd1 {   border: 1px dotted;}
22
   .bd2 {   border: 2px solid;}
23
   .blk {   color: black;}
24
   .lgr {   color: lightgrey;}
25
   .lblu{   color: lightblue;}
26
   .blu {   color: blue;}
27
   .grn {   color: green;}
28
   .red {   color: red;}
29
   .ylw {   color: yellow;}
30
   .org {   color: orange;}
31
   .ord {   color: orangered;}
32
   .prp {   color: purple;}
33
   .lim {   color: lime;}
34
   .spacer {   color: white;   font-weight: bold;}
35
36
   .print-format table, .print-format tr, 
37
   .print-format td, .print-format div, .print-format p {
38
      //font-family: Monospace;
39
      vertical-align: middle;
40
      font-family: "Roboto", Helvetica, Arial, sans-serif;
41
      -webkit-font-smoothing: antialiased;
42
      -moz-osx-font-smoothing: grayscale;
43
      padding: 0px;
44
      z-index: 10;
45
   }
46
   @media screen {
47
      .print-format {
48
         padding: 10mm;
49
      }
50
   }
51
</style>
52
53
{# NOTE: default is to use looked up company name from ERPNext, but that doesn't suit us, so I hardcoded it #}
54
{# {{ doc.company }}<br> #}
55
<h3 class="cn b">{{ _("Company Name") }}</h3>
56
<div class="cn">{{ _("VAT No: ")  }}{{ _("777777777")  }}</div>
57
<br>
58
{# NOTE: conditional date type based on SINV status #}
59
<div class="cn">  {% if doc.docstatus == 0 %}     {{ doc.status + " " + (doc.select_print_heading or _("Tax Invoice: ")) }}     {% else %}     {{ doc.select_print_heading or _("Tax Invoice: ") }}     {% endif %} {{ doc.name }} </div>
60
<br>
61
<table class="table-condensed no-border">
62
   <tr>
63
      <td class="rt b">
64
         {{ _("Date") }}:
65
      </td>
66
      <td class="lf">
67
              {% if doc.docstatus == 0 %}     {{ doc.get_formatted("posting_date") }}     {% else %}     {{ doc.get_formatted("invoice_date") }}     {% endif %}     
68
      </td>
69
      <td class="rt b">
70
        {{ _("Time") }}:
71
      </td>
72
      <td class="lf">
73
        {{ frappe.utils.get_datetime().strftime('%H:%M:%S') }}
74
      </td>
75
   </tr>
76
   <tr>
77
      <td class="rt b">
78
         {{ _("Customer: ") }}<br>
79
         {{ _("VAT No: ") }}<br>
80
         {{ _("Contact: ") }}
81
      </td>
82
      <td class="lf">
83
         {{ doc.customer_name }}<br>
84
         {{ doc.tax_id }}<br>
85
         {{ doc.contact_display }}<br>{{ doc.contact_mobile }}
86
      </td>
87
      <td class="rt b">
88
         {{ _("Address") }}
89
      </td>
90
      <td class="lf">
91
         {{ doc.address_display }} 
92
      </td>
93
   </tr>
94
</table>
95
96
<table class="table table-condensed table-bordered">
97
{# <table class="table table-condensed cart no-border"> #}
98
    <thead>
99
        <tr>
100
            <th>Row</th>
101
            <th>Code/Item</th>
102
            <th class="cn">ea.<br>exc</th>
103
         <th class="cn">ea.<br>VAT</th>
104
         <th class="cn">ea.<br>inc</th>
105
            <th class="cn">qty*ea.</th>
106
            <th class="cn">amt<br>inc</th>
107
        </tr>
108
    </thead>
109
    <tbody>
110
111
{# Get the tax/VAT rate for THIS.document #}
112
{% set this_docs_vat_rate = frappe.db.get_value("Sales Taxes and Charges", {"parent": doc.name}, "rate") %}
113
{# This matches doc.name [parent= THIS.SalesInvoice] to ONE db row, and then extracts ONE/relevant column [RATE] #}
114
        {%- for row in doc.items -%}
115
        <tr>
116
            <td style="width: 3%;">{{ row.idx }}</td>
117
            <td><small>
118
                {{ row.item_code }}</small><br>
119
                {% if row.item_code != row.item_name -%} {{ row.item_name}} {%- endif %}
120
            </td>
121
            <td class="rt sm" style="width: 10%;">{{ "%.2f"|format(row.rate) }}</td>
122
            <td class="rt sm" style="width: 10%;">{{ "%.2f"|format(row.rate * (this_docs_vat_rate/100)  )}}</td>
123
         {# <br><small>@{{ (this_docs_vat_rate) }}%</small> #}
124
            <td class="rt sm" style="width: 10%;">{{ "%.2f"|format(row.rate * (1+(this_docs_vat_rate/100)) ) }}</td>
125
            <td class="rt" style="width: 15%;">{{ row.qty }}<small> @ </small>{{ "%.2f"|format(row.rate * (1+(this_docs_vat_rate/100)) ) }}</td>
126
            <td class="rt vb" style="width: 10%;">{{ "%.2f"|format(row.amount * (1+ (this_docs_vat_rate/100)) ) }}</td>
127
        </tr>
128
        {%- endfor -%}
129
    </tbody>
130
</table>
131
132
<table>
133
   <tr>
134
      <td style="width:65%"></td>
135
      <td>
136
         {# Totals subsection #}
137
         <table class="table table-condensed no-border">
138
            <tbody>
139
               <tr>
140
                  {% if doc.flags.show_inclusive_tax_in_print %}
141
                     <td class="rt b" style="width: 50%">{{ _("Total Excl. Tax") }}</td>
142
                     {# <td class="rt">{{ doc.get_formatted("net_total", doc) }}</td> #}
143
                     <td class="rt">{{ "R {:,.2f}".format(doc.net_total) }}</td>
144
                  {% else %}
145
                     <td class="rt b" style="width: 50%">{{ _("SubTotal (Excl)") }}</td>
146
                     <td class="rt">{{ "R {:,.2f}".format(doc.total) }}</td>
147
                  {% endif %}
148
               </tr>
149
               {%- for row in doc.taxes -%}
150
                  {%- if not row.included_in_print_rate or doc.flags.show_inclusive_tax_in_print -%}
151
                     <tr>
152
                        <td class="rt b" style="width: 50%">{{ row.description }}</td>
153
                        <td class="rt">{{ "R {:,.2f}".format(row.tax_amount) }}</td>
154
                     <tr>
155
                  {%- endif -%}
156
               {%- endfor -%}
157
158
               {%- if doc.discount_amount -%}
159
                  <tr>
160
                     <td class="rt b" style="width: 50%">{{ _("Discount") }}</td>
161
                     {# <td class="rt">{{ doc.get_formatted("discount_amount") }}</td> #}
162
                     <td class="rt">{{ "R {:,.2f}".format(doc.discount_amount) }}</td>
163
                  </tr>
164
               {%- endif -%}
165
               <tr>
166
                  <td class="rt b" style="width: 50%">{{ _("Grand Total (Incl)") }}</td>
167
                  <td class="rt lg">{{ "R {:,.2f}".format(doc.grand_total) }}</td>
168
               </tr>
169
            </tbody>
170
         </table>
171
      </td>
172
   </tr>
173
</table>
174
<hr>
175
<p>{{ doc.terms or "" }}</p>
176
<p class="cn b">{{ _("Thank you for your business.") }}</p>
177
<table>
178
   <tr>
179
      <td class="lf">{{ _("www.example.com<br>info@example.com<br>+27 11 555 5555<br>+27 xx xxx xxxx<br>GPS: -XX.xxxxxx, YY.yyyyyy") }}</td>
180
      <td class="rt">{{ _("Address Line 1, Line 2<br>Building Name<br>cnr Street 1/Street 2<br>Suburb<br>PostCode") }}</td>
181
   </tr>
182
</table>

which produces something like this…
Resulting output

4 thoughts on “ERPNext Sales invoice custom Print Format”

sam says:

2021-12-21 at 23:43

Hi there,

Looks very similar to my template. At the moment I am struggling with the following:
The customer has a name. The contact of the customer has a company_name. In the invoice I want to print:
company_name (from contact)
customer name (from customer)

My struggle is getting the company_name. Any suggestion how to get?

Best regars
Sam

Cepho says:

2021-06-07 at 09:35

Hi all,

Has anyone tried this on V13?

1. Trent says:
  
  2021-08-27 at 16:42
  
  Not yet – I had to fix a series of (unrelated) server crashes, so I haven’t had a chance to try it. Those are (as of today 27 Aug) now working again, so I will have a crack at the v13 and create a new post or update this one ASAP
  
Vince says:

2019-10-01 at 02:29

Do ｙou mind if I quote a few of your posts as
long ɑs I provide credit and sources back to youг ѡeblog?
My bloց is in the very same niche as yours and my users would definitely benefit from some of the information you provide here.
Please let me know if this okɑy with you. Cheers!

You may also like these posts:

[Superceded/OLD:2019-11-15] ERPNext manual install on Debian Buster 10.x

[updated:2019/07] ERPNext manual install on Debian Stretch 9.x

[NEW:2020-07-18] ERPNext v12 manual install on ubuntu 16/18/20 with Python v3.x

4 thoughts on “ERPNext Sales invoice custom Print Format”

Leave a Reply to Cepho Cancel reply