Skip to content

Commit 5626bef

Browse files
committed
Update documentation for QR codes
1 parent cc9359e commit 5626bef

File tree

9 files changed

+37
-14
lines changed

9 files changed

+37
-14
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

source/en/qr-codes.md

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,21 @@ This is your normal IBAN. You can't use a reference! You are only allowed to use
3939

4040
Follows the ISO-11649 norm. Works like a QR-Reference but uses ISO-11649 which makes it usable international. Unlike the provious two QR codes, this also works outside of Switzerland. You have to use the normal IBAN, not the QR IBAN.
4141

42+
### Inserting the QR Code into your Invoice
43+
44+
<x-info>
45+
> Your company country must be set to Switzerland for the QR IBAN and BESR Number fields to become visible on the Company Details page.
46+
</x-info>
47+
4248
![alt text](/assets/images/pdf_customization/swiss_qrcode1.png "Swiss QR Codes")
4349

44-
You can configure this under Settigns > Company Details in the Details page.
50+
Codes can be inserted directly into the wysiwyg editor in either the public notes or terms sections.
4551

4652
![alt text](/assets/images/pdf_customization/swiss_qrcode3.png "Swiss QR Codes")
4753

48-
You'll then need to customize your design to include the QR code on your PDFs. To do this create a new design in Settings > Inovice Design > Customize
54+
<x-warning>
55+
> Due to the width of these containers, the QR Code will appear compressed. If you prefer to have the QR code stretch the width of the PDF, you'll want to create a custom design and insert the QR code into the body of the invoice as shown below.
56+
</x-warning>
4957
5058
In the body tab, at the bottom add
5159

@@ -61,43 +69,58 @@ or we have also made available a decoded version using the following variable
6169
$swiss_qr_raw
6270
```
6371

72+
![alt text](/assets/images/pdf_customization/swiss_qrcode4.png "Swiss QR Codes")
6473

65-
After you have saved the design, you'll want to make this your new default design.
74+
This will then allow the QR code to stretch the width of the PDF and will appear as follows.
6675

67-
![alt text](/assets/images/pdf_customization/swiss_qrcode2.png "Swiss QR Codes")
76+
![alt text](/assets/images/pdf_customization/swiss_qrcode5.png "Swiss QR Codes")
77+
78+
After you have saved the design, you'll want to make this your new default design.
6879

6980
If your QR codes are not appearing then there would be a configuration issue that needs to be addressed. The most common reasons the QR code does not appear on the PDF is due to missing company details. Your full address is required along with the clients full details.
7081

7182
## SEPA ERC QR Codes
7283

7384
To enable SEPA QR codes you'll need to follow a couple of steps to ensure there is the correct data.
7485

75-
SEPA QR codes require at the very least a IBAN, for payments outside of EEA you will also need the BIC. These two fields are harvested from the Custom Company Fields section of Invoice Ninja. Please note that IBAN must be the first custom field and BIC the second custom field. To configure these navigate to
86+
SEPA QR codes require at the very least a IBAN, for payments outside of EEA you will also need the BIC.
7687

77-
```bash
78-
Settings > Custom Fields > Company
79-
```
88+
You can configure your payment details by enabling E Invoicing and setting the payment method to Credit Transfer (code 30) or SEPA Credit Transfer (code 58).
89+
90+
![alt text](/assets/images/qr/sepa_qr_code_config_1.png "Enable E Invoicing")
91+
92+
Once you enable E Invoicing, the payment means dialog will appear, then set either code 30 or 58, the form will then populate with the correct fields.
8093

81-
![alt text](/assets/images/user_guide/iban_bic.png "IBAN and BIC configuration")
94+
![alt text](/assets/images/qr/sepa_qr_code_config_2.png "Set payment method to Credit/Transfer")
8295

83-
Once saved, then navigate to
96+
The variable
8497

8598
```bash
86-
Settings > Company Details
99+
$sepa_qr_code
87100
```
88101

89-
And enter in the values for your company
102+
Can be placed directly into the Public Notes or Terms sections of your invoice, for automatic generation of the QR code in your invoice.
103+
104+
![alt text](/assets/images/qr/sepa_qr_code_config_3.png "Insert code into invoice")
90105

91-
![alt text](/assets/images/user_guide/iban_bic_2.png "IBAN and BIC configuration")
106+
If you prefer to have control over the location of the QR code you can create a custom design and then use the following options to inject the QR code into your PDF.
92107

93-
In your custom design, you'll then want to insert the variable that allows the QR code to be injected, for example.
94108

95109
```
96110
<div data-state="encoded-html">
97111
$sepa_qr_code
98112
</div>
99113
```
100114

115+
or
116+
117+
```
118+
$sepa_qr_code_raw
119+
```
120+
121+
![alt text](/assets/images/qr/sepa_qr_code_config_4.png "Insert code into the custom design")
122+
123+
101124
## Generic Payment link QR Codes
102125

103126
Generic payment QR codes can easily be applied to your Invoice PDF using the following block in your custom Design

0 commit comments

Comments
 (0)