Skip to content

Commit eeda8eb

Browse files
committed
[IMP] essentials: iap rewrite
closes #8917 X-original-commit: 46d3bdc Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
1 parent 9d22bf9 commit eeda8eb

File tree

10 files changed

+172
-40
lines changed

10 files changed

+172
-40
lines changed
Lines changed: 172 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,191 @@
1-
=====================
2-
In-App Purchase (IAP)
3-
=====================
1+
======================
2+
In-app purchases (IAP)
3+
======================
44

5-
In-App Purchases (IAP) gives access to additional services through Odoo. For instance, it allows you
6-
to send SMS Text Messages or to send Invoices by post directly from your database.
5+
.. |IAP| replace:: :abbr:`IAP (In-app purchases)`
76

8-
.. _iap/buying_credits:
7+
In-app purchases (IAP) are optional services that enhance Odoo databases. Each service provides its
8+
own specific features and functionality. A full list of services is available on the `Odoo IAP
9+
Catalog <https://iap.odoo.com/iap/all-in-app-services>`_.
910

10-
Buying Credits
11-
==============
11+
.. image:: in_app_purchase/iap.png
12+
:align: center
13+
:alt: The IAP catalog with various services available on IAP.Odoo.com.
1214

13-
Each IAP Service relies on prepaid credits to work and has its own pricing. To consult your current
14-
balance or to recharge your account, go to :menuselection:`Settings --> Odoo IAP --> View my
15-
Services`.
15+
.. example::
16+
The :guilabel:`SMS` service sends text messages to contacts directly from the database, and the
17+
:guilabel:`Documents Digitization` service digitizes scanned or PDF vendor bills, expenses, and
18+
resumes with optical character recognition (OCR) and artificial intelligence (AI).
1619

17-
.. image:: in_app_purchase/image1.png
18-
:align: center
20+
|IAP| services do **not** need to be configured or set up before use. Odoo users can simply click on
21+
the service in the app to activate it. However, each service requires its own prepaid credits, and
22+
when they run out, users **must** :ref:`buy more <iap/buying_credits>` in order to keep using it.
23+
24+
.. note::
25+
Enterprise Odoo users with a valid subscription get free credits to test IAP features before
26+
deciding to purchase more credits for the database. This includes demo/training databases,
27+
educational databases, and one-app-free databases.
1928

20-
.. tip::
21-
If you are on Odoo Online and have the Enterprise version, you benefit from free credits to test our
22-
IAP features.
29+
.. _in_app_purchase/portal:
2330

24-
IAP accounts
31+
IAP services
2532
============
2633

27-
Credits to use IAP services are stored on IAP accounts, which are specific to each service.
28-
By default, IAP accounts are common to all companies, but can be restricted to specific
29-
ones. Activate the :ref:`developer mode <developer-mode>`, then go to :menuselection:`Technical
30-
Settings --> IAP Account`.
34+
|IAP| services are provided by Odoo, as well as third-parties, and have a wide range of uses.
3135

