Compare commits

...

63 Commits

Author SHA1 Message Date
Rémy Voet (ryv) 711889d379 [IMP] orm: api.constraint deferred 2025-02-04 11:37:08 +01:00
Merel Geens (mege) 8c0d1245e2 [FIX] administration: correct Fedora version
The Odoo 17 and 18 RPM builds target Fedora 38 instead of 36:

16: https://github.com/odoo/odoo/blob/16.0/setup/package.dffedora#L3
17: https://github.com/odoo/odoo/blob/17.0/setup/package.dffedora#L3
18: https://github.com/odoo/odoo/blob/18.0/setup/package.dffedora#L3

Note that both Fedora 36 and 38 are EOL:
https://docs.fedoraproject.org/en-US/releases/eol/

closes odoo/documentation#11953

X-original-commit: 24966a91c8
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2025-02-04 06:26:45 +00:00
jero-odoo 8c1ef584f8 [IMP] inventory: Delivery Methods
closes odoo/documentation#11946

X-original-commit: 968ca03d70
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2025-02-04 05:08:13 +00:00
Tanya Bouman 4bb36464cb [FIX] mobile: SS0 -> SSO typo
closes odoo/documentation#11916

X-original-commit: b8f2514f93
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2025-02-03 18:50:55 +00:00
mcsi-odoo f2c49f10ea [IMP] spreadsheet: remove default templates
task-4278043

closes odoo/documentation#11942

X-original-commit: 5cb47dcc92
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Siobhan McGonigle (mcsi) <mcsi@odoo.com>
2025-02-03 14:06:10 +00:00
benderliz 95bb52afa3 [IMP] Inventory: Consignment typo in 16.0
closes odoo/documentation#11896

X-original-commit: 38640aeb0e
Signed-off-by: Liz Bender (beli) <beli@odoo.com>
2025-01-31 17:50:18 +00:00
Audrey (auva) 8d42564a46 [IMP] iot: refactor and update configuration documentation
Restructure and update the iot documentation

closes odoo/documentation#11936

X-original-commit: a6dbcd0a9f
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
2025-01-31 13:42:49 +00:00
Donatienne (dopi) 6b54d22e2d [IMP] ecommerce: checkout
taskid-4392415

closes odoo/documentation#11938

X-original-commit: 6bf147384b
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
2025-01-31 13:42:42 +00:00
mcsi-odoo 0a3d4842b8 [IMP] studio: automated action send whatsapp
task-4442904

closes odoo/documentation#11928

X-original-commit: cafe8b3f4b
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Siobhan McGonigle (mcsi) <mcsi@odoo.com>
2025-01-31 08:07:17 +00:00
jero-odoo 0a9340f66b [IMP] General: Email Server Subdomain Limitation
closes odoo/documentation#11920

X-original-commit: 00eb919fb4
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2025-01-30 14:05:21 +00:00
sjai-odoo 2d871e7c32 [ADD] integration: barcodelookup documentation
Task-4464181

closes odoo/documentation#11907

X-original-commit: eee06ac7c4
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Jainam Shah (sjai) <sjai@odoo.com>
2025-01-30 07:54:22 +00:00
Tiffany Chang (tic) 862525f8c2 [I18N] *: export latest terms
As per usual, leave off developer.pot and contributing.pot since we
don't translate them (not useful, can't really contribute to/dev in
Odoo without knowing English)

closes odoo/documentation#11909

X-original-commit: 4fc13ed595
Signed-off-by: Tiffany Chang (tic) <tic@odoo.com>
2025-01-29 13:49:39 +00:00
Loredana Perazzo 9be262eaef [IMP] POS: move configuration in toctree
task-4512527

closes odoo/documentation#11887

X-original-commit: 92b968d337
Signed-off-by: Loredana Perazzo (lrpz) <lrpz@odoo.com>
2025-01-28 16:41:55 +00:00
Loredana Perazzo 24eeecb9e1 [ADD] POS: how to configure and use the preparation display
task-3604858

closes odoo/documentation#11855

X-original-commit: 2eb1deaf11
Signed-off-by: Loredana Perazzo (lrpz) <lrpz@odoo.com>
2025-01-28 11:10:20 +00:00
sk-nada 8800de73af [FW][FIX] tutorials/server_framework_101: update link for example of list
previous link was for code that used tree in xml. The tree tag throws Traceback error in 18.0. This commit will provide the correct example with list tag instead of tree tag.

closes odoo/documentation#11867

Forward-port-of: odoo/documentation#11865
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2025-01-28 02:59:51 +00:00
Erwin Zoer 41f15664e2 [FW][FIX] developer/howtos/upgrade_custom_db: fix typo
Changed the word devolopments to developments

closes odoo/documentation#11886

Forward-port-of: odoo/documentation#11864
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2025-01-28 02:59:49 +00:00
mcsi-odoo 4f24ab92bf [IMP] accounting: ocr free iap test credits for enterprise users
task-4328876

closes odoo/documentation#11883

X-original-commit: 058e379a40
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Siobhan McGonigle (mcsi) <mcsi@odoo.com>
2025-01-27 20:58:27 +00:00
mcsi-odoo 8094aecf2e [IMP] accounting: order of fiscal localizations updated in toc
task-4285498

closes odoo/documentation#11884

X-original-commit: f3d8007c29
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Siobhan McGonigle (mcsi) <mcsi@odoo.com>
2025-01-27 20:58:25 +00:00
“Chiara e8b8305ba1 [IMP] accounting: italian localization typo
closes odoo/documentation#11885

X-original-commit: 8b1f8e1fc6
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Chiara Prattico (chpr) <chpr@odoo.com>
2025-01-27 20:58:24 +00:00
Krzysztof Magusiak (krma) c9b4545e8f [IMP] release: PEP440 release naming
Use the PEP440 release naming.

closes odoo/documentation#11863

Related: odoo/odoo#195176
Signed-off-by: Krzysztof Magusiak (krma) <krma@odoo.com>
2025-01-27 19:38:21 +00:00
dikd-odoo e8da6e1fe4 [IMP] sales: removing the warning message for Amazon connector
closes odoo/documentation#11808

X-original-commit: e6bc52d641
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Dina Klarisse Dugar (dikd) <dikd@odoo.com>
2025-01-25 03:17:12 +00:00
samueljlieber f4f731d7f7 [IMP] sales: update simplified pricelist settings
closes odoo/documentation#11811

X-original-commit: a0c8570226
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Dina Klarisse Dugar (dikd) <dikd@odoo.com>
2025-01-25 03:17:10 +00:00
jero-odoo 3a2974584e [IMP] Inventory: wave transfers 18
closes odoo/documentation#11860

X-original-commit: 60a0d4cdb5
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: hojo-odoo <123424465+hojo-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2025-01-25 01:54:26 +00:00
William Braeckman 8b49ad8add [IMP] developer/reference/cli: --limit-time-cron-conn
Document the newly created config option.

closes odoo/documentation#11851

See: https://github.com/odoo/odoo/pull/194141
X-original-commit: ff6f55ae20
Related: odoo/odoo#195042
Signed-off-by: William Braeckman (wbr) <wbr@odoo.com>
2025-01-24 15:20:41 +00:00
“Dallas” 986a2a0483 [IMP] accounting/bank: outstanding accounts
Update bank doc to better explain suspense and outstanding accounts and to explain that payments don't create journal entries without outstanding accounts.

task-3474209

closes odoo/documentation#11850

X-original-commit: 88e1bee845
Signed-off-by: Dallas Dean (dade) <dade@odoo.com>
2025-01-24 13:57:46 +00:00
jero-odoo ed859771c1 [IMP] Inventory: Batch Picking 18
closes odoo/documentation#11842

X-original-commit: 9917949408
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: Liz Bender <92882399+benderliz@users.noreply.github.com>
Co-authored-by: Felicia Kuan <feku@odoo.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2025-01-24 12:29:02 +00:00
jero-odoo de07d3af6f [IMP] Inventory: cluster picking
closes odoo/documentation#11841

X-original-commit: c4e0f35aa9
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: dikd-odoo <dikd@odoo.com>
2025-01-24 12:29:00 +00:00
mcsi-odoo 15282c9900 [FIX] studio: can duplicate feature - list
task-4444001

closes odoo/documentation#11834

X-original-commit: 91103976f7
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Siobhan McGonigle (mcsi) <mcsi@odoo.com>
2025-01-24 09:44:59 +00:00
Meet Jivani [MEJI] 30dda24ac5 [ADD] point_of_sale: documentation for urbanPiper Integration
In this commit:
- Added detailed documentation on configuring online food delivery using
UrbanPiper integration.
- Provides step-by-step guidance for setting up the system.

Task-4263288

closes odoo/documentation#11827

X-original-commit: 8f77236070
Signed-off-by: Loredana Perazzo (lrpz) <lrpz@odoo.com>
Co-authored-by: Loredana Perazzo <lrpz@odoo.com>
Co-authored-by: Meet Jivani <meji@odoo.com>
2025-01-24 09:44:57 +00:00
Doh (KIDO) 7d4d42f2a5 [FIX] l10n_my: MyInvois credential update for preproduction
Despite registering ODOO S.A. as the name for both production and preproduction environment, MyInvois force changed pre-production to OXXX_XXXXO S.A. requiring an update on the credential for usage.

closes odoo/documentation#11821

X-original-commit: eba8e6028e
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Kim Dohyun (kido) <kido@odoo.com>
2025-01-24 06:13:12 +00:00
lase@odoo.com c3a308f4b9 [IMP] marketing: match the Display Timezone description with tooltips
Issue:

The current descriptions and naming of the `Date` fields (`date_begin`,
`date_end`) and the `Timezone` field (`date_tz`) can be confusing in the
form view of the event model. Specifically:

The timezone used for converting the form dates to the database is
determined by the context and not by the `Timezone` field present on the
form. However, this `Timezone` field determines the timezone used
for displaying the event's date/time on the website. This change
clarifies the situation according to the update done in the community PR

opw-4323142

closes odoo/documentation#11820

X-original-commit: fe9d186b54
Related: odoo/odoo#194685
Signed-off-by: Lancelot Semal (lase) <lase@odoo.com>
2025-01-23 15:23:57 +00:00
“Dallas” 8d22fea849 [IMP] l10n_spain: update FACe configuration
Update configration as the location of the config changed in 18.0.

task-4327068

closes odoo/documentation#11830

X-original-commit: cc226a7e1d
Signed-off-by: Dallas Dean (dade) <dade@odoo.com>
2025-01-23 15:23:50 +00:00
mcsi-odoo e190e03e93 [IMP] studio: can duplicate feature
task-4444001

closes odoo/documentation#11806

X-original-commit: c8b5ec9b8b
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Siobhan McGonigle (mcsi) <mcsi@odoo.com>
2025-01-22 10:11:36 +00:00
Antoine Vandevenne (anv) a8d555494f [IMP] supported_versions: release saas-18.1
closes odoo/documentation#11807

X-original-commit: 9b7d3d559b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2025-01-21 22:03:20 +00:00
benderliz f1007895b6 [FIX] Inventory: Fixing reordering rules navigation for 18.0
closes odoo/documentation#11711

X-original-commit: b6b6cf9de8
Signed-off-by: Liz Bender (beli) <beli@odoo.com>
2025-01-21 22:03:16 +00:00
“Chiara 106ac4d505 [IMP] accounting: einvoicing by country mention
closes odoo/documentation#11793

X-original-commit: 3ab129a370
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Chiara Prattico (chpr) <chpr@odoo.com>
2025-01-21 17:40:31 +00:00
Zuzanna Luczynska 6c027c9f4d [ADD] project/dashboard: project dashboard
task-id 4384333

closes odoo/documentation#11745

X-original-commit: 37d9b31da5
Signed-off-by: Zuzanna Luczynska (zulu) <zulu@odoo.com>
2025-01-20 10:07:16 +00:00
xpl-odoo 6e4ab30214 [IMP] database: update status of supported versions
task-4485068

closes odoo/documentation#11786

X-original-commit: 36d407830e
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2025-01-20 10:07:13 +00:00
“Dallas” ebca1144b6 [FIX] accounting:update internal transfers doc to 18.0
Internal transfers are now handled via reconciliation model button instead of through payments. This PR moves the internal transfers documentation from the Payments section to the Bank section and updates it to reflect the process in 18.0.

task-4331744

closes odoo/documentation#11778

X-original-commit: cc6306277b
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Dallas Dean (dade) <dade@odoo.com>
2025-01-18 06:15:25 +00:00
xpl-odoo 4d08ff7294 [IMP] l10n: odoo 18 update of the german l10n
Based on information from CBE and PR #11417

closes odoo/documentation#11772

X-original-commit: d7c1329007
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2025-01-17 12:43:30 +00:00
jero-odoo 241fd01063 [IMP] General: Outbound email servers correction
closes odoo/documentation#11764

X-original-commit: dfe54bdce3
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2025-01-16 15:00:22 +00:00
Christoforus Surjoputro 1f842b5f2b [FIX] payment_providers/xendit: remove step to enable optional 3ds
Enabling optional 3DS should not part of the official step. This configuration
is specific to cards payment, by default should perform 3DS, and only eligible
merchant able to perform cards payment with optional 3DS enabled.

closes odoo/documentation#11759

Forward-port-of: #11712
X-original-commit: bc1e3def1d
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
2025-01-15 23:00:05 +00:00
John Holton (hojo) af34c2c473 [IMP] Inventory: add delivery slip setting to serial numbers
closes odoo/documentation#11737

X-original-commit: 78b9c43030
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2025-01-15 19:08:56 +00:00
fvz-odoo 23f80369ff [IMP] accounting/l10n_uy: clarify onboarding
Currently, users are having a hard time setting up their Uruware account. With the improvement to the documentation we are adding clarifications to simplify the onboarding process as well as adding a see also section so users have more documentation and smart classes/eLearning available.

closes odoo/documentation#11758

X-original-commit: 2628303bc4
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Co-authored-by: dade-odoo <87431108+dade-odoo@users.noreply.github.com>
2025-01-15 17:36:27 +00:00
benderliz 830c311f68 [IMP] Inventory: Merged cycle count docs and updated for 17.0
closes odoo/documentation#11733

X-original-commit: 6852e4b980
Signed-off-by: Liz Bender (beli) <beli@odoo.com>
2025-01-14 19:36:17 +00:00
Florian Gilbert 0ee2ff365d [IMP] account/bank: Consistent number for available banks
The aim of this commit is making sure that we have the same number of available banks.
 
no task id

closes odoo/documentation#11751

X-original-commit: 40c830298c
Signed-off-by: Florian Gilbert (flg) <flg@odoo.com>
2025-01-14 16:55:47 +00:00
Aaron Bohy 336c77042a [IMP] javascript reference: document domain field options
Before this commit, options of the domain field weren't documented.
Now, they are.

closes odoo/documentation#11735

X-original-commit: 04ac6de366
Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
2025-01-13 08:39:55 +00:00
emmi-odoo cc896e052f [IMP] essentials/import data: add Import files section
task-4043639

closes odoo/documentation#11725

X-original-commit: 983346ae6b
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Emmanuel Minga (EMMI) <emmi@odoo.com>
2025-01-10 17:45:03 +00:00
jero-odoo 3d5d0681e9 [IMP] Helpdesk: Update SLAs
closes odoo/documentation#11727

X-original-commit: 7c6aa7f2c4
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: dikd-odoo <dikd@odoo.com>
2025-01-10 17:45:00 +00:00
jero-odoo b2677946fd [IMP] Helpdesk: Helpcenter updates
closes odoo/documentation#11726

X-original-commit: b78d7b86e6
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2025-01-10 17:44:59 +00:00
Donatienne (dopi) 512919de84 [IMP] ecommerce: delivery methods
taskid-4016678

closes odoo/documentation#11718

X-original-commit: 84abf415bc
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
2025-01-09 15:31:24 +00:00
Zuzanna Luczynska 461b4565c5 [IMP] project/tasks: correction in what triggers reccurence + icon
closes odoo/documentation#11706

Task-id: 3601222
X-original-commit: cb0cce2498
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
Signed-off-by: Zuzanna Luczynska (zulu) <zulu@odoo.com>
2025-01-08 14:45:50 +00:00
paan-odoo 8273efda22 [ADD] point_of_sale: documentation for pos-based marketing
This PR adds the documentation needed to use pos-based marketing.

In this PR, we introduce configuration and flow related to Email
and WhatsApp marketing in Point of Sale from storing contact details
to sending emails and WhatsApp messages from the point of sale.

task-4053075

closes odoo/documentation#11628

X-original-commit: 2bb0fa8e68
Signed-off-by: Loredana Perazzo (lrpz) <lrpz@odoo.com>
Co-authored-by: Anantkumar Parmar <paan@odoo.com>
Co-authored-by: Loredana Perazzo <lrpz@odoo.com>
2025-01-08 13:01:08 +00:00
guillaume gallant (guga) 851a828fd4 [ADD] project: task dependencies
task-4413833

closes odoo/documentation#11671

X-original-commit: a8959a121a
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Guillaume Gallant (guga) <guga@odoo.com>
2025-01-08 08:28:24 +00:00
“Dallas” 84451d1bf7 [FIX] accounting/tax-return: fix tax return menu path
Fix the menu navigation path of the tax return and update for 18.0 UI

task-4424499

closes odoo/documentation#11689

X-original-commit: 27bddd133b
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Dallas Dean (dade) <dade@odoo.com>
2025-01-07 19:20:51 +00:00
jero-odoo 4a069b9681 [IMP] Helpdesk: update basics 18
closes odoo/documentation#11700

X-original-commit: 21eb260fc8
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: Liz Bender <92882399+benderliz@users.noreply.github.com>
Co-authored-by: Felicia Kuan <feku@odoo.com>
2025-01-06 20:21:10 +00:00
Sylvain Francis 9319cc3b71 [FIX] Egypt fiscal localizations: Update proxy install instructions
Since Odoo 16, to install the local proxy, users need to select the
"Odoo IoT" option install of the "Local Proxy Mode" to install the local
proxy.

This commit updates both the text and accompanying screenshot

closes odoo/documentation#11670

X-original-commit: beeeff9068
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Sylvain Francis (syf) <syf+odoo@odoo.com>
2025-01-06 09:19:47 +00:00
Felicious a7264a1687 [IMP] inventory: add bpost link
closes odoo/documentation#11683

X-original-commit: e38438c0ae
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
2025-01-06 08:02:20 +00:00
gmz-odoo 749a8365c7 [IMP] accounting/l10n_pe: PLE 12.1 and PLE 13.1 inventory reports
Add new section for reports
Content based on V17
Images : [ADD]Inventory Reports: PLE 12.1 and PLE 13.1 - Images
Expected section to be added: [l10n_pe][USER DOC][ADD]Inventory Reports: PLE 12.1 and PLE 13.1

closes odoo/documentation#11696

X-original-commit: 1aac8f8dc6
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2025-01-02 21:55:19 +00:00
jero-odoo 38cd791272 [IMP] Helpdesk: receiving tickets
closes odoo/documentation#11690

X-original-commit: 5dea50eef0
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2025-01-02 18:54:51 +00:00
Parish Bracha 88620fad79 [IMP] Subscriptions: Contract in exception
closes odoo/documentation#10892

X-original-commit: ea2fc6dbc4
Signed-off-by: Parish Bracha (pabr) <pabr@odoo.com>
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>
2025-01-02 14:55:16 +00:00
Tiffany Chang (tic) 53c3d6442f [I18N] *: export latest terms
As per usual, leave off developer.pot and contributing.pot since we
don't translate them (not useful, can't really contribute to/dev in
Odoo without knowing English)

closes odoo/documentation#11673

X-original-commit: d4841aee90
Signed-off-by: Tiffany Chang (tic) <tic@odoo.com>
2025-01-02 10:51:22 +00:00
gmz-odoo 0d794c2cc2 [IMP] accounting/l10n_pe: update GRE credentials section
closes odoo/documentation#11632

