Skip to content

Commit c5e30a5

Browse files
meval1006huisit
andcommitted
[IMP] sales: pdf quote builder revision
closes #17195 X-original-commit: 37250a3 Signed-off-by: Felicia Kuan (feku) <feku@odoo.com> Signed-off-by: Megan Valenzuela (meval) <meval@odoo.com> Co-authored-by: Rex <11528309+huisit@users.noreply.github.com>
1 parent 8b331cb commit c5e30a5

2 files changed

Lines changed: 55 additions & 45 deletions

File tree

content/applications/sales/sales/sales_quotations/pdf_quote_builder.rst

Lines changed: 55 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,30 @@
55
PDF quote builder
66
=================
77

8-
The *PDF Quote Builder* in Odoo *Sales* provides the opportunity to send customers a fully
9-
customized PDF file for quotes, showcasing the company and products, with various information and
10-
design elements, instead of just showing the price and total.
8+
The *PDF Quote Builder* in the Odoo **Sales** app transforms a standard, text-heavy quote into a
9+
polished, branded proposal. Instead of sending a table of products and prices, it enables users to
10+
sandwich a quotation between professionally designed PDF pages.
1111

12-
The PDF Quote Builder groups header pages, product descriptions, the price(s), and footer pages to
13-
create a detailed quote. It can also inject dynamic texts or custom notes in the PDF to personalize
14-
the offer for the customer.
12+
The PDF Quote Builder seamlessly combines user-provided marketing documents, technical sheets,
13+
branded cover pages, and Odoo-generated quotes in one document. Quotation templates can be
14+
configured to include specific PDFs in the quote, ensuring documents reach the intended customers.
15+
Dynamic text in PDF templates allows users to extract **Sales** app data and customize files for
16+
each project or customer.
1517

16-
Having a customized PDF in quotes provides a heightened conclusion to the shopping experience for
17-
customers, and adds an elegant level of professionalism to a company.
18+
Empty text fields on the PDF can be completed directly from the quotation form in the **Sales** app.
19+
This approach lets users personalize quotes without editing the PDF itself.
20+
21+
Users can also configure PDFs on the product form. These files are then automatically added to the
22+
quote when a product is included. Beyond assembling quotes, the PDF Quote Builder also enables PDFs
23+
to be featured on the online store product page. This ensures customers can access detailed product
24+
information directly on the website.
1825

1926
.. seealso::
2027
`Odoo Quick Tips - Create a PDF quote [video] <https://www.youtube.com/watch?v=tQNydBZt-VI>`_
2128

2229
.. note::
23-
It is recommended to edit PDF forms with Adobe software. The form fields on the header and footer
24-
PDF templates are necessary to get dynamic values with Odoo.
30+
It is recommended to edit PDF forms with Adobe software. The form fields in the header and footer
31+
PDF templates are required to retrieve dynamic values in Odoo.
2532

2633
.. cards::
2734

@@ -38,60 +45,63 @@ customers, and adds an elegant level of professionalism to a company.
3845
.. card:: Add PDFs to products
3946
:target: pdf_quote_builder/add_pdf_products
4047

41-
Set up the headers and footers for products. These will appear on sales quotes and online
42-
store pages.
48+
Set up the PDF headers and footers for products. These appear on sales quotes and online store
49+
pages.
4350

4451

4552
Configuration
4653
=============
4754

48-
In order to add custom PDF files for quotes, the :guilabel:`PDF Quote builder` feature *must* be
49-
configured.
55+
To add custom PDF files to quotes, the :guilabel:`PDF Quote builder` feature *must* be configured.
5056

51-
To do that, navigate to :menuselection:`Sales app --> Configuration --> Settings`. Then, on the
52-
:guilabel:`Settings` page, scroll to the :guilabel:`Quotations & Orders` section, and locate the
53-
:guilabel:`PDF Quote builder` feature.
57+
Navigate to :menuselection:`Sales app --> Configuration --> Settings`. Scroll to the *Quotations &
58+
Orders* section, enable the :guilabel:`PDF Quote builder` feature, then click :guilabel:`Save`.
5459

5560
Add PDF as Header/Footer
5661
========================
5762

58-
In Odoo *Sales*, it's possible to add a custom PDF that can be used either as a header or a footer.
59-
When the PDF quote builder is activated in a quotation, you can then select as many headers and
60-
footers as you wish to use, these PDF will then also be inserted in the final PDF.
61-
62-
To add a custom PDF as header or footer, start by navigating to :menuselection:`Sales app -->
63-
Configuration --> Headers/Footers`. From this page, either click :guilabel:`New` or
64-
:guilabel:`Upload`.
63+
.. important::
64+
Odoo does not permit spaces in PDF field names. Only use letters, numbers, hyphens, or
65+
underscores.
6566

