diff --git a/content/applications/essentials/in_app_purchase.rst b/content/applications/essentials/in_app_purchase.rst index b2f00d4ba..aabad38c3 100644 --- a/content/applications/essentials/in_app_purchase.rst +++ b/content/applications/essentials/in_app_purchase.rst @@ -1,57 +1,191 @@ -===================== -In-App Purchase (IAP) -===================== +====================== +In-app purchases (IAP) +====================== -In-App Purchases (IAP) gives access to additional services through Odoo. For instance, it allows you -to send SMS Text Messages or to send Invoices by post directly from your database. +.. |IAP| replace:: :abbr:`IAP (In-app purchases)` -Buying Credits -============== +In-app purchases (IAP) are optional services that enhance Odoo databases. Each service provides its +own specific features and functionality. A full list of services is available on the `Odoo IAP +Catalog `_. -Each IAP Service relies on prepaid credits to work and has its own pricing. To consult your current -balance or to recharge your account, go to :menuselection:`Settings --> Odoo IAP --> View my -Services`. - -.. image:: in_app_purchase/image1.png +.. image:: in_app_purchase/iap.png :align: center + :alt: The IAP catalog with various services available on IAP.Odoo.com. -.. tip:: - If you are on Odoo Online and have the Enterprise version, you benefit from free credits to test our - IAP features. +.. example:: + The :guilabel:`SMS` service sends text messages to contacts directly from the database, and the + :guilabel:`Documents Digitization` service digitizes scanned or PDF vendor bills, expenses, and + resumes with optical character recognition (OCR) and artificial intelligence (AI). -IAP accounts +|IAP| services do **not** need to be configured or set up before use. Odoo users can simply click on +the service in the app to activate it. However, each service requires its own prepaid credits, and +when they run out, users **must** :ref:`buy more ` in order to keep using it. + +.. note:: + Enterprise Odoo users with a valid subscription get free credits to test IAP features before + deciding to purchase more credits for the database. This includes demo/training databases, + educational databases, and one-app-free databases. + +.. _in_app_purchase/portal: + +IAP services ============ -Credits to use IAP services are stored on IAP accounts, which are specific to each service. -By default, IAP accounts are common to all companies, but can be restricted to specific -ones. Activate the :ref:`developer mode `, then go to :menuselection:`Technical -Settings --> IAP Account`. +|IAP| services are provided by Odoo, as well as third-parties, and have a wide range of uses. -.. image:: in_app_purchase/image2.png +The following |IAP| services are offered by Odoo: + +- :guilabel:`Documents Digitization`: digitizes scanned or PDF vendor bills, expenses, and resumes + with OCR and AI. +- :guilabel:`Partner Autocomplete`: automatically populates contact records with corporate data. +- :guilabel:`SMS`: sends SMS text messages to contacts directly from the database. +- :guilabel:`Lead Generation`: generates leads based on a set of criteria, and converts web visitors + into quality leads and opportunities. +- :guilabel:`Snailmail`: sends customer invoices and follow-up reports by post, worldwide. +- :guilabel:`Signer identification with itsme®️`: ask document signatories in Odoo *Sign* to provide + their identity using the *itsme®* identity platform, which is available in Belgium and the + Netherlands. + +For more information on every service currently available (offered from developers other than Odoo), +visit the `Odoo IAP Catalog `_. + +Use IAP services +---------------- + +|IAP| services are automatically integrated with Odoo, and do **not** require users to configure any +settings. To use a service, simply interact with it wherever it appears in the database. + +.. example:: + The following flow focuses on the *SMS* |IAP| service being used from a contact's record. + + This can be done by clicking the :guilabel:`📱 SMS` icon within the database. + + .. image:: in_app_purchase/sms-icon.png + :align: center + :alt: The SMS icon on a typical contact information form located within an Odoo database. + + One way to utilize the *SMS* |IAP| service with Odoo is showcased in the following steps: + + First, navigate to the :menuselection:`Contacts application`, and click on a contact with a + mobile phone number entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the + contact form. + + Next, find the :guilabel:`📱 SMS` icon that appears to the right of the :guilabel:`Phone` or + :guilabel:`Mobile` fields. Click the :guilabel:`📱 SMS` icon, and a :guilabel:`Send SMS Text + Message` pop-up window appears. + + Type a message in the :guilabel:`Message` field of the pop-up window. Then, click the + :guilabel:`Send SMS` button. Odoo then sends the message, via SMS, to the contact, and logs what + was sent in the *chatter* of the contact's form. + + Upon sending the SMS message, the prepaid credits for the *SMS* |IAP| service are automatically + deducted from the existing credits. If there are not enough credits to send the message, Odoo + prompts the user to purchase more. + +.. seealso:: + For more information on how to use various |IAP| services, and for more in-depth instructions + related to SMS functionality in Odoo, review the documentation below: + + - :doc:`Lead mining <../sales/crm/acquire_leads/lead_mining>` + - :doc:`Enrich your contacts base with Partner Autocomplete + <../sales/crm/optimize/partner_autocomplete>` + - :doc:`SMS essentials <../marketing/sms_marketing/essentials/sms_essentials>` + +.. _in_app_purchase/credits: + +IAP credits +=========== + +Every time an |IAP| service is used, the prepaid credits for that service are spent. Odoo prompts +the purchase of more credits when there are not enough credits left to continue using a service. +Email alerts can also be set up for when :ref:`credits are low `. + +Credits are purchased in *Packs* from the `Odoo IAP Catalog +`_, and pricing is specific to each service. + +.. example:: + The `SMS service `_ has four packs available, in + denominations of: + + - :guilabel:`Starter Pack`: 10 credits + - :guilabel:`Standard Pack`: 100 credits + - :guilabel:`Advanced Pack`: 500 credits + - :guilabel:`Expert Pack`: 1,000 credits + + .. image:: in_app_purchase/packs.png + :align: center + :alt: Four different packs of credits for the SMS IAP service. + + The number of credits consumed depends on the length of the SMS and the country of destination. + + For more information, refer to the :doc:`SMS Pricing and FAQ + <../marketing/sms_marketing/pricing/pricing_and_faq>` documentation. + +.. _iap/buying_credits: + +Buy credits +----------- + +If there are not enough credits to perform a task, the database automatically prompts the purchase +of more credits. + +Users can check the current balance of credits for each service, and manually purchase more credits, +by navigating to the :menuselection:`Settings app --> Contacts section`, and beneath the +:guilabel:`Odoo IAP` setting, click :guilabel:`View My Services`. + +Doing so reveals a :guilabel:`My Services` page, listing the various |IAP| services in the database. +From here, click an |IAP| service to open its :guilabel:`Account Information` page, where additional +credits can be purchased. + +Manually buy credits +~~~~~~~~~~~~~~~~~~~~ + +To manually buy credits in Odoo, follow these steps: + +First, go to the :menuselection:`Settings application` and type `IAP` in the :guilabel:`Search...` +bar. Alternatively users can scroll down to the :guilabel:`Contacts` section. Under the +:guilabel:`Contacts` section, where it says :guilabel:`Odoo IAP`, click :guilabel:`View My +Services`. + +.. image:: in_app_purchase/view-services.png :align: center + :alt: The Settings app showing the Odoo IAP heading and View My Services button. -.. tip:: - An IAP account can be disabled by appending `+disabled` to its token. - Reverting this change will re-enable the account. +Doing so reveals an :guilabel:`IAP Account` page, listing the various |IAP| services in the +database. From here, click an |IAP| service to open details about it; additional credits can be +purchased from here. -IAP Portal -========== +On the following page, click the :guilabel:`Buy Credit` button. Doing so loads a :guilabel:`Buy +Credits for (IAP Account)` page in a new tab. From here, click :guilabel:`Buy` on the desired pack +of credits. Then, follow the prompts to enter payment details, and confirm the order. -The IAP Portal is a platform regrouping your IAP Services. It is accessible from -:menuselection:`Settings app --> Odoo IAP --> View my Services`. From there, you can view your current -balance, recharge your credits and set a reminder when your balance falls below a threshold. - -.. image:: in_app_purchase/image3.png +.. image:: in_app_purchase/buy-pack.png :align: center + :alt: The SMS service page on IAP.Odoo.com with four packs of credits available for purchase. -Get notified when credits are low -================================= +Once the transaction is complete, the credits are available for use in the database. -To be notified when it’s time to recharge your credits, you can go to your IAP Portal through -:menuselection:`Settings app --> Odoo IAP --> View my Services`, unfold a service and check the -Receive threshold warning option. Then, you can provide a minimum amount of credits and email -addresses. Now, every time that the limit is reached, an automatic reminder will be sent by -email! +.. _in_app_purchase/low-credits: -.. image:: in_app_purchase/image4.png - :align: center +Low-credit notification +~~~~~~~~~~~~~~~~~~~~~~~ + +It is possible to be notified when credits are low, in order to avoid running out of credits, while +using an |IAP| service. To do that, follow this process: + +Go to the :menuselection:`Settings application`, and type `IAP` in the :guilabel:`Search...` bar. +Under the :guilabel:`Contacts` section, where it says :guilabel:`Odoo IAP`, click :guilabel:`View My +Services`. + +The available |IAP| accounts appear in a list view on the :guilabel:`IAP Account` page. From here, +click on the desired |IAP| account to view that service's details. + +On the details page, tick the :guilabel:`Receive threshold warning` checkbox. Doing so reveals two +fields on the form: :guilabel:`Warning Threshold` and :guilabel:`Contact Email`. + +In the :guilabel:`Warning Threshold` field, enter an amount of credits Odoo should use as the +minimum threshold for this service. In the :guilabel:`Contact Email` field, enter the email address +that receives the notification. + +Odoo sends a low-credit alert to the :guilabel:`Contact Email` when the balance of credits falls +below the amount listed as the :guilabel:`Warning Threshold`. diff --git a/content/applications/essentials/in_app_purchase/buy-pack.png b/content/applications/essentials/in_app_purchase/buy-pack.png new file mode 100644 index 000000000..36f789f35 Binary files /dev/null and b/content/applications/essentials/in_app_purchase/buy-pack.png differ diff --git a/content/applications/essentials/in_app_purchase/iap.png b/content/applications/essentials/in_app_purchase/iap.png new file mode 100644 index 000000000..1a0749dc5 Binary files /dev/null and b/content/applications/essentials/in_app_purchase/iap.png differ diff --git a/content/applications/essentials/in_app_purchase/image1.png b/content/applications/essentials/in_app_purchase/image1.png deleted file mode 100644 index 7710699a0..000000000 Binary files a/content/applications/essentials/in_app_purchase/image1.png and /dev/null differ diff --git a/content/applications/essentials/in_app_purchase/image2.png b/content/applications/essentials/in_app_purchase/image2.png deleted file mode 100644 index 4b7efaef7..000000000 Binary files a/content/applications/essentials/in_app_purchase/image2.png and /dev/null differ diff --git a/content/applications/essentials/in_app_purchase/image3.png b/content/applications/essentials/in_app_purchase/image3.png deleted file mode 100644 index 1b763d2e3..000000000 Binary files a/content/applications/essentials/in_app_purchase/image3.png and /dev/null differ diff --git a/content/applications/essentials/in_app_purchase/image4.png b/content/applications/essentials/in_app_purchase/image4.png deleted file mode 100644 index 9015fccfa..000000000 Binary files a/content/applications/essentials/in_app_purchase/image4.png and /dev/null differ diff --git a/content/applications/essentials/in_app_purchase/packs.png b/content/applications/essentials/in_app_purchase/packs.png new file mode 100644 index 000000000..55672e636 Binary files /dev/null and b/content/applications/essentials/in_app_purchase/packs.png differ diff --git a/content/applications/essentials/in_app_purchase/sms-icon.png b/content/applications/essentials/in_app_purchase/sms-icon.png new file mode 100644 index 000000000..a9a7a3a7a Binary files /dev/null and b/content/applications/essentials/in_app_purchase/sms-icon.png differ diff --git a/content/applications/essentials/in_app_purchase/view-services.png b/content/applications/essentials/in_app_purchase/view-services.png new file mode 100644 index 000000000..b245e372e Binary files /dev/null and b/content/applications/essentials/in_app_purchase/view-services.png differ