32-
.. image:: in_app_purchase/image2.png
33-
:align: center
36+
The following |IAP| services are offered by Odoo:
37+
38+
- :guilabel:`Documents Digitization`: digitizes scanned or PDF vendor bills, expenses, and resumes
39+
with OCR and AI.
40+
- :guilabel:`Partner Autocomplete`: automatically populates contact records with corporate data.
41+
- :guilabel:`SMS`: sends SMS text messages to contacts directly from the database.
42+
- :guilabel:`Lead Generation`: generates leads based on a set of criteria, and converts web visitors
43+
into quality leads and opportunities.
44+
- :guilabel:`Snailmail`: sends customer invoices and follow-up reports by post, worldwide.
45+
- :guilabel:`Signer identification with itsme®️`: ask document signatories in Odoo *Sign* to provide
46+
their identity using the *itsme®* identity platform, which is available in Belgium and the
47+
Netherlands.
48+
49+
For more information on every service currently available (offered from developers other than Odoo),
50+
visit the `Odoo IAP Catalog <https://iap.odoo.com/iap/all-in-app-services>`_.
51+
52+
Use IAP services
53+
----------------
54+
55+
|IAP| services are automatically integrated with Odoo, and do **not** require users to configure any
56+
settings. To use a service, simply interact with it wherever it appears in the database.
57+
58+
.. example::
59+
The following flow focuses on the *SMS* |IAP| service being used from a contact's record.
60+
61+
This can be done by clicking the :guilabel:`📱 SMS` icon within the database.
62+
63+
.. image:: in_app_purchase/sms-icon.png
64+
:align: center
65+
:alt: The SMS icon on a typical contact information form located within an Odoo database.
66+
67+
One way to utilize the *SMS* |IAP| service with Odoo is showcased in the following steps:
68+
69+
First, navigate to the :menuselection:`Contacts application`, and click on a contact with a
70+
mobile phone number entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the
71+
contact form.
72+
73+
Next, find the :guilabel:`📱 SMS` icon that appears to the right of the :guilabel:`Phone` or
74+
:guilabel:`Mobile` fields. Click the :guilabel:`📱 SMS` icon, and a :guilabel:`Send SMS Text
75+
Message` pop-up window appears.
76+
77+
Type a message in the :guilabel:`Message` field of the pop-up window. Then, click the
78+
:guilabel:`Send SMS` button. Odoo then sends the message, via SMS, to the contact, and logs what
79+
was sent in the *chatter* of the contact's form.
80+
81+
Upon sending the SMS message, the prepaid credits for the *SMS* |IAP| service are automatically
82+
deducted from the existing credits. If there are not enough credits to send the message, Odoo
83+
prompts the user to purchase more.
84+
85+
.. seealso::
86+
For more information on how to use various |IAP| services, and for more in-depth instructions
87+
related to SMS functionality in Odoo, review the documentation below:
88+
89+
- :doc:`Lead mining <../sales/crm/acquire_leads/lead_mining>`
90+
- :doc:`Enrich your contacts base with Partner Autocomplete
91+
<../sales/crm/optimize/partner_autocomplete>`
92+
- :doc:`SMS essentials <../marketing/sms_marketing/essentials/sms_essentials>`
93+
94+
.. _in_app_purchase/credits:
95+
96+
IAP credits
97+
===========
98+
99+
Every time an |IAP| service is used, the prepaid credits for that service are spent. Odoo prompts
100+
the purchase of more credits when there are not enough credits left to continue using a service.
101+
Email alerts can also be set up for when :ref:`credits are low <in_app_purchase/low-credits>`.
34102

35-
.. tip::
36-
An IAP account can be disabled by appending `+disabled` to its token.
37-
Reverting this change will re-enable the account.
103+
Credits are purchased in *Packs* from the `Odoo IAP Catalog
104+
<https://iap.odoo.com/iap/all-in-app-services>`_, and pricing is specific to each service.
38105

39-
IAP Portal
40-
==========
106+
.. example::
107+
The `SMS service <https://iap.odoo.com/iap/in-app-services/1>`_ has four packs available, in
108+
denominations of:
41109

42-
The IAP Portal is a platform regrouping your IAP Services. It is accessible from
43-
:menuselection:`Settings app --> Odoo IAP --> View my Services`. From there, you can view your current
44-
balance, recharge your credits and set a reminder when your balance falls below a threshold.
110+
- :guilabel:`Starter Pack`: 10 credits
111+
- :guilabel:`Standard Pack`: 100 credits
112+
- :guilabel:`Advanced Pack`: 500 credits
113+
- :guilabel:`Expert Pack`: 1,000 credits
45114