66-
Clicking :guilabel:`Upload` instantly provides the opportunity to upload the desired document. Then,
67-
the document can be further configured on the document card, or by clicking the
68-
:icon:`fa-ellipsis-v` :guilabel:`(vertical ellipsis)` icon in the top right corner of the document
69-
card, and then clicking :guilabel:`Edit`.
67+
The Odoo **Sales** app can add a custom PDF as a header or footer. The :guilabel:`Quote Builder` tab
68+
in a quote allows the selection of multiple headers and footers for insertion into the final PDF
69+
quote.
7070

71-
Clicking :guilabel:`New` reveals a blank documents form, in which the desired PDF can be uploaded
72-
via the :guilabel:`Upload your file` button on the form, located in the :guilabel:`File Content`
73-
field.
71+
To add a custom PDF as a header or footer, navigate to :menuselection:`Sales app --> Configuration
72+
--> Headers/Footers`. On this page, click :guilabel:`New` to create a new header or footer, or click
73+
:guilabel:`Upload` to add a PDF file.
7474

75-
Various information and configurations related to the uploaded document can be modified here.
75+
Clicking :guilabel:`Upload` lets the user select a PDF file from their computer. Select the
76+
:guilabel:`Document Type` to set the order in which the PDF appears in the quote. :guilabel:`Header`
77+
places the PDF before the quote, and :guilabel:`Footer` places it after. Further configuration can
78+
be done by clicking the :icon:`fa-ellipsis-v` :guilabel:`(vertical ellipsis)` icon in the top-right
79+
corner of the document card and selecting :guilabel:`Edit`.
7680

77-
The first field on the documents form is for the :guilabel:`Name` of the document, and it is
78-
grayed-out (not clickable) until a document is uploaded. Once a PDF has been uploaded, the
79-
:guilabel:`Name` field is auto-populated with the name of the PDF, and it can then be edited.
81+
Click :guilabel:`New` to open a blank document form. In the :guilabel:`File Content` field, click
82+
the :guilabel:`Upload your file` button and select the PDF to upload. Once uploaded, Odoo
83+
automatically names the document after the file name. The :guilabel:`Name` field then becomes
84+
editable.
8085

81-
Then, in the :guilabel:`Document Type` field, click the drop-down menu, and select either:
82-
:guilabel:`Header`, or :guilabel:`Footer` to define whether these files would be selectable to be at
83-
the beginning or at the end of your quote.
86+
To modify the uploaded file, click the :icon:`fa-pencil` :guilabel:`(Edit)`, :icon:`fa-download`
87+
:guilabel:`(Download)`, or :icon:`fa-trash` :guilabel:`(Clear)` icon next to the file name. If the
88+
PDF includes form fields, they are automatically recognized as dynamic text fields. View and edit
89+
these fields by clicking :guilabel:`Configure dynamic fields`. For more details, refer to
90+
:doc:`pdf_quote_builder/dynamic_text`.
8491

85-
Under this, in the :guilabel:`Quotation Templates` section, this PDF can be restricted quotation
86-
templates only.
92+
The :doc:`quote_template` field assigns the PDF to the selected template, restricting the PDF's use
93+
to that template.
8794

8895
.. note::
89-
Alternatively, you can also navigate to :menuselection:`Sales app --> Configuration --> Quotation
90-
Templates`, select a template and directly :guilabel:`Add` or :guilabel:`Upload` a PDF to it in
91-
the :guilabel:`Quote Builder` tab.
96+
Headers and footers can also be added to a quotation template by navigating to
97+
:menuselection:`Sales app --> Configuration --> Quotation Templates`. Select a template and then
98+
in the :guilabel:`Quote Builder` tab, :guilabel:`Add` or :guilabel:`Upload` a PDF directly.
99+
100+
.. figure:: pdf_quote_builder/config-header-pdf.png
101+
:alt: A configured document form for a header.
92102

93-
Lastly, beside the :guilabel:`File Content` field, you have the possibility to :guilabel:`Configure
94-
dynamic fields`.
103+
The HVAC PDF file is configured as a Header and the **Sales** app recognizes the form fields as
104+
dynamic text fields.
95105

96106
.. toctree::
97107
:titlesonly:
9.53 KB
Loading

0 commit comments

Comments
 (0)