[IMP] rental: total update of the doc for the rental app

closes odoo/documentation#7091

X-original-commit: 230461a3e8
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>

content/applications/sales/rental.rst

@@ -2,10 +2,10 @@
 Rental
 ======
 
-**Odoo Rental** is a comprehensive solution to manage your rentals.
+The Odoo *Rental* application provides comprehensive solutions to configure and manage rentals.
 
-From a single view, you can send out quotations, confirm orders, schedule rentals, register when
+Send quotations, confirm orders, schedule rentals, register products when they are picked up and
-products are picked up and returned, and invoice your customers.
+returned, and invoice customers from this single platform.
 
 .. seealso::
    - `Odoo Rental: product page <https://www.odoo.com/app/rental>`_
@@ -13,35 +13,113 @@ products are picked up and returned, and invoice your customers.
 
 .. _rental/pricing:
 
-Rental Pricing
+Dashboard
-==============
+=========
 
-Configuration
+Upon opening the *Rental* application, the :guilabel:`Rental Orders` dashboard is revealed.
--------------
 
-Go to :menuselection:`Rental --> Products`, select or create a product, and click on the product's
+.. image:: rental/rental-orders-dashboard.png
-*Rental* tab. Under *Rental Pricing*, click on *Add a price*. Then choose a *Unit* of time (hours,
-days, weeks, or months), a *Duration*, and a *Price*. You can add as many price lines as necessary,
-usually to give out discounts for longer rental durations.
-
-.. image:: rental/rental-pricing-example.png
    :align: center
-   :alt: Example of rental pricing configuration in Odoo Rental
+   :alt: Example of the Rental Orders dashboard available in the Odoo Rental application.
 
-.. tip::
+In the default kanban view, all rentals are visible. Each rental card displays the customer name,
-   Under *Reservations*, you can add fines for any *Extra Hour* or *Extra Day*. You can also set a
+the price of the rental, the related sales order number, along with the status of the rental.
-   *Security Time*, expressed in hours, to make the product temporarily unavailable between two
-   rental orders.
 
 .. note::
-   If you want to rent a product created outside of the Rental app, do not forget to tick *Can be
+   Rental kanban cards that do **not** display a rental status means those rentals have confirmed
-   Rented* under the product's name. By default, this option is ticked when you create a product
+   quotations, but have not been picked up yet.
-   directly from the Rental app.
 
-Computing
+On the left sidebar, the :guilabel:`Rental Status` for each rental can be found. Beneath that, the
----------
+:guilabel:`Invoice Status` of the rentals is accessible. Clicking any option in the left sidebar
+filters the displayed rentals on the dashboard.
 
-Odoo always uses two rules to compute the price of a product when you create a rental order:
+Settings
+========
+
+To configure additional rental delay costs, availability of rental items, or minimum time of rental,
+navigate to :menuselection:`Rental app --> Configuration --> Settings`.
+
+.. image:: rental/rental-settings.png
+   :align: center
+   :alt: How the Settings page appears in the Odoo Rental application.
+
+In the :guilabel:`Rental` section, there are options to configure :guilabel:`Default Delay Costs`
+and :guilabel:`Default Padding Time`. There is also the option to activate :guilabel:`Rental
+Transfers` and :guilabel:`Digital Documents`.
+
+- :guilabel:`Default Delay Costs` are additional costs for late returns.
+- :guilabel:`Default Padding Time` represents the minimum amount of time between two rentals.
+- :guilabel:`Rental Transfers` means stock deliveries and receipts can be used for rental orders.
+- :guilabel:`Digital Documents` allows users to upload documents for customers to sign prior to
+   confirming their rental.
+
+In the :guilabel:`Rent Online` section, there are options to configure a :guilabel:`Minimal Rental
+Duration` and designate :guilabel:`Unavailability days`, or days during which pickup and return are
+not possible.
+
+Rental products
+===============
+
+To view all products that can rented in the database, navigate to :menuselection:`Rentals app -->
+Products`. By default, the :guilabel:`Can be Rented` search filter appears in the search bar.
+
+Each product kanban card displays that product's name, rental price, and product image (if
+applicable).
+
+Rental pricing
+==============
+
+To adjust the rental pricing on a product, go to the :guilabel:`Products` page in the *Rental* app,
+then select the desired product or click :guilabel:`New` to create a new product from scratch.
+
+On the product form, ensure the :guilabel:`Can be Rented` checkbox is ticked. Then, open the
+:guilabel:`Rental prices` tab.
+
+.. image:: rental/rental-prices-tab.png
+   :align: center
+   :alt: How the Settings page appears in the Odoo Rental application.
+
+.. note::
+   If creating a rental product outside of the *Rental* app, just ensure the :guilabel:`Can be
+   Rented` checkbox is ticked on the product form. By default, this checkbox is ticked whenever a
+   product is created directly in the *Rental* application.
+
+Pricing
+-------
+
+Under the :guilabel:`Pricing` section of the :guilabel:`Rental prices` tab, designate custom rental
+prices and rental periods for the product.
+
+To add pricing for a rental, click :guilabel:`Add a price`. Then, choose a *pricing period*
+(:dfn:`the unit of duration of the rental`) in the :guilabel:`Period` column, or create a new
+pricing period by typing in the name and clicking :guilabel:`Create`.
+
+Next, decide whether or not to apply this custom rental price to a specific :guilabel:`Pricelist`.
+
+Lastly, enter the desired :guilabel:`Price` for that specific :guilabel:`Period`.
+
+.. note::
+   There is no limit to how many pricing lines can be added. Multiple pricing options for rental
+   products are typically used to give discounts for customers who agree to longer rental durations.
+
+To delete any rental pricing option, click the :guilabel:`🗑️ (trash)` icon, and that row is
+deleted.
+
+Reservations
+------------
+
+Under the :guilabel:`Reservations` section of the :guilabel:`Rental prices` tab, there is the option
+to configure additional fines for any :guilabel:`Extra Hour` or :guilabel:`Extra Day` that the
+customer takes to return a rental.
+
+There is also the option to set a :guilabel:`Security Time`, expressed in hours, to make the rental
+product temporarily unavailable between two rental orders. Such a feature may prove useful if
+maintenance or cleaning is required between rentals.
+
+Price computing
+---------------
+
+Odoo always uses two rules to compute the price of a product when a rental order is created:
 
 #. Only one price line is used.
 #. The cheapest line is selected.