46-
.. image:: in_app_purchase/image3.png
115+
.. image:: in_app_purchase/packs.png
116+
:align: center
117+
:alt: Four different packs of credits for the SMS IAP service.
118+
119+
The number of credits consumed depends on the length of the SMS and the country of destination.
120+
121+
For more information, refer to the :doc:`SMS Pricing and FAQ
122+
<../marketing/sms_marketing/pricing/pricing_and_faq>` documentation.
123+
124+
.. _iap/buying_credits:
125+
126+
Buy credits
127+
-----------
128+
129+
If there are not enough credits to perform a task, the database automatically prompts the purchase
130+
of more credits.
131+
132+
Users can check the current balance of credits for each service, and manually purchase more credits,
133+
by navigating to the :menuselection:`Settings app --> Contacts section`, and beneath the
134+
:guilabel:`Odoo IAP` setting, click :guilabel:`View My Services`.
135+
136+
Doing so reveals a :guilabel:`My Services` page, listing the various |IAP| services in the database.
137+
From here, click an |IAP| service to open its :guilabel:`Account Information` page, where additional
138+
credits can be purchased.
139+
140+
Manually buy credits
141+
~~~~~~~~~~~~~~~~~~~~
142+
143+
To manually buy credits in Odoo, follow these steps:
144+
145+
First, go to the :menuselection:`Settings application` and type `IAP` in the :guilabel:`Search...`
146+
bar. Alternatively users can scroll down to the :guilabel:`Contacts` section. Under the
147+
:guilabel:`Contacts` section, where it says :guilabel:`Odoo IAP`, click :guilabel:`View My
148+
Services`.
149+
150+
.. image:: in_app_purchase/view-services.png
47151
:align: center
152+
:alt: The Settings app showing the Odoo IAP heading and View My Services button.
48153

49-
Get notified when credits are low
50-
=================================
154+
Doing so reveals an :guilabel:`IAP Account` page, listing the various |IAP| services in the
155+
database. From here, click an |IAP| service to open details about it; additional credits can be
156+
purchased from here.
51157

52-
To be notified when it’s time to recharge your credits, you can go to your IAP Portal through
53-
:menuselection:`Settings app --> Odoo IAP --> View my Services`, unfold a service and check the
54-
Receive threshold warning option. Then, you can provide a minimum amount of credits and email
55-
addresses. Now, every time that the limit is reached, an automatic reminder will be sent by
56-
email!
158+
On the following page, click the :guilabel:`Buy Credit` button. Doing so loads a :guilabel:`Buy
159+
Credits for (IAP Account)` page in a new tab. From here, click :guilabel:`Buy` on the desired pack
160+
of credits. Then, follow the prompts to enter payment details, and confirm the order.
57161

58-
.. image:: in_app_purchase/image4.png
162+
.. image:: in_app_purchase/buy-pack.png
59163
:align: center
164+
:alt: The SMS service page on IAP.Odoo.com with four packs of credits available for purchase.
165+
166+
Once the transaction is complete, the credits are available for use in the database.
167+
168+
.. _in_app_purchase/low-credits:
169+
170+
Low-credit notification
171+
~~~~~~~~~~~~~~~~~~~~~~~
172+
173+
It is possible to be notified when credits are low, in order to avoid running out of credits, while
174+
using an |IAP| service. To do that, follow this process:
175+
176+
Go to the :menuselection:`Settings application`, and type `IAP` in the :guilabel:`Search...` bar.
177+
Under the :guilabel:`Contacts` section, where it says :guilabel:`Odoo IAP`, click :guilabel:`View My
178+
Services`.
179+
180+
The available |IAP| accounts appear in a list view on the :guilabel:`IAP Account` page. From here,
181+
click on the desired |IAP| account to view that service's details.
182+
183+
On the details page, tick the :guilabel:`Receive threshold warning` checkbox. Doing so reveals two
184+
fields on the form: :guilabel:`Warning Threshold` and :guilabel:`Contact Email`.
185+
186+
In the :guilabel:`Warning Threshold` field, enter an amount of credits Odoo should use as the
187+
minimum threshold for this service. In the :guilabel:`Contact Email` field, enter the email address
188+
that receives the notification.
189+
190+
Odoo sends a low-credit alert to the :guilabel:`Contact Email` when the balance of credits falls
191+
below the amount listed as the :guilabel:`Warning Threshold`.
35.8 KB
Loading
72.7 KB
Loading
-10.5 KB
Binary file not shown.
-36.8 KB
Binary file not shown.
-50.1 KB
Binary file not shown.
-13.6 KB
Binary file not shown.
19.2 KB
Loading
9.07 KB
Loading
6.87 KB
Loading

0 commit comments

Comments
 (0)