Context: after Odoo17 the menu changes on the settings from Accounting to Inventory, as this workflow is related to stock moves
X-original-commit: f3969af47e
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
Signed-off-by: Gabriela Enriquez Manzano (gmz) <gmz@odoo.com>
2024-12-30 18:43:33 +00:00
309 changed files with 14492 additions and 9275 deletions
+3 -2
View File
@@ -21,7 +21,7 @@ copyright = 'Odoo S.A.'
# `version` is the version info for the project being documented, acts as replacement for |version|,
# also used in various other places throughout the built documents.
# `release` is the full version, including alpha/beta/rc tags. Acts as replacement for |release|.
# `release` is the full version, including a/b/rc tags. Acts as replacement for |release|.
version = release = 'master'
# `current_branch` is the technical name of the current branch.
@@ -116,7 +116,7 @@ else:
odoo.addons.__path__.append(str(odoo_dir) + '/addons')
from odoo import release as odoo_release # Don't collide with Sphinx's 'release' config option
odoo_version = '.'.join(str(s) for s in odoo_release.version_info[:2]).replace('~', '-') # Change saas~XX.Y to saas-XX.Y
odoo_version = 'master' if 'alpha' in odoo_release.version else odoo_version
odoo_version = 'master' if odoo_release.ALPHA in odoo_release.version_info else odoo_version
if release != odoo_version:
_logger.warning(
"Found Odoo sources in %(directory)s but with version '%(odoo_version)s' incompatible "
@@ -231,6 +231,7 @@ sphinx.transforms.i18n.docname_to_domain = (
# is populated. If a version is passed to `versions` but is not listed here, it will not be shown.
versions_names = {
'master': "Master",
'saas-18.1': "Odoo Online",
'18.0': "Odoo 18",
'saas-17.4': "Odoo Online",
'saas-17.2': "Odoo Online",
+1 -1
View File
@@ -64,4 +64,4 @@ The Odoo mobile apps are available for download on the `Google Play Store
.. important::
The iOS app cannot be updated and will be deprecated at some point in the future.
While the store apps support multi-accounts, they are not compatible with SS0 authentication.
While the store apps support multi-accounts, they are not compatible with SSO authentication.
@@ -132,7 +132,7 @@ be downloaded from the `Odoo download page <https://www.odoo.com/page/download>`
.. group-tab:: Fedora
.. note::
Odoo {CURRENT_MAJOR_VERSION} 'rpm' package supports Fedora 36.
Odoo {CURRENT_MAJOR_VERSION} 'rpm' package supports Fedora 38.
Once downloaded, the package can be installed using the 'dnf' package manager:
+10 -4
View File
@@ -31,6 +31,12 @@ This matrix shows the support status of every version.
- On-Premise
- Release date
- End of support
* - Odoo SaaS 18.1
- |green|
- N/A
- N/A
- January 2025
-
* - **Odoo 18.0**
- |green|
- |green|
@@ -38,17 +44,17 @@ This matrix shows the support status of every version.
- October 2024
- October 2027 (planned)
* - Odoo SaaS 17.4
- |green|
- |red|
- N/A
- N/A
- July 2024
-
- October 2024
* - Odoo SaaS 17.2
- |green|
- |red|
- N/A
- N/A
- April 2024
-
- October 2024
* - **Odoo 17.0**
- |green|
- |green|
@@ -28,15 +28,13 @@ select a record, tick the checkbox next to the corresponding record. Finally, cl
then :guilabel:`Export`.
.. image:: export_import_data/list-view-export.png
:align: center
:alt: View of the different things to enable/click to export data.
When clicking on :guilabel:`Export`, an :guilabel:`Export Data` pop-over window appears, with
several options for the data to export:
.. image:: export_import_data/export-data-overview.png
:align: center
:alt: Overview of options to consider when exporting data in Odoo..
:alt: Overview of options to consider when exporting data in Odoo.
#. With the :guilabel:`I want to update data (import-compatable export)` option ticked, the system
only shows the fields that can be imported. This is helpful in the case where the :ref:`existing
@@ -87,7 +85,6 @@ data into an Odoo database.
options: :guilabel:`Track history during import` and :guilabel:`Allow matching with subfields`.
.. image:: export_import_data/advanced-import.png
:align: center
:alt: Advanced import options when developer mode is activated.
If the model uses openchatter, the :guilabel:`Track history during import` option sets up
@@ -96,6 +93,8 @@ data into an Odoo database.
Should the :guilabel:`Allow matching with subfields` option be selected, then all subfields
within a field are used to match under the :guilabel:`Odoo Field` while importing.
.. _essentials/export_import_data/get-started:
Get started
-----------
@@ -103,30 +102,32 @@ Data can be imported on any Odoo business object using either Excel (`.xlsx`) or
(Comma-separated Values)` (`.csv`) formats. This includes: contacts, products, bank statements,
journal entries, and orders.
Open the view of the object to which the data should be imported/populated, and click on
:menuselection:`⚙️ (Action) --> Import records`.
Open the view of the object to which the data should be imported/populated, click the :icon:`fa-cog`
(:guilabel:`gear`) icon and select :guilabel:`Import records`.
.. image:: export_import_data/import-button.png
:align: center
:alt: Action menu revealed with the import records option highlighted.
After clicking :guilabel:`Import records`, Odoo reveals a separate page with templates that can be
downloaded and populated with the company's own data. Such templates can be imported in one click,
since the data mapping is already done. To download a template click :guilabel:`Import Template for
Customers` at the center of the page.
Click :icon:`fa-download`:guilabel:`Import Template for Customers` at the center of the page to
download a :ref:`template <essentials/export_import_data/adapt-a-template>` and populate it with
the company's own data. Such templates can be imported in one click since the data mapping is
already preconfigured.
.. important::
When importing a :abbr:`CSV (Comma-separated Values)` file, Odoo provides :guilabel:`Formatting`
options. These options do **not** appear when importing the proprietary Excel file type (`.xls`,
`.xlsx`).
To upload the downloaded template or your own file, follow the next steps:
.. image:: export_import_data/formatting.png
:align: center
:alt: Formatting options presented when a CVS file is imported in Odoo.
#. Click :guilabel:`Upload Data File` and select the desired file.
#. Adjust the :guilabel:`Formatting` options as needed (for CSV files only).
#. Ensure all data in the :guilabel:`File Column` is correctly mapped to the appropriate
:guilabel:`Odoo Field` and free of errors.
#. (Optional) Click :guilabel:`Load Data File` to reload the same file or upload a different one.
#. Click :guilabel:`Test` to verify that the data is valid.
#. Click :guilabel:`Import`.
Make necessary adjustments to the *Formatting* options, and ensure all columns in the
:guilabel:`Odoo field` and :guilabel:`File Column` are free of errors. Finally, click
:guilabel:`Import` to import the data.
.. note::
The :guilabel:`Formatting` options do **not** appear when importing the proprietary Excel file
type (i.e., `.xls` or `.xlsx`).
.. _essentials/export_import_data/adapt-a-template:
Adapt a template
----------------
@@ -144,7 +145,6 @@ Once the template is downloaded, proceed to follow these steps:
(ID) column.
.. image:: export_import_data/dragdown.gif
:align: center
:alt: An animation of the mouse dragging down the ID column, so each record has a unique ID.
.. note::
@@ -153,7 +153,6 @@ Once the template is downloaded, proceed to follow these steps:
Search the drop-down menu for the corresponding field.
.. image:: export_import_data/field_list.png
:align: center
:alt: Drop-down menu expanded in the initial import screen on Odoo.
Then, use this field's label in the import file to ensure future imports are successful.
@@ -203,7 +202,6 @@ If this happens, check the :guilabel:`Show fields of relation fields (advanced)
complete list of fields becomes available for each column.
.. image:: export_import_data/field_list.png
:align: center
:alt: Searching for the field to match the tax column.
Change data import format
@@ -401,6 +399,33 @@ respective contacts:
- :download:`Customers and their respective contacts
<export_import_data/o2m_customers_contacts.csv>`
Import image files
------------------
To import image files along with the :ref:`uploaded <essentials/export_import_data/get-started>`
CSV or Excel file, follow the next steps:
#. Add the image file names to the relevant :guilabel:`Image` column in the data file.
#. :ref:`Upload the data file <essentials/export_import_data/get-started>` or reload it by
clicking :guilabel:`Load Data File`.
#. Click :guilabel:`Upload your files` under the :guilabel:`Files to import` section.
#. Select the relevant image files. The number of files selected appears next to the button.
#. Click :guilabel:`Test` to verify that all data is valid.
#. Click :guilabel:`Import`. During the import process, Odoo performs a file check to automatically
link the uploaded images to the imported data file. If there is no match, the data file is
imported without any image.
.. note::
- The :guilabel:`Files to import` section is enabled if your product template has an
:guilabel:`Image` column with all fields populated.
- The image file names in the data file must correspond to the uploaded image files.
- When importing a large number of images, you can specify the maximum batch size in megabytes
and set a delay to prevent the system from becoming overloaded. To do so, :doc:`enable the
developer mode <../general/developer_mode>` and fill in the :guilabel:`Max size per
batch` and the :guilabel:`Delay after each batch` fields in the :guilabel:`Files to import`
section. By default, the delay meets the RPC/API call limit defined in the `Odoo Cloud -
Acceptable Use Policy <https://www.odoo.com/acceptable-use>`_.
Import records several times
----------------------------
@@ -4,7 +4,7 @@
Bank and cash accounts
======================
You can manage as many bank or cash accounts as needed on your database. Configuring them well
You can manage as many bank or cash accounts as needed on your database. Configuring them correctly
allows you to have all your banking data up-to-date and ready for :doc:`reconciliation
<bank/reconciliation>` with your journal entries.
@@ -21,22 +21,22 @@ which include action buttons.
.. image:: bank/card.png
:alt: Bank journals are displayed on the Accounting Dashboard and contain action buttons
.. _bank_accounts/manage:
.. _accounting/bank/manage:
Manage your bank and cash accounts
==================================
Manage bank and cash accounts
=============================
Connect your bank for automatic synchronization
-----------------------------------------------
Connect a bank for automatic synchronization
--------------------------------------------
To connect your bank account to your database, go to :menuselection:`Accounting --> Configuration
--> Banks: Add a Bank Account`, select your bank in the list, click on :guilabel:`Connect`, and
follow the instructions.
--> Add a Bank Account`, select your bank in the list, click on :guilabel:`Connect`, and follow the
instructions.
.. seealso::
:doc:`bank/bank_synchronization`
.. _bank_accounts/create:
.. _accounting/bank/create:
Create a bank account
---------------------
@@ -44,8 +44,9 @@ Create a bank account
If your banking institution is not available in Odoo, or if you don't want to connect your bank
account to your database, you can configure your bank account manually.
To manually add a bank account, go to :menuselection:`Accounting --> Configuration --> Banks:
Add a Bank Account`, click on :guilabel:`Create it` (at the bottom right), and fill out the form.
To manually add a bank account, go to :menuselection:`Accounting --> Configuration --> Add a Bank
Account`, click on :guilabel:`Record transactions manually` (at the bottom right), fill out the bank
information, and click :guilabel:`Create`.
.. note::
- Odoo automatically detects the bank account type (e.g., IBAN) and enables some features
@@ -61,7 +62,7 @@ To create a new cash journal, go to :menuselection:`Accounting --> Configuration
Journals`, click on :guilabel:`Create` and select :guilabel:`Cash` in the :guilabel:`Type` field.
For more information on the accounting information fields, read the
:ref:`bank_accounts/configuration` section of this page.
:ref:`accounting/bank/configuration` section of this page.
.. note::
A default cash journal is available and can be used straight away. You can review it by going to
@@ -73,7 +74,7 @@ Edit an existing bank or cash journal
To edit an existing bank journal, go to :menuselection:`Accounting --> Configuration --> Accounting:
Journals` and select the journal you want to modify.
.. _bank_accounts/configuration:
.. _accounting/bank/configuration:
Configuration
=============
@@ -86,14 +87,23 @@ You can edit the accounting information and bank account number according to you
.. seealso::
- :doc:`get_started/multi_currency`
- :doc:`bank/transactions`
- `Bank configuration <https://www.youtube.com/watch?v=tVhhXw-VnGE>`_
.. _bank_accounts/suspense:
.. _accounting/bank/suspense:
Suspense account
----------------
Bank statement transactions are posted on the :guilabel:`Suspense Account` until the final
reconciliation allows finding the right account.
Bank statement transactions are posted on the suspense account until they are reconciled. At any
moment, the suspense account's balance in the general ledger shows the balance of transactions that
have not yet been reconciled.
.. note::
When a bank transaction is reconciled, the journal entry is modified to replace the bank suspense
account with the account of the journal item it is reconciled with. This account is usually the
:ref:`outstanding receipts or payments account <accounting/bank/outstanding-accounts>` if
reconciling with a registered payment or the account receivable or payable if reconciling with
an invoice or bill directly.
Profit and loss accounts
------------------------
@@ -105,7 +115,7 @@ register a loss when the ending balance of a cash register differs from what the
Currency
--------
You can edit the currency used to enter the statements.
You can edit the currency used to enter the transactions.
.. seealso::
:doc:`get_started/multi_currency`
@@ -114,7 +124,7 @@ Account number
--------------
If you need to **edit your bank account details**, click on the external link arrow next to your
:guilabel:`Account Number`. On the new page, click on the external link arrow next to your
:guilabel:`Account Number`. On the account page, click on the external link arrow next to your
:guilabel:`Bank` and update your bank information accordingly. These details are used when
registering payments.
@@ -124,12 +134,13 @@ registering payments.
Bank feeds
----------
:guilabel:`Bank Feeds` defines how the bank statements are registered. Three options are available:
:guilabel:`Bank Feeds` defines how the bank transactions are registered. Three options are
available:
- :guilabel:`Undefined yet`, which should be selected when you dont know yet if you will
synchronize your bank account with your database or not.
- :guilabel:`Import (CAMT, CODA, CSV, OFX, QIF)`, which should be selected if you want to import
your bank statement using a different format.
your bank statements and transactions using a different format.
- :guilabel:`Automated Bank Synchronization`, which should be selected if your bank is synchronized
with your database.
@@ -137,53 +148,47 @@ Bank feeds
- :doc:`bank/bank_synchronization`
- :doc:`bank/transactions`
.. _bank/outstanding-accounts:
.. _accounting/bank/outstanding-accounts:
Outstanding accounts
====================
By default, payments are registered through transitory accounts named **outstanding accounts**,
before being recorded in your bank account.
By default, payments in Odoo do not create journal entries, but they can easily be configured to
create journal entries using **outstanding accounts**.
- An **outstanding payments account** is where outgoing payments are posted until they are linked
with a withdrawal from your bank statement.
- An **outstanding receipts account** is where incoming payments are posted until they are linked
with a deposit from your bank statement.
with incoming bank transactions.
- An **outstanding payments account** is where outgoing payments are posted until they are linked
with outgoing bank transactions.
These accounts should be of :ref:`type <chart-of-account/type>` :guilabel:`Current Assets`.
These accounts are usually of :ref:`type <chart-of-account/type>` :guilabel:`Current Assets` and
:guilabel:`Current Liabilities`.
Payments that are registered in Odoo are posted to the outstanding receipts and outstanding accounts
until they are reconciled. At any moment, the outstanding receipts account's balance in the general
ledger shows the balance of registered incoming payments that have not yet been reconciled, and the
outstanding payments account's balance in the general ledger shows the balance of registered
outgoing payments that have not yet been reconciled.
Bank and cash journal configuration
-----------------------------------
To configure payments to create journal entries, set outstanding accounts for the journal's payment
methods. This can be done for any journal with the :ref:`type <chart-of-account/type>`
:guilabel:`Bank` or :guilabel:`Cash`.
To configure the outstanding accounts for a journal's payment methods, first go to
:menuselection:`Accounting --> Configuration --> Journals` and select a bank or cash journal. In the
:guilabel:`Incoming Payments` and :guilabel:`Outgoing Payments` tabs, set :guilabel:`Outstanding
Receipts accounts` and :guilabel:`Outstanding Payments accounts` for each payment method that you
want to create journal entries.
.. note::
The movement from an outstanding account to a bank account is done automatically when you
reconcile the bank account with a bank statement.
Default accounts configuration
------------------------------
The outstanding accounts are defined by default. If necessary, you can update them by going to
:menuselection:`Accounting --> Configuration --> Settings --> Default Accounts` and update your
:guilabel:`Outstanding Receipts Account` and :guilabel:`Outstanding Payments Account`.
Bank and cash journals configuration
------------------------------------
You can also set specific outstanding accounts for any journal with the :ref:`type
<chart-of-account/type>` :guilabel:`Bank` or :guilabel:`Cash`.
From your :guilabel:`Accounting Dashboard`, click on the menu selection ⋮ of the journal you want to
configure, and click on :guilabel:`Configuration`, then open the :guilabel:`Incoming/Outgoing
Payments` tab. To display the outstanding accounts column, click on the toggle button and check the
:guilabel:`Outstanding Receipts/Payments accounts`, then update the account.
.. image:: bank/toggle-button.png
:align: center
:alt: Select the toggle button and click on outstanding Accounts
.. note::
- If you do not specify an outstanding payments account or an outstanding receipts account for a
specific journal, Odoo uses the default outstanding accounts.
- If your main bank account is added as an outstanding receipts account or outstanding payments
account, when a payment is registered, the invoice or bill's status is directly set to
:guilabel:`Paid`.
- If the main bank account of the journal is added as an outstanding receipts account or
outstanding payments account, when a payment is registered, the invoice or bill's status is
directly set to :guilabel:`Paid`.
- If the outstanding receipts or outstanding payments account for a payment method is left blank,
registering a payment with that payment method will not create any journal entry.
.. toctree::
:titlesonly:
@@ -192,5 +197,6 @@ Payments` tab. To display the outstanding accounts column, click on the toggle b
bank/transactions
bank/reconciliation
bank/reconciliation_models
bank/internal_transfers
bank/foreign_currency
bank/loans
Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.0 KiB

After

Width:  |  Height:  |  Size: 8.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 25 KiB

@@ -11,7 +11,7 @@ To check if your bank is compatible with Odoo, go to `Odoo Accounting Features
<https://www.odoo.com/page/accounting-features>`_, and click on
:guilabel:`See list of supported institutions`.
Odoo supports more than 25,000 institutions around the world.
Odoo supports more than 26,000 institutions around the world.
To connect to the banks, Odoo uses multiple web-services:
Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.4 KiB

After

Width:  |  Height:  |  Size: 6.4 KiB

@@ -0,0 +1,71 @@
==================
Internal transfers
==================
Internal money transfers can be handled in Odoo. At least two bank or cash accounts are needed to
make internal transfers.
.. seealso::
:ref:`How to add an additional bank account <accounting/bank/create>`
Configuration
=============
An internal transfer account is automatically created on your database based on your company's
:doc:`localization <../../fiscal_localizations>` and depending on your countrys legislation. To
modify the default :guilabel:`Internal Transfer` account, go to :menuselection:`Accounting -->
Configuration --> Settings` and scroll down to the :guilabel:`Default Accounts` section.
Register an internal transfer from one bank to another
======================================================
When money is transferred from one bank or cash account to another, that amount appears as two
transactions on the corresponding journals, whether the transactions are created manually, via
import, or via :doc:`bank synchronization <bank_synchronization>`. When reconciling the transaction,
select the :guilabel:`Internal Transfers` :doc:`reconciliation model <reconciliation_models>`
button. This reconciliation model button writes the transaction off to the :guilabel:`Internal
Transfer` account.
.. tip::
Remember to reconcile the transaction for both the outgoing transaction on the journal that sends
the payment and the incoming transaction on the journal that receives the payment.
.. example::
Take, for example, a transfer of $1000 from Bank A to Bank B:
- Bank journal (Bank A)
.. list-table::
:header-rows: 1
:stub-columns: 1
* - **Account**
- **Debit**
- **Credit**
* - Bank A account
-
- $1,000
* - **Internal transfer account**
- **$1,000**
-
- Bank journal (Bank B)
.. list-table::
:header-rows: 1
:stub-columns: 1
* - **Account**
- **Debit**
- **Credit**
* - Bank B account
- $1,000
-
* - **Internal transfer account**
-
- **$1,000**
.. seealso::
:doc:`reconciliation`
:doc:`reconciliation_models`
@@ -15,7 +15,7 @@ for use at a later date:
reduce/settle unpaid invoices/bills.
.. seealso::
- :doc:`Internal transfers <payments/internal_transfers>`
- :doc:`Internal transfers <bank/internal_transfers>`
- :doc:`bank/reconciliation`
- `Odoo Tutorials: Bank Configuration
<https://www.odoo.com/slides/slide/bank-configuration-6832>`_
@@ -27,10 +27,10 @@ Registering payment from an invoice or bill
When clicking :guilabel:`Register payment` in a customer invoice or vendor bill, it generates a new
journal entry and changes the amount due according to the payment amount. The counterpart is
reflected in an :ref:`outstanding <bank/outstanding-accounts>` **receipts** or **payments** account.
At this point, the customer invoice or vendor bill is marked as :guilabel:`In payment`. Then, when
the outstanding account is reconciled with a bank transaction line, the invoice or vendor bill
changes to the :guilabel:`Paid` status.
reflected in an :ref:`outstanding <accounting/bank/outstanding-accounts>` **receipts** or
**payments** account. At this point, the customer invoice or vendor bill is marked as :guilabel:`In
payment`. Then, when the outstanding account is reconciled with a bank transaction line, the invoice
or vendor bill changes to the :guilabel:`Paid` status.
The :icon:`fa-info-circle` information icon next to the payment line displays more
information about the payment. To access additional information, such as the related journal, click
@@ -51,8 +51,8 @@ information about the payment. To access additional information, such as the rel
.. tip::
If the main bank account is set as an :ref:`outstanding account
<bank/outstanding-accounts>`, and the payment is registered in Odoo (not through a related
bank transaction), invoices and bills are directly registered as :guilabel:`Paid`.
<accounting/bank/outstanding-accounts>`, and the payment is registered in Odoo (not through a
related bank transaction), invoices and bills are directly registered as :guilabel:`Paid`.
.. _accounting/payments/not-tied:
@@ -184,7 +184,6 @@ finalize the payment workflow and mark the invoice or bill as :guilabel:`Paid`.
payments/batch
payments/batch_sdd
payments/follow_up
payments/internal_transfers
payments/pay_sepa
payments/pay_checks
payments/forecast
@@ -17,7 +17,7 @@ into account checks yet to be cashed.
statement.
.. seealso::
* :ref:`Outstanding accounts <bank/outstanding-accounts>`
* :ref:`Outstanding accounts <accounting/bank/outstanding-accounts>`
* :ref:`Bank reconciliation <accounting/reconciliation>`
.. _checks/outstanding-account:
@@ -1,73 +0,0 @@
==================
Internal transfers
==================
Internal money transfers can be handled in Odoo. At least two bank accounts are needed to make
internal transfers.
.. seealso::
:doc:`How to add an additional bank account <../bank>`
Configuration
=============
An internal transfer account is automatically created on your database based on your company's
localization and depending on your countrys legislation. To modify the default :guilabel:`Internal
transfer account`, go to :menuselection:`Accounting --> Configuration --> Settings` and scroll down
to the :guilabel:`Default Accounts` section.
Register an internal transfer from one bank to another
======================================================
If you want to transfer money from one bank to another, access the Accounting Dashboard, click the
drop-down selection button (:guilabel:`⋮`) on the bank from which you want to make the transfer,
then click :guilabel:`Payments`. Select or create a payment, tick the :guilabel:`Internal Transfer`
checkbox, and select a :guilabel:`Destination Journal` before you :guilabel:`Confirm` the internal
transfer.
The money is now booked in the transfer account and another payment is automatically created in the
destination journal.
.. example::
- Bank journal (Bank A)
.. list-table::
:header-rows: 1
:stub-columns: 1
* - **Account**
- **Debit**
- **Credit**
* - Outstanding Payments account
-
- $1,000
* - **Internal transfer account**
- **$1,000**
-
- Bank journal (Bank B)
.. list-table::
:header-rows: 1
:stub-columns: 1
* - **Account**
- **Debit**
- **Credit**
* - Outstanding Receipts account
- $1,000
-
* - **Internal transfer account**
-
- **$1,000**
There is **one outstanding payment** and **one outstanding receipt** pending in your two bank
account journals because the bank statement confirming the sending and receiving of the money
has not been booked yet.
Once this is done, you can book and reconcile your bank statement lines as usual.
.. seealso::
:doc:`../bank/reconciliation`
@@ -35,9 +35,6 @@ To do so, go to :menuselection:`Accounting --> Configuration --> Settings`. Unde
- :guilabel:`Reminder`: define when Odoo should remind you to submit your tax return;
- :guilabel:`Journal`: select the journal in which to record the tax return.
.. image:: tax_returns/tax_return_periodicity.png
:align: center
:alt: Configure how often tax returns have to be made in Odoo Accounting
.. note::
This is usually configured during the :doc:`app's initial set up <../get_started>`.
@@ -53,16 +50,11 @@ You can see the :guilabel:`Tax Grids` by opening the :guilabel:`Journal Items` t
invoice and bill.
.. image:: tax_returns/tax_return_grids.png
:align: center
:alt: see which tax grids are used to record transactions in Odoo Accounting
To configure your tax grids, go to :menuselection:`Accounting --> Configuration --> Taxes`,
and open the tax you want to modify. There, you can edit your tax settings, along with the tax
grids that are used to record invoices or credit notes.
.. image:: tax_returns/tax_return_taxes.png
:align: center
:alt: Configure taxes and their tax grids in Odoo Accounting
grids that are used to record invoices or refunds.
.. note::
Taxes and reports are usually already pre-configured in Odoo: a :ref:`fiscal localization package
@@ -76,40 +68,41 @@ Close a tax period
.. _tax-returns/lock-date:
Tax Lock Date
Tax lock date
-------------
Any new transaction whose accounting date prior to the :guilabel:`Tax Lock Date` has its tax values
moved to the next open tax period. This is useful to make sure that no change can be made to a
report once its period is closed.
Any new transaction whose accounting date prior to the :guilabel:`Lock Tax Return` date has its tax
values moved to the next open tax period. This is useful to make sure that no change can be made to
a report once its period is closed.
Therefore, we recommend locking your tax date before working on your
:guilabel:`Closing Journal Entry`.
This way, other users cannot modify or add transactions that would have an impact on the
:guilabel:`Closing Journal Entry`, which can help you avoid some tax declaration errors.
To check the current :guilabel:`Tax Lock Date`, or to edit it, go to
:menuselection:`Accounting --> Accounting --> Actions: Lock Dates`.
.. image:: tax_returns/tax_return_lock.png
:align: center
:alt: Lock your tax for a specific period in Odoo Accounting
To check the current :guilabel:`Lock Tax Return` date, or to edit it, go to
:menuselection:`Accounting --> Accounting --> Lock Dates`.
.. _tax-returns/report:
Tax Report
Tax return
----------
Once all the transactions involving taxes have been posted for the period you want to report, open
your :guilabel:`Tax Report` by going to :menuselection:`Accounting --> Reporting -->
Audit Reports: Tax Report`. Make sure to select the right period you want to declare by using the
date filter, this way you can have an overview of your tax report. From this view, you can easily
access different formats of your tax report, such as `PDF` and XLSX. These include all the values to
report to the tax authorities, along with the amount you have to pay or be refunded.
the :guilabel:`Tax Return` report by going to :menuselection:`Accounting --> Reporting --> Tax
Return`. Select the period you want to declare using the date filter to have an overview of the tax
return. Then, click :guilabel:`Closing Entry` to create a tax closing journal entry. Odoo
automatically proposes the details of the journal entry. Make any necessary changes and click
:guilabel:`Post`.
.. image:: tax_returns/tax_return_report.png
:align: center
:alt: download the PDF with your Tax Report in Odoo Accounting
From the report, click :guilabel:`PDF` to download a PDF of the tax return. Alternatively, click the
:icon:`fa-cog` (:guilabel:`gear`) icon, then click :guilabel:`Download Excel` to download an XLSX of
the tax return. To save the report to the Documents app, click the :icon:`fa-cog` (:guilabel:`gear`)
icon, then click :guilabel:`Copy to Documents`. Select the format to :guilabel:`Export to`, the
:guilabel:`Documents Name`, the :guilabel:`Folder` to store it in, and add any :guilabel:`Tags`.
The report includes all the values to report to the tax authorities, along with the amount to be
paid or refunded.
.. note::
If you forgot to lock your tax date before clicking on :guilabel:`Closing Journal Entry`, then
Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

@@ -43,7 +43,7 @@ Before closing a fiscal year, ensure first everything is accurate and up-to-date
- Validate all :doc:`expenses <../../expenses>`, ensuring their accuracy.
- Corroborate that all :doc:`received payments <../payments>` have been encoded and recorded
accurately.
- Close all :ref:`suspense accounts <bank_accounts/suspense>`.
- Close all :ref:`suspense accounts <accounting/bank/suspense>`.
- Book all :doc:`depreciation <../vendor_bills/assets>` and :doc:`deferred revenue
<../customer_invoices/deferred_revenues>` entries.
@@ -91,9 +91,10 @@ To buy credits, go to :menuselection:`Accounting --> Configuration --> Settings
and click on :guilabel:`Buy credits`, or go to :menuselection:`Settings --> Odoo IAP` and click on
:guilabel:`View My Services`.
.. important::
If you are on Odoo Online and have the Enterprise version, you benefit from free trial credits to
test the feature.
.. 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.
.. seealso::
- `Our Privacy Policy <https://iap.odoo.com/privacy#header_6>`_
@@ -187,17 +187,17 @@ Fiscal localization modules are available for the countries listed below.
fiscal_localizations/mexico
fiscal_localizations/netherlands
fiscal_localizations/new_zealand
fiscal_localizations/romania
fiscal_localizations/peru
fiscal_localizations/philippines
fiscal_localizations/romania
fiscal_localizations/saudi_arabia
fiscal_localizations/singapore
fiscal_localizations/spain
fiscal_localizations/switzerland
fiscal_localizations/thailand
fiscal_localizations/vietnam
fiscal_localizations/united_arab_emirates
fiscal_localizations/united_kingdom
fiscal_localizations/united_states
fiscal_localizations/uruguay
fiscal_localizations/vietnam
fiscal_localizations/employment_hero
@@ -24,6 +24,10 @@ localization.
- `l10n_at_saft`
- Adds the SAF-T export.
.. seealso::
:doc:`Documentation on e-invoicings legality and compliance in Austria
<../accounting/customer_invoices/electronic_invoicing/austria>`
Financial reports
=================
@@ -11,6 +11,10 @@ Install the :guilabel:`🇧🇪 Belgium` :ref:`fiscal localization package
<fiscal_localizations/packages>` to get all the default accounting features of the Belgian
localization, following the :abbr:`IFRS(International Financial Reporting Standards)` rules.
.. seealso::
:doc:`Documentation on e-invoicings legality and compliance in Belgium
<../accounting/customer_invoices/electronic_invoicing/belgium>`
.. _belgium/coa:
Chart of accounts
@@ -584,8 +588,8 @@ provide the following information:
- your company's name, address, and legal structure; and
- the Mac address of your IoT Box.
Once your IoT box is certified, :doc:`connect <../../general/iot/config/connect>` it to your
database. To verify that the IoT Box recognizes the FDM, go to the IoT homepage and scroll down the
Once your IoT box is certified, :doc:`connect <../../general/iot/connect>` it to your database. To
verify that the IoT Box recognizes the FDM, go to the IoT homepage and scroll down the
:guilabel:`IOT Device` section, which should display the FDM.
.. image:: belgium/iot-devices.png
@@ -205,11 +205,11 @@ An Odoo local server works as a bridge between your computer and your Odoo datab
Download the Odoo Community installer from the page https://www.odoo.com/page/download and start the
installation on your computer.
Select :guilabel:`Local Proxy Mode` as the type of install.
Select :guilabel:`Odoo IoT` as the type of install.
.. image:: egypt/install-odoo-local-proxy.png
:align: center
:alt: Selection of "Local Proxy Mode" during the installation of Odoo Community.
:alt: Selection of "Odoo IoT" during the installation of Odoo Community.
.. note::
This installation of Odoo only works as a server and does not install any Odoo apps on your
Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 10 KiB

@@ -2,6 +2,10 @@
France
======
.. seealso::
:doc:`Documentation on e-invoicings legality and compliance in France
<../accounting/customer_invoices/electronic_invoicing/france>`
.. _localization/france/fec:
FEC - Fichier des Écritures Comptables
@@ -2,222 +2,154 @@
Germany
=======
German Chart of Accounts
========================
Accounting
==========
The chart of accounts SKR03 and SKR04 are both supported in Odoo. You can choose the
one you want by going in :menuselection:`Accounting --> Configuration` then choose the
package you want in the Fiscal Localization section.
.. seealso::
:doc:`Documentation on e-invoicing's legality and compliance in Germany
<../accounting/customer_invoices/electronic_invoicing/germany>`
Be careful, you can only change the accounting package as long as you have not created any accounting entry.
Chart of accounts
-----------------
.. tip::
Both SKR03 and SKR04 charts of accounts are supported in Odoo. When you create a new Odoo Online
database, SKR03 is installed by default.
When you create a new Odoo Online database, the SKR03 is installed by default.
Verify which is installed by going to :menuselection:`Accounting --> Configuration --> Settings`
and checking the :guilabel:`Package` field under the :guilabel:`Fiscal Localization` section.
German Accounting Reports
=========================
.. warning::
Selecting another package is only possible if you have not created an accounting entry. If one
was posted, a new company or database must be set up to select another package. In
addition, all journal entries will need to be created again.
Here is the list of German-specific reports available on Odoo Enterprise:
Reports
-------
The following German-specific reports available on Odoo Enterprise:
- Balance Sheet
- Profit & Loss
- Tax Report (Umsatzsteuervoranmeldung)
- Partner VAT Intra
- EC Sales List
- Intrastat
Export from Odoo to Datev
=========================
Exporting entries from Odoo to DATEV
------------------------------------
It is possible to export your accounting entries from Odoo to Datev. To be able to use this
feature, the german accounting localization needs to be installed on your Odoo Enterprise database.
Then you can go in :menuselection:`Accounting --> Reporting --> General Ledger` then click on the
**Export Datev (csv)** button.
Provided that one of the German :ref:`fiscal localization packages
<fiscal_localizations/accounting>` is installed, you can export your accounting entries from Odoo to
DATEV from the general ledger.
.. _germany/pos:
Point of Sale in Germany: Technical Security System
===================================================
The **Kassensicherungsverordnung** (The Act on Protection against Manipulation of Digital Records)
requires that electronic record-keeping systems - including the :doc:`point of sale
</applications/sales/point_of_sale>` systems - must be equipped with a **Technical Security System**
(also called **TSS** or **TSE**).
Odoo offers a service that is compliant with the help of `fiskaly <https://fiskaly.com>`_, a
*cloud-based solution*.
.. important::
Since this solution is cloud-based, a working internet connection is required.
Two types of exports are needed: first the DATEV ATCH export, then the DATEV DATA export.
.. note::
The only VAT rates allowed are given by fiskaly. You can check these rates by consulting:
`fiskaly DSFinV-K API: VAT Definition
<https://developer.fiskaly.com/api/dsfinvk/v0/#tag/VAT-Definition>`_.
Both are needed at different stages to transfer the data correctly to DATEV, as DATEV works with
two interfaces, one for clients (DUO - DATEV Unternehmen Online) and one for tax advisors (DATEV
Rechnungswesen).
Configuration
-------------
1. DATEV ATCH
~~~~~~~~~~~~~
Modules installation
~~~~~~~~~~~~~~~~~~~~
Go to :menuselection:`Accounting --> Reporting --> General Ledger`, click the :icon:`fa-cog`
(:guilabel:`Actions`) button, and select :guilabel:`Datev ATCH (zip)`.
#. If your database was created before June 2021, :ref:`upgrade <general/upgrade>` your **Point of
Sale** app (`point_of_sale`) and the **Restaurant** module (`pos_restaurant`).
#. :ref:`Install <general/install>` the **Germany - Certification for Point of Sale**
(`l10n_de_pos_cert`) and **Germany - Certification for Point of Sale of type restaurant**
(`l10n_de_pos_res_cert`) modules.
.. image:: germany/datev-export.png
:alt: General ledger's actions menu with DATEV exports
.. tip::
If these modules are not listed, :ref:`update the app list <general/install>`.
Upload the downloaded ZIP file via the `DATEV Belegtransfer software <https://www.datev.de/web/de/service-und-support/software-bereitstellung/download-bereich/betriebliches-rechnungswesen/belegtransfer>`_.
.. image:: germany/pos-upgrade.png
:align: center
:alt: Upgrading Odoo Point of Sale from the Apps dashboard
If you do not have the DATEV Belegtransfer software installed on your computer, ask your tax advisor
to help you with this.
Register your company at the financial authority
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. warning::
The DATEV ATCH ZIP file includes the files (reports) linked to an Odoo invoice or bill. For
customer invoices, the file must have been generated by using the :guilabel:`Send` button. For
vendor bills, the file must have been received via an email alias or uploaded by using the
:guilabel:`Upload` button.
To register your company, go to :menuselection:`Settings --> General Settings --> Companies -->
Update Info`, fill out the following fields and *Save*.
.. admonition:: DATEV ATCH ZIP file
- **Company name**
- Valid **address**
- **VAT** number
- **St.-Nr** (Steuernummer): this number is assigned by the tax office to every taxable natural or
legal person. (e.g., `2893081508152`)
- **W-IdNr** (Wirtschafts-Identifikationsnummer): this number is used as a permanent
identification number for economically active persons.
The ZIP file contains two types of files:
You can then **register your company through fiskaly** by opening the *fiskaly* tab and clicking on
the *fiskaly Registration* button.
- the individual invoice/bill files (PDF, JPEG, etc.) for the selected period on the general
ledger, and
- a :file:`document.xml` file used to generate a unique ID (GUID) for each file.
.. image:: germany/fiskaly-registration.png
:align: center
:alt: Button to register a company through fiskaly in Odoo
These unique IDs are essential as they allow DATEV to automatically link the files to the
individual journal items, which will be imported with the DATEV DATA file in the next step.
.. tip::
If you do not see the *fiskaly Registration* button, make sure that you *saved* your company
details and are not in *editing mode* anymore.
2. DATEV DATA
~~~~~~~~~~~~~
Once the registration has been finalized, new fields appear:
Go to :menuselection:`Accounting --> Reporting --> General Ledger`, click the :icon:`fa-cog`
(:guilabel:`Actions`) button, and select :guilabel:`Datev DATA (zip)`.
- **fiskaly organization ID** refers to the ID of your company at the fiskaly side.
- **fiskaly API key** and **secret** are the credentials the system uses to access the services
offered by fiskaly.
Transfer the downloaded ZIP file to your tax advisor. They should import the ZIP file into DATEV
Rechnungswesen.
.. image:: germany/fiskaly-keys.png
:align: center
:alt: fiskaly keys as displayed on Odoo
Check with your tax advisor how often they need these files.
.. note::
It is possible to request new credentials if there is any issue with the current ones.
.. admonition:: DATEV ATCH ZIP file
Create and link a Technical Security System to your PoS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ZIP file contains three CSV files:
.. image:: germany/create-tss.png
:align: right
:alt: Create TSS option from a point of sale
To use your point of sale in Germany, you first have to create a :abbr:`TSS (Technical Security
System)` for it.
To do so, go to :menuselection:`Point of Sale --> Configuration --> Point of Sale`, open the point
of sale you want to edit, then check the box next to **Create TSS** and *Save*.
.. image:: germany/tss-ids.png
:align: right
:alt: Example of TSS ID and Client ID from fiskaly in Odoo Point of Sale
Once the creation of the TSS is successful, you can find your **TSS ID** and **Client ID** under the
*fiskaly API* section.
- **TSS ID** refers to the ID of your TSS at fiskaly's side.
- **Client ID** refers to your PoS but at fiskaly's side.
DSFinV-K
--------
.. image:: germany/dsfinv-k-export.png
:align: right
:alt: Menu to export DSFinV-K
Whenever you close a PoS session, the orders' details are sent to the :abbr:`DSFinV-K (Digitale
Schnittstelle der Finanzverwaltung für Kassensysteme)` service of fiskaly.
In case of an audit, you can export the data sent to DSFinV-K by going to :menuselection:`Point of
Sale --> Orders --> DSFinV-k exports`.
These fields are mandatory:
- **Name**
- **Start Datetime** (export data with dates larger than or equal to the given start date)
- **End Datetime** (export data with dates smaller than or equal to the given end date)
Leave the **Point of Sale** field blank if you want to export the data of all your points of sale.
Specify a Point of Sale if you want to export this specific PoS' data only.
The creation of a DSFinV-K export triggers on export at fiskaly's side.
.. image:: germany/dsfinv-k-export-fields.png
:align: center
:alt: Pending DSFinV-K export on Odoo
As you can see, the **State** is *Pending*. This means that the export has been successfully
triggered and is being processed. You have to click on *Refresh State* to check if it is ready.
- the :file:`EXTF_customer_accounts.csv` file containing all information related to your
customers,
- the :file:`EXTF_vendor_accounts.csv` file containing all information related to your vendors,
and
- the :file:`EXTF_accounting_entries.csv` containing all journal items for the period defined on
the general ledger, as well as the unique IDs (GUID) so that the journal items can be linked to
the files inside the DATEV ATCH ZIP file.
.. _germany/gobd:
German Tax Accounting Standards: Odoo's guide to GoBD Compliance
================================================================
GoBD compliance
---------------
**GoBD** stands for *Grundsätze zur ordnungsmäßigen Führung und Aufbewahrung von Büchern,
Aufzeichnungen und Unterlagen in elektronischer Form sowie zum Datenzugriff*.
In short, it is a **guideline for the proper management and storage of books, records, and documents
in electronic form, as well as for data access**, that is relevant for the German tax authority, tax
declaration, and balance sheet.
Aufzeichnungen und Unterlagen in elektronischer Form sowie zum Datenzugriff*. In short, it is a
guideline for the proper management and storage of books, records, and documents in electronic form,
as well as for data access, that is relevant for the German tax authority, tax declaration, and
balance sheet.
These principles have been written and published by the Federal Ministry of Finance (BMF) in
November 2014. Since January 2015, **they have become the norm** and replace previously accepted
practices linked to computer-based accounting. Several changes have been made by the BMF in 2019 and
January 2020 to specify some of the content and due to the development of digital solutions (cloud
hosting, paperless companies, etc.).
November 2014. Since January 2015, **they have become the norm** and have replaced previously
accepted practices linked to computer-based accounting. Several changes have been made by the BMF in
2019 and January 2020 to specify some of the content due to the development of digital solutions
(cloud hosting, paperless companies, etc.).
.. important::
Odoo gives you **the means to be compliant with GoBD**.
Odoo is certified **GoBD-compliant**.
What do you need to know about GoBD when relying on accounting software?
------------------------------------------------------------------------
Understanding GoBD in relation to accounting software
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. note::
If you can, the best way to understand GoBD is to Read the `Official GoBD text
<https://ao.bundesfinanzministerium.de/ao/2021/Anhaenge/BMF-Schreiben-und-gleichlautende-Laendererlasse/Anhang-64/anhang-64.html>`_.
It is a bit long but quite readable for non-experts. But in short, here is what to expect:
The **GoBD is binding for companies that have to present accounts, which includes SMEs, freelancers,
and entrepreneurs, to the financial authorities**. As such, **the taxpayer himself is the sole
responsible** for the complete and exhaustive keeping of fiscal-relevant data (above-mentioned
The **GoBD is binding for companies that have to present accounts**, which includes SMEs,
freelancers, and entrepreneurs, to the financial authorities. As such, **the taxpayer himself is the
sole responsible** for the complete and exhaustive keeping of fiscal-relevant data (above-mentioned
financial and related data).
Apart from software requirements, the user is required to ensure Internal control systems (*in
Apart from software requirements, the user is required to ensure internal control systems (*in
accordance with sec. 146 of the Fiscal Code*):
- Access rights control;
- Segregation of Duties, Functional separating;
- Entry controls (error notifications, plausibility checks);
- Reconciliation checks at data entry;
- Processing controls;
- Measures to prevent intentional or unintentional manipulation of software, data, or documents.
- access rights control;
- segregation of duties, functional separating;
- entry controls (error notifications, plausibility checks);
- reconciliation checks at data entry;
- processing controls; and
- measures to prevent intentional or unintentional manipulation of software, data, or documents.
The user must distribute tasks within its organization to the relevant positions (*control*) and
The user must distribute tasks within their organization to the relevant positions (*control*) and
verify that the tasks are properly and completely performed (*supervision*). The result of these
controls must be recorded (*documentation*), and should errors be found during these controls,
appropriate measures to correct the situation should be put into place (*prevention*).
What about data security?
-------------------------
Data security
~~~~~~~~~~~~~
**The taxpayer must secure the system against any data loss due to deletion, removal, or theft of
any data**. If the entries are not sufficiently secured, the bookkeeping will be regarded as not in
The taxpayer must **secure the system against any data loss** due to deletion, removal, or theft of
any data. If the entries are not sufficiently secured, the bookkeeping will be regarded as not in
accordance with the GoBD guidelines.
Once bookings have been finally posted, they can no longer be changed or deleted via the
@@ -229,104 +161,183 @@ application.
.. seealso::
`Odoo Cloud Hosting - Service Level Agreement <https://www.odooo.com/cloud-sla>`_
- If the server is operated locally, it is the responsibility of the user to create the necessary
backup infrastructure.
- If the server is operated locally, the user is responsible for creating the necessary backup
infrastructure.
.. important::
In some cases, data has to be kept for ten years or more, so always have backups saved. It is
even more important if you decide to change software provider.
Responsibility of the software editor
-------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Considering GoBD only applies between the taxpayer and the financial authority, **the software
editor can by no means be held responsible for the accurate and compliant documentation of financial
transactional data of their users**. It can merely provide the necessary tools for the user to
respect the software related guidelines described in the GoBD.
Considering GoBD applies only to the taxpayer, **the software editor can by no means be held
responsible for the accurate and compliant documentation of their users' financial transactional
data**. It can merely provide the necessary tools for the user to respect the software-related
guidelines described in the GoBD.
How can Odoo help you achieve Compliance?
-----------------------------------------
Ensuring compliance through Odoo
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The key words, when it comes to GoBD, are: **traceable, verifiable, true, clear, and continuous**.
In short, you need to have audit-proof archiving in place and Odoo provides you with the means to
The keywords, when it comes to GoBD are: **traceable, verifiable, true, clear, and continuous**.
In short, you need to have audit-proof archiving in place, and Odoo provides you with the means to
achieve all of these objectives:
#. | **Traceability and verifiability**
| Each record in Odoo is stamped with the creator of the document, the creation date, the
modification date, and who modified it. In addition, relevant fields are tracked thus it can be
seen which value was changed by whom in the chatter of the relevant object.
modification date, and who modified it. In addition, relevant fields are tracked. Thus, it can
be seen which value was changed by whom in the chatter of the relevant object.
#. | **Completeness**
| All financial data must be recorded in the system, and there can be no gaps. Odoo ensures that
there is no gap in the numbering of the financial transactions. It is the responsibility of the
user to encode all financial data in the system. As most financial data in Odoo is generated
user to encode all financial data in the system. As most financial data in Odoo is generated
automatically, it remains the responsibility of the user to encode all vendor bills and
miscellaneous operations completely.
#. | **Accuracy**
| Odoo ensures with the correct configuration that the correct accounts are used. In addition,
| Odoo ensures that, with the correct configuration, the correct accounts are used. In addition,
the control mechanisms between purchase orders and sales orders and their respective invoices
reflect the business reality. It is the responsibility of the user to scan and attach the
paper-based vendor bill to the respective record in Odoo. *Odoo Document helps you automate
this task*.
reflect the reality of the business. It is the responsibility of the user to scan and attach
the paper-based vendor bill to the respective record in Odoo. *Odoo Documents helps you
automate this task*.
#. | **Timely booking and record-keeping**
| As most financial data in Odoo is generated by the transactional objects (for example, the
invoice is booked at confirmation), Odoo ensures out-of-the-box timely record-keeping. It is
the responsibility of the user to encode all incoming vendor bills in a timely manner, as well
as the miscellaneous operations.
#. | **Order**
| Financial data stored in Odoo is per definition ordered and can be reordered according to most
fields present in the model. A specific ordering is not enforced by the GoBD, but the system
must ensure that a given financial transaction can be quickly found by a third-party expert.
Odoo ensures this out-of-the-box.
| Financial data stored in Odoo is, per definition, ordered and can be reordered according to
most fields present in the model. A specific ordering is not enforced by the GoBD, but the
system must ensure that a given financial transaction can be quickly found by a third-party
expert. Odoo ensures this out-of-the-box.
#. | **Inalterability**
| With the German Odoo localization, Odoo is in standard configured in such a way that the
inalterability clause can be adhered to without any further customization.
Do you need a GoBD-Export?
--------------------------
GoBD export
~~~~~~~~~~~
In the case of fiscal control, the fiscal authority can request three levels of access to the
accounting system (Z1, Z2, Z3). These levels vary from direct access to the interface to the
handover of the financial data on a storage device.
In case of a handover of the financial data on a storage device, the format is **not** enforced by
the GoBD. It can be, for example, in XLS, CSV, XML, Lotus 123, SAP-format, AS/400-format, or else.
Odoo supports the CSV and XLS-export of financial data out-of-the-box. The GoBD **recommends** the
export in a specific XML-based GoBD-format (see "Ergänzende Informationen zur
Datenntträgerüberlassung" §3) but it is not binding.
In the case of a handover of financial data to a storage device, the GoBD does **not** enforce the
format. It can be, for example, in XLS, CSV, XML, Lotus 123, SAP-format, AS/400-format, or else.
Odoo supports the CSV and XLS export of financial data out of the box. The GoBD **recommends** the
export in a specific XML-based GoBD format (see "Ergänzende Informationen zur
Datenträgerüberlassung" §3), but it is not binding.
What is the role and meaning of the compliance certification?
-------------------------------------------------------------
Non-compliance
~~~~~~~~~~~~~~
The GoBD clearly states that due to the nature of a state of the art accounting software, their
configuration possibilities, changing nature, and various forms of use, **no legally binding
certification can be given**, nor can the software be made liable towards a public authority.
Third-party certificates can indeed have **an informative value** for customers to make software
buying decisions but are by no means legally binding or of any other legal value (A. 12, § 181).
In the event of an infringement, you can expect a fine and a court order demanding the
implementation of specific measures.
A GoBD certificate states nothing more than that if you use the software according to its
guidelines, the software will not refrain you from respecting the GoBD. These certifications are
very expensive in terms of time and cost, and their value is very relative. Thus we focus our
efforts on ensuring GoBD compliance rather than pay for a marketing tool which does not, however,
offer our customer any legal certainty.
.. _germany/pos:
Point of Sale
=============
Technical security system
-------------------------
The **Kassensicherungsverordnung** (The Act on Protection against Manipulation of Digital Records)
requires that electronic record-keeping systems - including the :doc:`point of sale
</applications/sales/point_of_sale>` systems - must be equipped with a **technical security system**
(also called **TSS** or **TSE**).
Odoo offers a service that is compliant with the help of `fiskaly <https://fiskaly.com>`_, a
*cloud-based solution*.
.. important::
The BMF actually states the following in the `Official GoBD text
<https://ao.bundesfinanzministerium.de/ao/2021/Anhaenge/BMF-Schreiben-und-gleichlautende-Laendererlasse/Anhang-64/anhang-64.html>`_:
Since this solution is cloud-based, a working internet connection is required.
- 180. Positive attestations on the correctness of the bookkeeping - and thus on the correctness
of IT-based bookkeeping systems - are not issued either in the context of a tax field audit or
in the context of binding information.
- 181. "Certificates" or "attestations" from third parties can serve as a decision criterion for
the company when selecting a software product, but develop from the in margin no. 179 is not
binding on the tax authorities.
.. note::
The only VAT rates allowed are given by fiskaly. You can check these rates by consulting
`fiskaly DSFinV-K API: VAT Definition
<https://developer.fiskaly.com/api/dsfinvk/v0/#tag/VAT-Definition>`_.
.. note::
The previous content was `automatically translated from German with Google Translate
<https://translate.google.com/?sl=de&tl=en&text=180.%0APositivtestate%20zur%20Ordnungsm%C3%A4%C3%9Figkeit%20der%20Buchf%C3%BChrung%20-%20und%20damit%20zur%20Ordnungsm%C3%A4%C3%9Figkeit%20DV-gest%C3%BCtzter%20Buchf%C3%BChrungssysteme%20-%20werden%20weder%20im%20Rahmen%20einer%20steuerlichen%20Au%C3%9Fenpr%C3%BCfung%20noch%20im%20Rahmen%20einer%20verbindlichen%20Auskunft%20erteilt.%0A%0A181.%0A%E2%80%9EZertifikate%E2%80%9C%20oder%20%E2%80%9ETestate%E2%80%9C%20Dritter%20k%C3%B6nnen%20bei%20der%20Auswahl%20eines%20Softwareproduktes%20dem%20Unternehmen%20als%20Entscheidungskriterium%20dienen%2C%20entfalten%20jedoch%20aus%20den%20in%20Rz.%20179%20genannten%20Gr%C3%BCnden%20gegen%C3%BCber%20der%20Finanzbeh%C3%B6rde%20keine%20Bindungswirkung.%20&op=translate>`_.
Configuration
~~~~~~~~~~~~~
:ref:`Install <general/install>` the **Germany - Certification for Point of Sale**
(`l10n_de_pos_cert`) and **Germany - Certification for Point of Sale of type restaurant**
(`l10n_de_pos_res_cert`) modules.
What happens if you are not compliant?
--------------------------------------
.. tip::
If these modules are not listed, :ref:`update the app list <general/install>`.
In the event of an infringement, you can expect a fine but also a court order demanding the
implementation of specific measures.
Company registration at the financial authority
***********************************************
To register your company, open the :guilabel:`Settings` app, click :guilabel:`Update Info` under the
:guilabel:`Companies` section, and fill in the following fields:
- :guilabel:`Company Name`
- :guilabel:`Address`
- :guilabel:`VAT`
- :guilabel:`St.-Nr.` (Steuernummer) this number is assigned by the tax office to every taxable
natural or legal person (e.g., `2893081508152`).
- :guilabel:`W-IdNr.` (Wirtschafts-Identifikationsnummer) this number is used as a permanent
identification number for economically active persons.
You can then **register your company through fiskaly** by opening the :guilabel:`Fiskaly` tab and
clicking the :guilabel:`Fiskaly Registration` button.
.. tip::
If you do not see the :guilabel:`Fiskaly Registration` button, make sure that you *saved* your
company details and are not in *editing mode* anymore.
Once the registration has been finalized, new fields appear:
- :guilabel:`Fiskaly Organization ID` refers to the ID of your company on fiskaly's side.
- :guilabel:`Fiskaly API Key` and :guilabel:`Fiskaly API Secret` are the credentials the system
uses to access the services offered by fiskaly.
.. image:: germany/fiskaly-registration.png
:alt: Fiskaly registration tab
.. note::
It is possible to request new credentials if there is any issue with the current ones by clicking
the :guilabel:`New keys` button.
Create a technical security system and link it to a POS
*******************************************************
To use a point of sale in Germany, first create a :abbr:`TSS (Technical Security System)` by going
to :menuselection:`Point of Sale --> Configuration --> Point of Sale`, selecting the
:guilabel:`Point of Sale` to edit, then checking the :guilabel:`Create TSS` box under the
:guilabel:`Fiskaly API` section.
Once the creation of the TSS is successful, you can find the:
- :guilabel:`TSS ID`, which refers to the ID of your TSS on fiskaly's side, and
- :guilabel:`Fiskaly Client ID`, which refers to your POS on fiskaly's side.
.. image:: germany/fiskaly-tss.png
:alt: Fiskaly API section
DSFinV-K export
~~~~~~~~~~~~~~~
Whenever you close a PoS session, the details of the orders are sent to the :abbr:`DSFinV-K
(Digitale Schnittstelle der Finanzverwaltung für Kassensysteme)` service of fiskaly.
In case of an audit, you can export the data sent to DSFinV-K by going to :menuselection:`Point of
Sale --> Orders --> DSFinV-K Exports --> New`.
.. image:: germany/pos-orders-menu.png
:alt: Menu to export DSFinV-K
These fields are mandatory:
- :guilabel:`Start Datetime`: export data with dates larger than or equal to the given start date
- :guilabel:`End Datetime`: export data with dates smaller than or equal to the given end date
Leave the :guilabel:`Point of Sale` field blank to export the data of all your points of sale;
specify one if you want to export data for this specific POS only.
.. image:: germany/dsfinv-k-export.png
:alt: Exporting DSFinV-K
When an export is successfully triggered and is being processed, the :guilabel:`State` field should
mention :guilabel:`Pending`. Click :guilabel:`Refresh State` to check if it is ready.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 6.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.4 KiB

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

@@ -33,6 +33,10 @@ localization:
- `l10n_it_stock_ddt`
- Transport documents - Documento di Trasporto (DDT)
.. seealso::
:doc:`Documentation on e-invoicings legality and compliance in Italy
<../accounting/customer_invoices/electronic_invoicing/italy>`
Company information
-------------------
@@ -651,7 +655,7 @@ as follows:
#. Make sure the fiscal printer is set to its default state: printer on, start-up cycle complete,
and no transaction in progress.
#. Type `3333`.
#. Press :guilabel:`Chiave`. The screen displays :guilabel:`Scleta Funzione`.
#. Press :guilabel:`Chiave`. The screen displays :guilabel:`Scelta Funzione`.
#. Type `14`. The screen displays :guilabel:`Apprendimento`.
#. Type `62`. The screen displays :guilabel:`Simulazione`.
#. To turn the :guilabel:`no` into a :guilabel:`si`, press :guilabel:`X`.
@@ -32,6 +32,10 @@ localization:
Installing the module :guilabel:`Luxembourg - Accounting Reports` installs all three modules at
once.
.. seealso::
:doc:`Documentation on e-invoicings legality and compliance in Luxembourg
<../accounting/customer_invoices/electronic_invoicing/luxembourg>`
Standard Chart of Accounts - PCN 2020
=====================================
@@ -104,7 +104,10 @@ portal to grant Odoo the **right to invoice** as an intermediary for your compan
- :guilabel:`TIN`: `C57800417080`
- :guilabel:`BRN`: `BE0477472701`
- :guilabel:`Name`: `ODOO S.A.`
- :guilabel:`Name`:
- :guilabel:`Production`: `ODOO S.A.`
- :guilabel:`Pre-production`: `OXXX_XXXXO S.A.`
#. Grant the following permissions by clicking the :icon:`fa-toggle-on` :guilabel:`(toggle-on)`
icon:
@@ -2,6 +2,10 @@
Netherlands
===========
.. seealso::
:doc:`Documentation on e-invoicings legality and compliance in the Netherlands
<../accounting/customer_invoices/electronic_invoicing/netherlands>`
XAF Export
==========
@@ -7,6 +7,7 @@ Peru
.. |GRE| replace:: :abbr:`GRE (Guía de Remisión Electrónica)`
.. |RUS| replace:: :abbr:`RUS (Régimen Único Simplificado)`
.. |EDI| replace:: :abbr:`EDI (Electronic Data Interchange)`
.. |PLE| replace:: :abbr:`PLE (Programa de Libros Electrónico)`
Modules
=======
@@ -57,6 +58,10 @@ Peruvian localization.
- Adds the delivery guide (Guía de Remisión), which is needed as proof that you are sending
goods between A and B. It is only when a delivery order is validated that the delivery guide
can be created.
* - :guilabel:`Peru - Stock Reports`
- `l10n_pe_reports_stock`
- Enables the :ref:`PLE reports <peru/reports-ple>` for permanent inventory record in physical
units and permanent valued inventory records.
* - :guilabel:`Peruvian eCommerce`
- `l10n_pe_website_sale`
- Enables the identification type in eCommerce checkout forms and the ability to generate
@@ -724,14 +729,22 @@ and the :ref:`master data <peru-master_data>`, :ref:`install <general/install>`
Next, you need to retrieve the *client ID* and *client secret* from |SUNAT|. To do so, follow the
`manual de servicios web plataforma nueva GRE
<https://cpe.sunat.gob.pe/sites/default/files/inline-files/Manual_Servicios_GRE.pdf>`_.
<https://cpe.sunat.gob.pe/sites/default/files/inline-files/Manual_Servicios_GRE%20%281%29.pdf>`_.
.. note::
In the |SUNAT| portal, it is important to have the correct access rights enabled, as they may
differ from the user set for electronic invoicing.
These credentials should be used to configure the delivery guide general settings from
:menuselection:`Accounting --> Configuration --> Settings --> Peruvian Electronic Invoicing`.
:menuselection:`Inventory --> Configuration --> Settings`, and scroll down to the :guilabel:`Peru
Delivery Guide` section.
Configure the following :guilabel:`Sunat Delivery Guide API` fields:
- :guilabel:`Guide Client ID`: the unique API *client ID* generated in the |SUNAT| portal
- :guilabel:`Guide Client Secret`: the unique API *client secret* generated in the |SUNAT| portal
- :guilabel:`Guide SOL User`: the RUC Number + SOL username
- :guilabel:`Guide SOL Password`: the SOL user password
.. image:: peru/gre-fields-example.png
:alt: Example for the SUNAT Delivery Guide API section configuration.
@@ -908,7 +921,7 @@ Configuration
After configuring the Peruvian :ref:`electronic invoicing <peru-accounting-settings>` flow, complete
the following configurations for the **eCommerce** flow:
- :ref:`Client account registration <checkout-sign>`;
- :ref:`Client account registration <ecommerce/checkout/policy>`;
- :ref:`Automatic invoice <handling/legal>`;
- :doc:`../../websites/ecommerce/products`: Set the :guilabel:`Invoicing Policy` to
:guilabel:`Ordered quantities` and define the desired :guilabel:`Customer taxes`.
@@ -940,5 +953,100 @@ based on their tax ID (RUC/DNI). The invoice must then :ref:`be sent to the OSE
<peru-electronic-invoice-status>`. By default, all published invoices are sent once a day through
a scheduled action, but you can also send each invoice manually if needed.
Once the invoice is validated with |SUNAT|, customers can download the :file:`.zip` with the CDR,
XML, and PDF files directly from the customer portal by clicking the :guilabel:`Download` button.
Once the invoice is validated with |SUNAT|, customers can download the .zip file with the CDR, XML,
and PDF files directly from the customer portal by clicking the :guilabel:`Download` button.
Reports
=======
.. _peru/reports-ple:
Permanent inventory reports: |PLE| 12.1 and |PLE| 13.1
------------------------------------------------------
Odoo can produce two permanent inventory reports as `.txt` files for Peruvian accounting: |PLE| 12.1
and |PLE| 13.1. All inventory transactions made need to be reported.
- |PLE| 12.1 **only tracks inventory in physical units**, focusing on the inflow and outflow of
goods for effective management and planning.
- |PLE| 13.1 tracks **both physical quantities and monetary values of inventory**, providing a
comprehensive view for tax and management purposes.
Both reports must be maintained semi-annually (January-June and July-December), with monthly
transaction details reported within these periods. The submission deadlines are October 1st for the
first semester and April 1st for the second semester, in accordance with the *Resolución de
Superintendencia N° 169-2015*.
Configuration
~~~~~~~~~~~~~
Before generating the |PLE| 12.1 or |PLE| 13.1 reports, make sure the :guilabel:`Peru - Stock
Reports` (`l10n_pe_reports_stock`) module is installed, then update the fields for:
- :ref:`Products <peru/reports-ple-products>`
- :ref:`Warehouses <peru/reports-ple-warehouses>`
- :ref:`Inventory transfers <peru/reports-ple-transfers>`
.. _peru/reports-ple-products:
Products
********
Several configurations related to the product or product category are necessary for |PLE| reporting:
- **Type of existence**: For all products needing |PLE| reporting, go to the product record's
:guilabel:`Accounting` tab and select the :guilabel:`Type of Existence` according to |SUNAT|'s
table 5 for inventory reporting.
- **Automatic inventory valuation**: For storable goods (:dfn:`products with tracked inventory`),
use :doc:`automatic inventory valuation
<../../inventory_and_mrp/inventory/product_management/inventory_valuation/inventory_valuation_config>`.
Once automatic inventory valuation is enabled, this valuation method can be enabled for
a product's :ref:`product category <inventory/warehouses_storage/valuation-on-product-category>`.
- **Costing method:** Storable goods must use a :doc:`costing method
<../../inventory_and_mrp/inventory/product_management/inventory_valuation/inventory_valuation_config>`
**other** than :guilabel:`Standard Price`, as the journal entries generated from stock moves are
used to populate the |PLE| reports.
.. _peru/reports-ple-warehouses:
Warehouses
**********
When :doc:`setting up a warehouse
<../../inventory_and_mrp/inventory/warehouses_storage/inventory_management/warehouses>`, the
:guilabel:`Annex Establishment Code` field must be filled. This code acts as a unique ID for each
warehouse and should only be a numeric combination, containing between 4 to 7 digits.
.. _peru/reports-ple-transfers:
Inventory transfers
*******************
Transferring inventory is a key process captured in the |PLE| 12.1 and |PLE| 13.1 reports.
:doc:`Inventory transfers <../../inventory_and_mrp/inventory/shipping_receiving/daily_operations>`
include both incoming and outgoing shipments.
When validating an inventory transfer (either on a warehouse receipt or delivery order), select the
:guilabel:`Type of Operation (PE)` performed according to |SUNAT|'s table 12 for permanent inventory
reporting.
Generate a .txt file for permanent inventory Kardex reports
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|PLE| 12.1 and 13.1 come as two separate books. The books need to be downloaded in `.txt` file
format from Odoo, and then they should be submitted to the |SUNAT| |PLE| software.
On the :ref:`Inventory Valuation Report <inventory/management/reporting/valuation-report>`, click
the :guilabel:`PLE Reports` button. Then, select the :guilabel:`Period` and choose a report to
export: either the :guilabel:`PLE 12.1` or :guilabel:`PLE 13.1`. Odoo generates a `.txt` file
for the chosen report.
.. image:: peru/l10n-ple-export-button.png
:alt: Export Buttons selection
.. note::
Only a download of the report in `.txt` format is available. There is no preview or visualization
available within Odoo.
Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

@@ -24,6 +24,10 @@ localization.
.. image:: romania/romania-modules.png
:alt: Modules for the Romanian localization
.. seealso::
:doc:`Documentation on e-invoicings legality and compliance in Romania
<../accounting/customer_invoices/electronic_invoicing/romania>`
D.406 declaration
=================
@@ -20,6 +20,12 @@ select a package in the :guilabel:`Fiscal Localization` section.
.. warning::
You can only change the accounting package as long as you have not created any accounting entry.
.. seealso::
- :doc:`Documentation on e-invoicings legality and compliance in Spain
<../accounting/customer_invoices/electronic_invoicing/spain>`
- :doc:`Documentation on e-invoicings legality and compliance in the Basque Country
<../accounting/customer_invoices/electronic_invoicing/basque_country>`
Chart of accounts
=================
@@ -149,11 +155,16 @@ Before configuring the :abbr:`FACe (General Entrance for Electronic Invoices)` s
:ref:`install <general/install>` the :guilabel:`Spain - Facturae EDI (l10n_es_edi_facturae)` module
and other **Facturae EDI**-related modules.
To enable FACe, go to :menuselection:`Settings --> General Settings`, click
:guilabel:`Update Info` in the :guilabel:`Companies` section, then click :guilabel:`Update Info` and
set the :guilabel:`Country` and :guilabel:`Tax ID` of your company. Next, add the
:guilabel:`Facturae signature certificate` by clicking :guilabel:`Add a line`, uploading the
certificate provided by the tax agency, and entering the provided password.
To configure FACe, follow these steps:
#. Go to :menuselection:`Accounting --> Configuration --> Certificates`.
#. Click :guilabel:`New` to create a new certificate.
#. Complete the fields, including uploading the file of the :guilabel:`Certificate` provided by the
tax agency and the provided :guilabel:`Certificate Password`.
.. note::
If using the Invoicing app instead of Accounting, go to :menuselection:`Invoicing -->
Configuration --> Certificates`.
Use case
--------
@@ -105,39 +105,61 @@ search for your company to verify the following:
Set up a Uruware account
------------------------
To set up a Uruware account, first be sure to have a valid Odoo subscription. Then follow the
proceeding steps.
To set up a Uruware account, follow these steps:
Locate the Uruware credentials settings by navigating to the :menuselection:`Accounting -->
Configuration --> Settings`. Scroll down to the :guilabel:`Uruguayan Localization` section and click
on :guilabel:`Create Uruware Account`.
#. Verify that you have a valid Odoo subscription.
#. Locate the Uruware credentials settings by navigating to the :menuselection:`Accounting -->
Configuration --> Settings`.
#. Scroll down to the :guilabel:`Uruguayan Localization` section and select the environment
(:guilabel:`Production` or :guilabel:`Testing`).
#. Click on :guilabel:`Create Uruware Account`.
Upon doing so, an email is sent to the address associated with your Odoo subscription with the
username and password to enter Uruware's portal and set up your account.
password to enter Uruware's portal and set up your account.
.. tip::
Your :guilabel:`Tax ID` needs to be setup to be able to create your account.
- The email with the credentials is not immediate; it might take up to 48 hours for the account to
be created.
- The company's :guilabel:`Tax ID` needs to be set up to be able to create an Uruware account.
- The password sent expires after 24 hours. In this case, reset it by using the *Forgot Password*
link in Uruware's portal.
.. note::
This action will create an account with Uruware with the following information:
- Legal name (razón social)
- RUT from the company
- User name (RUT.odoo)
- Username (the Odoo subscription email or `RUT`.odoo. For example: `213344556677.odoo`)
- Odoo database link
To ensure your account is created correctly, please add any missing information from above.
Once the account is created, a confirmation email is sent to the email linked to your subscription
in Odoo, containing the credentials to configure the account directly in the Uruware
`testing portal <https://odootest.ucfe.com.uy/Gestion/>`_ or
Once the account is created and you have received the email containing the credentials, configure
your accounts directly in the Uruware `testing portal <https://odootest.ucfe.com.uy/Gestion/>`_ or
`production portal <https://prod6109.ucfe.com.uy/Gestion/>`_:
Use the account credentials in the email to log in to the portal.
Use the account credentials in the email to log in to the to the corresponding (`test
<https://odootest.ucfe.com.uy/Gestion/>`_ or `production <https://prod6109.ucfe.com.uy/Gestion/>`_)
portal.
In Uruware's portal, the following steps are needed to be able to issue invoices from Odoo:
#. Complete and correct the company's information.
#. Add your digital certificate.
#. Add your :abbr:`CAEs (Constancia de Autorización para Emisión)` for each document-type you plan
to issue.
#. Configure the format of the PDF to be printed and sent to your customers.
.. important::
Be sure to configure two accounts, one for testing and one for production. The email address can
be changed in Uruware and the same can be used in both environments.
Be sure to configure two accounts, one for testing and one for production. The certificate is
needed in both environments, but :abbr:`CAEs (Constancia de Autorización para Emisión)` are only
needed in production.
.. seealso::
- `Odoo Tutorials: Uruguay Localization
<https://www.odoo.com/slides/smart-tutorial-localizacion-de-uruguay-432>`_
- `Odoo Help Forum: Uruguay
<https://www.odoo.com/forum/help-1?search=l10n_uy>`_
Electronic invoice data
-----------------------
@@ -156,6 +178,9 @@ First, select the :guilabel:`UCFE Web Services` environment:
to the |DGI|. For this reason, rejection errors will not appear in this mode. Every internal
validation can be tested in demo mode. Avoid selecting this option in a production database.
.. note::
Using :guilabel:`Demo` mode does not require a Uruware account.
Then, enter the :guilabel:`Uruware Data`:
- :guilabel:`Uruware WS Password`
@@ -166,9 +191,16 @@ Then, enter the :guilabel:`Uruware Data`:
:alt: Required information for electronic invoice.
.. note::
This data can be obtained from the Uruware portal, after configuring the :ref:`Uruware account
<l10n_uy/uruware-account>`. The :guilabel:`Uruware WS Password` differs from the password you use
to enter your Uruware account.
This data can be obtained from the Uruware portal after configuring the :ref:`Uruware account
<l10n_uy/uruware-account>`.
To get the :guilabel:`Uruware WS Password`, go to :menuselection:`Configuration --> Company -->
Edit` and look for the :guilabel:`Validators and Additional Information` tab to find
:guilabel:`WS Password`.
To get the :guilabel:`Commerce Code`, go to :menuselection:`Configuration --> Branches`.
To get the :guilabel:`Terminal Code`, go to :menuselection:`Configuration --> Issuing Points`.
Master data
-----------
@@ -367,6 +367,8 @@ enable :guilabel:`Allow Express Checkout`.
.. note::
All prices shown on the express checkout payment form always include taxes.
.. _payment_providers/availability:
Availability
============
@@ -441,8 +443,8 @@ entries. We recommend you ask your accountant for advice.
By default, the :guilabel:`Bank Account` defined for the :ref:`payment journal
<payment_providers/journal>` is used, but you can also specify an :ref:`outstanding account
<bank/outstanding-accounts>` for each payment provider to separate the provider's payments from
other payments.
<accounting/bank/outstanding-accounts>` for each payment provider to separate the provider's
payments from other payments.
.. image:: payment_providers/bank_journal.png
:alt: Define an outstanding account for a payment provider.
@@ -33,8 +33,6 @@ Configuration on the Xendit Dashboard
#. In the :guilabel:`Webhook URL` section, enter your Odoo database's URL, followed by
`/payment/xendit/webhook` (e.g., `https://example.odoo.com/payment/xendit/webhook`) in the field
:guilabel:`Invoices paid` and click the :guilabel:`Test and save` button next to it.
#. Navigate to the `Card Settings page <https://dashboard.xendit.co/settings/payment-methods/cards-configuration>`_
and ensure that :guilabel:`Optional 3DS` is enabled while :guilabel:`Dynamic 3DS` is disabled.
Configuration on Odoo
=====================
@@ -17,6 +17,10 @@ emails. The deliverability is optimized for this subdomain as it uses Odoos D
If the database subdomain is `company-name.odoo.com` and all mailing configurations are the
default ones, all emails will be sent from `notifications@company-name.odoo.com`.
.. important::
Only **one** subdomain can be used as a mailing server in Odoo. Subdomains for additional
companies require an external email server with a custom domain.
.. image:: email_servers_outbound/diagram-inbound-mailing-method.png
:alt: Odoos default outbound messages configuration.
@@ -100,9 +104,10 @@ Sending emails with an external SMTP server
the DNS of an Odoo subdomain is not feasible.
To add an external SMTP server in Odoo, open :guilabel:`Settings`, and enable the :guilabel:`Use
Custom Email Servers` option found under the :guilabel:`Discuss` section.
Custom Email Servers` option found under the :guilabel:`Emails` section. Then, click
:guilabel:`Save` at the top of the page to save the changes.
Still under the :guilabel:`Discuss` section, click :guilabel:`Outgoing Email Servers`, then `New` to
Returning to the :guilabel:`Emails` section, click :guilabel:`Outgoing Email Servers`, then `New` to
create an outgoing mail server record. Most fields are the common parameters used to set up a
connection to an SMTP server; use the values provided by your email provider.
@@ -158,9 +163,8 @@ transactional emails are given priority.
:alt: Example of split between transaction and mass mailing mail servers.
Now, go to :menuselection:`Email Marketing --> Configuration --> Settings`, enable
:guilabel:`Dedicated Server`, and select the appropriate email server. Odoo uses the server
with the lowest priority value for transactional emails, and the server selected here for mass
mailings.
:guilabel:`Dedicated Server`, and select the appropriate email server. Odoo uses the server with the
lowest priority value for transactional emails, and the server selected here for mass mailings.
.. image:: email_servers_outbound/dedicated-mass-mail-server.png
:alt: Dedicated mail server on Email Marketing app settings.
@@ -194,8 +198,8 @@ When an email is sent from Odoo, the following sequence is used to choose the ou
If the sender's email address is `test@example.com`, only an email server having a FROM filtering
value equal to `test@example.com` or `example.com` can be used.
- If no server is found based on the first criteria, Odoo looks for the first server
without a FROM filtering value set. The email will be overridden with the notification address.
- If no server is found based on the first criteria, Odoo looks for the first server without a FROM
filtering value set. The email will be overridden with the notification address.
- If no server is found based on the second criteria, Odoo uses the first server, and the email will
be overridden with the notification address.
@@ -228,8 +232,8 @@ server is set, the default Odoo's SMTP server will be used.
:alt: Splitting of Odoo mail server for transactional emails and Mail server for Mass mailing.
.. note::
On Odoo Online, the command line interface is equivalent to the default Odoo mail
server, using the same limit as if there was no outgoing mail server in place.
On Odoo Online, the command line interface is equivalent to the default Odoo mail server, using
the same limit as if there was no outgoing mail server in place.
.. tip::
On Odoo Online, the page also shows your daily email usage and your daily limit. On Odoo.sh, you
@@ -8,3 +8,4 @@ Integrations
integrations/unsplash
integrations/geolocation
integrations/google_translate
integrations/barcodelookup
@@ -0,0 +1,40 @@
:show-content:
==============
Barcode Lookup
==============
`Barcode Lookup <https://www.barcodelookup.com/>`_ allows you to scan (or enter) products' barcodes
(:abbr:`UPC (Universal Product Code)`, :abbr:`EAN (European Article Number)`, or :abbr:`ISBN
(International Standard Book Number)`) to automatically create them in your Odoo database, complete
with product names, descriptions, images, categories, etc.
.. _barcodelookup/configuration:
Configuration
-------------
If your database is hosted on **Odoo Online**, you can use Barcode Lookup without configuration.
If your database is hosted on **Odoo.sh** or **on-premise**, proceed as follows:
#. Visit the `Barcode Lookup website <https://www.barcodelookup.com/api>`_ and click
:guilabel:`Sign Up for the API`.
#. Choose the appropriate plan based on the number of barcodes you need to scan.
#. Fill in the required details and complete the registration process.
#. Copy the API key.
#. In Odoo, open the Settings app, scroll down to the :guilabel:`Integrations` section, and, under
:guilabel:`Barcode Database`, paste the Barcode Lookup :guilabel:`API Key`.
Use
---
To fill in product information using Barcode Lookup, create a new product and fill in the
:guilabel:`Barcode` field. The product's details are then automatically imported from Barcode
Lookup, updating the following fields: :guilabel:`Name`, :guilabel:`Price`, :guilabel:`Description`,
:guilabel:`Tax`, :guilabel:`Image`, :guilabel:`Weight`, :guilabel:`Attributes`, :guilabel:`Product
category`, and :guilabel:`Volume`. You can then modify any field(s) as needed.
.. seealso::
:ref:`Create new products during internal transfers using the Barcode Lookup database
<barcode/setup/barcodelookup>`.
+76 -3
View File
@@ -1,14 +1,87 @@
:nosearch:
:show-content:
:hide-page-toc:
:show-toc:
:nosearch:
========================
Internet of Things (IoT)
========================
Odoo Internet of Things (IoT) allows to connect physical devices such as barcode scanners, receipt
printers, payment terminals, measurement tools, etc. to an Odoo database using an IoT system.
The following IoT systems are supported:
- :doc:`IoT box <iot/iot_box>`: micro-computer, plug-and-play device (i.e., the Odoo IoT program is
pre-installed);
- :doc:`Windows virtual IoT <iot/windows_iot>`: Odoo IoT program for Windows that can be installed
on a Windows computer.
.. note::
- :abbr:`MRP (Material Requirement Planning)` devices, including cameras and measurement tools,
are not compatible with Windows virtual IoT.
- Multiple IoT systems can be used at the same time.
- It is also possible to create a Windows Virtual Machine on a MacOS/Linux computer. However,
this option is not supported by Odoo, and no troubleshooting assistance will be provided.
.. _iot/iot/iot-subscription:
IoT box subscription
====================
An IoT box subscription is required for production use of IoT systems. If you have issues related
to your subscription, contact the database's account manager or Odoo partner for assistance.
.. tip::
If the subscription is linked to an `Odoo.com <https://www.odoo.com>`_ portal user, check the
information on the portal's subscription page.
.. seealso::
- `Odoo's compatible IoT devices <https://www.odoo.com/app/iot-hardware>`_
- `Odoo Tutorials: Internet of Things (IoT) Tutorials
<https://www.odoo.com/slides/internet-of-things-iot-175>`_
- `IoT system FAQ <https://www.odoo.com/app/iot-faq>`_
.. cards::
.. card:: IoT box
:target: iot/iot_box
:large:
Set up an IoT box.
.. card:: Windows virtual IoT
:target: iot/windows_iot
:large:
Set up Windows virtual IoT.
.. card:: IoT system connection to Odoo
:target: iot/connect
Connect the IoT system to your Odoo database and troubleshoot potential connection issues.
.. card:: Devices
:target: iot/devices
Connect devices such as printers, screens, measurement tools, etc., to the IoT system.
.. card:: HTTPS certificate
:target: iot/iot_advanced/https_certificate_iot
Verify your IoT system and database meet the eligibility requirements for HTTPS certificate
generation and address any related issues.
.. card:: IoT system updates
:target: iot/iot_advanced/updating_iot
Update your IoT system's image, core code, and handlers to benefit from the latest IoT fixes
and features or reset the IoT system if needed.
.. toctree::
:titlesonly:
iot/config
iot/iot_box
iot/windows_iot
iot/connect
iot/iot_advanced
iot/devices
@@ -1,17 +0,0 @@
:nosearch:
=============
Configuration
=============
.. toctree::
:titlesonly:
:glob:
config/connect
config/pos
config/https_certificate_iot
config/updating_iot
config/troubleshooting
config/windows_iot
config/ssh_connect
@@ -1,181 +0,0 @@
==========================
Connect an IoT box to Odoo
==========================
An Internet of Things (IoT) box is a micro-computer device that allows for the connection of input
and output devices to an Odoo database. An :abbr:`IoT (Internet of Things)` box subscription is
required in order to use the :abbr:`IoT (Internet of Things)` box with a secured connection. A
computer is also required to set up the :abbr:`IoT (Internet of Things)` box.
.. seealso::
`IoT Box FAQ <https://www.odoo.com/app/iot-faq>`_
Begin the :abbr:`IoT (Internet of Things)` configuration process by :ref:`installing the IoT app
<general/install>` on the Odoo database through the :menuselection:`Apps` application.
.. image:: connect/install-iot-app.png
:align: center
:alt: The Internet of Things (IoT) app on the Odoo database.
Next, after the *IoT app* is installed, navigate to :menuselection:`IoT app --> IoT Boxes`, and then
click on the :guilabel:`Connect` button located in the upper-left corner of the :menuselection:`IoT
Boxes` dashboard.
.. image:: connect/connect-iot.png
:align: center
:alt: Connecting an IoT box to the Odoo database.
There are two recommended ways to connect the :abbr:`IoT (Internet of Things)` box to the database
once the *IoT app* is installed. Follow the steps in either of the next two sections to connect the
:abbr:`IoT (Internet of Things)` box via :ref:`wired ethernet connection <iot_connect/ethernet>` or
via :ref:`WiFi <iot_connect/wifi>`.
.. image:: connect/connect-iot-box.png
:align: center
:alt: Connection steps for a wired connection or WiFi connection.
.. important::
The disk image that the :abbr:`IoT (Internet of Things)` box SD card is formatted with is unique
to the version of the Odoo database that the :abbr:`IoT (Internet of Things)` box is running on.
Ensure that the :abbr:`IoT (Internet of Things)` box is :ref:`flashed <iot/config/flash>` with
the most up-to-date disk image.
.. _iot_connect/ethernet:
Ethernet connection
===================
The following is the process to connect the :abbr:`IoT (Internet of Things)` box via an ethernet
cable to the Odoo database (by way of the ethernet port; RJ-45).
First, connect all wired devices to the :abbr:`IoT (Internet of Things)` box (ethernet, :abbr:`USB
(Universal Serial Bus)` devices, etc.). At minimum, an HDMI screen should be connected. Then, plug
the :abbr:`IoT (Internet of Things)` box into a power source.
Immediately after the unit powers on and boots up, read the *pairing code* from the screen or from
the printout of a receipt printer connected to the :abbr:`IoT (Internet of Things)` box.
.. warning::
By default, the :abbr:`IoT (Internet of Things)` box will display the *pairing code* for a
maximum of 5 minutes after the unit boots up. After 5 minutes, the *pairing code* will disappear
for security purposes and the :abbr:`IoT (Internet of Things)` box will need to be rebooted
manually by unplugging the unit from the power source for ten seconds and re-plugging it back in.
.. note::
If no screen is attached to the :abbr:`IoT (Internet of Things)` box, then the *pairing code* can
be accessed from the :abbr:`IoT (Internet of Things)` box homepage by clicking on the
:guilabel:`POS Display` button. For instructions on how to access the :abbr:`IoT (Internet of
Things)` box homepage visit :ref:`iot_connect/token`.
On the computer, navigate to :menuselection:`IoT app --> IoT Boxes`, and then click on the
:guilabel:`Connect` button located in the upper-left corner of the the :menuselection:`IoT Boxes`
dashboard. Input the *pairing code* in the :guilabel:`Pairing Code` field and click on the
:guilabel:`Pair` button. The database will now link to the :abbr:`IoT (Internet of Things)` box and
it will appear on the :menuselection:`IoT Boxes` page.
.. _iot_connect/wifi:
WiFi connection
===============
The following is the process to connect the :abbr:`IoT (Internet of Things)` box via a WiFi
connection to the Odoo database.
First, ensure there is no ethernet cable plugged into the :abbr:`IoT (Internet of Things)` box.
Then, connect all wired devices to the :abbr:`IoT (Internet of Things)` box (:abbr:`USB (Universal
Serial Bus)` devices, etc.).
After connecting the devices, plug the :abbr:`IoT (Internet of Things)` box into to a power source.
On the computer, navigate to :menuselection:`IoT app --> IoT Boxes`, and then click on the
:guilabel:`Connect` button located in the upper-left corner of the the :menuselection:`IoT Boxes`
dashboard. Then copy the :guilabel:`Token` from the :guilabel:`WiFi connection` section as this will
later be used to link the Odoo database to the :abbr:`IoT (Internet of Things)` box.
Back on the computer, navigate to the available WiFi networks and connect to the :abbr:`IoT
(Internet of Things)` box WiFi network. The WiFi network dispersed by the :abbr:`IoT (Internet of
Things)` box will start with `IoTBox-xxxxxxxxxx`.
.. image:: connect/connect-iot-wifi.png
:align: center
:alt: WiFi networks available on the computer.
Upon connecting to the :abbr:`IoT (Internet of Things)` box WiFi, a browser will automatically
redirect to the :menuselection:`Configure Iot Box` wizard. Name the :abbr:`IoT (Internet of Things)`
box, then paste the previously copied *token* into the :guilabel:`Server Token` field, and then
click on :guilabel:`Next`.
.. image:: connect/server-token.png
:align: center
:alt: Enter the server token into the IoT box.
.. note::
If the :abbr:`IoT (Internet of Things)` box WiFi connection wizard doesn't start, then see the
documentation on :ref:`connecting with a token <iot_connect/token>`.
Now, choose the WiFi network that the :abbr:`IoT (Internet of Things)` box will connect with (enter
the password if there is one) and click on :guilabel:`Connect`. Wait a few seconds and the browser
will redirect to the :abbr:`IoT (Internet of Things)` box homepage. The computer may need to be
manually re-connected back to the original WiFi connection, if this does not happen automatically.
.. image:: connect/configure-wifi-network-iot.png
:align: center
:alt: Configuring the WiFi for the IoT box.
After completing each step, the :abbr:`IoT (Internet of Things)` box should appear when navigating
to :menuselection:`IoT app --> IoT Boxes` on the Odoo database.
.. image:: connect/iot-box-connected.png
:align: center
:alt: The IoT box has been successfully configured on the Odoo database.
.. important::
The :abbr:`IoT (Internet of Things)` box may need to be manually rebooted upon successfully
connecting via WiFi for the box to appear in the *IoT app* on the Odoo database. To do so, simply
unplug the device and plug it back into the power source after ten seconds.
.. _iot_connect/token:
Manually connecting the IoT box using the token
===============================================
A manual connection of the :abbr:`IoT (Internet of Things)` box to the :abbr:`IoT (Internet of
Things)` app can be made using the *token*, from a computer. The *token* can be found by navigating
to :menuselection:`IoT app --> IoT Boxes` and clicking on :guilabel:`Connect`.
Under the :guilabel:`WiFi Connection` section of the :guilabel:`Connect an IoT Box` page that
appears, click :guilabel:`Copy` to the right of the :guilabel:`Token`. This token will be entered
into the :abbr:`IoT (Internet of Things)` box homepage.
Access the :abbr:`IoT (Internet of Things)` box homepage by entering the :abbr:`IP (Internet
Protocol)` address of the :abbr:`IoT (Internet of Things)` box into a browser window from a computer
on the same network as the :abbr:`IoT (Internet of Things)` box (preferably by ethernet connection).
.. note::
The :abbr:`IP (Internet Protocol)` address can be accessed by the router admin console that the
:abbr:`IoT (Internet of Things)` box is connected to, or by connecting a receipt printer to the
:abbr:`IoT (Internet of Things)` box. A receipt will print out with the :abbr:`IoT (Internet of
Things)` box's :abbr:`IP (Internet Protocol)` address on it.
On the :abbr:`IoT (Internet of Things)` box homepage, enter the *token* under the :guilabel:`Server`
section by clicking on :guilabel:`Configure`. Then, paste the *token* into the :guilabel:`Server
Token` field and click :guilabel:`Connect`. The :abbr:`IoT (Internet of Things)` box will then link
to the Odoo database.
.. _iot/connect_schema:
IoT box schema
==============
Raspberry Pi 4
--------------
.. figure:: connect/iot-box-schema.png
The Odoo IoT box (Raspberry Pi 4) schema with labels.
Raspberry Pi 3
--------------
.. figure:: connect/iox-box-schema-3.png
The Odoo IoT box (Raspberry Pi 3) schema with labels.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

@@ -1,258 +0,0 @@
.. _iot/https_certificate_iot:
=======================
HTTPS certificate (IoT)
=======================
What is HTTPS?
==============
*Hypertext Transfer Protocol Secure* (HTTPS) is the secure version of *Hypertext Transfer Protocol*
(HTTP), which is the primary protocol used to send data back and forth between a web browser and a
website. :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` is encrypted in order to increase the
security of data transfer.
:abbr:`HTTPS (Hypertext Transfer Protocol Secure)` uses an encryption protocol to encrypt
communications. The protocol is called *Transport Layer Security* (TLS), although formerly it was
known as *Secure Sockets Layer* (SSL).
:abbr:`HTTPS (Hypertext Transfer Protocol Secure)` occurs based upon the transmission of :abbr:`TLS
(Transport Layer Security)`/:abbr:`SSL (Secure Sockets Layer)` certificates, which verify that a
particular provider is who they say they are.
.. note::
In this documentation and throughout Odoo the term "HTTPS certificate" will be used to define the
fact that the :abbr:`SSL (Secure Sockets Layer)` certificate is valid and allows a :abbr:`HTTPS
(Hypertext Transfer Protocol Secure)` connection.
Why is it needed?
-----------------
In order to communicate with certain network devices (in particular for payment terminals), the
usage of :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` is mandatory. If the :abbr:`HTTPS
(Hypertext Transfer Protocol Secure)` certificate isn't valid, some devices won't be able to
interact with the :abbr:`IoT (Internet of Things)` Box.
How to obtain a Hypertext Transfer Protocol Secure (HTTPS) certificate
======================================================================
The generation of the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate is automatic.
The :abbr:`IoT (Internet of Things)` Box will send a specific request to `<https://www.odoo.com>`_
which will send back the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate if the
:abbr:`IoT (Internet of Things)` box and database are eligible.
.. _iot/iot-eligibility:
Internet of Things (IoT) eligibility
------------------------------------
#. The database should be a **production** instance. The database instance should not be a copy, a
duplicate, a staging, or a development environment.
#. The Odoo subscription must:
- Have an :guilabel:`IoT Box Subscription` line.
- :guilabel:`Status` must be :guilabel:`In Progress`.
If the subscription is linked to a `<https://www.odoo.com>`_ portal user check the information
on the portal subscription page.
.. figure:: https_certificate_iot/sub-example-in-progress.png
:align: center
:alt: Odoo.com portal subscriptions filtered by "in progress".
In this case, both subscriptions are considered "in progress" as the :guilabel:`Filter By\:
In Progress` was used.
.. note::
If the subscription is in question, contact the database's Account Manager or Partner
regarding the matter.
Troubleshooting Hypertext Transfer Protocol Secure (HTTPS) certificate errors
=============================================================================
If anything goes wrong during the process of the "HTTPS certificate" generation or reception, a
specific error will code be given on the :abbr:`IoT (Internet of Things)` box home page.
.. tip::
Accessing the :abbr:`IoT (Internet of Things)` box homepage will check for the presence of the
"HTTPS certificate" and will attempt its generation if it is missing. As such, if there is an
error on the :abbr:`IoT (Internet of Things)` box home page, refresh the :abbr:`IoT (Internet of
Things)` home page to see if the error disappears.
`ERR_IOT_HTTPS_CHECK_NO_SERVER`
-------------------------------
Reason:
The configuration regarding the server is missing. In other words, the Odoo instance is not
connected with the IoT box.
Solution:
Ensure that the server is configured.
.. seealso::
:doc:`/applications/general/iot/config/connect`
`ERR_IOT_HTTPS_CHECK_CERT_READ_EXCEPTION`
-----------------------------------------
Reason:
An unhandled error happened when trying to read the existing :abbr:`HTTPS (Hypertext Transfer
Protocol Secure)` certificate.
Solution:
Ensure that the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate file is readable.
`ERR_IOT_HTTPS_LOAD_NO_CREDENTIAL`
----------------------------------
Reason:
The contract and/or database :abbr:`UUID (Universal Unique Identifier)` is missing.
Solution:
Ensure that both values are configured as intended. To modify them, go to the :abbr:`IoT
(Internet of Things)` box home page, and navigate to :guilabel:`Credential`.
`ERR_IOT_HTTPS_LOAD_REQUEST_EXCEPTION`
--------------------------------------
Reason:
An unexpected error happened when the :abbr:`IoT (Internet of Things)` box tried to reach
`<https://www.odoo.com>`_. The causes are likely due to the network
infrastructure/configuration:
- The :abbr:`IoT (Internet of Things)` box does not have access to internet.
- The network does not allow the :abbr:`IoT (Internet of Things)` box to communicate with
`<https://www.odoo.com>`_. This may be due to network devices preventing the communication
(firewalls, etc.) or the network configuration (:abbr:`VPN (Virtual Private Network)`,
etc.).
.. note::
More information regarding the error that occurred can be found in the full request
exception details, which are in the :abbr:`IoT (Internet of Things)` box logs.
Solution:
.. warning::
Consult with your system or network administrator should this issue arise. This error code
depends on the network infrastructure and goes beyond Odoo support's service scope.
`ERR_IOT_HTTPS_LOAD_REQUEST_STATUS`
-----------------------------------
Reason:
The IoT-box was able to reach `<https://www.odoo.com>`_ but received an unusual
`HTTP response (status codes)
<https://developer.mozilla.org/en-US/docs/Web/HTTP/Status>`_.
This error code will also give the HTTP response status codes. For example, if the error reads
`ERR_IOT_HTTPS_LOAD_REQUEST_STATUS 404` it means that the page returned a 404 error, which is
the "Page Not Found" code.
Solution:
Check if `<https://www.odoo.com>`_ is down using a web browser, as it's possible that it is down
due to maintenance.
- If `<https://www.odoo.com>`_ is down due to maintenance, unfortunately there is nothing that
can be done but instead wait for it to recover.
- If `<https://www.odoo.com>`_ is not down due to maintenance, open a `support ticket
<https://www.odoo.com/help>`_ on the matter. Ensure that the 3 digits status code next to the
code error is included in the support ticket.
`ERR_IOT_HTTPS_LOAD_REQUEST_NO_RESULT`
--------------------------------------
Reason:
The :abbr:`IoT (Internet of Things)` box was able to reach `<https://www.odoo.com>`_ but it
refused to deliver the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate.
Solution:
Ensure that the :abbr:`IoT (Internet of Things)` box and database are eligible for a
certificate: :ref:`Internet of Things (IoT) eligibility <iot/iot-eligibility>`.
How to ensure that the HTTPS certificate is correct
===================================================
If the certificate has been applied successfully, a new :abbr:`HTTPS (Hypertext Transfer Protocol
Secure)` :abbr:`URL (Uniform Resource Locator)` for the :abbr:`IoT (Internet of Things)` box ending
with `.odoo-iot.com` will appear on the Odoo database, inside of the :menuselection:`IoT`
application on that specific device's form.
.. image:: https_certificate_iot/odoo-new-domain.png
:align: center
:alt: Odoo IoT app IoT box with .odoo-iot.com domain.
When navigating to the :abbr:`URL (Uniform Resource Locator)` in a browser a secured :abbr:`HTTPS
(Hypertext Transfer Protocol Secure)` connection will be established.
.. figure:: https_certificate_iot/secured-connection.png
:align: center
:alt: Example of valid SSL certificate details on the browser.
Padlock in Chrome on Windows 10 attesting the fact that the connection is secured in :abbr:`HTTPS
(Hypertext Transfer Protocol Secure)`.
The IoT-box homepage will now display an `OK` status next to `HTTPS certificate`. The
drop-down menu icon, when clicked, will reveal information regarding the certificate.
.. image:: https_certificate_iot/status-ok.png
:align: center
:alt: IoT box homepage with HTTPS certificate OK status.
Domain Name System (DNS) issue
==============================
If the :abbr:`IoT (Internet of Things)` box can be accessed from its :abbr:`IP (Intrernet Protocol)`
address but not the Odoo assigned domain: `.odoo-iot.com`; then the :abbr:`IoT (Internet of Things)`
box is likely running into a :abbr:`DNS (Domain Name System)` issue. On some browsers, it will give
an error code mentioning :abbr:`DNS (Domain Name System)` (like `DNS_PROBE_FINISHED_NXDOMAIN`).
These :abbr:`DNS (Domain Name System)` issues may appear as the following in different browsers:
.. tabs::
.. tab:: Chrome
.. figure:: https_certificate_iot/dns-chrome.png
:align: center
:alt: DNS issue on Chrome browser on Windows 10.
DNS issue on Chrome browser on Windows 10.
.. tab:: Firefox
.. figure:: https_certificate_iot/dns-firefox.png
:align: center
:alt: DNS issue on Firefox browser on Windows 10.
DNS issue on Firefox browser on Windows 10.
.. tab:: Edge
.. figure:: https_certificate_iot/dns-edge.png
:align: center
:alt: DNS issue on Edge browser on Windows 10.
DNS issue on Edge browser on Windows 10.
Domain Name System (DNS) issue solution
---------------------------------------
#. Should the router allow the :abbr:`DNS (Domain Name System)` to be manually changed, change the
DNS to use `Google DNS <https://developers.google.com/speed/public-dns>`_.
#. If your router doesn't allow for this, then a change will need to be made on the :abbr:`DNS
(Domain Name System)` settings of each of the devices using `Google DNS
<https://developers.google.com/speed/public-dns>`_. This will need to occur on **every** device
that plans to interact with the :abbr:`IoT (Internet of Things)` box (e.g. computer, tablet or
phone). The individual device configuration processes can be found on the website of the
device's manufacturer.
.. note::
Other :abbr:`IoT (Internet of Things)` devices such as payment terminals likely won't need
their :abbr:`DNS (Domain Name System)` settings changed as they are already configured with
custom :abbr:`DNS (Domain Name System)`.
.. warning::
Consult with your system or network administrator should this issue arise. This error code
depends on the network infrastructure, and it goes beyond Odoo support's service scope.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

@@ -1,67 +0,0 @@
=========================
Use an IoT box with a PoS
=========================
Prerequisites
=============
Before starting, make sure the following equipment is available:
- An :abbr:`IoT (Internet of Things)` box, with its power adapter.
- A computer or tablet with an up-to-date web browser.
- Odoo Online or an Odoo instance with the *Point of Sale* and *IoT* applications installed.
- A local network set up with :abbr:`DHCP (Dynamic Host Configuration Protocol)` (this is the
default setting).
- An RJ45 Ethernet Cable (optional, but preferred over WiFi, which is already built in).
- Any of the supported hardware (receipt printer, barcode scanner, cash drawer, payment terminal,
scale, customer display, etc.). The list of supported hardware can be found on the `POS Hardware
page <https://www.odoo.com/page/point-of-sale-hardware>`_.
Setup
=====
.. figure:: pos/pos-connections.png
A suggested configuration for a point of sale system.
To connect hardware to the :abbr:`PoS (Point of Sale)`, the first step is to connect an :abbr:`IoT
(Internet of Things)` box to the database. To do this, follow these instructions: :doc:`Connect an
Internet of Things (IoT) box to the Odoo database <connect>`.
Then, connect the peripheral devices to the :abbr:`IoT (Internet of Things)` box.
.. list-table::
:header-rows: 1
:stub-columns: 1
* - Device Name
- Instructions
* - Printer
- Connect a supported receipt printer to a :abbr:`USB (Universal Serial Bus)` port or
to the network, and power it on. Refer to
:doc:`/applications/sales/point_of_sale/restaurant/kitchen_printing`.
* - Cash drawer
- The cash drawer should be connected to the printer with an RJ25 cable.
* - Barcode scanner
- In order for the barcode scanner to be compatible it must end barcodes with an `ENTER`
character (keycode 28). This is most likely the default configuration of the barcode scanner.
* - Scale
- Connect the scale and power it on. Refer to
:doc:`../devices/scale`.
* - Customer display
- Connect a screen to the :abbr:`IoT (Internet of Things)` box to display the :abbr:`PoS (Point
of Sale)` order. Refer to :doc:`../devices/screen`.
* - Payment terminal
- The connection process depends on the terminal. Refer to the :doc:`payment terminals
documentation </applications/sales/point_of_sale/payment_methods>`.
Once this is completed, connect the :abbr:`IoT (Internet of Things)` box to the :menuselection:`PoS`
application. To do this, go to :menuselection:`Point of Sale --> Configuration --> PoS`, tick the
:guilabel:`IoT Box` option, and select the devices to be used in this :abbr:`PoS (Point of Sale)`.
:guilabel:`Save` the the changes.
.. image:: pos/iot-connected-devices.png
:align: center
:alt: Configuring the connected devices in the POS application.
Once set up is done, a new :abbr:`PoS (Point of Sale)` session can be launched.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.5 KiB

@@ -1,46 +0,0 @@
==========================
Connect an IoT box via SSH
==========================
.. |iot| replace:: :abbr:`IoT (Internet of Things)`
.. |SSH| replace:: :abbr:`SSH (secure shell protocol)`
To provide an |SSH| connection to an Internet of Things (IoT) box, a password needs to be generated.
.. warning::
This feature should **only** be utilized with trusted parties, as it provides administrative
access to the |iot| box, which can create security issues.
Managing an |SSH| connection is **not** covered under the standard scope of Odoo support. Visit
the `Odoo Support <https://www.odoo.com/help>`_ page for additional information about what is
covered.
First, navigate to the :menuselection:`IoT app --> IoT Boxes`. Click on the IP address of the
appropriate |iot| box.
.. note::
If the desired |iot| box does not appear, see :doc:`troubleshooting` for additional steps.
At the bottom of the |iot| box pop-up window, click :guilabel:`Remote Debug`. This opens the
:guilabel:`Remote Debugging` pop-up window.
.. image:: ssh_connect/ssh-generate-password.png
:align: center
:alt: The Remote Debugging password generation window.
Click :guilabel:`Generate password`.
.. warning::
After the password has been generated from the :guilabel:`Remote Debugging` pop-up window, the
information **must** be recorded immediately. Once this window is closed, there is no current
method for looking up this information.
Enter the :guilabel:`Authentication Token` provided by the user attempting to connect to the |iot|
box.
Click :guilabel:`Enable Remote Debugging`.
.. seealso::
- :doc:`connect`
- :doc:`troubleshooting`
- :doc:`updating_iot`
Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

@@ -1,645 +0,0 @@
===============
Troubleshooting
===============
IoT box connection
==================
Unable to locate the pairing code to connect the IoT box
--------------------------------------------------------
The pairing code should be printed on receipt printers connected to the :abbr:`IoT (Internet of
Things)` box and should also be displayed on connected monitors.
The pairing code does not show under the following circumstances:
- The :abbr:`IoT (Internet of Things)` box is already connected to an Odoo database.
- The :abbr:`IoT (Internet of Things)` box is not connected to the Internet.
- The code is only valid for 5 minutes after the :abbr:`IoT (Internet of Things)` box has started.
It is automatically removed from connected displays when this time has expired.
- The version of the :abbr:`IoT (Internet of Things)` box image is too old. If the :abbr:`IoT
(Internet of Things)` box image is from an earlier version, then the SD card of the :abbr:`IoT
(Internet of Things)` box needs to be re-flashed to update the image (see :ref:`Flashing the SD
Card <iot/config/flash>`).
If none of the cases listed above correct the issue, then make sure the :abbr:`IoT (Internet of
Things)` box has correctly started, by checking that a fixed green LED is showing next to the power
port.
IoT box is connected but it is not showing in the database
----------------------------------------------------------
When an :abbr:`IoT (Internet of Things)` box connects to a database, it may restart. If so, it can
take up to five minutes before appearing in the database. If the :abbr:`IoT (Internet of Things)`
box is still not showing after five minutes, make sure that the :abbr:`IoT (Internet of Things)` box
can reach the database and that the server does not use a multi-database environment.
To access the database from the :abbr:`IoT (Internet of Things)` box, open a browser and type in the
database address.
The IoT box is connected to the Odoo database, but cannot be reached
--------------------------------------------------------------------
Make sure that the :abbr:`IoT (Internet of Things)` box and the computer running the browser are
located on the same network, as the :abbr:`IoT (Internet of Things)` box cannot be reached from
outside the local network.
The HTTPS certificate does not generate
---------------------------------------
In order to generate a :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate, an IoT box
subscription is required for the :abbr:`IoT (Internet of Things)` box. Connecting the :abbr:`IoT
(Internet of Things)` box prior to configuring an :abbr:`IoT (Internet of Things)` subscription for
the database and :abbr:`IoT (Internet of Things)` box with the Account Manager will result in an
unsecured connection.
In addition, a firewall can also prevent the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)`
certificate from generating correctly. In this case, deactivate the firewall until the certificate
is successfully generated. It should also be noted that certain devices, such as a router that has
a built-in firewall, can prevent the :abbr:`HTTPS (Hypertext Transfer Protocol Secure)` certificate
from generating.
.. seealso::
:doc:`HTTPS certificate (IoT) <https_certificate_iot>`
Printer
=======
The printer is not detected
---------------------------
If a printer does not appear in the devices list, go to the :abbr:`IoT (Internet of Things)` box
homepage and make sure that it is listed under :guilabel:`Printers`.
.. image:: troubleshooting/printer-status.png
:align: center
:alt: The IoT box Home Page landing page.
If the printer is not present on the :abbr:`IoT (Internet of Things)` box homepage, click
:guilabel:`Printers Server`, go to the :guilabel:`Administration` tab and click on :guilabel:`Add
Printer`. If the printer is not present in the list, it is likely not connected properly.
The printer outputs random text
-------------------------------
For most printers, the correct driver should be automatically detected and selected. However, in
some cases, the automatic detection mechanism might not be enough, and if no driver is found, the
printer might print random characters.
The solution is to manually select the corresponding driver. On the :abbr:`IoT (Internet of Things)`
box homepage, click on :guilabel:`Printers Server`, go to the :guilabel:`Printers` tab and select
the printer in the list. In the :guilabel:`Administration` drop-down menu, click on
:guilabel:`Modify Printer`. Follow the steps and select the *make* and *model* corresponding to the
printer.
.. image:: troubleshooting/modify-printer.png
:align: center
:alt: Edit the printer connected to the IoT box.
.. note::
Epson receipt printers and Zebra label printers do not need a driver to work. Make sure that no
driver is selected for those printers.
The printer is detected but is not recognized correctly
-------------------------------------------------------
If the printer is not recognized correctly by Odoo and the :abbr:`IoT (Internet of Things)` box, go
to the form view of the device (:menuselection:`IoT App --> Devices -->Printer Device`) and change
the subtype. The three options available are: :guilabel:`Receipt Printer`, :guilabel:`Label
Printer`, and :guilabel:`Office Printer`.
.. image:: troubleshooting/sub-type.png
:align: center
:alt: Sub-type selection in a printer IoT device.
Epson configuration special case
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Most Epson printers support printing receipts in Odoo :abbr:`POS (Point of Sale)` using the `GS v 0`
command. However, the following Epson printer models do not support this command:
- TM-U220
- TM-U230
- TM-P60
- TMP-P60II
Bypass this issue by configuring the printer to use the `ESC *` command instead.
Process to force ESC * command
******************************
Epson printer compatibility
^^^^^^^^^^^^^^^^^^^^^^^^^^^
The first step is to check whether the printer is incompatible with `GS v 0` command.
.. seealso::
- `Epson GS v 0 documentation <https://reference.epson-biz.com/modules/ref_escpos/index.php?
content_id=94>`_ for `GS v 0` compatible printers.
- `Epson ESC * documentation <https://reference.epson-biz.com/modules/ref_escpos/index.php
?content_id=88>`_ for `ESC *` compatible printers.
If the printer is not compatible with the `ESC *` command then the following process is not
possible. Should the printer be compatible to use the `ESC *` command to print, follow this process
to configure the printer with the :abbr:`IoT (Internet of Things)` box.
IoT box configuration for ESC *
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To configure the :abbr:`IoT (Internet of Things)` box to use the `ESC *` command to print, go to the
:abbr:`IoT (Internet of Things)` box homepage by navigating to :menuselection:`IoT app --> IoT
Boxes`. Then click on the :guilabel:`IP address` and this will direct to the :abbr:`IoT (Internet of
Things)` box homepage.
**Choosing the printer**
Now click on the :guilabel:`Printers server` button. This will redirect the browser to the *CUPS*
page. Next, go to :menuselection:`Administration --> Printers --> Add Printer`, choose the printer
that should be modified, and then click :guilabel:`Continue`.
.. tip::
If the name of the printer is still uncertain, take the following steps:
#. Take note of the listed printers on the *CUPS* page.
#. Turn the printer off and refresh the page.
#. Now compare the difference with the first list to see which printer disappeared.
#. Turn the printer back on and refresh the page again.
#. Double-check the list again to see if the printer re-appears.
#. The printer that disappeared and reappears again on the listed printers is the name of the
printer in question.
.. note::
This can be :guilabel:`Unknown` under :guilabel:`Local printers`.
**CUPS naming convention**
`CUPS` will prompt the administrator for three pieces of information: the :guilabel:`Name`,
:guilabel:`Description` and the :guilabel:`Location`. The last two pieces of information do not need
to be specific, however, the :guilabel:`Name` should follow a particular convention to work with the
`ESC *` command.
The :guilabel:`Name` should match this convention:
`<printer_name>__IMC_<param_1>_<param_2>_..._<param_n>__`
A breakdown of the naming convention:
- `printer_name`: This is the printer name. It can be any character as long as it does not contain
`_`, `/`, `#`, or ` ` (space character).
- `IMC`: This stands for *Image Mode Column* (the simplified name for `ESC *`).
- `param_1`: This stands for the specific parameter:
- `SCALE<X>`: Scale of the picture (with the same aspect ratio). `X` should be an integer
describing the scale percentage that should be used.
.. example::
`100` is the original size, `50` is half the size, `200` is twice the size.
- `LDV`: *Low Density Vertical* (will be set to *High Density Vertical* if not specified).
- `LDH`: *Low Density Horizontal* (will be set to *High Density Horizontal* if not specified).
.. note::
*Density* parameters might need to be configured in a particular way depending on the printer
model.
.. seealso::
Visit `Epson's ESC * documentation
<https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=88>`_ and click on the
printer model printer in the table above to see if the printer should set these parameters.
.. example::
The following are examples of proper and improper name formatting:
Proper name formatting:
- `EPSONTMm30II__IMC__`
- `EPSON_TM_U220__IMC_LDV_LDH_SCALE80__`
Improper name formatting (this will not prevent printing, but the result might not have the
expected printed output):
- `EPSON TMm 30II` -> The name cannot have spaces.
- `EPSONTMm30II` -> The name itself is correct, but it will not use `ESC *`.
- `EPSONTMm30II__IMC` -> This name is missing the end `__`.
- `EPSONTMm30II__IMC_XDV__` -> The parameter `XDV` does not match any existing parameters.
- `EPSONTMm30II__IMC_SCALE__` -> The parameter `SCALE` is missing the scale value.
**Finish adding a printer**
After setting the name of the printer with the appropriate naming convention, click
:guilabel:`Continue`. Next, set the :guilabel:`Make` value to :guilabel:`Raw` and for the
:guilabel:`Model` value, set this to :guilabel:`Raw Queue (en)`.
After completing these steps, click :guilabel:`Add Printer`. If everything was done correctly, the
page should redirect to the *Banners* page.
At this point the printer should have been created, now the :abbr:`IoT (Internet of Things)` box
just needs to detect it and then sync to Odoo's server (this could take a few minutes).
**Adding the printer to Odoo PoS**
Once the printer is visible on the Odoo database, do not forget to choose it in the :abbr:`PoS
(Point of Sale)`configuration as the :abbr:`IoT (Internet of Things)` printer. Navigate to
:menuselection:`Pos App --> Settings --> Connected Devices --> IoT Box --> Receipt Printer -->
Save`.
.. note::
If the printer was set up incorrectly (it is still printing random text or the printed receipt is
too big or small), then it cannot be modified via the printer name with *CUPS*. Instead, the
above process can be repeated to set up another printer from scratch to create one with modified
parameters.
**Example setup of the Epson TM-U220B printer using ESC**
.. spoiler::
Click this text to reveal the example
The following is an example of the troubleshooting process for a TM-U220B printer model using the
`ESC *` command. The receipt pictured below is an example of a receipt that is printing correctly
due to proper formatting (in theory):
.. image:: troubleshooting/receipt-example.png
:align: center
:alt: Properly formatted receipt picture from a demo database.
Trying to print this receipt right-away prior to the proper formatting will not work as the
TM-U220B printer model does not support `GS v 0`. Instead random characters will print:
.. image:: troubleshooting/receipt-print-random-letters.png
:align: center
:alt: Printer paper with seemingly random characters.
To properly configure formatting for the Epson TM-U220B printer model take the following steps.
After consulting Epson's website for compatibility for both of the commands: `GS v 0
<https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=94>`_ and `ESC *
<https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=88>`_, it can be seen
that indeed the TM-U220B is not compatible with `GS v 0`, but is compatible with `ESC *`.
.. image:: troubleshooting/epson-compatibility-compare.png
:align: center
:alt: Epson compatibility evaluation from Epson website.
When adding the printer, *CUPS* will ask which printer should be added:
.. image:: troubleshooting/add-printer.png
:align: center
:alt: Administration menu, add printer selection.
In this case, the printer is connected via :abbr:`USB (Universal Serial Bus)` so it won' be part
of the :guilabel:`Discovered Network Printers`. Instead it is likely part of the
:guilabel:`Unknown` selection under :guilabel:`Local Printers`. By unplugging the printer's
:abbr:`USB (Universal Serial Bus)` cable from the :abbr:`IoT (Internet of Things)` box and
refreshing the page, the :guilabel:`Unknown` printer disappears. By plugging it back in, the
printer reappears, so it can be said that this is the printer in question.
For the naming convention, since it needs to print using the `ESC *` command, it is imperative to
add `__IMC`. Reference the printer model on `Epson's ESC * site
<https://reference.epson-biz.com/modules/ref_escpos/index.php?content_id=88>`_ to find out more
about the *density* parameters.
.. image:: troubleshooting/epson-tm-u220-specification.png
:align: center
:alt: Epson TM-U220 specifications on manufacturer's website.
For this particular model, TM-U220, `m` should be equal to 0 or 1. While referencing the
:guilabel:`Description` below the pink box in the above picture, the `m` values could be 0, 1, 32
or 33. So in this printers case, the `m` value can NOT be 32 or 33 (otherwise there will be
random characters printed).
The table includes the numeric values: 32 and 33, they both occur if the :guilabel:`Number of
bits for vertical data` is set to 24. This means that is a *High Vertical Density*. In the case
of configuring the Epson TM-U220, the *Low Vertical Density* will need to be forced, as this
printer model does not support *High Vertical Density* for this command `ESC *`.
To add a *Low Vertical Density*, add the `LDV` parameter to the naming convention.
.. image:: troubleshooting/add-printer-filled.png
:align: center
:alt: Add a *Low Vertical Density* (the `LDV` parameter) to the naming convention.
Click :guilabel:`Continue` to proceed. Next, set the :guilabel:`Make` value to :guilabel:`Raw`
and for the :guilabel:`Model` value, set this to :guilabel:`Raw Queue (en)`.
.. image:: troubleshooting/add-printer-add.png
:align: center
:alt: Epson TM-U220 specifications on manufacturers website.
However, when trying to print with the naming convention: `EpsonTMU220B__IMC_LDV__`, it prints
the receipt, but it is too big and outside the margin. To resolve this, add a new printer (and
naming convention) with the `SCALE<X>` parameter to adapt to our receipt size.
Here are some examples:
.. list-table::
:header-rows: 1
* - Printer Naming Convention
- `EpsonTMU220B__IMC_LDV__`
- `EpsonTMU220B__IMC_LDV_SCALE75__`
- `EpsonTMU220B__IMC_LDV_LDH__`
- `EpsonTMU220B__IMC_LDV_LDH_SCALE35__`
* - .. image:: troubleshooting/receipt-example.png
:align: center
:alt: Receipt example format.
- .. image:: troubleshooting/tm-u220-ldv.png
:align: center
:alt: Receipt format using naming convention: EpsonTMU220B__IMC_LDV__.
- .. image:: troubleshooting/tm-u220-ldv-scale75.png
:align: center
:alt: Receipt format using naming convention: EpsonTMU220B__IMC_LDV_SCALE75__.
- .. image:: troubleshooting/tm-u220-ldv-hdv.png
:align: center
:alt: Receipt format using naming convention: EpsonTMU220B__IMC_LDV_LDH__.
- .. image:: troubleshooting/tm-u220-ldv-hdv-scale35.png
:align: center
:alt: Receipt format using naming convention: EpsonTMU220B__IMC_LDV_LDH_SCALE35__.
DYMO LabelWriter print issue
----------------------------
The DYMO LabelWriter has a known issue in printing with the :abbr:`IoT (Internet of Things)` box.
The OpenPrinting CUPS server installs the printer using :guilabel:`Local RAW Printer` drivers. In
order to print anything, the correct :guilabel:`Make and Model` needs to be set, so the correct
driver is referenced when using the device.
Additionally, a new printer needs to be added to reduce a print delay that occurs after updating the
driver.
.. important::
The DYMO LabelWriter 450 DUO printer is the recommended DYMO printer for use with Odoo and the
:abbr:`IoT (Internet of Things)` box. It **must** already be connected to, and recognized on, the
:abbr:`IoT (Internet of Things)` box.
The DYMO LabelWriter 450 DUO printer contains two printers in one: a label printer and a tape
printer. Choosing the correct model (either DYMO LabelWriter 450 DUO Label (en) or DYMO
LabelWriter 450 DUO Tape (en)) is crucial when configuring the following processes.
To keep things consistent, both of the following processes detail the configuration for the DYMO
LabelWriter 450 DUO Label (en) model. Change the model when needed.
.. _troubleshooting/dymo/update_drivers:
DYMO LabelWriter not printing
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In the case where the DYMO LabelWriter is not printing anything, a new driver needs to be installed.
First, open the OpenPrinting CUPS console by clicking :menuselection:`Printers server` at the bottom
of the :abbr:`IoT (Internet of Things)` box homepage. Next, click on :menuselection:`Printers` in
the top menu. Click into the printer in question, and select :guilabel:`Maintenance` in the first
drop-down menu. Then, select :guilabel:`Modify Printer` in the second drop-down menu.
.. image:: troubleshooting/main-modify.png
:align: center
:alt: Modify the make and model of the DYMO LabelWriter. Maintenance and Modify drop-down menus
highlighted.
Next, select the specific network connection/printer that the modification should be made on. Click
:guilabel:`Continue`.
.. image:: troubleshooting/modify-select-printer.png
:align: center
:alt: Printer selection screen with Continue highlighted.
On the next page, click :guilabel:`Continue` to proceed to set the :guilabel:`Make` of the printer.
.. image:: troubleshooting/modify-printer-dymo.png
:align: center
:alt: Printer modification screen with Continue highlighted.
Under :guilabel:`Make` select :guilabel:`DYMO` from the menu. Click on :guilabel:`Continue` to set
the :guilabel:`Model`.
.. image:: troubleshooting/setting-make.png
:align: center
:alt: Setting the make page, with DYMO and continue highlighted.
On the following page, set the :guilabel:`Model` to :guilabel:`DYMO LabelWriter 450 DUO Label (en)`
(or whichever DYMO printer model is being used). Click on :guilabel:`Modify Printer` to complete
setting the new driver, a confirmation page will appear.
.. image:: troubleshooting/setting-model.png
:align: center
:alt: Setting the printer model page with DYMO LabelWriter 450 DUO Label (en) highlighted.
After being redirected to a confirmation page, acknowledging a successful update, click on the
:menuselection:`Printers` button in the top menu.
All the printers installed on the OpenPrinting CUPS server appear, including the newly updated:
:guilabel:`DYMO LabelWriter 450 DUO Label` (or whichever DYMO printer model is being used). Click
into the printer that was just updated.
To print a test label, click on the :guilabel:`Maintenance` drop-down menu to the left of the
:guilabel:`Administration` drop-down menu, and select :guilabel:`Print Test Page`. The test label
will print out with a ten-second delay if the driver update was successful.
.. image:: troubleshooting/print-test.png
:align: center
:alt: Printing a test page from the administration drop-down menu in the OpenPrinting CUPs
server.
To reduce this delay a new printer will need to be added, follow the process below.
DYMO LabelWriter print delay
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To resolve the delay issue after modifying the driver, the printer **must** be reinstalled. To
reinstall the printer, open the OpenPrinting CUPS administration page by clicking
:menuselection:`Printers server`, at the bottom of the :abbr:`IoT (Internet of Things)` box
homepage. Then, click on :menuselection:`Administration` in the top menu, then click :guilabel:`Add
a Printer`.
.. tip::
If the DYMO LabelWriter 450 DUO printer is not printing at all, or is not recognizable (has a RAW
driver type), then update the drivers on the device. See
:ref:`troubleshooting/dymo/update_drivers`.
.. image:: troubleshooting/add-printer-dymo.png
:align: center
:alt: Add a printer button highlighted on the Printer CUPS management page.
On the next screen, in the :guilabel:`Local Printers` section, select the :guilabel:`DYMO
LabelWriter 450 DUO Label (DYMO LabelWriter 450 DUO Label)` (or whichever DYMO printer model is
being used) pre-installed printer. Click :guilabel:`Continue`.
.. image:: troubleshooting/local-printer.png
:align: center
:alt: Add a printer screen on OpenPrinting CUPS with DYMO LabelWriter 450 DUO Label highlighted.
On the following screen, modify the :guilabel:`Name` to something recognizable, as the original
printer will still be present. Click :guilabel:`Continue` to be taken to the next screen.
.. image:: troubleshooting/rename-printer.png
:align: center
:alt: Rename printer page in the 'Add a Printer' flow, with the name field highlighted.
Next, choose the :guilabel:`Model`. Select :guilabel:`DYMO LabelWriter 450 DUO Label (en)` (or
whichever DYMO printer model is being used), and finally, click :guilabel:`Add Printer` to complete
the installation.
.. image:: troubleshooting/choose-printer.png
:align: center
:alt: Choose model screen on the OpenPrinting CUPS console with model and add a printer
highlighted.
After being redirected to a confirmation page, acknowledging a successful installation, click on the
:menuselection:`Printers` button in the top menu.
All the printers installed on the OpenPrinting CUPS server appear, including the newly installed:
:guilabel:`DYMO LabelWriter 450 DUO Label` (or whichever DYMO printer model is being used). Click
into the printer that was just installed.
.. image:: troubleshooting/printer-page.png
:align: center
:alt: Printer page with newly installed printer highlighted.
To print a test label, click on the :guilabel:`Maintenance` drop-down menu to the left of the
:guilabel:`Administration` drop-down menu, and select :guilabel:`Print Test Page`. The test label
should print out immediately (one-to-two seconds delay).
.. image:: troubleshooting/print-test.png
:align: center
:alt: Printing a test page from the administration drop-down menu in the OpenPrinting CUPs
server.
The Zebra printer does not print anything
-----------------------------------------
Zebra printers are quite sensitive to the format of the Zebra Programming Language (ZPL) code that
is printed. If nothing comes out of the printer or blank labels are printed, try changing the format
of the report that is sent to the printer by accessing :menuselection:`Settings --> Technical -->
User Interface --> Views` in :ref:`developer mode <developer-mode>` and look for the corresponding
template.
.. seealso::
Check out Zebra's instructions on printing :abbr:`ZPL (Zebra Programming Language)` files `here
<https://supportcommunity.zebra.com/s/article/Print-a-zpl-file-using-the-Generic-Text-Printer>`_.
Barcode scanner
===============
The characters read by the barcode scanner do not match the barcode
-------------------------------------------------------------------
By default, most barcode scanners are configured in the US QWERTY format. If the barcode scanner
uses a different layout, go to the form view of the device (:menuselection:`IoT App --> Devices -->
Barcode Device`) and select the correct format.
Nothing happens when a barcode is scanned
-----------------------------------------
Make sure that the correct device is selected in the :menuselection:`Point of Sale` configuration
and that the barcode is configured to send an `ENTER` character (keycode 28) at the end of every
barcode. To do so, navigate to :menuselection:`PoS app --> 3-Dot Menu on the PoS --> IoT Box section
--> Edit`.
The barcode scanner is detected as a keyboard
---------------------------------------------
.. important::
Some barcode scanners do not advertise themselves as barcode scanners but as a USB keyboard
instead, and will not be recognized by the :abbr:`IoT (Internet of Things)` box.
The device type can be manually changed by going to its form view (:menuselection:`IoT App -->
Devices --> Barcode Device`) and activating the :guilabel:`Is scanner` option.
.. image:: troubleshooting/barcode-scanner-settings.png
:align: center
:alt: Modifying the form view of the barcode scanner.
Barcode scanner processes barcode characters individually
---------------------------------------------------------
When accessing the mobile version of Odoo from a mobile device, or tablet, paired with a barcode
scanner, via the :abbr:`IoT (Internet of Things)` box, the scanner may process each barcode
character as an individual scan. In this case, the *Keyboard Layout* option **must** be filled out
with the appropriate language of the barcode scanner on the *Barcode Scanner* form page.
.. tip::
Access the barcode scanner form page by navigating to :menuselection:`IoT App --> Devices -->
Barcode Scanner`.
.. image:: troubleshooting/keyboard-layout.png
:align: center
:alt: Barcode scanner form page, with keyboard layout option highlighted.
The :guilabel:`Keyboard Layout` is language based, and the options available vary, depending on the
device and the language of the database. For example: :guilabel:`English (UK)`, :guilabel:`English
(US)`, etc.
Cash drawer
===========
The cash drawer does not open
-----------------------------
The cash drawer should be connected to the printer and the :guilabel:`Cash drawer` checkbox should
be ticked in the :abbr:`PoS (Point of Sale)` configuration. To do so, navigate to
:menuselection:`POS app --> 3-Dot Menu on the POS --> IoT Box section --> Edit --> Receipt Printer
--> Cashdrawer checkbox`.
Scale
=====
Scales play a crucial role in the checkout process, especially for products sold by weight, rather
than fixed pricing.
Set up Ariva S scales
---------------------
Odoo has determined that a specific setting in Ariva S series scales (manufactured by
Mettler-Toledo, LLC.) needs modification, and a dedicated Mettler :abbr:`USB (Universal Serial
Bus)`-to-proprietary RJ45 cable is required for the scale to function with Odoo's :abbr:`IoT
(Internet of Things)` box.
To correctly configure the scale for recognition by the :abbr:`IoT (Internet of Things)` box, follow
this setup process for the Ariva S series scales.
.. important::
It is crucial to use the official Mettler :abbr:`USB (Universal Serial Bus)`-to-RJ45 cable during
this process.
Cable
~~~~~
The Mettler part number is 72256236 - :abbr:`USB (Universal Serial Bus)`-to-:abbr:`POS (Point of
Sale)` cable. Contact Mettler, or a partner, to purchase an authentic cable. Note that **no other**
cable outside of this Mettler cable works for this configuration. Using a serial-only cable attached
to a serial-to-:abbr:`USB (Universal Serial Bus)` adapter is **not** effective.
.. image:: troubleshooting/cable-mettler.png
:align: center
:alt: Authentic Mettler USB to POS cable, part number 72256236.
Setup
~~~~~
Refer to Mettler's Setup Guide for Ariva S series scales during the following configuration: `Ariva
Checkout Scale User's Guide <https://www.mt.com/dam/RET_DOCS/Ariv.pdf>`_.
To begin, go to page 17 in the above manual for *Setup*. This guide lists potential settings for the
Ariva S series scales.
Follow the instructions, along with the following process, to set the scale to setup mode. First,
hold the **>T<** button for eight seconds, or until :guilabel:`CONF` appears.
Next, press **>T<** until :guilabel:`GRP 3` appears, then press **>0<** to confirm.
Under :guilabel:`3.1`, ensure the setting is set to :guilabel:`1` (USB Virtual COM ports). Press
**>T<** to cycle through the options under group 3.1.
Once :guilabel:`3.1` is set to :guilabel:`1`, press **>0<** to confirm the selection. Continue to
press **>0<** until :guilabel:`GRP 4` appears.
Now, press **>T<** until :guilabel:`EXIT` appears.
.. important::
Do **not** make any other changes unless otherwise needed.
Once :guilabel:`EXIT` appears, press **>0<**. Following this, press **>0<** again to
:guilabel:`SAVE`. Now the scale restarts.
Finally, restart the :abbr:`IoT (Internet of Things)` box to recognize the changes made on the
scale's configuration. After restarting, the scale appears as `Toledo 8217`, as opposed to the
previous display, where it appeared as `Adam Equipment Serial`.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

@@ -1,230 +0,0 @@
==============
Updating (IoT)
==============
Due to the complexity of the :abbr:`IoT (Internet of Things)` box, and virtual Windows :abbr:`IoT
(Internet of Things)` box, the term 'updating' can mean several different things.
The actual drivers can be updated, the core code on the :abbr:`IoT (Internet of Things)` box can be
updated, or a new image can be flashed (using a physical :abbr:`IoT (Internet of Things)` box).
This document explores the various ways to update :abbr:`IoT (Internet of Things)` boxes to ensure
smooth operation of :abbr:`IoT (Internet of Things)` box processes and devices.
.. _iot/config/flash:
Flashing the SD card on IoT box
===============================
.. important::
This update does **not** apply to the Windows :abbr:`IoT (Internet of Things)` box (Odoo 16 and
higher).
To update the Windows :abbr:`IoT (Internet of Things)`, first, uninstall the previous version of
the Odoo Windows program, and then reinstall it using the most up-to-date installation package.
To begin the installation, navigate to the Odoo 16 (or higher) installation package for
Enterprise or Community - Windows edition, at `Odoo's download page
<https://odoo.com/download>`_.
In some circumstances, the :abbr:`IoT (Internet of Things)` box's micro SD Card may need to be
re-flashed with *Etcher* software to benefit from Odoo's latest :abbr:`IoT (Internet of Things)`
image update. This means the Odoo :abbr:`IoT (Internet of Things)` box software may need to be
updated in instances of a new :abbr:`IoT (Internet of Things)` box, or when a handler's update, or
an update from the :abbr:`IoT (Internet of Things)` box home page, does not resolve issues.
.. note::
- It is often necessary to re-flash the :abbr:`IoT (Internet of Things)` box's image after
upgrading the Odoo database to a new version.
- A computer with a micro SD card reader/adapter is **required** to re-flash the micro SD card.
First, begin by downloading `Etcher <https://www.balena.io/etcher#download-etcher>`_. It is a free,
open-source utility, used for burning image files onto drives. After the download completes, install
and launch the program on the computer.
Then, download the latest :abbr:`IoT (Internet of Things)` image from `nightly
<http://nightly.odoo.com/master/iotbox>`_, which will be labeled as `iotbox-latest.zip`. This
particular image is compatible with *all* supported versions of Odoo.
After this step is complete, insert the :abbr:`IoT (Internet of Things)` box's micro SD card into
the computer or reader. Open *Etcher*, and select :guilabel:`Flash from file`, then find and select
the `iotbox-latest.zip` image and extract it. Next, select the drive the image should be burned to.
Lastly, click :guilabel:`Flash`, and wait for the process to finish.
.. image:: updating_iot/etcher-app.png
:align: center
:alt: Balena's Etcher software dashboard.
.. tip::
Balena's *Etcher* software also allows for the administrator to flash the :abbr:`SD (Secure
Digital)` card from a :abbr:`URL (Uniform Resource Locator)`. To flash from a :abbr:`URL (Uniform
Resource Locator)`, simply click :guilabel:`Flash from URL`, instead of :guilabel:`Flash from
file`.
Then, enter the following: `http://nightly.odoo.com/master/iotbox/iotbox-latest.zip`.
.. image:: updating_iot/url-flash.png
:align: center
:alt: A view of Balena's Etcher software, with the flash from URL option highlighted.
.. note::
An alternative software for flashing the micro SD card is `Raspberry Pi Imager
<https://www.raspberrypi.com/software/>`_.
Windows IoT update
==================
Windows virtual :abbr:`IoT (Internet of Things)` box may occasionally need an update to work
properly.
The following processes cover the :ref:`uninstallation <iot/config/uninstall-windows-iot>` and
:ref:`re-installation <iot/config/re-install-windows-iot>` of the Windows virtual :abbr:`IoT
(Internet of Things)` box.
.. _iot/config/uninstall-windows-iot:
Uninstalling Windows IoT
------------------------
Prior to upgrading the Windows virtual :abbr:`IoT (Internet of Things)` box, the previous version
should be uninstalled first.
.. important::
Before uninstalling a previous version of the Windows virtual :abbr:`IoT (Internet of Things)`
box, ensure that there is a newer version of Windows virtual :abbr:`IoT (Internet of Things)` box
available, compared to the version currently installed. To do so, navigate to the `Odoo Nightly
builds <https://nightly.odoo.com/>`_ page.
On the :guilabel:`Odoo Nightly builds` page, navigate to :menuselection:`Builds (stable version)
--> windows/` to view the date next to the :file:`odoo_(version).latest.exe` file; where
*(version)* is equal to the version of Odoo (e.g. 16.0, 17.0). The latest version of the Windows
virtual :abbr:`IoT (Internet of Things)` box can be downloaded by selecting this file, or it is
always available at the `Odoo Download <https://odoo.com/download/>`_ page.
Uninstalling the Windows virtual :abbr:`IoT (Internet of Things)` box is done through the Windows
program manager.
On any version of Windows, search for `program` to open the :menuselection:`Programs --> Programs
and Features` section of the :guilabel:`Control Panel`. Then, select :guilabel:`Uninstall or change
a program`. Next, search for `Odoo`, and click the :guilabel:`... (three dot)` menu on the
:guilabel:`Odoo.exe` program to uninstall.
Confirm the uninstallation, and follow the steps to uninstall through the Odoo uninstall wizard.
.. _iot/config/re-install-windows-iot:
Download and re-install
-----------------------
The latest version of the Windows virtual :abbr:`IoT (Internet of Things)` box can be downloaded
from the `Odoo Nightly builds <https://nightly.odoo.com/>`_ page or it is always available at the
`Odoo Download <https://odoo.com/download/>`_ page.
To download from the :guilabel:`Odoo Nightly builds` page, navigate to :menuselection:`Builds
(stable version) --> windows/` to and select the :file:`odoo_(version).latest.exe` file; where
*(version)* is equal to the version of Odoo (e.g. 16.0, 17.0).
To download from the :guilabel:`Odoo Download` page, find the section for the version of Odoo (e.g.
16.0, 17.0), and select the :guilabel:`Download` button for :guilabel:`Windows`.
Next, install and setup the downloaded Odoo :file:`.exe` file. After the instructions screen, click
:guilabel:`Next` to start the installation, and agree to the :abbr:`TOS (Terms of Service)`.
During the next step of the re-installation, select :guilabel:`Odoo IoT` from the :guilabel:`Select
the type of install` drop-down menu.
.. example::
For reference, the following should be installed:
- :guilabel:`Odoo server`
- :guilabel:`Odoo IoT`
- :guilabel:`Nginx WebServer`
- :guilabel:`Ghostscript interpreter`
Ensure there is enough space on the computer for the installation, then click :guilabel:`Next`.
Set the destination and complete the installation
-------------------------------------------------
To complete the re-installation, select the :guilabel:`Destination Folder`, and click
:guilabel:`Install`.
.. warning::
Choosing `C:\\odoo` as the install location allows for the *Nginx* server to start. Odoo's
Windows virtual :abbr:`IoT (Internet of Things)` box software should **not** be installed inside
any of the Windows user's directories. Doing so does **not** allow for *Nginx* to initialize.
The installation may take a few minutes. When complete, click :guilabel:`Next` to continue.
Then, ensure that the :guilabel:`Start Odoo` box is checked, and click :guilabel:`Finish`. After
installation, the Odoo server runs, and automatically opens `http://localhost:8069` on a web
browser. The webpage should display the :abbr:`IoT (Internet of Things)` box homepage.
.. tip::
A :ref:`restart <iot/restart_windows_iot>` of the Windows IoT program may be necessary if the web
browser does not display anything.
.. _iot/config/homepage-upgrade:
Update from the IoT box home page
=================================
In the background, the :abbr:`IoT (Internet of Things)` box uses a version of Odoo code to run and
connect to the Odoo database. This code may need to be updated in order for the :abbr:`IoT (Internet
of Things)` box to operate effectively. This operation should be completed on a routine basis, to
ensure the :abbr:`IoT (Internet of Things)` system, and its processes, stay up-to-date.
Go to the :abbr:`IoT (Internet of Things)` box home page by navigating to :menuselection:`IoT app
--> IoT Boxes`, and clicking on the :guilabel:`IP address` of the :abbr:`IoT (Internet of Things)`
box. Then, click on :guilabel:`Update` (next to the version number).
If a new version of the :abbr:`IoT (Internet of Things)` box image is available, an
:guilabel:`Upgrade to _xx.xx_` button appears at the bottom of the page. Click this button to
upgrade the unit, at which point the :abbr:`IoT (Internet of Things)` box flashes itself to the
newer version. All of the previous configurations are then saved.
.. important::
This process can take more than 30 minutes. Do **not** turn off, or unplug, the :abbr:`IoT
(Internet of Things)` box, as it would leave it in an inconsistent state. This means the
:abbr:`IoT (Internet of Things)` box needs to be :ref:`re-flashed <iot/config/flash>` with a new
image.
.. image:: updating_iot/flash-upgrade.png
:align: center
:alt: IoT box software upgrade in the IoT Box Home Page.
Handler (driver) update
=======================
There may be some instances where drivers or interfaces need to be updated for individual devices
(e.g. scales, measurement tools, etc.). The IoT handler's (drivers and interfaces) code can be
modified by syncing them with the configured server handler's code.
This can be helpful in instances where :abbr:`IoT (Internet of Things)` devices (e.g. scales,
measurement tools, etc.) are not working properly with the :abbr:`IoT (Internet of Things)` box.
For both the Windows :abbr:`IoT (Internet of Things)` (Odoo 16 and higher) and physical :abbr:`IoT
(Internet of Things)` box, this process can be performed manually from the :abbr:`IoT (Internet of
Things)` box home page. Go to the :abbr:`IoT (Internet of Things)` box home page by navigating to
:menuselection:`IoT app --> IoT Boxes`, and clicking on the :guilabel:`IP address` of the :abbr:`IoT
(Internet of Things)` box.
Next, click :guilabel:`Handlers list`, and then select :guilabel:`Load Handlers` at the bottom of
the page.
.. image:: updating_iot/load-handlers.png
:align: center
:alt: Handlers list on an IoT box with the load handlers button highlighted.
.. important::
Handler's code is fetched from the configured server, and it needs to be up-to-date to have the
latest fixes and patches.
.. note::
A handler update is also performed automatically each time the :abbr:`IoT (Internet of Things)`
box is restarted. The only exception to this process is if the *Automatic drivers update* is
unchecked in the form view of the :abbr:`IoT (Internet of Things)` box on the Odoo server. This
setting can be reached by going to :menuselection:`IoT App --> Select the IoT box --> Automatic
drivers update`.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.0 KiB

@@ -1,314 +0,0 @@
========================
Connect Windows IoT Odoo
========================
A Virtual IoT box is a computer program that needs to be downloaded and installed on a Windows
computer. This requires a Windows operating system with an Odoo 16 or later database.
The Windows virtual :abbr:`IoT (Internet of Things)` box works the same way as a physical :abbr:`IoT
(Internet of Things)` box, with the ability to run most of the same devices. All :abbr:`POS (Point
of Sale)` devices work with it, such as a scale or printer. Payment terminals will also work, but it
should be noted that :abbr:`MRP (Material Requirement Planning)` devices are not compatible. *These
include cameras or measurement tools.*
Pre-requisites
==============
The following items will be needed to complete the Windows :abbr:`IoT (Internet of Things)`
installation.
- Odoo 16 database or any version above.
- :abbr:`IoT (Internet of Things)` compatible devices (except those mentioned above). Refer to:
`Odoo's compatible IoT devices <https://www.odoo.com/app/iot-hardware>`_.
- Device drivers for Windows.
.. note::
Odoo recommends using an updated, recent version of Windows (Windows 10/11) as some older
operating systems can cause the Windows virtual :abbr:`IoT (Internet of Things)` to not work.
- Windows computer (laptop, desktop, or server).
- Odoo :abbr:`IoT (Internet of Things)` subscription. Refer to: :ref:`iot/iot-eligibility`.
Connect the Windows virtual IoT box to an Odoo database
=======================================================
The Windows virtual IoT box is simple to setup in just a few easy steps. Follow this process when
installing the Windows virtual IoT software for the first time.
Download and initial installation
---------------------------------
To begin the installation, navigate to the Odoo 16 or higher installation package for Community -
Windows edition at `Odoo's download page <https://odoo.com/download>`_. Next, install and setup the
Odoo :file:`.exe` file. After the instructions screen, click :guilabel:`Next` to start the
installation and agree to the :abbr:`TOS (Terms of Service)`.
During the next step of the installation, select :guilabel:`Odoo IoT` from the :guilabel:`Select the
type of install` drop-down menu.
.. example::
For reference, the following should be installed:
- **Odoo server**
- **Odoo IoT**
- **Nginx WebServer**
- **Ghostscript interpreter**
Ensure there is enough space on the computer for the installation and click :guilabel:`Next`.
Setting the destination and completing the installation
-------------------------------------------------------
To complete the installation, select the :guilabel:`Destination Folder` and click
:guilabel:`Install`.
.. tip::
Choosing ``C:\odoo`` as the install location will allow for the Nginx server to start. If the
folder doesn't exist, then create it. Otherwise the installation files will be spread throughout
the hard drive.
.. warning::
Odoo's Windows virtual IoT software should not be installed inside any of the Window's User's
directories. Doing so will not allow for Nginx to initialize.
The installation may take a few minutes. When complete, click :guilabel:`Next` to continue.
Ensure that the :guilabel:`Start Odoo` box is checked and click :guilabel:`Finish`. After
installation, the Odoo server will run and automatically open `http://localhost:8069` on a web
browser. The webpage should display the :abbr:`IoT (Internet of Things)` box homepage.
.. seealso::
A restart of the Windows IoT program may be necessary should the web browser not display
anything. :ref:`iot/restart_windows_iot`
Connecting devices
------------------
Next, connect the :abbr:`IoT (Internet of Things)` devices to the Windows computer. Windows should
automatically detect the device because the driver is pre-installed on the computer. If not, search
for and install the Windows driver for the device.
.. important::
Most devices connect to the Windows Machine for Windows IoT automatically through Windows
Plug-N-Play (PnP). However, if Windows does not automatically recognize the device after
connecting, then the administrator may need to install the corresponding drivers manually.
Devices automatically recognized:
- Regular ink/toner based printers
- Receipt printers (Epson/Star)
- Barcode scanners
- Measurement devices (although some configuration of the measurement device settings is
required) See this documentation: :doc:`../devices/measurement_tool`
Devices not automatically recognized (requires manual driver download):
- Label printers (Zebra)
- Scales
Reference the manufacturer's website for the equipment in question. Then, download the drivers
and install them on the Windows machine. Reconnect the device in question and Windows will find
the device.
Following connecting devices to the computer, refresh the :abbr:`IoT (Internet of Things)` box
homepage and verify the device is seen. If not, reload the handlers through the :abbr:`IoT (Internet
of Things)` box homepage.
Finally, connect Windows :abbr:`IoT (Internet of Things)` to a database using existing instructions
(manually using the Token).
.. seealso::
:doc:`/applications/general/iot/config/connect`
Now the installation is complete, the devices connected to :abbr:`IoT (Internet of Things)` can be
used to complete processes/actions.
Troubleshooting
===============
.. _iot/restart_windows_iot:
Restart Windows IoT box
-----------------------
In some instances a manual restart of the physical :abbr:`IoT (Internet of Things)` box can resolve
the issue of an :abbr:`IoT (Internet of Things)` box not showing up on the database. For the Windows
virtual :abbr:`IoT (Internet of Things)` box a manual restart of the Odoo server can resolve
database connection issues.
To restart the virtual Windows IoT server:
#. Type `Services` into the Windows :guilabel:`Search Bar`.
#. Select the :menuselection:`Services` App and scroll down to the :guilabel:`Odoo` service.
#. Right click on :guilabel:`Odoo` and select :guilabel:`Start` or :guilabel:`Restart`. This action
will manually restart the Odoo IoT server.
Firewalls
---------
Firewalls keep devices safe and secure. Sometimes they can block connections that should be made
though. The Windows virtual :abbr:`IoT (Internet of Things)` box software may not be reachable to
the :abbr:`LAN (Local Area Network)` due to a firewall preventing the connection. Consult your local
IT support team to make exceptions (network discovery) in the :abbr:`OS (Operating System)` or
firewall program. Windows has their own firewall as do other virus protection programs.
.. example::
A client might encounter a time when they are able to reach the homepage of the :abbr:`IoT
(Internet of Things)` box, yet they cannot access it from another computer/mobile device/tablet
on the same network.
Making an exception on Windows Defender
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It is possible to allow other devices to access the Windows virtual :abbr:`IoT (Internet of Things)`
box while keeping the firewall on. This is done by creating a rule on *Windows Defender* and
allowing communication through port `8069`. The following process describes the steps to take in
order to make this exception.
Create a rule in Windows Defender
*********************************
First, open the *Windows Firewall* by navigating to the :menuselection:`Start Menu` and typing in
`Firewall`. Then, open the :menuselection:`Windows Defender Firewall` program. In the left-hand
menu, navigate to :guilabel:`Advanced Settings`.
Once :guilabel:`Advanced Settings` have been selected, click :guilabel:`Inbound Rules` in the
left-hand menu. Then, in the right-hand menu column (under :guilabel:`Inbound Rules`), click on
:guilabel:`New Rule` to create a new rule.
Configure new rule
******************
On the :menuselection:`Rule Type` screen, select :guilabel:`Port`. Then click :guilabel:`Next`. From
the :menuselection:`Protocol and Ports` page leave the rule application to :guilabel:`TCP`. Then,
select :guilabel:`Specific Local Ports` for the :guilabel:`ports` option. In the text box, type in
`8069, 443`. Finally, click :guilabel:`Next` to continue to the next step.
On the :menuselection:`Actions` page, select :guilabel:`Allow the connection` and click
:guilabel:`Next`. The following page on the :menuselection:`Rule Configuration` wizard is the
:guilabel:`Profile` page. On this page, select whichever connection type applies to the network the
Windows machine is operating on. Ideally, select :guilabel:`Private` only connections. The *Private*
connection type is the most secure connection while allowing the selected port to communicate. Click
:guilabel:`Next` to continue.
Finally, assign a new, unique name to the rule. For example, this name can be `Odoo`. Optionally,
add a brief description in the :guilabel:`Description` field. Click :guilabel:`Finish` to complete
the :guilabel:`Rule Configuration` wizard. Now, the new rule is active and devices can connect to
the Windows virtual :abbr:`IoT (Internet of Things)` box.
.. _iot/windows/wordline:
Worldline exception
~~~~~~~~~~~~~~~~~~~
*Worldline* is a payment terminal that can be connected to Odoo's *PoS* (point of sale) system. It
allows for a comprehensive and fluid payment experience for customers. Worldline is available in
Belgium, the Netherlands, and Luxembourg.
When using the Windows IoT server to connect the Worldline payment terminal, it is necessary to
create an exception in the Windows firewall so that a connection can be made between the Odoo
database/:abbr:`IoT (Internet of Things)` box and Worldline.
.. seealso::
:doc:`../../../sales/point_of_sale/payment_methods/terminals/worldline`
To create the exception, first, open the *Windows Defender Firewall* app on the Windows machine.
This can be accomplished by typing `windows defender` in the :guilabel:`Search` bar.
Next, click :guilabel:`Advanced settings` in the left menu.
.. image:: windows_iot/advanced-settings.png
:align: center
:alt: Advanced settings option highlighted in the left pane of the Windows Defender Firewall app.
In the left menu, choose :guilabel:`Inbound Rules`.
.. image:: windows_iot/inbound-rules.png
:align: center
:alt: Windows Defender left window pane with inbound rules menu item highlighted.
After selecting :guilabel:`Inbound Rules`, select :guilabel:`New Rule` in the far right menu.
.. image:: windows_iot/new-rule.png
:align: center
:alt: New rule dropdown shown with new rule option highlighted.
Then, for the :guilabel:`Rule Type`, select the radio button for :guilabel:`Port`. Click
:guilabel:`Next` to continue to the rest of the configuration.
.. image:: windows_iot/radio-port.png
:align: center
:alt: Rule Type window open, with the radio button next to port highlighted.
On the :guilabel:`Protocols and Ports` page, choose the radio button for :guilabel:`TCP`, under
:guilabel:`Does this rule apply to TCP or UDP?`.
Next, under :guilabel:`Does this rule apply to all local ports or specific ports?`, select the radio
button for :guilabel:`Specific local ports`. Then, enter `9050`, and click :guilabel:`Next` to
continue.
.. image:: windows_iot/protocol-port.png
:align: center
:alt: Protocol/port configuration window with TCP, specific port (9050) and Next highlighted.
The next screen is the :guilabel:`Action` page. Under :guilabel:`What action should be taken when a
connection matches the specified conditions?`, choose the radio button for :guilabel:`Allow the
connection`. Then, click :guilabel:`Next` to continue.
A :guilabel:`Profile` page appears. Under :guilabel:`When does this rule apply?`, leave the three
boxes checked for: :guilabel:`Domain`, :guilabel:`Private`, and :guilabel:`Public`. Click
:guilabel:`Next` to continue to the naming convention page.
On the :guilabel:`Name` page, enter `Odoo Worldline`, under the :guilabel:`Name` field. Enter a
:guilabel:`Description (optional)`. Finally, once ready, click :guilabel:`Finish`.
The final :guilabel:`Inbound rule` should appear as follows:
.. list-table::
:header-rows: 1
:stub-columns: 1
* -
- Odoo Worldline
* - Profile
- All
* - Enabled
- Yes
* - Action
- Allow
* - Override
- No
* - Program
- Any
* - Local Address
- Any
* - Remote Address
- Any
* - Protocol
- TCP
* - Local Port
- 9050
* - Remote Port
- Any
* - Authorized Users
- Any
* - Authorized Computers
- Any
* - Authorized Local Principals
- Any
* - Local User Owner
- Any
* - PolicyAppld
- None
* - Application Package
- Any
Uninstalling Windows IoT
------------------------
Uninstalling the Windows virtual :abbr:`IoT (Internet of Things)` box is done through the Windows
program manager. Using any Windows version, search for `program`. Then, select :guilabel:`Add or
Remove Programs` located in the control panel. Search for `Odoo` and click the :guilabel:`three dot
menu` to uninstall.
Confirm the un-installation and follow the steps to uninstall through the Odoo uninstall guide.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

@@ -0,0 +1,148 @@
=============================
IoT system connection to Odoo
=============================
Prerequisites
=============
To connect the IoT system to an Odoo database, the following prerequisites must be met:
- The Internet of Things (IoT) app must be :ref:`installed <general/install>`.
- The IoT system must be connected to the network.
- The computer connecting to Odoo must be on the same network as the IoT system.
.. note::
It is recommended to connect the IoT system to a **production** instance, as other types of
environments may cause issues (e.g., with :ref:`HTTPS certificate generation
<iot/https_certificate_iot/iot-eligibility>`).
.. seealso::
- :doc:`iot_box`
- :doc:`windows_iot`
Connection
==========
The IoT system can be connected to the Odoo database using a :ref:`pairing code
<iot/connect/pairing-code>` or a :ref:`connection token <iot/connect/token>`.
.. _iot/connect/pairing-code:
Connection using a pairing code
-------------------------------
.. note::
- The pairing code is displayed for up to 5 minutes after the IoT system starts. If the code is
no longer visible, reboot the IoT box or :ref:`restart the Windows virtual IoT service
<iot/windows_iot/restart>` to display the pairing code again. Alternatively, connect the IoT
system to the database using a :ref:`connection token <iot/connect/token>`.
- The pairing code is not displayed if the IoT system is already connected to a database (e.g.,
a test database).
#. Retrieve the IoT's system pairing code:
.. tabs::
.. group-tab:: IoT box
Connect the IoT box to an external monitor or printer. If the IoT box was already plugged
prior to this, reboot it by unplugging it for a few seconds and replugging it.
- External monitor: The pairing code should be displayed on the screen a few minutes after
rebooting the IoT box.
- Printer: The pairing code should be printed automatically.
.. tip::
If no external monitor or printer is connected to the IoT box, access the :ref:`IoT
box's homepage <iot/iot-box/homepage>`; the code is displayed in the :guilabel:`Pairing
Code` section.
.. group-tab:: Windows virtual IoT
On the computer with the Windows virtual IoT installed, open the IoT system's homepage
in a web browser by navigating to the URL `http://localhost:8069`. Then, scroll to the
:guilabel:`Pairing Code` section.
#. In Odoo, open the IoT app and click :guilabel:`Connect`.
#. In the :guilabel:`Connect an IoT Box` popup that opens, enter the :guilabel:`Pairing code`.
#. Click :guilabel:`Pair`.
.. _iot/connect/token:
Connection using a connection token
-----------------------------------
#. In Odoo, open the IoT app and click :guilabel:`Connect`.
#. In the :guilabel:`Connect an IoT Box` popup that opens, copy the :guilabel:`Token`.
#. Access the :ref:`IoT box's <iot/iot-box/homepage>` or :ref:`Windows virtual IoT's
<iot/windows-iot/homepage>` homepage.
#. In the :guilabel:`Odoo database connected` section, click :guilabel:`Configure`.
#. Paste the token into the :guilabel:`Server Token` field and click :guilabel:`Connect`.
.. _iot/connect/IoT-form:
IoT system form
===============
Once the IoT system is connected to the Odoo database, it is displayed as a card in the IoT app.
Click the IP address on the card to access the :ref:`IoT box's <iot/windows-iot/homepage>` or
:ref:`Windows virtual IoT's <iot/iot-box/homepage>` homepage. Click the card to access the
list of :doc:`devices <devices>` connected to the IoT system.
.. tip::
:ref:`Enable the developer mode <developer-mode>` to access the IoT system's
:guilabel:`Technical Information`, such as its :guilabel:`Identifier`, :guilabel:`Domain
address`, and :guilabel:`Image version`.
.. note::
By default, drivers are automatically :ref:`udpated <iot_updating_iot/handlers>` every time the
IoT system is restarted. To disable automatic updates, uncheck the :guilabel:`Automatic drivers
update` option.
.. _iot/connect/troubleshooting:
Troubleshooting
===============
The pairing code does not appear or does not work
-------------------------------------------------
The :ref:`pairing code <iot/connect/pairing-code>` might not be displayed or printed under the
following circumstances:
- The IoT system is not connected to the Internet.
- The IoT system is already connected to an Odoo database.
- The :ref:`pairing code <iot/connect/pairing-code>` display time has expired. Reboot the IoT box
or :ref:`restart the Windows virtual IoT service <iot/windows_iot/restart>` to display the pairing
code again.
- The IoT system's image version is too old and needs to be :ref:`updated
<iot/updating_iot/image-code>`.
The IoT system is connected but does not appear in the database
---------------------------------------------------------------
The IoT system might take a few minutes to restart when it connects to a database. If it still does
not appear after a few minutes:
- Verify that the IoT system can reach the database and the server does not use a multi-database
environment.
- Reboot the IoT box or :ref:`restart the Windows virtual IoT service <iot/windows_iot/restart>`.
The IoT box is connected to the Odoo database but cannot be reached
-------------------------------------------------------------------
Verify that the IoT system and the computer running the Odoo database are connected to the same
network.
The Windows virtual IoT's homepage cannot be accessed from another device
-------------------------------------------------------------------------
Check the :ref:`iot/windows-iot/firewall`.
The IoT system is disconnected from the database after an Odoo upgrade
----------------------------------------------------------------------
:ref:`Update the IoT system's image <iot/updating_iot/image-code>` by flashing the IoT box's card or
:ref:`uninstalling the Windows virtual IoT program <iot/windows_iot/uninstall>` and
:ref:`reinstalling <iot/windows-iot/installation>` the latest package for Windows **matching your
database's version**.
+6 -5
View File
@@ -6,6 +6,12 @@
Devices
=======
.. seealso::
- :doc:`Connect a Worldline payment terminal
<../../sales/point_of_sale/payment_methods/terminals/worldline>`
- :doc:`Connect an Ingenico payment terminal
<../../sales/point_of_sale/payment_methods/terminals/ingenico>`
.. toctree::
:titlesonly:
:glob:
@@ -16,8 +22,3 @@ Devices
devices/footswitch
devices/printer
devices/scale
.. seealso::
- :doc:`Worldline payment terminal
<../../sales/point_of_sale/payment_methods/terminals/worldline>`
- :doc:`Ingenico payment terminal <../../sales/point_of_sale/payment_methods/terminals/ingenico>`
Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Some files were not shown because too many files have changed in this diff Show More