From 81225fe2d67279a582d76e2ba275a1e4387521ac Mon Sep 17 00:00:00 2001 From: Ricardo Gomes Rodrigues Date: Mon, 19 Feb 2024 09:52:05 +0100 Subject: [PATCH] [IMP] l10n: update CodaBox documentation This commit updates the documentation of CodaBox: - new connection process - new revocation process - modified potential errors closes odoo/documentation#7771 X-original-commit: 2c6c7a0dcd23d85f7cc2e4e93618e2541e031a5a Related: odoo/enterprise#56888 Signed-off-by: Ricardo Gomes Rodrigues (rigr) --- .../finance/fiscal_localizations/belgium.rst | 187 +++++++----------- .../codabox_configuration_connection_ok.png | Bin 4987 -> 0 bytes 2 files changed, 76 insertions(+), 111 deletions(-) delete mode 100644 content/applications/finance/fiscal_localizations/belgium/codabox_configuration_connection_ok.png diff --git a/content/applications/finance/fiscal_localizations/belgium.rst b/content/applications/finance/fiscal_localizations/belgium.rst index 2bc850958..234da49ef 100644 --- a/content/applications/finance/fiscal_localizations/belgium.rst +++ b/content/applications/finance/fiscal_localizations/belgium.rst @@ -124,7 +124,7 @@ Categories`. Some categories already exist by default but do not have any rates. This makes the vehicle mandatory while booking a vendor bill. To link a disallowed expenses category with a specific account, go to :menuselection:`Accounting --> -Configuration --> Acounting: Chart of Accounts`. Find the account you want, and click on +Configuration --> Accounting: Chart of Accounts`. Find the account you want, and click on :guilabel:`Setup`. Add the :guilabel:`Disallowed Expense category` in the :guilabel:`Disallowed Expenses` field. From now, when an expense is created with this account, the disallowed expense is calculated based on the rate mentioned in the :guilabel:`Disallowed Expense category`. @@ -234,8 +234,7 @@ SODA files can be imported into the journal you use to record salaries by going to your Accounting **dashboard** and clicking :guilabel:`Upload` in the related journal card form. -Once your **SODA** files are imported, the entries are created automatically in your 'salary' -journal. +Once your **SODA** files are imported, the entries are created automatically in your salary journal. .. image:: belgium/soda-import.png :alt: Import SODA files @@ -245,7 +244,7 @@ journal. CodaBox ------- -**CodaBox** is a service that allows Belgian accounting firms accessing their clients' bank +**CodaBox** is a service that allows Belgian accounting firms to access their clients' bank information and statements. Odoo provides a way to import such statements automatically. .. note:: @@ -259,15 +258,15 @@ The configuration must be done on each client database. In the following instructions, we will refer to your client's company as *Company* and to your accounting firm as *Accounting Firm*. -You must first :ref:`Install ` :guilabel:`CodaBox` to start. +You must first :ref:`install ` :guilabel:`CodaBox` to start. .. important:: Make sure the company settings are correctly configured, i.e., the country is set to :guilabel:`Belgium`, the :guilabel:`Tax ID` and :guilabel:`Accounting Firm` fields are filled, - as well as the :guilabel:`Tax ID` of the accounting firm (unless it is the same as the - company's :guilabel:`Tax ID`). + as well as the :guilabel:`Tax ID` of the accounting firm (if not filled, the :guilabel:`Tax ID` + of the company is used). -Configure the Journals +Configure the journals ********************** .. tabs:: @@ -276,7 +275,7 @@ Configure the Journals #. :doc:`Create a new bank journal <../accounting/bank>`. #. Set the right IBAN in the :guilabel:`Account Number` field. - #. Select :guilabel:`CodaBox synchronisation` as the :guilabel:`Bank Feed`. + #. Select :guilabel:`CodaBox synchronization` as the :guilabel:`Bank Feed`. .. image:: belgium/codabox_configuration_coda_journal.png :align: center @@ -285,7 +284,8 @@ Configure the Journals .. tab:: For SODA files #. Create a new miscellaneous journal. - #. Go to :menuselection:`Accounting --> Configuration --> Accounting: CodaBox`. + #. Go to :menuselection:`Accounting --> Configuration --> Settings`, then go to the + :guilabel:`CodaBox` section. #. Select the journal you just created in the SODA journal field. .. image:: belgium/codabox_configuration_soda_setting.png @@ -294,54 +294,28 @@ Configure the Journals .. _belgium/codabox-configuration-connection: -Configure the Connection +Configure the connection ************************ -First, you must select which users can access the **CodaBox** connection settings. To do so, go to -:menuselection:`Settings --> Users & Companies --> Groups`, and search for the group -:guilabel:`Allow to show and modify the CodaBox Connection Settings`. Add the users you want -to this group. By default, only the :guilabel:`Administrator` is part of this group. +#. Go to :menuselection:`Accounting --> Configuration --> Settings`, then go to the + :guilabel:`CodaBox` section. +#. Click on :guilabel:`Manage Connection` to open the connection wizard, which shows the + :guilabel:`Accounting Firm VAT` number and the :guilabel:`Company VAT` number that will be used + for the connection. +#. If this is your **first connection**, click on :guilabel:`Create connection`. + The wizard confirms that the connection has been created on **Odoo's side**. Follow the steps + to validate the connection on **CodaBox's side**, too. -Then, to configure the connection itself, go to -:menuselection:`Accounting --> Configuration --> Accounting: CodaBox`. + If this is **not your first connection**, the :guilabel:`Accounting Firm Password` provided by + Odoo during the first connection will be requested to create a new connection. -The procedure differs depending on whether **CodaBox** is -being setup for a first client or an additional one. + .. note:: + This :guilabel:`Accounting Firm Password` is unique to Odoo and must be stored securely + on your side. -.. tabs:: +The :guilabel:`Status` should have now switched to :guilabel:`Connected`. - .. tab:: First connection - - #. Click on :guilabel:`Connect`, where you are redirected to - the **CodaBox** platform, here validate the connection. - #. Once redirected back to Odoo, the :guilabel:`Status` should be set to - :guilabel:`Connected` and a new field :guilabel:`Access Token` should appear - with a unique value generated by Odoo. - - .. image:: belgium/codabox_configuration_connection_ok.png - :align: center - :alt: Configured connection. - - .. note:: - This Odoo :guilabel:`Access Token` will be used to create new connections - for other clients without having to validate the connection again. - - .. tab:: Following connection - - #. Copy the :guilabel:`Access Token` from a previous connection. - #. Click on :guilabel:`Connect`. - - The **CodaBox** connection linked to the :guilabel:`Access Token` should still exist, - therefore there is no need to validate the connection again. A new and different - :guilabel:`Access Token` is generated by Odoo, and the :guilabel:`Status` should be set to - :guilabel:`Connected`. - - .. note:: - By having a different :guilabel:`Access Token` for each client, you can - easily revoke the access of a client to your CodaBox account without - affecting the other clients. One client cannot interfere with another. - -Synchronisation +Synchronization ~~~~~~~~~~~~~~~ Once the connection is established, Odoo can be synchronized with CodaBox. @@ -360,87 +334,78 @@ Once the connection is established, Odoo can be synchronized with CodaBox. .. tab:: For SODA files - SODA files are automatically imported from CodaBox once a day as draft. You do - not have to do anything. However, if you wish, it can also be done manually, - by clicking on :guilabel:`Fetch SODA's` in the Accounting Dashboard. + SODA files are automatically imported from CodaBox once a day as a draft. You do not have to + do anything. However, if you wish, it can also be done manually by clicking on + :guilabel:`Fetch SODA's` in the Accounting Dashboard. - By default, if an account in the SODA is not mapped to an account in Odoo, the Suspense - Account (499000) is used and a note is left in the created journal entry. + By default, if an account in the SODA file is not mapped to an account in Odoo, the Suspense + Account (499000) is used, and a note is added to the created journal entry. .. image:: belgium/codabox_dashboard_soda.png :align: center :alt: Manually fetch SODA's. .. note:: - You can access the mapping between the SODA accounts and the Odoo accounts by clicking - on the :guilabel:`SODA Mapping` button in - :menuselection:`Accounting --> Configuration --> Accounting: CodaBox`. + You can access the mapping between the SODA and Odoo accounts by going to + :menuselection:`Accounting --> Configuration --> Settings` and clicking on the + :guilabel:`Open SODA Mapping` button in the :guilabel:`CodaBox` section. -.. note:: - The connection between Odoo and CodaBox can be revoked by using the - :guilabel:`Revoke` button in the CodaBox settings, which will revoke - the link on Odoo's side only. - - If you have multiple connections, you will still be able to use the - Access Token of one of them to easily reconnect Odoo and CodaBox for - another client. - - However, if you have only one (remaining) connection, you will not be able - to use its Access Token to create new connections. In that case, you will - have to revoke the connection from the CodaBox platform too, - and then recreate a new one following the steps in the - :ref:`first connection ` section. Potential issues ~~~~~~~~~~~~~~~~ -CodaBox is not configured. Please check your configuration. - Either the Company VAT of the Accounting Firm VAT is not set. +* **CodaBox is not configured. Please check your configuration.** -It seems that the fiduciary VAT number you provided is not valid. Please check your configuration. - Either the Company VAT of the Accounting Firm VAT is in the wrong format. + Either the :guilabel:`Company VAT` or the :guilabel:`Accounting Firm VAT` is not set. -It seems that the fiduciary VAT number you provided does not exist in CodaBox. Please check your configuration. - The Accounting Firm VAT number you provided is not registered in CodaBox. +* **No connection exists with these accounting firms and company VAT numbers.** + **Please check your configuration.** -Error while connecting to the IAP server. Please contact Odoo support. - It seems that Odoo's IAP server is down or unreachable. Please contact - Odoo support. + This can happen when checking the connection status, and the :guilabel:`Accounting Firm VAT` and + :guilabel:`Company VAT` combination still needs to be registered. This may happen if you have + changed the :guilabel:`Company VAT` after the connection was established. For security reasons, + you have to :ref:`recreate a connection ` + for this :guilabel:`Company VAT`. -It seems that your CodaBox connection is not valid anymore. Please check your configuration. - It seems that you have either revoked the access of Odoo to your CodaBox account, or that - you have not completed the configuration process. In this case, you must click on the - :guilabel:`Revoke connection` button in the settings, and follow again the steps in - the :ref:`first connection ` section. +* **It seems that your CodaBox connection is not valid anymore. Please connect again.** -A previous CodaBox registration already exists. Paste the access token from a previous connection here. Odoo will generate a new one, exclusive to this database. - It seems that you have already your Accounting Firm with Odoo, but that the Access Token - is either not filled or wrong. You should follow the steps in the - :ref:`following connection ` tab section. + This can happen if you revoke Odoo's access to your CodaBox account or still need to complete + the configuration process. In this case, you must revoke the connection and create a new one. - If you have lost your Access Token, you have to go on the CodaBox platform, - and revoke the access of Odoo to your CodaBox account. Then, you will have to follow - the steps in the :ref:`first connection ` section. +* **The provided password is not valid for this accounting firm.** + **You must reuse the password you received from Odoo during your first connection.** -The provided access token is not valid for this fiduciary. Please check your configuration. If you have lost your access token, please contact Odoo support. - Same as above. + The password you provided is different from the one you received from Odoo during your first + connection. You must use the password you received from Odoo during your first connection to + create a new connection for this accounting firm. If you have lost your password, you must first + revoke the Odoo connection on CodaBox's side (i.e., on your myCodaBox portal). Then, you can + revoke the connection on Odoo's side and + :ref:`create a new one `. -It seems that no connection linked to your database/VAT number exists. Please check your configuration. - You may obtain this error when revoking or trying to fetch files from CodaBox if - the pair (Accounting Firm VAT, Company VAT) is not registered yet. This may happen if - you have changed the company VAT after the connection was established for instance. - For security reasons, you have to recreate a connection for this company VAT by following the - steps in the :ref:`first connection ` section. +* **It seems that the company or accounting firm VAT number you provided is not valid.** + **Please check your configuration.** -No files were found. Please check your configuration. - This may occur if the company VAT has changed after the connection was established. - In that case, you must click on the :guilabel:`Revoke connection` button in the settings, - and recreate the connection. + Either the :guilabel:`Company VAT` or the :guilabel:`Accounting Firm VAT` is not in a valid + Belgian format. -It seems you have already created a connection to CodaBox with this fiduciary. To create a new connection, you must first revoke the old one on myCodaBox portal. - You must go on the CodaBox platform, and revoke the access of Odoo to your CodaBox account. - Then, you will have to follow the steps in the - :ref:`first connection ` section. +* **It seems that the accounting firm VAT number you provided does not exist in CodaBox.** + **Please check your configuration.** + + The :guilabel:`Accounting Firm VAT` number you provided is not registered in CodaBox. + You may not have a valid CodaBox license linked to this VAT number. + +* **It seems you have already created a connection to CodaBox with this accounting firm.** + **To create a new connection, you must first revoke the old one on myCodaBox portal.** + + You must go to your myCodaBox portal and revoke Odoo's access to your CodaBox account. + Then, you can :ref:`create a new connection ` + on Odoo's side. + +.. tip:: + To revoke the connection between Odoo and CodaBox, go to + :menuselection:`Accounting --> Configuration --> Settings`, scroll down to the + :guilabel:`CodaBox` section, click on :guilabel:`Manage Connection`, then click on + :guilabel:`Revoke`. Electronic invoicing ==================== diff --git a/content/applications/finance/fiscal_localizations/belgium/codabox_configuration_connection_ok.png b/content/applications/finance/fiscal_localizations/belgium/codabox_configuration_connection_ok.png deleted file mode 100644 index b07582fa2fa472bd0e174e13b7b671c358cd9cdf..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 4987 zcmZ{oc{tRMx5tIDga#2qgve5ZWJw~EWh(o=YeZt0?8d&2eX@-0YYUOx*cxJpAw=2t zEz8&mQ+7VL@9(+yKKGyd$2sqF{y5M1=XK8WoD;31rOrqXrl+8wV0;Es(W9Wa1pgbq zr=|MqHx}Guf zh}HFN*BADFVezt1W9wHg)3XargiZiBiHJ+Bu4__!s&{$;=&I_HR@Qs^h8BM=FXsjC zlYeh*ZUYw^z)+rtrc-u)DR4I871A|K27t5qtJ-}{rVHs`& zIN*dHV} zU@+Kh`B%9YOU+M0zRIduz*P18^*oFX%(ekwbz^b-43Kjyw@BocRdaHCUD2P0h$il^ z#z|u{^9F{-hc~u?d0d+}Vs>aU`^z5idnM2C4Y1J}t@Ea>Zy`97R~Bj)osdzLQ6?3C z>y&`b3ihge`DSBhx7NWiH!QVi9f&PjX2et*2uNWI#9z||_NU~I=*+g}kvgI*J+wmBND~$#e{}lRzGO#P$9II9I9l6>f1U@deX()o zdgr9>Cz^H}W8Z>TE*eG;-j{#>-Ik1U#MJnp!ZT-1wu&4IxG2|p?v&<5U(M{p@YTQ4wja9 zOhiTJB=R*9`^I%`?eKeBceRJUeQ4oAUHp|$Y+Ff6*Y|*!nu+uwf)c(`FZR|5>D(Pt zn{9`P&J&6?ba(1$`Pr@CFyBr0A(ywTp*0RA*D;&6cX27a%riQ3;b5X;t_6c~qtC^} zRA?rT&D9L1mH672gx0Bd%q&kQH0}YZ{+Q>P62NNQ)im#KUtl>40IDXqzE-*@xE5NU zR?_BJNH8EpC-jxmZctEw_@1dK8=$7Pvgu6pjoE|W!YJtyXsAQ^?h1lH5}@lUy`s}P z7QxC-lq2$Kqps_w%Xc!~7%>uss9JoDFmkzsA1v`Kn{p+_mljl*8CaBha#jqFt;<;V z6U0Ms*HvG^moMh+_vgM7#CwAJA06Ia5rJN(kAUXs2>+G+ASU8RCM$lr%BzPPxgsbH z&ALYtz$dQxALq6@nX^{b#oBVUr3jju#qK;1Q5!Oae+4TaX1ErP?PW}>A4Le$LMG4&&!`+R>}~l!TvJF*ei-inVR0`kSf@2&hfRLx&s$C<4H1Wuc98P2A4NwaKgj&O zNeXobEVnV@r*!9vs2106_)qvZwOnK0F8lSJmUP9(wOnAU@0j7Uws z+VG(Hc&E2T5rME}Zh=N0dzoXb2F14iuxWSuIiB=r!LAg^aq)XmZVo^EPLu) zbKsJXX^pHRIm_INtxIk19(f{78hg9fY?9i{?fEc|MsW3wCuYA$3OwQx{0Hw%ckAL` zPQ-O>rf4a&PKw<;E<|(qZm!s+x;_Z~LoX*RTj(dp63b`)d8Rj7J`0m@O2BdxG+<@s zd<_LmOVMZv@y`@@zF&EaQ$K_^L&-(R@lceKNTOW0ls;`{UQd z6~9+44K688%W9*R0lS^`wCNF7jr$8{o~%8;u246NG&v8aJ6LR}jC`K!jbW^pPP8^z#r&_%P!lAEHi_!1xYQz6h`P=qp1)I74@83JAj?@CjIK+lM zLC=FVWOirQo(($xv0SB5l?ztubZv*c962PJxJ(};BM=u&P1^7Mb7p~?d7k=`DXQf* z*QP3eqBbg$o%!3=NP_IvC|XRP7)ta#$7jF|8bc8+1qR&35L6ZR5a><-RJGpG> zIF=tg+e)w-+N8jYboga~&K%wewiE~C5jqv#P0uQHmNDPAD=;&~b&i3PE=A4W)?>Vr z<)|0sMeD_OeniE03N^C2(ozjCXJe~0&zFfK_3sX3+Zai(tgg)bMA${cJW~f`?oPX> zo!^icF@-9Y=e+aYm<(wYDKnGW3Z&fs1x~uTAJ5}un;Ioul9csa+8lir8FZIPDCB)M-FlZY^3HJ9{QsTz=QK+RTOugIJq@ol?$8@|%sopv z$4CABAUuQyePJ!F9otnbQy9wQBkFCAQB^s-&8A;#4?R$Zn9zU1*lIzfbW8{DxDaJx z)yp0ZW-ydl9Z6p+6#NR^lKmjS`0hTkM(n;1l6Voo@9`%ei;Qizo{?yE z`yCXV!RH6j@V;CVY*|IM2&`ZGHuN#AX8sztSOrxT;-dN)?{3%nYqWF!8ge9d+xMr;p!!&j) z^}d}ti}e>=41)h8j8R)7CN}m_G^5n4KVs~oohx{%+<2tJ?yVO@Z7iB~yT{LRPxqDC zvn+_br;KDTGvmz~)xN&$wTRCTji1#dXI>l`t*j^v(=f5T%M}%ZoU%L|ss$UFnPwaG zIf9xa`mvqa3>$lt=mO0E4H&44+C|eJRD&bA@!`#;+^AG+(u3brMvFid1sViwOo-4t ziC_h!&BhlnhPgB$OgI>U2uTRprsWWK9^R$E2)&qy?|ULF3&K zDHrSh0h{CQdky!V=A@Ef3Ph?4F`1PBws*E+)~|wC7Owc7VNxFThx3f)9RWkh+f>!d zxG|SAds&6L$d|zd1_g4xl5i;$T6;X!i_BUiL~k^bwJbLNmfcnYNqMm1fW8+|z}>(y zkwB{%Z8yFzKY!>l0Es> zG)(~8sf^`6+aVmX^Y0#@NnsyPZLQ6&S8`;jy16;oC`ej(5iBL+80Rk<@n(B+*nT8~ zi-sJImrdxzSCAXF594SSZZ`YLkPLVbD=SUFP#f+Nlu|HtM8&;Cx*|i=c%+!~KY}pX zlmQL~E_c`EtM`~S)EPKFwbu#;nDHFcccJaVXeOkpo_-sx3xO9ou~Wk@f~N%*wl!O` zWtiAnmLf_|Cr-=s-4uU6g*@)gnSY(ha`p%=VG%{9>ky;!3BLmgdwf^x#`c5eM%xic z((M?w(+MZ$Di7B331MyWpU^nTOzZ7U>AJ|O0H;NL#uv&g_k+2p_%f+S@-@RPAjaL7 zQ=rCceDN}p(gQLYpQ9uAZ!fxO_Hcgbr1Cc*euaj~kav+Ude8l9h77G(XrazATvO%F zxFk`@Vp|i zg%?)HWLtk)K_CY>Y{o63(8fsj8<{g54G&`f*i%;L>&Gb-)elb^s7RWY-j}2*DbV4% zJ!(T8@A=$8|91rKsG*LTxm_Kt>lIlY#J$fI$jw+L?jy&lPqGKr6Fxb9AcR zc#2oS8JP@6O#F9^6U0XKIHSjD!;?QmtCQgBVbTBq_2{-Z!71e%qKvj(N$!oA{Zr z6yBa$!7|6qa@6x!)t`k?tct9Dw=~o&DIIeeETH$Oc_Uq9w$x2m$tV5OEAnla z_sMChbCV_}@M_mEY?#kLzG8dIZ~5I z`V=N)ExHes2J30O-1h>1_=$rC??_3{xNM(iz=xG9_HcZuf>w!E%f^04aI{TT$>^Tr zzZXu{S+`}c9(oq%7T>{PEZl3z8}EV#%hwu`?h&8+FOlMnsY=>j1-4TdiTLby%BV8N zDf0U~`&_?TXYS`1jKsTt6mWkE_fag|1c_Nnm3RctOT5|hMtp~oy+3VxH80oREH1Nq z{0^f$fy?j9X>K-~QW2d!tQ)fHFOh=n{}2fx7;P^eVQ&bsD-SRZ&K%=$i8iYHzoK#7XeA?UiLXc(u8TDPPUyu#V4SqSkU zvH_{?@-Rq;j4v))H9JNO`qaN$>!EeWfC;nRuxeETkJ#sP7R!E-ych6h$6XJmXHlnUgHi!<~@4 zZ};SQR+}c06jz}=W~#vF(jp9~rMg!$^Njg-JG|s9B1WasRba>-LWbzyvOL7qpGEnz z?nLpme3{!JUz6NnkqV9xlkpL2P3mbb)z;{pq28v(baAw@gs_J@IvAG2KcUj{n)#sVfPXf&#Pl%n}A0(elzmhJS4XRBtt zDlqB^98b*&lN6syHAuaN+k&#(bYz*o8U=usQYzUeG$GIm-@O6V{p7|M=!EC?o||OL zHrn*nKZa*!01NH4RoC;OKk~lF*|dhf@jh74KJKa1!NHz?n%pgT*Q;XF4>!s#y