@@ -60,44 +138,147 @@ Odoo always uses two rules to compute the price of a product when you create a r
 
 .. _rental/customer-signature:
 
+Rental orders
+=============
+
+To create a rental order in the *Rental* app, navigate to :menuselection:`Rental app --> Orders -->
+Orders`, and click :guilabel:`New`. Doing so reveals a blank rental order form to be filled in
+accordingly.
+
+.. image:: rental/rental-order.png
+   :align: center
+   :alt: Sample of a filled out rental order available in the Odoo Rental application.
+
+Start by adding a :guilabel:`Customer`, then configure the desired duration of the rental in the
+:guilabel:`Rental period` field.
+
+To adjust the rental duration, click the first date in the :guilabel:`Rental period` field, and
+select the range of dates to represent the rental duration from the pop-up calendar form that
+appears.
+
+.. image:: rental/rental-period-field-popup.png
+   :align: center
+   :alt: Sample of a rental period calendar pop-up window in the Odoo Rental application.
+
+Once complete, click :guilabel:`Apply` in the calendar pop-up form. Following that, the pop-up form
+disappears, and the designated time period of the rental is represented in the :guilabel:`Duration`
+field.
+
+Next, add a rental product in the :guilabel:`Order Lines` tab, by clicking :guilabel:`Add a
+product`, and selecting the desired rental product to add to the form.
+
+.. note::
+   If a rental product is added *before* the :guilabel:`Rental period` field has been properly
+   configured, the user can *still* adjust the :guilabel:`Rental period` field accordingly.
+
+   Simply select the desired range of dates to represent the duration of the rental, then click
+   :guilabel:`Update Rental Prices` in the :guilabel:`Duration` field.
+
+   .. image:: rental/rental-update-rental-prices.png
+      :align: center
+      :alt: The update rental prices option that appears in the Odoo Rental application.
+
+   Doing so reveals a :guilabel:`Confirmation` pop-up window. If everything is correct, click
+   :guilabel:`Ok`, and Odoo recalculates the rental price accordingly.
+
+Once all the information has been entered correctly on the rental order form, click the
+:guilabel:`Send by Email` button to send the quotation to the customer, or click the
+:guilabel:`Confirm` button to confirm the order.
+
 Customer signature
 ==================
 
-You can ask your customers to sign a rental agreement outlining the arrangement between you and your
+Upon confirming a rental order, the :guilabel:`Sign Documents` button appears. This gives the
-customers before they pick up products to make sure your products are returned on time and in their
+ability to request the customer sign a rental agreement, outlining the arrangement between the
-original condition. To do so, go to :menuselection:`Rental --> Configuration --> Settings`, activate
+company and customer, *before* they pick up the rental product(s).
-*Digital Documents*, and *Save*.
 
-.. image:: rental/digital-documents-settings.png
+Such documents can ensure everything is returned on-time and in its original condition.
-   :align: center
+
-   :alt: Digital Documents settings in Odoo Rental
+.. important::
+   The :guilabel:`Sign Documents` button/option **only** appears if the :guilabel:`Digital
+   Documents` feature has been activated in the *Rental* application settings. To do so, navigate to
+   :menuselection:`Rental app --> Configuration --> Settings`, activate :guilabel:`Digital
+   Documents`, and click :guilabel:`Save`.
 
 .. note::
-   This feature requires the :doc:`Sign <../finance/sign>` app. If necessary, Odoo installs it after
+   This feature also requires the :doc:`Sign <../finance/sign>` app. If necessary, Odoo
-   activating *Digital Documents*.
+   automatically installs it after activating the :guilabel:`Digital Documents` setting.
 
-Once the app settings are saved, you have the option to change the default *Rental Agreement* from
+To request a customer signature on a rental agreement, select a confirmed rental order, and click
-the dropdown menu. You can pick any document already uploaded to the *Sign* app, or upload a new one
+the :guilabel:`Sign Documents` button to reveal a :guilabel:`Sign Documents` pop-up window.
-to the *Sign* app by clicking on *Upload Template*.
 
-To request a customer signature, select a confirmed rental order, click on *Sign Documents*, choose
+.. image:: rental/sign-documents-popup.png
-the document template and click on *Sign Documents* again. On the next window, select your customer
+   :align: center
-and click on *Sign Now* to start the signing process with your customer. Once the document is
+   :alt: The Sign Documents pop-up window that appears in the Odoo Rental application.
-completed, click on *Validate & Send Completed Document*.
+
+From here, select the desired document from the :guilabel:`Document Template` field. Then, click
+:guilabel:`Sign Document`. Doing so reveals a :guilabel:`New Signature Request` pop-up window.
+
+.. image:: rental/new-signature-request-form.png
+   :align: center
+   :alt: The New Signature Request pop-up window that appears in the Odoo Rental application.
+
+Upon confirming the information in the :guilabel:`New Signature Request` pop-up form, click
+:guilabel:`Sign Now` to initiate the signing process.
+
+A separate page is then revealed, showcasing the document to be signed, which is accessible to the
+customer via the customer portal.
+
+Odoo guides the customer through the signing process with clear, clickable indicators, and allows
+them to create electronic signatures to quickly complete the form.
+
+.. image:: rental/adopt-signature-popup.png
+   :align: center
+   :alt: The adopt your signature pop-up window that appears in the Odoo Rental application.
+
+Once the document has been signed and completed, click the :guilabel:`Validate & Send Completed
+Document` button at the bottom of the document.
+
+.. image:: rental/validate-send-doc-button.png
+   :align: center
+   :alt: The validate and send completed document button in the Odoo Rental application.
+
+Upon clicking the :guilabel:`Validate & Send Completed Document` button, Odoo presents the option to
+download the signed document for record-keeping purposes, if necessary.
 
 .. seealso::
-   - `Odoo Tutorials: Sign <https://www.odoo.com/slides/sign-61>`_
+   `Odoo Tutorials: Sign <https://www.odoo.com/slides/sign-61>`_
 
 .. _rental/pickup-return:
 
-Pickup and Return receipt
+Pickup products
-=========================
+===============
 
-You can print and give your customers receipts when they pick up and/or return products. To do so,
+When a customer picks up the product(s), navigate to the appropriate rental order, click the
-open any rental order, click on *Print* and select *Pickup and Return Receipt*. Odoo then generates
+:guilabel:`Pickup` button, and then click :guilabel:`Validate` in the :guilabel:`Validate a pickup`
-a PDF detailing all information about the current status of the rented items: which were picked up,
+pop-up form that appears.
-when they are expected to be returned, which were returned, and potential rental delay costs.
 
-.. image:: rental/print-receipt.png
+Doing so places a :guilabel:`Picked-up` status banner on the rental order.
+
+Return products
+===============
+
+When a customer returns the product(s), navigate to the appropriate rental order, click the
+:guilabel:`Return` button, and validate the return by clicking :guilabel:`Validate` in the
+:guilabel:`Validate a return` pop-up form that appears.
+
+Doing so places a :guilabel:`Returned` status banner on the rental order.
+
+Print pickup and return receipts
+================================
+
+Pickup and return receipts can be printed for customers when they pick up and/or return rental
+products.
+
+To print pickup and/or return receipts, navigate to the appropriate rental order, click the
+:guilabel:`⚙️ (gear)` icon to reveal a drop-down menu.
+
+.. image:: rental/print-pickup-return-receipt.png
    :align: center
-   :alt: Printing a Pickup and Return receipt in Odoo Rental
+   :alt: The pickup and return receipt print option in the Odoo Rental application.
+
+From this drop-down menu, hover over the :guilabel:`Print` option to reveal a sub-menu. Then select
+:guilabel:`Pickup and Return Receipt`.
+
+Odoo generates and downloads a PDF, detailing all information about the current status of the rented
+item(s).