Compare commits

...

217 Commits

Author SHA1 Message Date
Vincent Larcin 9113ed2cca [IMP] *: standardize spelling of “cancelled” across documentation
In https://github.com/odoo/odoo/pull/129722, we settled on using the spelling “cancelled”,
and removed all occurrences of “canceled” from the codebase.

This commit does the same for the documentation.

Task-3951276
2024-05-31 17:20:38 +02:00
Felicious add4cb8a04 [ADD] inventory: print delivery slip
closes odoo/documentation#9537

X-original-commit: 05cd6af1ed
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: brse-odoo <brse@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-31 08:11:47 +00:00
Lara Martini (larm) 34c303ecea [ADD] Frontdesk: moving visitors section to new doc
closes odoo/documentation#9533

X-original-commit: cb644b0834
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-05-31 08:11:46 +00:00
Felicious fd9e326ca6 [ADD] inventory: locations dashboard
closes odoo/documentation#9529

X-original-commit: 6bfa0802c7
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: larm-odoo <121518652+larm-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-30 01:01:37 +00:00
KC (ksc) 42b16e1347 [ADD] events: event templates doc
closes odoo/documentation#9517

X-original-commit: fb2f1d5f8b
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2024-05-29 23:43:22 +00:00
jero-odoo 2df60cb372 [REM] crm: generate leads
closes odoo/documentation#9516

X-original-commit: e59188d85b
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2024-05-29 23:43:21 +00:00
Felicious 08fbc57c22 [IMP] inventory: sendcloud shipping info
closes odoo/documentation#9490

X-original-commit: 6305211a1e
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: hojo-odoo <123424465+hojo-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-29 21:32:43 +00:00
Yaroslav Soroko (yaso) af310bfeff [IMP] point_of_sale: Setup all Ingenico terminals
Currently we only tell how to setup Ingenico Lane/5000 terminal.
Actually, Lane/5000 and Move/5000 can be set up in almost the same way,
only the button to enter settings is different.

This PR adds a more generic configutation guide applicable  to all the
Ingenico Lane/Desk/Move terminals

Also, it replaces erroneous Worldline mention in the top by Ingenico

task-3879038

closes odoo/documentation#9498

X-original-commit: 23a1c496bf
Signed-off-by: Yaroslav Soroko (yaso) <yaso@odoo.com>
2024-05-28 18:49:22 +00:00
Lara Martini (larm) 6c9e6b94e8 [ADD] Employees: new departments doc
closes odoo/documentation#9484

X-original-commit: 714b75ce3b
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-05-28 18:49:21 +00:00
Lara Martini (larm) 0cd769549c [ADD] Time Off: Moving TO request to new doc
closes odoo/documentation#9482

X-original-commit: 59ba096ee2
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-05-28 18:49:20 +00:00
Lara Martini (larm) 6ac164fdf7 [ADD] referrals: moving share jobs section to new doc
closes odoo/documentation#9481

X-original-commit: 4e929b4ebc
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-05-28 18:49:19 +00:00
John Holton (hojo) a208a077dd [ADD] Manufacturing: Dropship subcontracting lead times
closes odoo/documentation#9421

X-original-commit: 62b02031fa
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: John Holton (hojo) <hojo@odoo.com>
2024-05-28 18:49:17 +00:00
John Holton (hojo) ddf5d2ca5a [ADD] Manufacturing: Resupply subcontracting lead times
closes odoo/documentation#9418

X-original-commit: 1929185270
Signed-off-by: John Holton (hojo) <hojo@odoo.com>
2024-05-28 18:49:16 +00:00
jero-odoo fa6bc19ecb [ADD] crm: email and manual leads
closes odoo/documentation#9483

X-original-commit: 905914c939
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: brse-odoo <brse@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-28 17:29:29 +00:00
Jonathan 64b2295cd4 [IMP] inventory-mrp: rename the category into Supply Chain
closes odoo/documentation#9467

X-original-commit: 9f279170a5
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-05-24 18:06:21 +00:00
Donatienne (dopi) 4b67e08dcb [IMP] website: google search console
taskid-3932743

closes odoo/documentation#9402

X-original-commit: abf62125ea
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Donatienne Pirlot (dopi) <dopi@odoo.com>
2024-05-24 09:02:38 +00:00
jero-odoo 8b69948613 [MOV] helpdesk: move getting started, reorg toctree
closes odoo/documentation#9457

X-original-commit: 5c781afe88
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2024-05-23 19:11:00 +00:00
Felicious 9d6c7600d4 [ADD] inventory: aging report
closes odoo/documentation#9451

X-original-commit: de7fd89137
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: Jess Rogers <104637850+jero-odoo@users.noreply.github.com>
Co-authored-by: Zachary Straub <zst@odoo.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-23 19:10:54 +00:00
Vincent Larcin ac5f9cd28e [IMP] developer/view_architectures: new date filters
Task-3692123

closes odoo/documentation#9398

Related: odoo/odoo#156746
Related: odoo/enterprise#59901
Related: odoo/upgrade#6034
Signed-off-by: Vincent Larcin (vila) <vila@odoo.com>
2024-05-23 16:31:34 +00:00
Lara Martini (larm) 5b82c8cb00 [ADD] Appraisals: Moving goals to new doc
closes odoo/documentation#9446

X-original-commit: 9fb69e4eaf
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-05-23 14:12:03 +00:00
kcv-odoo 2adc169aec [IMP] developer/js_reference: new attribute for m2m_tags
task-3526304

closes odoo/documentation#9438

Related: odoo/upgrade#6039
Related: odoo/enterprise#62721
Related: odoo/odoo#165935
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-05-23 11:01:06 +00:00
jero-odoo 7fe5675144 [IMP] CRM: lead mining 17
closes odoo/documentation#9420

X-original-commit: 430f7e2307
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
Co-authored-by: Zachary Straub <zst@odoo.com>
2024-05-21 11:53:14 +00:00
Felicious 3941c8191e [ADD] inventory: moves history report
closes odoo/documentation#9428

X-original-commit: 6920015971
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: brse-odoo <brse@odoo.com>
Co-authored-by: Zachary Straub <zst@odoo.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-20 19:07:54 +00:00
Felicious 9ae8bee50f [IMP] mrp: assign lot/serial number to manuf products
closes odoo/documentation#9419

X-original-commit: 6738b2cbea
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-19 07:31:56 +00:00
Valentino 6120d187ed [IMP] accounting/l10n_br: electronic invoicing & tax computation flow
With the addition of l10n_br_{avatax,edi,edi_sale}_services to the previous modules, now electronic invoices and tax computation for services can be created from Odoo through Avalara.

PR that includes these features: https://github.com/odoo/enterprise/pull/57868

This PR includes the necessary information to use these new modules - configuration and workflows.

closes odoo/documentation#9409

X-original-commit: 20282cdb4c
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-05-17 22:17:49 +00:00
Felicious c7f385fee3 [IMP] mrp: overhaul bom basics 17.0
closes odoo/documentation#9406

X-original-commit: 4d211ed914
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: hojo-odoo <123424465+hojo-odoo@users.noreply.github.com>
Co-authored-by: Zachary Straub <zst@odoo.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-17 22:17:47 +00:00
tiku-odoo 431f88f955 [IMP] finance: avatax version 17 updates
closes odoo/documentation#9393

X-original-commit: f80a74f460
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-05-17 20:48:17 +00:00
Felicious e8e9f86b8f [IMP] inventory: fix lot assignment
closes odoo/documentation#9392

X-original-commit: 7e37903b8f
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: Jess Rogers <104637850+jero-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Timothy Kukulka <91896312+tiku-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-17 20:48:16 +00:00
jero-odoo a28a65a373 [ADD] CRM: contact form leads
jero edits

closes odoo/documentation#9386

X-original-commit: 50b3852bab
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: larm-odoo <121518652+larm-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-17 20:48:15 +00:00
Sam Lieber (sali) f0b25461c7 [FIX] extensions: icon_role fa icons
closes odoo/documentation#9383

X-original-commit: d71c19b7be
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-05-17 20:48:14 +00:00
Lara Martini (larm) 04b8762b51 [IMP] payroll: added needed module info
closes odoo/documentation#9366

X-original-commit: e8a260f20a
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-05-16 17:38:42 +00:00
maya-odoo 652bead830 [IMP] accounting/l10n_hk: add Hong Kong payroll
Impacted Version:

- 17.0 and above

This commit improve below features:

- Add Hong Kong payroll documentation

closes odoo/documentation#9364

X-original-commit: a08fc7db34
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-05-16 17:38:41 +00:00
Lara Martini (larm) fab3e9f352 [IMP] Recruitment: instructions and images for 17
closes odoo/documentation#9363

X-original-commit: 1f5a41a209
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
Co-authored-by: StraubCreative <zst@odoo.com>
2024-05-16 17:38:40 +00:00
Brandon Seltenrich (BRSE) 74884ff81c [IMP] purchase: replace vendor bills screenshots
closes odoo/documentation#9369

X-original-commit: e25de2b5b5
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-05-16 12:49:11 +00:00
jero-odoo c3e4d920d3 [ADD] Purchase: Vendor costs
closes odoo/documentation#9368

X-original-commit: 34598f13bf
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: hojo-odoo <123424465+hojo-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-16 12:49:10 +00:00
Brandon Seltenrich (BRSE) a2d4bc6956 [IMP] purchase: replace purchase uom screenshots
closes odoo/documentation#9367

X-original-commit: ba97b13527
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-05-16 12:49:09 +00:00
KC (ksc) ff0a767f79 [ADD] events: adding create events doc
closes odoo/documentation#9365

X-original-commit: 6ebd27144b
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2024-05-16 12:49:08 +00:00
Felicious 9264fe40be [ADD] inventory: stock report
closes odoo/documentation#9347

X-original-commit: 8aa219a7fd
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: larm-odoo <121518652+larm-odoo@users.noreply.github.com>
Co-authored-by: Zachary Straub <zst@odoo.com>
2024-05-16 00:01:58 +00:00
Loan (LSE) c636893e32 [IMP] general: iot add payment terminals link
closes odoo/documentation#9336

X-original-commit: 258636564e
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
2024-05-15 00:28:58 +00:00
mjvi-odoo fbfb81d80c [IMP] sales: add sample pdf quotaion file added
task-3645924

closes odoo/documentation#8391

Related: odoo/upgrade#5644
Related: odoo/enterprise#61325
Related: odoo/odoo#152270
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-05-14 18:18:09 +00:00
KC (ksc) a9620242af [FIX] subscriptions: modified detail re: prorated warning
closes odoo/documentation#9338

X-original-commit: 9543b25714
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2024-05-14 13:05:58 +00:00
KC (ksc) 3ca0a69957 [FIX] sales: corrected pricelist configuration detail
closes odoo/documentation#9337

X-original-commit: d00c04e259
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2024-05-14 13:05:57 +00:00
KC (ksc) 085320a86d [FIX] sales: fixed a loyalty card specificity
closes odoo/documentation#9335

X-original-commit: 214fed5fdf
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2024-05-14 13:05:56 +00:00
Samuel Degueldre 2c5c43c474 [IMP] developer: add an article to explain error handling in JS
closes odoo/documentation#9310

X-original-commit: 489fe7d3ea
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2024-05-14 08:41:55 +00:00
Brandon Seltenrich (BRSE) 26edc3c56b [IMP] inventory: update scrap doc
closes odoo/documentation#9311

X-original-commit: 2d0f640223
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-05-13 21:46:56 +00:00
Felicious 8bbfebea55 [IMP] inventory: purchase security lead time
closes odoo/documentation#9303

X-original-commit: 71577350e9
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: brse-odoo <brse@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
2024-05-11 16:43:43 +00:00
Felicious 85fda3e9e1 [ADD] inventory: reassign lots/serial numbers
closes odoo/documentation#9302

X-original-commit: 57de351036
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: Jess Rogers <104637850+jero-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-11 16:43:42 +00:00
tiku-odoo 98f9fa803e [ADD] finance: avalara portal
closes odoo/documentation#9296

X-original-commit: 38fa0d3a4e
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-05-10 18:57:21 +00:00
Felicious 6a0bb6ba9f [IMP] inventory: stock input + output account fix
closes odoo/documentation#9287

X-original-commit: b5a80eed7b
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: Zachary Straub <zst@odoo.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-10 15:32:51 +00:00
tiku-odoo 50bd2e0d42 [IMP]accounting: avatax api integration rewrite
closes odoo/documentation#9281

X-original-commit: fe3cbf7231
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-05-10 14:13:33 +00:00
tiku-odoo c743f44177 [IMP] finance: avatax use add logging
closes odoo/documentation#9273

X-original-commit: 314ddb2de3
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-05-09 20:50:40 +00:00
jero-odoo f5aaeb524e [IMP] Helpdesk: Reporting 17
closes odoo/documentation#9270

X-original-commit: f036553f5a
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: Felicia Kuan <feku@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-09 20:50:39 +00:00
jero-odoo 7524eccaef [REM] CRM: multi teams
closes odoo/documentation#9269

X-original-commit: 2a9bd10799
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2024-05-09 20:50:38 +00:00
Brandon Seltenrich (BRSE) 5c645508d4 [IMP] inventory: update two step doc copy
closes odoo/documentation#9259

X-original-commit: 5f5deac264
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-05-09 19:36:56 +00:00
John Holton (hojo) b6fef3dec0 [MOV] MRP: Create subcontracting scope
closes odoo/documentation#9102

X-original-commit: d38eb79411
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: John Holton (hojo) <hojo@odoo.com>
2024-05-08 20:32:56 +00:00
Sam Lieber (sali) 7e04e250b0 [IMP] extensions: icon_role odoo ui
closes odoo/documentation#9252

X-original-commit: a39903ca12
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-05-08 19:21:56 +00:00
jero-odoo 6f4f511b34 [ADD] CRM: manage sales teams 17
closes odoo/documentation#9250

X-original-commit: 25f44f7ac2
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: brse-odoo <brse@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-05-08 18:04:43 +00:00
John Holton (hojo) fb5fc7915c [IMP] Manufacturing: Subcontracting overview
closes odoo/documentation#9063

X-original-commit: 5c41d20474
Signed-off-by: John Holton (hojo) <hojo@odoo.com>
2024-05-08 18:04:40 +00:00
KC (ksc) 89d3907b4f [IMP] surveys: time_random rewrite for questions
closes odoo/documentation#8847

X-original-commit: 45c5d9eef4
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2024-05-08 16:51:38 +00:00
Brandon Seltenrich (BRSE) 2a3117dfee [IMP] inventory: update create second warehouse doc
closes odoo/documentation#9224

X-original-commit: 860befac4a
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-05-08 15:33:30 +00:00
Brandon Seltenrich (BRSE) c9f1bf7df8 [IMP] inventory: update one step shipments doc
closes odoo/documentation#9220

X-original-commit: 7cf04c1dba
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-05-08 14:11:52 +00:00
XPL f7769365bc [IMP] settings: simplify the developer mode page
task-3849915

closes odoo/documentation#9238

X-original-commit: 67f02edd7b
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-05-08 10:25:40 +00:00
tiku-odoo 364d997cae [IMP] sales: amazon connector add fba warning block
closes odoo/documentation#9232

X-original-commit: ee2b0e4a66
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-05-07 13:38:10 +00:00
Donatienne (dopi) 692b932eed [IMP] Documents: updating documentation
taskid-3778148

closes odoo/documentation#9150

X-original-commit: de9e726858
Signed-off-by: Donatienne Pirlot (dopi) <dopi@odoo.com>
2024-05-07 12:22:37 +00:00
Tiffany Chang (tic) 508c7aeccc [I18N] *: export latest terms
closes odoo/documentation#9082

X-original-commit: 697f78e513
Signed-off-by: Louis Wicket (wil) <wil@odoo.com>
Signed-off-by: Tiffany Chang (tic) <tic@odoo.com>
2024-05-07 08:24:59 +00:00
“Audrey f603ac5624 [IMP] Studio: update automation rules doc for v17
task-3745330

closes odoo/documentation#9204

X-original-commit: 3140917a53
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
2024-05-07 07:08:26 +00:00
Antoine Vandevenne (anv) 6332d389f9 [FIX] reference/view_architectures/*: remove nosearch meta directives
The `nosearch` meta directive is not fully supported in included files:
the generated file is excluded from search results, but the "nosearch"
term is present in the included content.

closes odoo/documentation#9191

X-original-commit: 298a222d00
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-05-07 07:08:25 +00:00
Samuel Degueldre 59e8cb1c3a [FIX] developer: rewrite a bunch of outdated info in JS reference
Previously, a lot of information on the JavaScript reference page was
outdated.

This commit rewrites a bunch of sections to bring them up to date and
removes others that are no longer relevant. While a more profound rework
of the JS documentation is still needed, this commit at least reduces
the amount of outdated information significantly in the meantime.

closes odoo/documentation#9203

X-original-commit: 2354f0946e
Signed-off-by: Samuel Degueldre (sad) <sad@odoo.com>
2024-05-07 05:56:26 +00:00
tiku-odoo e0e2200a60 [ADD] finance: avatax tax calculation
closes odoo/documentation#9218

X-original-commit: 41b6e2f227
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-05-07 00:49:54 +00:00
Brandon Seltenrich (BRSE) 8e5c99f42a [IMP] inventory: update wh/loc doc
closes odoo/documentation#9202

X-original-commit: 66fc5639b6
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-05-07 00:49:51 +00:00
Brandon Seltenrich (BRSE) c529500e6a [FIX] inventory: fix manufacturing lead time section
closes odoo/documentation#9201

X-original-commit: 4a066cb017
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-05-07 00:49:50 +00:00
XPL 95739dc0fc [IMP] website: warn about privacy regulations for recaptcha and gtm
task-3896553
task-3896425

closes odoo/documentation#9186

X-original-commit: 79b383ddcf
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-05-06 18:17:27 +00:00
jero-odoo 0180929780 [IMP] Helpdesk: customer ratings
closes odoo/documentation#9177

X-original-commit: c19f71fd4c
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: Timothy Kukulka <91896312+tiku-odoo@users.noreply.github.com>
2024-05-06 14:11:08 +00:00
jero-odoo da8e2dfe6a [ADD] email marketing: analyze metrics
closes odoo/documentation#9173

X-original-commit: 753d561fe8
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: larm-odoo <121518652+larm-odoo@users.noreply.github.com>
2024-05-06 14:11:06 +00:00
Lara Martini (larm) 980d9f67c5 [MOV] fleet: config doc to parent
closes odoo/documentation#8848

X-original-commit: 62f6502d61
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-05-06 14:10:59 +00:00
XPL 44e3bd028b [IMP] accounting: change the lock date warning to an optional tip
task-3787113

closes odoo/documentation#9170

X-original-commit: 5c84c9fc7f
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-05-04 02:03:49 +00:00
Donatienne (dopi) fae4de26f2 [ADD] Website: features blocks
task-3733828

closes odoo/documentation#9155

X-original-commit: 9e6572ad08
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-05-04 00:40:01 +00:00
Lara Martini (larm) 0865e62d5f [IMP] referrals: update pics and remove save button
closes odoo/documentation#9144

X-original-commit: acb0a1cc5f
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-05-03 20:52:58 +00:00
jero-odoo d4da0c2425 [IMP] CRM: rewrite gamification config section
closes odoo/documentation#9141

X-original-commit: fd17dcef90
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2024-05-03 16:25:46 +00:00
Xavier-Do 4dfb271bde [FIX] adapt requirements to ubuntu Jammy
The docutils is pinned to 0.16.0 while the Jammy version should be 0.17

This is the case for a compatibility issue with sphinx-tabs==3.2.0
also official versions in ubuntu Jammy.

The odoo.requirements package contains already a docutils 0.17.0
creating some downgrade when installing requirements, this commit
upgrade both dependency to a compatible version.

This should avoid installing requirements in all documentation build
and hopefully avoid some random errors.

closes odoo/documentation#9135

X-original-commit: f73bf36e6d
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>
2024-05-03 08:50:53 +00:00
Donatienne (dopi) 79878321d6 [IMP] website: redirects
taskid-3667291

closes odoo/documentation#9129

X-original-commit: d2ba715df8
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Donatienne Pirlot (dopi) <dopi@odoo.com>
2024-05-03 07:26:05 +00:00
Brandon Seltenrich (BRSE) e7c634b31b [IMP] inventory: update locations doc
closes odoo/documentation#9131

X-original-commit: 5d735775b6
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-05-02 17:55:28 +00:00
Felicious 28596bd782 [IMP] inventory: multi-step label section
closes odoo/documentation#9130

X-original-commit: 12c82cabbe
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
2024-05-02 17:55:27 +00:00
Lara Martini (larm) 5fd963a36f [IMP] Gen settings: updated images
closes odoo/documentation#9103

X-original-commit: 6840b5df3f
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-05-02 16:34:08 +00:00
Lara Martini (larm) 570313b1cd [IMP] activities: updating for 17.0
closes odoo/documentation#9091

X-original-commit: 05bc055641
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-05-02 16:34:07 +00:00
jero-odoo 8e3142bc37 [IMP] CRM: rewrite gamification
closes odoo/documentation#9040

Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Co-authored-by: hojo-odoo <123424465+hojo-odoo@users.noreply.github.com>
Co-authored-by: StraubCreative <zst@odoo.com>
2024-05-02 16:34:06 +00:00
tiku-odoo ba056f4f36 [IMP] admin: onprem password reset
closes odoo/documentation#9112

X-original-commit: ad3343d158
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-05-02 13:26:57 +00:00
tiku-odoo 14dddabc4d [IMP] general: iot windows iot revise version
closes odoo/documentation#9097

X-original-commit: fcd9b40293
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-05-02 13:26:56 +00:00
dido-odoo e89dc21e44 [FIX] Online payments: Correct the Webhook URL entered in Xendit
The Webhook URL in our documentation was missing the "payment/xendit/webhook" part, meaning Odoo wasn't processing messages from Xendit if users followed the documentation. Therefore this commit corrects this so it's included.

Support Ticket: opw-3849683

task-3859686

closes odoo/documentation#9081

X-original-commit: 5bf5db129f
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-30 16:24:04 +00:00
Antoine Vandevenne (anv) 7eb1324d1c [IMP] Makefile: print the full traceback for unhandled exceptions
This should help reading the traceback on Runbot, where the log files
are not always kept.

closes odoo/documentation#9075

X-original-commit: 73ee687aca
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-04-30 16:24:03 +00:00
Sam Lieber (sali) 1287839683 [ADD] extensions: icon_role font awesome
closes odoo/documentation#9066

X-original-commit: 1f851af029
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-04-30 16:24:01 +00:00
Victor Feyens b4a8e166a6 [FIX] dev/tutorials: typo
courtesy of @/ChloeLiang

closes odoo/documentation#9051

X-original-commit: 3e62a8c4cd
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-04-30 02:30:25 +00:00
Brandon Seltenrich (BRSE) a936e3cb5d [IMP] inventory: udpate shipments & deliveries doc
closes odoo/documentation#8974

X-original-commit: 3973c40516
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-04-30 00:57:24 +00:00
XPL 48a20b1596 [IMP] l10n-belgium: update the supported blackbox model
task-3895014

closes odoo/documentation#9024

X-original-commit: ca40adc12e
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-29 16:22:44 +00:00
Zachary Straub (ZST) 3d10ecf770 [FIX] quality: replace overview 404 link
closes odoo/documentation#9037

X-original-commit: 8984c27df9
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
2024-04-28 20:18:22 +00:00
Felicious d09028357e [IMP] inventory: UPS config
closes odoo/documentation#9030

X-original-commit: a63462d880
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: Zachary Straub <zst@odoo.com>
2024-04-26 22:59:54 +00:00
tiku-odoo 790b9c7fd9 [IMP] sales: partner autocomplete rewrite
closes odoo/documentation#9016

X-original-commit: 5bed8eb25b
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-26 13:26:54 +00:00
Loredana Perazzo 8e25d81ce5 [ADD] pos: list of compatible epos printers
no-task related

closes odoo/documentation#9011

X-original-commit: 96fd984293
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
Co-authored-by: Timothy Kukulka <tiku@odoo.com>
Co-authored-by: Loredana Perazzo <lrpz@odoo.com>
2024-04-25 23:51:22 +00:00
tiku-odoo abf2ea81dd [IMP] database mgt: odoocom account add dup limit
closes odoo/documentation#9002

X-original-commit: ecd7d62a01
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-25 23:51:21 +00:00
rps-odoo 40f4077669 [IMP] accounting/l10n_ec: add eCommerce section
Link to GDrive images folder: https://drive.google.com/drive/folders/1TRuIFiQJO5kcy11LWKDyNUuBD4sI9ZQb?usp=sharing

closes odoo/documentation#8993

X-original-commit: 2ecb63825b
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-04-25 22:13:29 +00:00
John Holton (hojo) 28476a2894 [ADD] Manufacturing: Basic subcontracting
closes odoo/documentation#8787

X-original-commit: ba8289b0da
Signed-off-by: John Holton (hojo) <hojo@odoo.com>
2024-04-25 20:37:08 +00:00
Loredana Perazzo 57314bb63f [IMP] iot: admonition about the required certification to use a scale in POS
task-3876833

closes odoo/documentation#8988

X-original-commit: 4a12c56fc4
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-04-25 18:32:55 +00:00
tiku-odoo 50efd5d4ce [IMP] marketing: sms essentials automation rule v17
closes odoo/documentation#8980

X-original-commit: a443e6b9d1
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-25 18:32:49 +00:00
Felicious 545e124d02 [IMP] inventory: troubleshooting 3rd party carrier
closes odoo/documentation#8950

X-original-commit: b360ff1042
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: brse-odoo <brse@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-04-25 18:32:45 +00:00
Vincent Schippefilt 564f2640c7 [IMP] base: add read_group relative granularity
references https://github.com/odoo/odoo/pull/159528

closes odoo/documentation#8447

Task: 3836802
Related: odoo/odoo#159528
Signed-off-by: Vincent Schippefilt (vsc) <vsc@odoo.com>
2024-04-25 17:11:23 +00:00
XPL 348da6ec78 [IMP] upgrade: modify support information
task-3473194

closes odoo/documentation#8958

X-original-commit: aed1667cdc
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-25 06:59:34 +00:00
Syed Sarmad Sabih 54e6c5d6d4 [FIX] general: ir.config_parameter correction
Fix the incorrect usage of `ir.config.parameters`. The correct one is `ir.config_parameter`.

closes odoo/documentation#8981

X-original-commit: 644f383656
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
2024-04-25 02:13:51 +00:00
Brandon Seltenrich (BRSE) 601e6fe30c [IMP] inventory: update 2 step routes doc
closes odoo/documentation#8968

X-original-commit: 16b0137ae5
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-04-24 19:10:07 +00:00
Brandon Seltenrich (BRSE) 5db7eabaaf [ADD] repairs: add repair orders doc
closes odoo/documentation#8967

X-original-commit: a76e5782cd
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-04-24 19:10:06 +00:00
Lara Martini (larm) d7beff11c0 [ADD] Lunch: Manage orders ad vendors
closes odoo/documentation#8960

X-original-commit: a9b5cf3f6a
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-04-24 19:10:05 +00:00
Brandon Seltenrich (BRSE) cd6f706e7c [IMP] inventory: update cycle counts doc
closes odoo/documentation#8924

X-original-commit: 0456d100b2
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-04-24 19:10:03 +00:00
Brandon Seltenrich (BRSE) bf0a7d3160 [IMP] update 3 step receipts doc
closes odoo/documentation#8954

X-original-commit: ba2a95a3d5
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-04-24 13:32:57 +00:00
jero-odoo c56819763f [ADD] Discuss: New Canned Responses Doc
closes odoo/documentation#8884

X-original-commit: ca7d2936dd
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-04-24 13:32:55 +00:00
Felicious 5bc5448bbe [IMP] inventory: print shipping label
closes odoo/documentation#8944

X-original-commit: ecc993ee35
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: brse-odoo <brse@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
2024-04-23 20:08:46 +00:00
tiku-odoo 4b030b0b83 [IMP] essentials: iap rewrite
closes odoo/documentation#8938

X-original-commit: cd49934d95
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-23 20:08:45 +00:00
Lara Martini (larm) 96deed63ad [ADD] Lunch: placing orders doc
closes odoo/documentation#8783

X-original-commit: 30e76c6eb3
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-04-23 15:06:41 +00:00
Yaroslav Soroko (yaso) 3c082c8f0b [IMP] point_of_sale: add Ingenico details
This PR adds the very much necessary details about the Ingenico
terminals we support, the communication protocol and the countries
coverage.
- We support only Ingenico terminals in Benelux
- The terminals must support TLV as communication protocol
- We contact terminals through TCP/IP only, not the serial port
- According to our contact in Ingenico (now Axepta) this is the case for
  all the Lane/Desk/Move payment terminals

task-3865904

closes odoo/documentation#8832

X-original-commit: 67f096cfe8
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-04-23 10:39:03 +00:00
XPL 378eff8585 [ADD] spreadsheet: functions
closes odoo/documentation#8903

X-original-commit: 1e1389c679
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-22 20:52:53 +00:00
tiku-odoo 417867026e [ADD] sales: crm lead enrichment
closes odoo/documentation#8915

X-original-commit: 0bd590d4b9
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-22 19:22:50 +00:00
tiku-odoo e14b809722 [IMP] productivity: microsoft calendar rewrite
closes odoo/documentation#8907

X-original-commit: 5626d03c98
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-22 16:46:39 +00:00
tiku-odoo f741898d3e [IMP] sales: subscription follow-up alerts add block
closes odoo/documentation#8897

X-original-commit: 3cb351b6b9
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-22 14:00:09 +00:00
Felicious ead609a337 [IMP] inventory: overhaul 3rd party shippers
closes odoo/documentation#8893

X-original-commit: 4d7926f159
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: brse-odoo <brse@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-04-20 00:56:51 +00:00
Victor Feyens a712aeabea [FIX] redirects: forgotten redirects
Missing redirections for 91a48bfe88

closes odoo/documentation#8876

X-original-commit: ca1d8adf7e
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-04-19 19:11:01 +00:00
Sam Lieber (sali) 0c25dbe3e7 [IMP] marketing automation: workflow activities
closes odoo/documentation#8867

X-original-commit: 0aaff7f75e
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
2024-04-19 17:48:22 +00:00
jero-odoo 15bdaa7bdb [IMP] crm: utilize activities for sales teams 17
closes odoo/documentation#8864

X-original-commit: 2c9457e573
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2024-04-19 17:48:20 +00:00
KC (ksc) c932d24162 [ADD] surveys: created new 'dashboard' doc
closes odoo/documentation#8863

X-original-commit: 3e4f44211b
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2024-04-19 17:48:19 +00:00
Alvaro Fuentes 3bba491f57 [IMP] doc: improve organization of upgrades docs
* Add autodoc directives to generate documentation directly from
  upgrade-util repo.
* Group all upgrades-related reference documentation into one group in
  the sidebar, instead of having two entries.
* Mention `upgrades` vs `migrations` directory. It has been supported
  since a while but nothing was explicit in the documentation.

Original commit: 91a48bfe88

closes odoo/documentation#8849

X-original-commit: ef4b5f87d5
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2024-04-19 13:35:52 +00:00
Alvaro Fuentes 16fd9dc828 [IMP] upgrade-util: link code documentation
Add direct code documentation from upgrade-util repo.
Adapt `extensions/github_link`.

Original commit: 3352d33997

X-original-commit: 26fd5f3192
Part-of: odoo/documentation#8849
Co-authored-by: Victor Feyens <vfe@odoo.com>
2024-04-19 13:35:52 +00:00
tiku-odoo 4a0624c897 [IMP] productivity: calendar google add troubleshooting
closes odoo/documentation#8857

X-original-commit: 728dcf5078
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-18 20:52:41 +00:00
XPL 8d4ad5f6fb [IMP] hosting: add Odoo.sh as not supporting intermediary versions
task-3874935

closes odoo/documentation#8818

X-original-commit: d1e65a3224
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-18 08:20:01 +00:00
Loredana Perazzo 5c7ab478d9 [IMP] pos: digital labels becomes electronic shelf labels
closes odoo/documentation#8825

X-original-commit: 98cac21297
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-04-18 06:22:54 +00:00
Yaroslav Soroko (yaso) b301ee896a [IMP] point_of_sale: add Adyen details
This PR adds a link to a much needed Adyen coverage per country and
their terminal models

task-3865904

closes odoo/documentation#8817

X-original-commit: c100f94748
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-04-18 06:22:53 +00:00
Yaroslav Soroko (yaso) 124edfd676 [IMP] point_of_sale: add Worldline terminal models
This PR adds the Worldline terminal models we support to better redirect
our clients and colleagues when using Worldline terminals.

task-3865904

closes odoo/documentation#8803

X-original-commit: 09f5c15e90
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-04-18 06:22:52 +00:00
Yaroslav Soroko (yaso) 7adaac544f [IMP] finance: add Stripe links for more info
This PR adds more details about Stripe coverage and supported payment
methods and terminals.

task-3865904

closes odoo/documentation#8797

X-original-commit: f7bc929e00
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-04-17 21:46:17 +00:00
Yaroslav Soroko (yaso) a4f06b2130 [IMP] point_of_sale: stripe add details
This PR adds details like countries coverage, supported terminals and
payment methods to Stripe documentation for point_of_sale

task-3865904

closes odoo/documentation#8756

X-original-commit: 59108aedda
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-04-17 18:55:47 +00:00
rps-odoo 5fa5126572 [IMP] accounting/l10n_ec: add additional modules
closes odoo/documentation#8625

X-original-commit: a30b2bbdfb
Signed-off-by: Roberto Palacios (rps) <rps@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-04-17 17:29:07 +00:00
Donatienne (dopi) 6402602d1e [ADD] website: dynamic content
task-3733885

closes odoo/documentation#8776

X-original-commit: 50d09bf155
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-17 08:31:05 +00:00
John Holton (hojo) fe5e284c4d [ADD] Manufacturing: Resupply subcontractor
closes odoo/documentation#8759

X-original-commit: 579048ce2c
Signed-off-by: John Holton (hojo) <hojo@odoo.com>
2024-04-16 18:09:51 +00:00
KC (ksc) bab0ae401c [IMP] surveys: rewrite of create surveys doc for 17
closes odoo/documentation#8762

X-original-commit: a2f80c56c2
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2024-04-16 15:40:00 +00:00
tiku-odoo c2caa3cc34 [IMP] productivity: calendar add troubleshooting
closes odoo/documentation#8769

X-original-commit: 856836af1d
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-16 13:57:02 +00:00
Zuzanna Luczynska 03873b6b34 [IMP] project: remove recurring task checkbox on individual project
task-3861601

closes odoo/documentation#8726

X-original-commit: efc6cb8cca
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Zuzanna Luczynska (zulu) <zulu@odoo.com>
2024-04-16 07:52:01 +00:00
XPL 8fed1cf0a8 [IMP] point of sale: wordline windows firewall
task-3865298

closes odoo/documentation#8747

X-original-commit: 15a12a7b10
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-15 12:39:07 +00:00
John Holton (hojo) a25e800a76 [ADD] Manufacturing: Dropship to subcontractor
closes odoo/documentation#8638

X-original-commit: 582828999a
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
2024-04-15 01:01:05 +00:00
Felicious e0a499bb39 [ADD] inventory: assign new serials
closes odoo/documentation#8731

X-original-commit: 1fc601e7c3
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Co-authored-by: hojo-odoo <123424465+hojo-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
2024-04-13 22:14:49 +00:00
Lara Martini (larm) 44e9dfb329 [ADD] Lunch: manage accounts
closes odoo/documentation#8740

X-original-commit: 36a0e84a17
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Co-authored-by: jero-odoo <jero@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: StraubCreative <zst@odoo.com>
2024-04-13 20:27:13 +00:00
Syed Sarmad Sabih 013a121b6a Update email_servers.rst
Added missing space between defaultnotifications

closes odoo/documentation#8737

X-original-commit: 8778183bc7
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
2024-04-13 20:27:12 +00:00
jero-odoo 64203a815f [ADD] Discuss: Chatter Doc
closes odoo/documentation#8734

X-original-commit: b84b924463
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: Timothy Kukulka <91896312+tiku-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
2024-04-13 20:27:11 +00:00
Donatienne (dopi) 40fa45c252 [IMP] website: inner content blocks
taskid-3733888

closes odoo/documentation#8722

X-original-commit: 8f88ea892b
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-13 15:31:33 +00:00
Antoine Vandevenne (anv) 57b7ca69d9 [IMP] developer: improve navigation in top-level pages
Prior to this commit, users had to either know in advance or guess the
location of the content they were looking for. Top-level pages of the
"Developer" section of the documentation, in particular the "Developer"
page itself, were listing their sub-pages without directions for users.

This commit brings the following changes to improve the navigation:
- add directions for users on the "Developer" page and list the three
  main categories of developer documentation ("Tutorials", "How-to
  guides", and "Reference") with explanations of their content and
  target audience;
- add categories for content cards on the "Tutorials" and "How-to
  guides" pages, and fine-tune the toctree of the "Reference" page to
  more easily locate specific topics;
- clarify what are the "Python framework" and the "JavaScript framework"
  by relabelling them to "Server framework" and "Web framework" on
  top-level pages, as some users were confused to find that the JS
  framework was not responsible for the server, and others that the
  documentation for QWeb template is located in the Python documentation;
- extract the "Setup guide" from the "Getting started" tutorial and
  rename the latter to "Server framework 101" to allow reusing the setup
  guide in other tutorials and make clear that the "Server framework 101"
  tutorial is not about the Web framework.

task-3802536

closes odoo/documentation#8712

X-original-commit: 7f623b6ad5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
2024-04-13 12:16:35 +00:00
Felicious b8dae6e6b2 [IMP] barcode: broken eLearning link
closes odoo/documentation#8707

X-original-commit: c8ad3af954
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
2024-04-13 12:16:28 +00:00
tiku-odoo f83b27d07a [IMP] general: iot troubleshooting printer addition
closes odoo/documentation#8694

X-original-commit: e444f8678e
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-13 11:01:57 +00:00
jero-odoo 257b86abb1 [REM] crm: track prospects visits
closes odoo/documentation#8687

X-original-commit: 1b4516057a
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-04-13 09:50:23 +00:00
tiku-odoo 5911d0be1b [IMP] general: user doc 17 edits
closes odoo/documentation#8698

X-original-commit: 1250c4bf20
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-13 08:40:47 +00:00
XPL a59a882dd0 [IMP] accounting: snailmail trial credits removal
task-3844653

closes odoo/documentation#8683

X-original-commit: e7dc7815b5
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-12 07:38:51 +00:00
Brandon Seltenrich (BRSE) e3f5824313 [ADD] maintenance: add maintenance calendar doc
closes odoo/documentation#8676

X-original-commit: c5ead11f0e
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-04-12 05:43:46 +00:00
jero-odoo e4f81db89e [IMP] CRM: utilize activities 16.0
closes odoo/documentation#8673

X-original-commit: 50a8171f02
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2024-04-12 05:43:43 +00:00
Brandon Seltenrich (BRSE) d0135e4d3e [IMP] purchase: update bill control policy doc
closes odoo/documentation#8671

X-original-commit: d25a0d261b
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-04-12 05:43:42 +00:00
Lara Martini (larm) 6f4a3b61db [ADD] Lunch: new configuration doc
closes odoo/documentation#8670

X-original-commit: 0a309c5c6b
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-04-12 05:43:41 +00:00
Brandon Seltenrich (BRSE) 6b13865e4d [IMP] inventory: update landed costs doc
closes odoo/documentation#8669

X-original-commit: db6288f9a1
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-04-12 05:43:40 +00:00
Donatienne (dopi) 210effcd22 [ADD] Website: inner content building blocks
taskid-3733888

closes odoo/documentation#8657

X-original-commit: a3ca109cf5
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-12 03:31:11 +00:00
tiku-odoo 9c7ce86077 [IMP] general: users rewrite
closes odoo/documentation#8653

X-original-commit: 3f2f33a349
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-12 03:31:05 +00:00
Felicious b91b663c82 [MOV] inventory: group inventory adj docs together
closes odoo/documentation#8641

X-original-commit: 8d6bd636e1
Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-04-11 18:54:51 +00:00
KC (ksc) 734dc4ff93 [ADD] surveys: created survey analysis doc for 17
closes odoo/documentation#8635

X-original-commit: bf5ddc5886
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2024-04-11 12:29:30 +00:00
Brandon Seltenrich (BRSE) c7daca2df6 [ADD] maintenance: add setup doc
closes odoo/documentation#8628

X-original-commit: d674c419c0
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-04-11 12:29:28 +00:00
Tom Aarab (toaa) 67aefbacd4 [IMP] accounting: transactions update
taskid-3835958

closes odoo/documentation#8603

X-original-commit: 52a0df9b6e
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Tom Aarab (toaa) <toaa@odoo.com>
2024-04-11 10:30:11 +00:00
tiku-odoo 8bee34d230 [IMP] general: integrations outlook plugin add block
closes odoo/documentation#8624

X-original-commit: 21f23d98d3
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-09 21:32:41 +00:00
Ricardo Gomes Rodrigues 7c0598e164 [IMP] accounting: update hash
We did a big refactor of the hash in
https://github.com/odoo/odoo/pull/160820@

This commit updates the documentation accordingly.

task-id 3820975

closes odoo/documentation#8605

X-original-commit: b3ed49c167
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-04-09 21:32:41 +00:00
tiku-odoo a8f0df1fde [IMP] productivity: voip OnSIP US only block
closes odoo/documentation#8615

X-original-commit: 93552388ab
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-09 19:20:52 +00:00
tiku-odoo ac5f799d02 [FIX] general: integrations google translate
closes odoo/documentation#8608

X-original-commit: 867b90b13f
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-09 19:20:51 +00:00
Lara Martini (larm) 28b5989abf [IMP] fleet: new sections and forms
closes odoo/documentation#8555

X-original-commit: ca2738ef00
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-04-09 17:33:23 +00:00
KC (ksc) 7b3824fa23 [ADD] surveys: created doc for Live Sessions
closes odoo/documentation#8586

X-original-commit: 919ab71dcd
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2024-04-09 15:37:55 +00:00
Lara Martini (larm) 92e313396f [IMP] payroll: contract doc for version 17
closes odoo/documentation#8564

X-original-commit: 6522417fa6
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-04-09 15:37:51 +00:00
jero-odoo 3793e8cc37 [ADD] crm: utilize activities for sales teams
closes odoo/documentation#8594

X-original-commit: d27def362b
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
2024-04-09 12:53:55 +00:00
Ali Alfie (alal) 3730e134cc [IMP] fiscal_localizations: HMRC mode config param
In odoo/enterprise/pull/59152 a system parameter is added to control the HMRC mode from production to demo allowing the use of dummy credentials.

task-3820114

closes odoo/documentation#8580

X-original-commit: 307e264241
Related: odoo/enterprise#60232
Signed-off-by: Ali Alfie (alal) <alal@odoo.com>
2024-04-09 02:09:53 +00:00
jero-odoo 8cacfab918 [IMP] CRM: update lost opps 17.0
closes odoo/documentation#8578

X-original-commit: b28e3073d1
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
2024-04-09 02:09:50 +00:00
Gorash 644cbd052f [IMP] base: required field (from view python expr) are add automatically
related to odoo/odoo#137031

closes odoo/documentation#6115

Related: odoo/enterprise#48832
Related: odoo/upgrade#5861
Signed-off-by: Raphael Collet <rco@odoo.com>
2024-04-08 19:17:56 +00:00
Ricardo Gomes Rodrigues 2ab5bb32c8 [IMP] accounting: clarify deferred start date
closes odoo/documentation#8573

X-original-commit: 1f4c1f455d
Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com>
Signed-off-by: Ricardo Gomes Rodrigues (rigr) <rigr@odoo.com>
2024-04-06 02:11:18 +00:00
tiku-odoo 2277114c8e [IMP] general: companies digest email rewrite
closes odoo/documentation#8552

X-original-commit: 9897673e93
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-05 19:15:16 +00:00
jero-odoo 0227f484f2 [IMP] CRM: Convert leads to opps
closes odoo/documentation#8545

X-original-commit: 63636d0518
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
2024-04-05 19:15:15 +00:00
Sam Lieber (sali) d805a742ab [IMP] essentials: search filter and group
closes odoo/documentation#8544

X-original-commit: 6c350a6bb0
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Co-authored-by: tiku-odoo <tiku@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
2024-04-05 19:15:14 +00:00
tiku-odoo aaaf688d13 [IMP] general: companies rewrite
closes odoo/documentation#8543

X-original-commit: 4073aac2bc
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-05 19:15:13 +00:00
Lara Martini (larm) d78b540718 [IMP] fleet: new vehicle updates
closes odoo/documentation#8530

X-original-commit: 3a16f09f78
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-04-05 13:21:55 +00:00
Donatienne (dopi) 07d762cb29 [IMP] Link trackers: updating content
task-3754778

closes odoo/documentation#8520

X-original-commit: fd5c4b21ca
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-05 09:59:48 +00:00
Brandon Seltenrich (BRSE) f51df981f2 [IMP] purchase: update alternative rfq doc
closes odoo/documentation#8525

X-original-commit: aae54dedd2
Signed-off-by: Brandon Seltenrich (brse) <brse@odoo.com>
2024-04-05 07:09:02 +00:00
Jonathan b0d390c1bf [IMP] on_premise: update version number in source install
closes odoo/documentation#8521

X-original-commit: 67058f8b96
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-04-05 05:22:33 +00:00
jero-odoo 34db98ad59 [ADD] CRM: Merge Leads and Opps
closes odoo/documentation#8512

X-original-commit: 83d105c067
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-04-04 20:07:46 +00:00
John Holton (hojo) 81a73ce00e [ADD] Manufacturing: Shop Floor time tracking
closes odoo/documentation#8509

X-original-commit: ee2cfe2bb5
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: John Holton (hojo) <hojo@odoo.com>
2024-04-04 18:25:14 +00:00
Damien Bouvy 141399ec33 [FIX] studio: incorrect screenshot of light layout
Since 16.0, the layout does not have intermediary borders in its tables
(this is an explicit choice in R&D since they seem to be using the
`table-borderless` class explicitely). This commit updates the
screenshot to match this reality.

opw-3266968

closes odoo/documentation#8506

X-original-commit: d56d85da69
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-03 17:05:47 +00:00
Antoine Vandevenne (anv) 258fa17a76 [IMP] supported_versions: release saas-17.2
closes odoo/documentation#8500

X-original-commit: a906478bc7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-04-03 05:24:06 +00:00
XPL e2503fdc29 [ADD] database management: odoo mobile apps
task-3821019

closes odoo/documentation#8492

X-original-commit: 9fd199ff27
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-04-03 05:24:01 +00:00
KC (ksc) acb491fba2 [IMP] email marketing: update essentials doc
closes odoo/documentation#8479

X-original-commit: f019e3b18f
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-04-03 05:23:53 +00:00
mathysPaul 06d25495e6 [IMP] payment: Remove _compute_view_configuration_fields docs
Following the removal of explicit view configuration fields and
the `_compute_view_configuration_fields` method in the payment
module, this commit updates the documentation accordingly. It
removes all references and instructions related to
`_compute_view_configuration_fields`, ensuring the documentation
reflects the current implementation that leverages XPath for
view customization.

task-3679393

See odoo/odoo#152517
See odoo/enterprise#56181
See odoo/upgrade#5667

closes odoo/documentation#7686

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-04-02 13:09:25 +00:00
Sam Lieber (sali) b298744499 [IMP] marketing automation: audience targeting
closes odoo/documentation#8475

X-original-commit: 31bfb0c693
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
2024-04-02 01:47:42 +00:00
KC (ksc) 45efd8c90d [FIX] subscriptions: updated and corrected mistake regarding eLearning connection
closes odoo/documentation#8465

X-original-commit: cc8c576936
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Kevin Scannell (ksc) <ksc@odoo.com>
2024-04-02 01:47:40 +00:00
MaxKeilOdoo e84a7d1f28 [ADD] email marketing: lost leads email doc
closes odoo/documentation#8463

X-original-commit: 9ff60ea1d7
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Co-authored-by: StraubCreative <zst@odoo.com>
Co-authored-by: tiku-odoo <tiku@odoo.com>
Co-authored-by: ksc-odoo <ksc@odoo.com>
Co-authored-by: samueljlieber <sali@odoo.com>
2024-04-02 01:47:39 +00:00
tiku-odoo 1dd818e0c7 [IMP] general: users access rights rewrite
closes odoo/documentation#8402

X-original-commit: ae061c9041
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-04-01 23:48:23 +00:00
jero-odoo 8c8679c856 [ADD] Live Chat: Reports
closes odoo/documentation#8464

X-original-commit: a4cdf38bd6
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: larm-odoo <121518652+larm-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
2024-04-01 15:31:45 +00:00
jero-odoo d0e0332651 [IMP] Livechat: chatbots 17.0
closes odoo/documentation#8456

X-original-commit: c54584a3f0
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: larm-odoo <121518652+larm-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-04-01 15:31:44 +00:00
rps-odoo d14daf3e82 [IMP] accounting/l10n_ar: liquidity product direct sales
Link to GDrive images folder: https://drive.google.com/drive/folders/1qWtbGewR3LxDKs21QpMEPhCKEovVyoKx?usp=drive_link

closes odoo/documentation#8450

X-original-commit: 094924d5ff
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Co-authored-by: XPL <xpl@odoo.com>
2024-04-01 04:20:16 +00:00
John Holton (hojo) 0a93b57cb3 [MOV] Manufacturing: Restructure scope
closes odoo/documentation#8453

X-original-commit: ee735a813f
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: John Holton (hojo) <hojo@odoo.com>
2024-03-31 23:39:44 +00:00
XPL 5f3e56454a [IMP] website: domain names CNAME records
Clarify that it is required to create a redirection from the naked domain to the
www. subdomain

closes odoo/documentation#8444

X-original-commit: 363d0a582f
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-03-31 20:36:11 +00:00
Melanie Nguyen (meng) b3f96a6168 [IMP] crm: update webpage visits
closes odoo/documentation#8437

X-original-commit: e3eae6ac88
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-03-31 18:53:54 +00:00
tiku-odoo 76ca1e1eef [IMP] general: iot windows iot update process
closes odoo/documentation#8430

X-original-commit: e30c87800d
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-03-31 18:53:52 +00:00
“ralo-odoo” 28accc3dd2 [IMP] localizations: Philippines (SLSP and 2550Q)
Added additonal sections for SLSP and 2550Q tax report as these were updated for 17.0

closes odoo/documentation#8427

X-original-commit: 56cf586061
Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-03-31 18:53:51 +00:00
Lara Martini (larm) c08c69ce79 [IMP] recruitment: job positions new images and options
closes odoo/documentation#8420

X-original-commit: b5bfc45f09
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-03-31 17:29:40 +00:00
Lara Martini (larm) 9078dec21d [IMP] time off: updating images and directions
closes odoo/documentation#8416

X-original-commit: f16d89dbc7
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Lara Martini (larm) <larm@odoo.com>
2024-03-31 16:16:03 +00:00
Yaroslav Soroko (yaso) 27bf8784c0 [ADD] Pricer tags section added to PoS/pricing
task-3603496

This PR adds the documentation needed to use Point Of Sale
with Pricer electronic price tags.

Related PRs:
https://github.com/odoo/enterprise/pull/50368

task-3603496

closes odoo/documentation#8412

X-original-commit: 656064ea1c
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-03-31 14:12:00 +00:00
jero-odoo 2c71281056 [IMP] Livechat: basics 17.0
closes odoo/documentation#8408

X-original-commit: 36ca933672
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: Timothy Kukulka <91896312+tiku-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
2024-03-30 23:48:12 +00:00
tiku-odoo 2cd4a12dd4 [ADD] general: integrations google translate
closes odoo/documentation#8405

X-original-commit: 880f1cc01d
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-03-30 18:06:22 +00:00
Syed Sarmad Sabih d27481635c Update deploy.rst
Fix typo db_filter to the correct usage dbfilter

closes odoo/documentation#8397

X-original-commit: 0fbf9995f0
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-03-30 11:57:13 +00:00
Felicious 5420b360ff [IMP] inventory: invoice shipping
closes odoo/documentation#8379

X-original-commit: 2733aac1fc
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Co-authored-by: Zachary Straub <zst@odoo.com>
2024-03-29 19:05:23 +00:00
Sam Lieber (sali) 498670abc1 [IMP] l10n_ec/accounting: ats report
closes odoo/documentation#8373

X-original-commit: 6ebc4d7b19
Signed-off-by: Roberto Palacios (rps) <rps@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-03-29 19:05:22 +00:00
João Alves 21cd532bb2 Update location of Outlook Calendar setting
closes odoo/documentation#8353

X-original-commit: 2c613fdfc4
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-03-29 19:05:21 +00:00
John Holton (hojo) 7c40b31212 [ADD] Maintenance: Maintenance requests
closes odoo/documentation#8338

X-original-commit: e0e97ea763
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: John Holton (hojo) <hojo@odoo.com>
2024-03-29 19:05:17 +00:00
tiku-odoo 6d28b69fda [IMP] essenials: import export version 17 updates
closes odoo/documentation#8388

X-original-commit: 97f5c6f02a
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
Signed-off-by: Timothy Kukulka (tiku) <tiku@odoo.com>
2024-03-29 06:55:06 +00:00
John Holton (hojo) c46e9eb7ea [ADD] MRP: Unbuild orders
closes odoo/documentation#8385

X-original-commit: 51a70769ca
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2024-03-29 06:55:04 +00:00
Tiffany Chang (tic) 88f51eff5e [I18N] *: export latest terms + add missing resources
This commit does 2 things:

- exports the latest terms to be translated
- adds missing pot files + adds them to be translated on transifex
  (essentials, hr, and studio)

Notes:
- hr (source) was already in v16, but was missing from v15 and v17,
  hence the commits being slightly different
- latest pot files of `contributing`, `developer`, and `legal` were
  purposely left off this PR because they are either not translated
  or not translated via Transifex, so these pot files serve no purpose

closes odoo/documentation#8367

X-original-commit: b65460db47
Signed-off-by: Tiffany Chang (tic) <tic@odoo.com>
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2024-03-28 09:47:21 +00:00
1443 changed files with 64272 additions and 31501 deletions
+30
View File
@@ -21,6 +21,16 @@ replace_edited_strings = false
keep_translations = false
source_lang = en
[o:odoo:p:odoo-17-doc:r:essentials]
file_filter = locale/<lang>/LC_MESSAGES/essentials.po
source_file = locale/sources/essentials.pot
type = POT
minimum_perc = 0
resource_name = essentials
replace_edited_strings = false
keep_translations = false
source_lang = en
[o:odoo:p:odoo-17-doc:r:finance]
file_filter = locale/<lang>/LC_MESSAGES/finance.po
source_file = locale/sources/finance.pot
@@ -41,6 +51,16 @@ replace_edited_strings = false
keep_translations = false
source_lang = en
[o:odoo:p:odoo-17-doc:r:hr]
file_filter = locale/<lang>/LC_MESSAGES/hr.po
source_file = locale/sources/hr.pot
type = POT
minimum_perc = 0
resource_name = hr
replace_edited_strings = false
keep_translations = false
source_lang = en
[o:odoo:p:odoo-17-doc:r:index]
file_filter = locale/<lang>/LC_MESSAGES/index.po
source_file = locale/sources/index.pot
@@ -111,6 +131,16 @@ replace_edited_strings = false
keep_translations = false
source_lang = en
[o:odoo:p:odoo-17-doc:r:studio]
file_filter = locale/<lang>/LC_MESSAGES/studio.po
source_file = locale/sources/studio.pot
type = POT
minimum_perc = 0
resource_name = studio
replace_edited_strings = false
keep_translations = false
source_lang = en
[o:odoo:p:odoo-17-doc:r:websites]
file_filter = locale/<lang>/LC_MESSAGES/websites.po
source_file = locale/sources/websites.pot
+1
View File
@@ -18,6 +18,7 @@ CONFIG_DIR = .
SPHINXOPTS = -D project_root=$(ROOT) -D canonical_version=$(CANONICAL_VERSION) \
-D versions=$(VERSIONS) -D languages=$(LANGUAGES) -D language=$(CURRENT_LANG) \
-D is_remote_build=$(IS_REMOTE_BUILD) \
-T \
-A google_analytics_key=$(GOOGLE_ANALYTICS_KEY) \
-A plausible_script=$(PLAUSIBLE_SCRIPT) \
-A plausible_domain=$(PLAUSIBLE_DOMAIN) \
+4 -2
View File
@@ -9,6 +9,7 @@
- Python dependencies listed in the file `requirements.txt`.
- Make
- A local copy of the [odoo/odoo repository](https://github.com/odoo/odoo) (optional)
- A local copy of the [odoo/upgrade-util repository](https://github.com/odoo/upgrade-util) (optional)
### Instructions
@@ -18,8 +19,9 @@
3. See [this guide](https://www.odoo.com/documentation/latest/contributing/documentation.html)
for more detailed instructions.
Optional: place your local copy of the `odoo/odoo` repository in the parent directory or in the root
directory of the documentation to build the latter with the documented Python docstrings.
Optional: place your local copy of the `odoo/odoo` and `odoo/upgrade-util` repositories in
the parent directory or in the root directory of the documentation to build the latter
with the documented Python docstrings.
## Contribute to the documentation
+22
View File
@@ -133,6 +133,24 @@ else:
)
odoo_dir_in_path = True
if odoo_dir_in_path:
upgrade_util_dir = next(filter(Path.exists, [Path('upgrade-util'), Path('../upgrade-util')]), None)
if not upgrade_util_dir:
_logger.warning(
"Could not find Upgrade Utils sources directory in `upgrade_util`.\n"
"The developer documentation will be built but autodoc directives will be skipped.\n"
"In order to fully build the 'Developer' documentation, clone the repository with "
"`git clone https://github.com/odoo/upgrade-util` or create a symbolic link."
)
odoo_dir_in_path = False
else:
_logger.info(
"Found Upgrade Util sources in %(directory)s",
{'directory': upgrade_util_dir.resolve()},
)
from odoo import upgrade
upgrade.__path__.append(str((upgrade_util_dir / 'src').resolve()))
# Mapping between odoo models related to master data and the declaration of the
# data. This is used to point users to available xml_ids when giving values for
# a field with the autodoc_field extension.
@@ -213,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-17.2': "Odoo Online",
'saas-17.1': "Odoo Online",
'17.0': "Odoo 17",
'saas-16.4': "Odoo Online",
@@ -249,6 +268,9 @@ redirects_dir = 'redirects/'
sphinx_tabs_disable_tab_closing = True
sphinx_tabs_disable_css_loading = True
# Autodoc ordering
autodoc_member_order = 'bysource'
#=== Options for HTML output ===#
html_theme = 'odoo_theme'
+1
View File
@@ -61,4 +61,5 @@ functionalities, including functional support, upgrades, and hosting. `Pricing
administration/upgrade
administration/neutralized_database
administration/supported_versions
administration/mobile
administration/odoo_accounts
+4 -4
View File
@@ -46,10 +46,10 @@ Transferring an Odoo Online database
====================================
.. important::
Odoo Online's :ref:`intermediary versions <supported_versions>` cannot be hosted on-premise as
that type of hosting does not support those versions. Therefore, if the database to transfer
is running an intermediary version, it must be upgraded first to the next :ref:`major version
<supported_versions>`, waiting for its release if necessary.
Odoo Online's :ref:`intermediary versions <supported_versions>` are not supported by Odoo.sh or
on-premise. Therefore, if the database to transfer is running an intermediary version, it must be
upgraded first to the next :ref:`major version <supported_versions>`, waiting for its release if
necessary.
.. example::
Transferring an online database running on Odoo 16.3 would require first upgrading it to Odoo
+67
View File
@@ -0,0 +1,67 @@
================
Odoo mobile apps
================
Two kind of Odoo mobile app exist: the progressive web app (PWA) and store apps. Using the PWA is
recommended.
Progressive web app (PWA)
=========================
PWAs are web-based applications designed to function across different devices and platforms,
leveraging web browsers to deliver user experiences similar to native apps.
The Odoo PWA features include:
- Quick access by adding the PWA to a device's home screen
- Seamless and borderless navigation experience
- Push notifications
- SSO authentication
To install the Odoo PWA, launch a browser supporting PWAs, and sign in to an Odoo database. The
instructions to install a PWA depend on the platform and browser used.
.. tabs::
.. tab:: Android
**Chrome**: open Chrome's menu (:guilabel:`⋮`), select :guilabel:`Install app`, and tap
:guilabel:`Install`.
**Firefox**: open Firefox's menu (:guilabel:`⋮`), select :guilabel:`Install`, and either touch
and hold the Odoo icon or tap :guilabel:`Add automatically`.
The PWA can also be installed with **Samsung Internet**, **Edge**, and **Opera**.
.. tab:: iOS
**Safari**: open the **Share** menu by tapping the square with an arrow pointing upwards icon,
select :guilabel:`Add to Home Screen`, edit the PWA details if desired, and tap
:guilabel:`Add`.
On iOS 16.4 and above, the PWA can also be installed with **Chrome**, **Firefox**, and
**Edge**.
.. tab:: Desktop
**Chrome** and **Edge**: click the installation icon at the right of the address bar and click
:guilabel:`Install`.
.. seealso::
- `Google Chrome Help: Use progressive web apps
<https://support.google.com/chrome/answer/9658361>`_
- `MDN Web Docs: Installing and uninstalling web apps
<https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Guides/Installing>`_
- `Microsoft Support: Install, manage, or uninstall apps in Microsoft Edge <https://support.microsoft.com/en-us/topic/install-manage-or-uninstall-apps-in-microsoft-edge-0c156575-a94a-45e4-a54f-3a84846f6113>`_
Store apps
==========
The Odoo mobile apps are available for download on the `Google Play Store
<https://play.google.com/store/apps/details?id=com.odoo.mobile>`_ and `Apple App Store
<https://apps.apple.com/app/odoo/id1272543640>`_.
.. 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.
+2
View File
@@ -30,6 +30,8 @@ confirmation for the account deletion.
To confirm the deletion, enter the :guilabel:`Password` and the :guilabel:`Login` for the account
being deleted. Then, click the :guilabel:`Delete Account` button to confirm the deletion.
.. _odoocom/change_password:
Odoo.com account password change
================================
+2
View File
@@ -60,6 +60,8 @@ daily operations.
- By checking :guilabel:`For testing purposes`, all external actions (emails, payments, delivery
orders, etc.) are disabled by default on the duplicated database.
- Duplicated databases expire automatically after 15 days.
- A maximum of five duplicates can be made per database. Under extraordinary circumstances,
contact `support <https://www.odoo.com/help>`_ to raise the limit.
.. _odoo_online/rename:
@@ -146,7 +146,7 @@ Manually
--------
If you want to create your module structure manually,
you can follow the :doc:`/developer/tutorials/getting_started` tutorial to understand
you can follow the :doc:`/developer/tutorials/server_framework_101` tutorial to understand
the structure of a module and the content of each file.
Push the development branch
+141 -5
View File
@@ -9,7 +9,7 @@ internet.
.. warning:: If you are setting up a public server, be sure to check our :ref:`security` recommendations!
.. _db_filter:
.. _dbfilter:
dbfilter
========
@@ -573,12 +573,12 @@ security-related topics:
- Use appropriate database filters ( :option:`--db-filter <odoo-bin --db-filter>`)
to restrict the visibility of your databases according to the hostname.
See :ref:`db_filter`.
See :ref:`dbfilter`.
You may also use :option:`-d <odoo-bin -d>` to provide your own (comma-separated)
list of available databases to filter from, instead of letting the system fetch
them all from the database backend.
- Once your ``db_name`` and ``db_filter`` are configured and only match a single database
- Once your ``db_name`` and ``dbfilter`` are configured and only match a single database
per hostname, you should set ``list_db`` configuration option to ``False``, to prevent
listing databases entirely, and to block access to the database management screens
(this is also exposed as the :option:`--no-database-list <odoo-bin --no-database-list>`
@@ -722,7 +722,7 @@ management screens.
the system administrator, including provisioning of new databases and automated backups.
Be sure to setup an appropriate ``db_name`` parameter
(and optionally, ``db_filter`` too) so that the system can determine the target database
(and optionally, ``dbfilter`` too) so that the system can determine the target database
for each request, otherwise users will be blocked as they won't be allowed to choose the
database themselves.
@@ -740,7 +740,143 @@ It should be stored securely, and should be generated randomly e.g.
$ python3 -c 'import base64, os; print(base64.b64encode(os.urandom(24)))'
which will generate a 32 characters pseudorandom printable string.
which generates a 32-character pseudorandom printable string.
Reset the master password
-------------------------
There may be instances where the master password is misplaced, or compromised, and needs to be
reset. The following process is for system administrators of an Odoo on-premise database detailing
how to manually reset and re-encrypt the master password.
.. seealso::
For more information about changing an Odoo.com account password, see this documentation:
:ref:`odoocom/change_password`.
When creating a new on-premise database, a random master password is generated. Odoo recommends
using this password to secure the database. This password is implemented by default, so there is a
secure master password for any Odoo on-premise deployment.
.. warning::
When creating an Odoo on-premise database the installation is accessible to anyone on the
internet, until this password is set to secure the database.
The master password is specified in the Odoo configuration file (`odoo.conf` or `odoorc` (hidden
file)). The Odoo master password is needed to modify, create, or delete a database through the
graphical user interface (GUI).
Locate configuration file
~~~~~~~~~~~~~~~~~~~~~~~~~
First, open the Odoo configuration file (`odoo.conf` or `odoorc` (hidden file)).
.. tabs::
.. tab:: Windows
The configuration file is located at: `c:\\ProgramFiles\\Odoo{VERSION}\\server\\odoo.conf`
.. tab:: Linux
Depending on how Odoo is installed on the Linux machine, the configuration file is located in
one of two different places:
- Package installation: `/etc/odoo.conf`
- Source installation: `~/.odoorc`
Change old password
~~~~~~~~~~~~~~~~~~~
Once the appropriate file has been opened, proceed to modify the old password in the configuration
file to a temporary password.
.. tabs::
.. group-tab:: Graphical user interface
After locating the configuration file, open it using a (:abbr:`GUI (graphical user
interface)`). This can be achieved by simply double clicking on the file. Then, the device
should have a default :abbr:`GUI (graphical user interface)` to open the file with.
Next, modify the master password line `admin_passwd = $pbkdf2-sha…` to `admin_passwd =
newpassword1234`, for example. This password can be anything, as long as it is saved
temporarily. Make sure to modify all characters after the `=`.
.. example::
The line appears like this:
`admin_passwd =
$pbkdf2-sh39dji295.59mptrfW.9z6HkA$w9j9AMVmKAP17OosCqDxDv2hjsvzlLpF8Rra8I7p/b573hji540mk/.3ek0lg%kvkol6k983mkf/40fjki79m`
The modified line appears like this: `admin_passwd = newpassword1234`
.. group-tab:: Command-line interface
Modify the master password line using the following Unix command detailed below.
Connect to the Odoo server's terminal via Secure Shell (SSH) protocol, and edit the
configuration file. To modify the configuration file, enter the following command:
:command:`sudo nano /etc/odoo.conf`
After opening the configuration file, modify the master password line `admin_passwd =
$pbkdf2-sha…` to `admin_passwd = newpassword1234`. This password can be anything, as long as
it is saved temporarily. Make sure to modify all characters after the `=`.
.. example::
The line appears like this:
`admin_passwd =
$pbkdf2-sh39dji295.59mptrfW.9z6HkA$w9j9AMVmKAP17OosCqDxDv2hjsvzlLpF8Rra8I7p/b573hji540mk/.3ek0lg%kvkol6k983mkf/40fjki79m`
The modified line appears like this: `admin_passwd = newpassword1234`
.. important::
It is essential that the password is changed to something else, rather than triggering a new
password reset by adding a semicolon `;` at the beginning of the line. This ensures the database
is secure throughout the entire password reset process.
Restart Odoo server
~~~~~~~~~~~~~~~~~~~
After setting the temporary password, a restart of the Odoo server is **required**.
.. tabs::
.. group-tab:: Graphical user interface
To restart the Odoo server, first, type `services` into the Windows :guilabel:`Search` bar.
Then, select the :guilabel:`Services` application, and scroll down to the :guilabel:`Odoo`
service.
Next, right click on :guilabel:`Odoo`, and select :guilabel:`Start` or :guilabel:`Restart`.
This action manually restarts the Odoo server.
.. group-tab:: Command-line interface
Restart the Odoo server by typing the command: :command:`sudo service odoo15 restart`
.. note::
Change the number after `odoo` to fit the specific version the server is running on.
Use web interface to re-encrypt password
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
First, navigate to `/web/database/manager` or `http://server_ip:port/web/database/manager` in a
browser.
.. note::
Replace `server_ip` with the IP address of the database. Replace `port` with the numbered port
the database is accessible from.
Next, click :guilabel:`Set Master Password`, and type in the previously-selected temporary password
into the :guilabel:`Master Password` field. Following this step, type in a :guilabel:`New Master
Password`. The :guilabel:`New Master Password` is hashed (or encrypted), once the
:guilabel:`Continue` button is clicked.
At this point, the password has been successfully reset, and a hashed version of the new password
now appears in the configuration file.
.. seealso::
For more information on Odoo database security, see this documentation:
:ref:`db_manager_security`.
Supported Browsers
==================
+2 -2
View File
@@ -45,7 +45,7 @@ Git
To clone a Git repository, choose between cloning with HTTPS or SSH. In most cases, the best option
is HTTPS. However, choose SSH to contribute to Odoo source code or when following the :doc:`Getting
Started developer tutorial </developer/tutorials/getting_started>`.
Started developer tutorial </developer/tutorials/server_framework_101>`.
.. tabs::
@@ -144,7 +144,7 @@ Odoo requires **Python 3.10** or later to run.
to download and install Python 3 if needed.
.. note::
If Python 3 is already installed, make sure that the version is 3.7 or above, as previous
If Python 3 is already installed, make sure that the version is 3.10 or above, as previous
versions are not compatible with Odoo.
.. tabs::
@@ -31,6 +31,12 @@ This matrix shows the support status of every version.
- On-Premise
- Release date
- End of support
* - Odoo saas~17.2
- |green|
- N/A
- N/A
- April 2024
-
* - Odoo saas~17.1
- |green|
- N/A
+21 -30
View File
@@ -2,8 +2,6 @@
Upgrade
=======
.. _administration/upgrade:
An upgrade is the process of moving your database from an older version to a newer :doc:`supported
version <supported_versions>` (e.g., Odoo 14.0 to Odoo 16.0). Frequently upgrading is essential as
each version comes with new and improved features, bug fixes, and security patches.
@@ -45,30 +43,23 @@ An upgrade does not cover:
<upgrade/request-test-database>` while also :doc:`upgrading the source code of your custom
modules </developer/howtos/upgrade_custom_db>`.
Upgrading in a nutshell
-----------------------
#. Request an upgraded test database (see :ref:`obtaining an upgraded test database
<upgrade/request-test-database>`).
#. If applicable, upgrade the source code of your custom module to be compatible with the new
version of Odoo (see :doc:`/developer/howtos/upgrade_custom_db`).
#. Thoroughly test the upgraded database (see :ref:`testing the new version of the database
<upgrade/test_your_db>`).
#. Report any issue encountered during the testing to Odoo via the `support page
<https://odoo.com/help?stage=migration>`__.
#. Report any issue encountered during the testing to Odoo by `submitting a ticket for an issue
related to my future upgrade (I am testing an upgrade) <https://odoo.com/help?stage=migration>`_.
#. Once all issues are resolved and you are confident that the upgraded database can be used as
your main database without any issues, plan the upgrade of your production database.
#. Request the upgrade for the production database, rendering it unavailable for the time it takes
to complete the process (see :ref:`upgrading the production database <upgrade/upgrade-prod>`).
#. Report any issue encountered during the upgrade to Odoo via the `support page
<https://odoo.com/help?stage=post_upgrade>`__.
#. Report any issue encountered during the upgrade to Odoo by `submitting a ticket for an issue
related to my upgrade (production) <https://odoo.com/help?stage=post_upgrade>`_.
.. _upgrade/request-test-database:
@@ -254,9 +245,9 @@ working correctly and to get more familiar with the new version.
This list is **not** exhaustive. Extend the example to your other apps based on your use of Odoo.
If you face an issue while testing your upgraded test database, you can request the assistance of
Odoo via the `support page <https://odoo.com/help?stage=migration>`__ by selecting the option
related to testing the upgrade. In any case, it is essential to report any
problem encountered during the testing to fix it before upgrading your production database.
Odoo by `submitting a ticket for an issue related to my future upgrade (I am testing an upgrade)
<https://odoo.com/help?stage=migration>`_. In any case, it is essential to report any problem
encountered during the testing to fix it before upgrading your production database.
You might encounter significant differences with standard views, features, fields, and models during
testing. Those changes cannot be reverted on a case-by-case basis. However, if a change introduced
@@ -280,24 +271,25 @@ Upgrading the production database
---------------------------------
Once the :ref:`tests <upgrade/test_your_db>` are completed and you are confident that the upgraded
database can be used as your main database without any issues, it is time to plan the go-live day. It
can be planned in coordination with Odoo's upgrade support analysts, reachable via the `support page
<https://odoo.com/help>`__.
database can be used as your main database without any issues, it is time to plan the go-live day.
It can be planned in coordination with Odoo's upgrade support analysts by `submitting a ticket for
an issue related to my future upgrade (I am testing an upgrade)
<https://odoo.com/help?stage=migration>`_.
Your production database will be unavailable during its upgrade. Therefore, we recommend planning
the upgrade at a time when the use of the database is minimal.
As the standard upgrade scripts and your database are constantly evolving, it is also recommended
to frequently request another upgraded test database to ensure that the upgrade process is
still successful, especially if it takes a long time to finish. **Fully rehearsing the upgrade
process the day before upgrading the production database is also recommended.**
to frequently request another upgraded test database to ensure that the upgrade process is still
successful, especially if it takes a long time to finish. **Fully rehearsing the upgrade process the
day before upgrading the production database is also recommended.**
.. important::
- Going into production without first testing may lead to:
Going into production without first testing may lead to:
- Users failing to adjust to the changes and new features
- Business interruptions (e.g., no longer having the possibility to validate an action)
- Poor customer experience (e.g., an eCommerce website that does not work correctly)
- Users failing to adjust to the changes and new features
- Business interruptions (e.g., no longer having the possibility to validate an action)
- Poor customer experience (e.g., an eCommerce website that does not work correctly)
The process of upgrading a production database is similar to upgrading a test database with a few
exceptions.
@@ -358,10 +350,9 @@ exceptions.
a filestore. Therefore, the upgraded database filestore must be merged with the production
filestore before deploying the new version.
In case of an issue with your production database, you can request the assistance of Odoo via the
`support page <https://odoo.com/help?stage=post_upgrade>`__ by selecting the option related to
the upgrade in production.
In case of an issue with your production database, you can request the assistance of Odoo by
`submitting a ticket for an issue related to my upgrade (production)
<https://odoo.com/help?stage=post_upgrade>`_.
.. _upgrade/sla:
+274 -164
View File
@@ -2,238 +2,348 @@
Activities
==========
*Activities* are follow-up tasks tied to a record in an Odoo database. Activities can be scheduled
on any page of the database that contains a chatter thread, kanban view, list view, or activities
view of an application.
*Activities* are follow-up tasks tied to a record in an Odoo database.
.. _activities/important:
The icon used to display activities varies depending on the :ref:`activity type <activities/types>`:
- :guilabel:`🕘 (clock)`: the default icon, which appears if nothing is scheduled.
- :guilabel:`📞 (phone)`: this icon appears if a phone call is scheduled.
- :guilabel:`✉️ (envelope)`: this icon appears if an email is scheduled.
- :guilabel:`✔️ (checkmark)`: this icon appears if a to-do is scheduled.
- :guilabel:`(group of people)`: this icon appears if a meeting is scheduled.
- :guilabel:`(arrow pointing up above a line)`: this icon appears if a document is scheduled to be
uploaded.
- :guilabel:`(pencil in a box)`: this icon appears if a signature request is scheduled.
Schedule activities
===================
One way that activities are created is by clicking the :guilabel:`Schedule Activity` button, located
at the top of the *chatter* on any record. On the pop-up window that appears, select an
:guilabel:`Activity Type` from the drop-down menu.
Activities can be scheduled on any page of the database that contains a :ref:`chatter
<activities/chatter>` thread, :ref:`Kanban view <activities/kanban>`, :ref:`list view
<activities/list>`, or :ref:`activities view <activities/activity>` of an application.
.. tip::
Individual applications have a list of *Activity Types* dedicated to that application. For
example, to view and edit the activities available for the *CRM* application, go to
:menuselection:`CRM app --> Configuration --> Activity Types`.
.. _activities/chatter:
Enter a title for the activity in the :guilabel:`Summary` field, located in the :guilabel:`Schedule
Activity` pop-up window.
Chatter
-------
To assign the activity to a different user, select a name from the :guilabel:`Assigned to` drop-down
menu. Otherwise, the user creating the activity is automatically assigned.
Activities can be created from the chatter on any record.
Lastly, feel free to add any additional information in the optional :guilabel:`Log a note...` field.
To schedule a new activity, click the :guilabel:`Activities` button, located at the top of the
chatter. In the :guilabel:`Schedule Activity` pop-up window that appears, :ref:`fill out the
Schedule Activity form <activities/form>`.
.. image:: activities/chatter.png
:align: center
:alt: New activity type form.
.. _activities/kanban:
Kanban view
-----------
Another way that activities are created is from the Kanban view in an application.
.. image:: activities/kanban.png
:align: center
:alt: The Kanban icon in the top menu, highlighted.
To do so, click on the :guilabel:`🕘 (clock)` icon located at the bottom of an individual record.
Click :guilabel:`+ Schedule An Activity`, then proceed to :ref:`fill out the Schedule Activity form
<activities/form>`.
.. image:: activities/schedule-kanban-activity.png
:align: center
:alt: Kanban view of the CRM pipeline and the option to schedule an activity.
.. note::
The :guilabel:`Due Date` field on the :guilabel:`Schedule Activity` pop-up window auto-populates
based on the configuration settings for the selected :guilabel:`Activity Type`. However, this
date can be changed by selecting a day on the calendar in the :guilabel:`Due Date` field.
If a record already has a scheduled activity, the :guilabel:`🕘 (clock)` icon is replaced by the
icon that represents the existing scheduled activity. Click on the activity type's icon to
schedule another activity.
Lastly, click one of the following buttons:
.. _activities/list:
- :guilabel:`Schedule`: adds the activity to the chatter under :guilabel:`Planned activities`.
- :guilabel:`Mark as Done`: adds the details of the activity to the chatter under :guilabel:`Today`.
The activity is not scheduled, it is automatically marked as completed.
- :guilabel:`Done \& Schedule Next`: adds the task under :guilabel:`Today` marked as done, and
opens a new activity window.
- :guilabel:`Discard`: discards any changes made on the pop-up window.
List view
---------
.. image:: activities/schedule-pop-up.png
:alt: View of CRM leads and the option to schedule an activity.
Activities can also be created from a list view.
If the :guilabel:`Activities` column is hidden, reveal it using the :guilabel:`(additional options
toggle)` icon in the far-right of the top row, represented by two horizontal lines with two dots.
Then, click on the :guilabel:`🕘 (clock)` icon for the record the activity is being added to, then
click :guilabel:`+ Schedule an activity`. Proceed to :ref:`fill out the Schedule Activity form
<activities/form>` that appears.
.. note::
Depending on the activity type, the :guilabel:`Schedule` button may be replaced by a
:guilabel:`Save` button, or an :guilabel:`Open Calendar` button.
If a record already has a scheduled activity, the :guilabel:`🕘 (clock)` icon is replaced by the
icon that represents the existing scheduled activity. Click on the activity type's icon to
schedule another activity.
Scheduled activities are added to the chatter for the record under :guilabel:`Planned activities`.
.. image:: activities/schedule-list-activity.png
:align: center
:alt: List view of the CRM pipeline and the option to schedule an activity.
.. image:: activities/chatter-activities.png
:alt: View of CRM leads and the option to schedule an activity.
.. _activities/activity:
Activities can also be scheduled from the kanban, list, or activities view of an application.
Activity view
-------------
.. tabs::
Most applications in Odoo have an *Activity* view available. If available, a :guilabel:`🕘 (clock)`
activity icon is visible in the top-right of the main menu bar.
.. tab:: Kanban view
To open the activity view, click the :guilabel:`🕘 (clock)` activity icon.
Select a record on which to schedule an activity. Click on the :guilabel:`🕘 (clock)` icon,
then :guilabel:`Schedule An Activity`, and proceed to fill out the pop-up form.
.. image:: activities/activities.png
:align: center
:alt: Top-right menu with the Activities icon called out.
.. image:: activities/schedule-kanban-activity.png
:alt: Kanban view of the CRM pipeline and the option to schedule an activity.
In this view, all the available activities are listed in the columns, while the horizontal entries
represent all the individual records.
.. tab:: List view
Activities that appear green have a due date in the future, activities that appear orange are due
today, while activities appearing red are overdue.
Select a record on which to schedule an activity. Click on the :guilabel:`🕘 (clock)` icon,
then :guilabel:`Schedule An Activity`. If the record already has an activity scheduled, the
clock icon may be replaced by a :guilabel:`📞 (phone)` or an :guilabel:`✉️ (envelope)` icon.
Color bars in each column represent records for specific activity types, and display a number
indicating how many activities are scheduled for that type.
.. image:: activities/schedule-list-activity.png
:alt: List view of the CRM pipeline and the option to schedule an activity.
.. tab:: Activity view
To open the activity view for an application, select the :guilabel:`🕘 (clock)` icon from the
menu bar anywhere in the database. Select any application from the drop-down menu, and click
the :guilabel:`🕘 (clock)` icon for the desired app.
.. image:: activities/schedule-activity-view-menu.png
:alt: Activity menu drop down with focus on where to open activity view for CRM.
Select a record on which to schedule an activity. Move across the row to find the desired
activity type, then click the :guilabel:` (plus sign)`.
.. image:: activities/schedule-activity-view.png
:alt: Activity view of the CRM pipeline and the option to schedule an activity.
If multiple activity types are scheduled for a record, a number appears in the box, indicating the
total number of scheduled activities.
.. note::
Activity colors, and their relation to an activity's due date, is consistent throughout Odoo,
regardless of the activity type, or the view.
- Activities that appear in **green** indicate a due date sometime in the future.
- **Yellow** indicates that the activity's due date is today.
- **Red** indicates that the activity is overdue and the due date has passed.
To schedule an activity for a record, hover over the corresponding field, and a :guilabel:` (plus
sign)` appears. Click the :guilabel:` (plus sign)`, and then :ref:`fill out the Schedule Activity
form <activities/form>`.
For example, if an activity is created for a phone call, and the due date passes, the activity
appears with a red phone in list view, and a red clock on the kanban view.
.. image:: activities/activity-view.png
:align: center
:alt: Activity view of the CRM pipeline and the option to schedule an activity.
View scheduled activities
=========================
.. _activities/form:
To view scheduled activities, open either the :menuselection:`Sales app` or :menuselection:`CRM app`
and click the :guilabel:`🕘 (clock)` icon, located to the far-right side of the other view options.
Schedule Activity form
----------------------
Doing so opens the activities menu, showcasing all the scheduled activities for the user, by
default. To show all activities for every user, remove the :guilabel:`My Pipeline` filter from the
:guilabel:`Search...` bar.
Activities can be scheduled from many different places, such as from the :ref:`chatter
<activities/chatter>` of a record, or from one of multiple views in an application, when available:
the :ref:`Kanban view <activities/kanban>`, :ref:`list view <activities/list>`, or :ref:`activity
view <activities/activity>`.
To view a consolidated list of activities separated by the application where they were created, and
by deadline, click the :guilabel:`🕘 (clock)` icon on the header menu to see the activities for that
specific application in a drop-down menu.
Enter the following information on the form:
The possibility to :guilabel:`Add new note` and :guilabel:`Request a Document` appear at the bottom
of this drop-down menu, when the :guilabel:`🕘 (clock)` icon on the header menu is clicked.
- :guilabel:`Activity Type`: select the type of activity from the drop-down menu. The default
options are: :guilabel:`Email`, :guilabel:`Call`, :guilabel:`Meeting`, or :guilabel:`To-Do`.
Depending on what other applications are installed, additional options may be available.
.. image:: activities/activities-menu.png
:alt: View of CRM leads page emphasizing the activities menu.
.. note::
Individual applications have a list of dedicated :ref:`activity types <activities/types>`. For
example, installing the *Sales* application makes :guilabel:`Order Upsell` available, while
installing the *Sign* application makes :guilabel:`Request Signature` available.
Configure activity types
- :guilabel:`Summary`: enter a short title for the activity, such as `Discuss Proposal`.
- :guilabel:`Due Date`: using the calendar popover, select the activity's deadline.
- :guilabel:`Assigned to`: by default, the current user populates this field. To assign a different
user to the activity, select them from the drop-down menu.
- :guilabel:`Notes`: add any additional information for the activity in this field.
When the :guilabel:`Schedule Activity` pop-up window is completed, click one of the following
buttons:
- :guilabel:`Open Calendar`: opens the user's calendar to add and schedule the activity.
Click on the desired date and time for the activity, and a :guilabel:`New Event` pop-up window
appears. The summary from the *Schedule Activity* pop-up window populates the :guilabel:`Title`
field.
Enter the information in the :guilabel:`New Event` pop-up window, then click :guilabel:`Save &
Close` to schedule it. Once scheduled, the activity is added to the chatter under the
:guilabel:`Planned Activities` section.
.. important::
The :guilabel:`Open Calendar` button **only** appears if the :guilabel:`Activity Type` is set
to either :guilabel:`Call` or :guilabel:`Meeting`.
- :guilabel:`Schedule`: schedules the activity, and adds the activity to the chatter under
:guilabel:`Planned Activities`.
- :guilabel:`Schedule & Mark as Done`: adds the details of the activity to the chatter under
:guilabel:`Today`. The activity is not scheduled, and is automatically marked as done.
- :guilabel:`Done & Schedule Next`: adds the details of the activity to the chatter under
:guilabel:`Today`. The activity is not scheduled, is automatically marked as done, and a new
:guilabel:`Schedule Activity` pop-up window appears.
- :guilabel:`Cancel`: discards any changes made on the :guilabel:`Schedule Activity` pop-up window.
.. image:: activities/schedule-pop-up.png
:align: center
:alt: View of CRM leads and the option to schedule an activity.
.. _activities/all:
All scheduled activities
========================
To configure the types of activities in the database, go to :menuselection:`Settings app --> Discuss
--> Activities --> Activity Types`.
To view a consolidated list of activities, organized by application, click the :guilabel:`🕘
(clock)` icon in the header menu, located in the top-right.
If any activities are scheduled, the number of activities appear in a red bubble on the
:guilabel:`🕘 (clock)` icon.
All activities for each application are further divided into subsections, indicating where in the
application the activity is to be completed. Each sub-section lists the number of scheduled
activities that are :guilabel:`Late`, due :guilabel:`Today`, and scheduled in the
:guilabel:`Future`.
.. example::
In the *Time Off* application, one activity is scheduled to be done in the *All Time Off*
requests dashboard, and six activities are scheduled to be done in the *Allocations* dashboard.
These requests appear in two separate lists in the all activities drop-down menu: one labeled
`Time Off` and one labeled `Time Off Allocation`.
.. image:: activities/activities-menu.png
:align: center
:alt: The list of activities that is accessed from the main menu bar. Two entries for the Time
Off application are highlighted.
Request a document
------------------
The option to :guilabel:`Request a Document` is available at the bottom of the list of :ref:`all
scheduled activities <activities/all>`, the option to :guilabel:`Request a Document` appears. Click
:guilabel:`Request a Document`, and a :guilabel:`Request a file` pop-up window appears.
Enter the following information on the form:
- :guilabel:`Document Name`: enter a name for the document being requested.
- :guilabel:`Request To`: select the user the document is being requested from using the drop-down
menu.
- :guilabel:`Due Date In`: enter a numerical value indicating when the document is due. Next to
this field, a :guilabel:`Days` field is visible. Click :guilabel:`Days`, the default option, to
reveal a drop-down menu. Select the desired time-frame option from the list. The options are
:guilabel:`Days`, :guilabel:`Weeks`, or :guilabel:`Months`.
- :guilabel:`Workspace`: using the drop-down menu, select the specific :ref:`Workspace
<documents/workspaces>` the document is being uploaded to.
- :guilabel:`Tags`: select any desired tags from the drop-down menu. The available tags displayed
are based on the tags configured for the selected :guilabel:`Workspace`.
- :guilabel:`Message`: enter a message to clarify the document request in this field.
When all the fields are completed, click :guilabel:`Request` to send the document request.
.. image:: activities/request-doc.png
:align: center
:alt: The Request a file form, with all fields filled out to request a contract.
.. _activities/types:
Activity types
==============
To view the currently configured types of activities in the database, navigate to
:menuselection:`Settings app --> Discuss section --> Activities setting --> Activity Types`.
.. image:: activities/settings-activities-types.png
:alt: View of the settings page emphasizing the menu activity types.
:align: center
:alt: Activity Types button in the Settings application under the Discuss section.
Doing so reveals the :guilabel:`Activity Types` page, where the existing activity types are found.
To edit an existing activity type, select it from the list, then click :guilabel:`Edit`. To create a
new activity type, click :guilabel:`Create`.
.. image:: activities/activity-list.png
:align: center
:alt: The list of activity types already configured and available.
At the top of a blank activity type form, start by choosing a :guilabel:`Name` for the new activity
type.
Edit activity types
-------------------
.. image:: activities/new-activity-type.png
:alt: New activity type form.
To edit an existing :ref:`activity type <activities/types>`, click on the activity type, and the
activity type form loads.
Activity settings
-----------------
Make any desired changes to the activity type form. The form automatically saves, but it can be
saved manually at any time by clicking the :guilabel:`Save Manually` option, represented by a
:guilabel:`(cloud upload)` icon, located in the top-left corner of the page.
Action
~~~~~~
Create new activity types
-------------------------
The *Action* field specifies the intent of the activity. Some actions trigger specific behaviors
after an activity is scheduled.
To create a new :ref:`activity type <activities/types>`, click :guilabel:`New` from the
:guilabel:`Activity Types` page, and a blank activity type form loads.
- If :guilabel:`Upload Document` is selected, a link to upload a document is added directly to the
planned activity in the chatter.
- If either :guilabel:`Phonecall` or :guilabel:`Meeting` are selected, users have the option to open
their calendar to schedule a time for this activity.
- If :guilabel:`Request Signature` is selected, a link is added to the planned activity in the
chatter that opens a signature request pop-up window.
Enter a :guilabel:`Name` for the activity type at the top of the form, then enter the following
information on the form.
.. note::
The actions available to select on an activity type vary, depending on the applications currently
installed in the database.
Activity Settings section
~~~~~~~~~~~~~~~~~~~~~~~~~
Default user
~~~~~~~~~~~~
- :guilabel:`Action`: using the drop-down menu, select an action associated with this new activity
type. Some actions trigger specific behaviors after an activity is scheduled, such as:
To automatically assign this activity to a specific user when this activity type is scheduled,
choose a name from the :guilabel:`Default User` drop-down menu. If this field is left blank, the
activity is assigned to the user who creates the activity.
- :guilabel:`Upload Document`: if selected, a link to upload a document is automatically added to
the planned activity in the chatter.
- :guilabel:`Call` or :guilabel:`Meeting`: if selected, users have the option to open their
calendar to select a date and time for the activity.
- :guilabel:`Request Signature`: if selected, a link to open a signature request pop-up window is
automatically added to the planned activity in the chatter. This requires the Odoo *Sign*
application to be installed.
Default summary
~~~~~~~~~~~~~~~
.. note::
Available activity types vary based on the installed applications in the database.
To include notes whenever this activity type is created, enter them into the :guilabel:`Default
Summary` field.
- :guilabel:`Folder`: select a specific :ref:`workspace <documents/workspaces>` folder to save a
document to. This field **only** appears if :guilabel:`Upload Document` is selected for the
:guilabel:`Action`.
.. note::
The information in the :guilabel:`Default User` and :guilabel:`Default Summary` fields are
included when an activity is created. However, they can be altered before the activity is
scheduled or saved.
Using the drop-down menu, select the :guilabel:`Folder` the document is saved to.
Next activity
-------------
- :guilabel:`Default User`: select a user from the drop-down menu to automatically assign this
activity to the selected user when this activity type is scheduled. If this field is left blank,
the activity is assigned to the user who creates the activity.
- :guilabel:`Default Summary`: enter a note to include whenever this activity type is created.
To automatically suggest, or trigger, a new activity after an activity has been marked complete, the
:guilabel:`Chaining Type` must be set.
.. note::
The information in the :guilabel:`Default User` and :guilabel:`Default Summary` fields are
included when an activity is created. However, they can be altered before the activity is
scheduled or saved.
Suggest next activity
- :guilabel:`Keep Done`: tick this checkbox to keep activities that have been marked as `Done`
visible in the :ref:`activity view <activities/activity>`.
- :guilabel:`Default Note`: enter any notes to appear with the activity.
Next Activity section
~~~~~~~~~~~~~~~~~~~~~
In the :guilabel:`Chaining Type` field, select :guilabel:`Suggest Next Activity`. Upon doing so, the
field underneath changes to: :guilabel:`Suggest`. Click the :guilabel:`Suggest` field drop-down menu
to select any activities to recommend as follow-up tasks to this activity type.
It is possible to have another activity either suggested or triggered. To do so, configure the
:guilabel:`Next Activity` section.
In the :guilabel:`Schedule` field, choose a default deadline for these activities. To do so,
configure a desired number of :guilabel:`Days`, :guilabel:`Weeks`, or :guilabel:`Months`. Then,
decide if it should occur :guilabel:`after completion date` or :guilabel:`after previous activity
deadline`.
- :guilabel:`Chaining Type`: select either :guilabel:`Suggest Next Activity` or :guilabel:`Trigger
Next Activity` from the drop-down menu. Depending on the selected option, either the
:guilabel:`Suggest` or :guilabel:`Trigger` field is displayed.
This :guilabel:`Schedule` field information can be altered before the activity is scheduled.
.. note::
The :guilabel:`Chaining Type` field does **not** appear if :guilabel:`Upload Document` is
selected for the :guilabel:`Action`.
When all configurations are complete, click :guilabel:`Save`.
- :guilabel:`Suggest/Trigger`: depending on what is selected for the :guilabel:`Chaining Type`, this
field either displays :guilabel:`Suggest` or :guilabel:`Trigger`. Using the drop-down menu, select
the activity to recommend or schedule as a follow-up task to the activity type.
- :guilabel:`Schedule`: configure when the next activity is suggested or triggered.
.. image:: activities/schedule-recommended-activity.png
:alt: Schedule activity popup with emphasis on recommended activities.
First, enter a numerical value indicating when the activity is suggested or triggered.
.. note::
If an activity has the :guilabel:`Chaining Type` set to :guilabel:`Suggest Next Activity`, and
has activities listed in the :guilabel:`Suggest` field, users are presented with recommendations
for activities as next steps.
Next to this field, a :guilabel:`Days` field is visible. Click :guilabel:`Days`, the default
option, to reveal a drop-down menu. Select the desired time-frame option from the list. The
options are :guilabel:`Days`, :guilabel:`Weeks`, or :guilabel:`Months`.
Trigger next activity
~~~~~~~~~~~~~~~~~~~~~
Lastly, using the drop-down menu, select whether the activity is scheduled or triggered either
:guilabel:`after previous activity deadline` or :guilabel:`after completion date`.
Setting the :guilabel:`Chaining Type` to :guilabel:`Trigger Next Activity` immediately launches the
next activity once the previous one is completed.
If :guilabel:`Trigger Next Activity` is selected in the :guilabel:`Chaining Type` field, the field
beneath changes to: :guilabel:`Trigger`. From the :guilabel:`Trigger` field drop-down menu, select
the activity that should be launched once this activity is completed.
In the :guilabel:`Schedule` field, choose a default deadline for these activities. To do so,
configure a desired number of :guilabel:`Days`, :guilabel:`Weeks`, or :guilabel:`Months`. Then,
decide if it should occur :guilabel:`after completion date` or :guilabel:`after previous activity
deadline`.
This :guilabel:`Schedule` field information can be altered before the activity is scheduled.
When all configurations are complete, click :guilabel:`Save`.
.. image:: activities/triggered-activities.png
:alt: Schedule new activity popup with emphasis on Done and launch next button.
.. note::
When an activity has the :guilabel:`Chaining Type` set to :guilabel:`Trigger Next Activity`,
marking the activity as `Done` immediately launches the next activity listed in the
:guilabel:`Trigger` field.
.. image:: activities/new-activity.png
:align: center
:alt: A new Activity form with all the fields filled out.
.. seealso::
- :doc:`/applications/productivity/discuss`
- :doc:`/applications/productivity/discuss/team_communication`
- :doc:`../productivity/discuss`
- :doc:`../productivity/discuss/team_communication`
Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

@@ -20,7 +20,7 @@ can aid in reporting on activities, although, Odoo provides a precise and easy r
each available application.
With Odoo, the values can be exported from any field in any record. To do so, activate the list view
(:guilabel:` (three horizontal lines)` icon), on the items that need to be exported, and then
(:guilabel:` (four horizontal lines)` icon), on the items that need to be exported, and then
select the records that should be exported. To select a record, tick the checkbox next to the
corresponding record. Finally, click on :guilabel:`⚙️ Action`, and then :guilabel:`Export`.
@@ -55,8 +55,9 @@ several options for the data to export:
can)` icon to remove the field.
#. For recurring reports, it is helpful to save export presets. Select all the needed fields, and
click on the template drop-down menu. Once there, click on :guilabel:`New template`, and give a
unique name to the export just created. The next time the same list needs to be exported, select
the related template that was previously saved from the drop-down menu.
unique name to the export just created. Click the :guilabel:`💾 (floppy drive)` icon to save the
configuration. The next time the same list needs to be exported, select the related template that
was previously saved from the drop-down menu.
.. tip::
It is helpful to know the field's external identifier. For example, :guilabel:`Related Company`
@@ -98,11 +99,11 @@ Data can be imported on any Odoo business object using either Excel (`.xlsx`) or
journal entries, and orders.
Open the view of the object to which the data should be imported/populated, and click on
:menuselection:`⭐ Favorites --> Import records`.
:menuselection:`⚙️ (Action) --> Import records`.
.. image:: export_import_data/import-button.png
:align: center
:alt: Favorites menu revealed with the import records option highlighted.
: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,
Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 47 KiB

@@ -1,6 +1,6 @@
=====================
In-app purchase (IAP)
=====================
======================
In-app purchases (IAP)
======================
.. |IAP| replace:: :abbr:`IAP (In-app purchases)`
@@ -22,7 +22,9 @@ the service in the app to activate it. However, each service requires its own pr
when they run out, users **must** :ref:`buy more <iap/buying_credits>` in order to keep using it.
.. note::
Users with an Enterprise version of Odoo Online get free credits to test IAP features.
Enterprise Odoo users with a valid subscription get free credits to test IAP features before
deciding to purchase more credits for the database. This includes demo/training databases,
educational databases, and one-app-free databases.
.. _in_app_purchase/portal:
@@ -31,7 +33,7 @@ IAP services
|IAP| services are provided by Odoo, as well as third-parties, and have a wide range of uses.
The following |IAP| services are provided by Odoo:
The following |IAP| services are offered by Odoo:
- :guilabel:`Documents Digitization`: digitizes scanned or PDF vendor bills, expenses, and resumes
with OCR and AI.
@@ -40,9 +42,12 @@ The following |IAP| services are provided by Odoo:
- :guilabel:`Lead Generation`: generates leads based on a set of criteria, and converts web visitors
into quality leads and opportunities.
- :guilabel:`Snailmail`: sends customer invoices and follow-up reports by post, worldwide.
- :guilabel:`Signer identification with itsme®️`: ask document signatories in Odoo *Sign* to provide
their identity using the *itsme®* identity platform, which is available in Belgium and the
Netherlands.
For more information on every service currently available, visit the `Odoo IAP Catalog
<https://iap.odoo.com/iap/all-in-app-services>`_.
For more information on every service currently available (offered from developers other than Odoo),
visit the `Odoo IAP Catalog <https://iap.odoo.com/iap/all-in-app-services>`_.
Use IAP services
----------------
@@ -53,7 +58,7 @@ settings. To use a service, simply interact with it wherever it appears in the d
.. example::
The following flow focuses on the *SMS* |IAP| service being used from a contact's record.
This can be done by clicking the :guilabel:`📱 (phone) SMS` icon within the database.
This can be done by clicking the :guilabel:`📱 SMS` icon within the database.
.. image:: in_app_purchase/sms-icon.png
:align: center
@@ -61,16 +66,17 @@ settings. To use a service, simply interact with it wherever it appears in the d
One way to utilize the *SMS* |IAP| service with Odoo is showcased in the following steps:
#. Navigate to the :menuselection:`Contacts application`, and click on a contact with a mobile
phone number entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the
contact form.
#. Hover the mouse over the :guilabel:`Phone` or :guilabel:`Mobile` field, and a :guilabel:`📱
(phone) SMS` icon appears to the right.
#. Click the :guilabel:`📱 (phone) SMS` icon, and a :guilabel:`Send SMS Text Message` pop-up
window appears.
#. Type a message in the :guilabel:`Message` field of the :guilabel:`Send SMS Text Message`
pop-up window. Then, click the :guilabel:`Send SMS` button. Odoo then sends the message, via
SMS, to the contact, and logs what was sent in the *chatter* of the contact's form.
First, navigate to the :menuselection:`Contacts application`, and click on a contact with a
mobile phone number entered in either the :guilabel:`Phone` or :guilabel:`Mobile` field of the
contact form.
Next, find the :guilabel:`📱 SMS` icon that appears to the right of the :guilabel:`Phone` or
:guilabel:`Mobile` fields. Click the :guilabel:`📱 SMS` icon, and a :guilabel:`Send SMS Text
Message` pop-up window appears.
Type a message in the :guilabel:`Message` field of the pop-up window. Then, click the
:guilabel:`Send SMS` button. Odoo then sends the message, via SMS, to the contact, and logs what
was sent in the *chatter* of the contact's form.
Upon sending the SMS message, the prepaid credits for the *SMS* |IAP| service are automatically
deducted from the existing credits. If there are not enough credits to send the message, Odoo
@@ -80,10 +86,10 @@ settings. To use a service, simply interact with it wherever it appears in the d
For more information on how to use various |IAP| services, and for more in-depth instructions
related to SMS functionality in Odoo, review the documentation below:
- :doc:`Lead mining </applications/sales/crm/acquire_leads/lead_mining>`
- :doc:`Lead mining <../sales/crm/acquire_leads/lead_mining>`
- :doc:`Enrich your contacts base with Partner Autocomplete
</applications/sales/crm/optimize/partner_autocomplete>`
- :doc:`SMS essentials </applications/marketing/sms_marketing/essentials/sms_essentials>`
<../sales/crm/optimize/partner_autocomplete>`
- :doc:`SMS essentials <../marketing/sms_marketing/essentials/sms_essentials>`
.. _in_app_purchase/credits:
@@ -113,7 +119,7 @@ Credits are purchased in *Packs* from the `Odoo IAP Catalog
The number of credits consumed depends on the length of the SMS and the country of destination.
For more information, refer to the :doc:`SMS Pricing and FAQ
</applications/marketing/sms_marketing/pricing/pricing_and_faq>` documentation.
<../marketing/sms_marketing/pricing/pricing_and_faq>` documentation.
.. _iap/buying_credits:
@@ -124,9 +130,10 @@ If there are not enough credits to perform a task, the database automatically pr
of more credits.
Users can check the current balance of credits for each service, and manually purchase more credits,
by navigating to the :menuselection:`Settings app --> Search IAP --> View My Services`.
by navigating to the :menuselection:`Settings app --> Contacts section`, and beneath the
:guilabel:`Odoo IAP` setting, click :guilabel:`View My Services`.
Doing so reveals an :guilabel:`IAP Account` page, listing the various |IAP| services in the
Doing so reveals an :guilabel:`IAP Service` page, listing the various |IAP| services in the
database. From here, click an |IAP| service to open its :guilabel:`Account Information` page, where
additional credits can be purchased.
@@ -135,32 +142,29 @@ Manually buy credits
To manually buy credits in Odoo, follow these steps:
#. Go to the :menuselection:`Settings application`.
#. Type `IAP` in the search bar.
#. Click :guilabel:`View My Services`.
First, go to the :menuselection:`Settings application` and type `IAP` in the :guilabel:`Search...`
bar. Alternatively users can scroll down to the :guilabel:`Contacts` section. Under the
:guilabel:`Contacts` section, where it says :guilabel:`Odoo IAP`, click :guilabel:`View My
Services`.
.. image:: in_app_purchase/view-services.png
:align: center
:alt: The Settings app showing the Odoo IAP heading and View My Services button.
.. image:: in_app_purchase/view-services.png
:align: center
:alt: The Settings app showing the Odoo IAP heading and View My Services button.
#. Doing so reveals an :guilabel:`IAP Account` page, listing the various |IAP| services in the
database. From here, click an |IAP| service to open its :guilabel:`Account Information` page,
where additional credits can be purchased.
#. On the :guilabel:`Account Information` page, click the :guilabel:`Buy Credit` button.
Doing so reveals an :guilabel:`IAP Account` page, listing the various |IAP| services in the
database. From here, click an |IAP| service to open its :guilabel:`Account Information` page, where
additional credits can be purchased.
.. image:: in_app_purchase/account-info.png
:align: center
:alt: The Account Information page for an IAP service showing the Buy Credit button.
On the :guilabel:`Account Information` page, click the :guilabel:`Buy Credit` button. Doing so loads
a :guilabel:`Buy Credits for (IAP Account)` page in a new tab. From here, click :guilabel:`Buy` on
the desired pack of credits. Then, follow the prompts to enter payment details, and confirm the
order.
#. Doing so loads a :guilabel:`Buy Credits for (IAP Account)` page in a new tab. From here, click
:guilabel:`Buy` on the desired pack of credits. Then, follow the prompts to enter payment
details, and confirm the order.
.. image:: in_app_purchase/buy-pack.png
:align: center
:alt: The SMS service page on IAP.Odoo.com with four packs of credits available for purchase.
.. image:: in_app_purchase/buy-pack.png
:align: center
:alt: The SMS service page on IAP.Odoo.com with four packs of credits available for purchase.
#. Once the transaction is complete, the credits are available for use in the database.
Once the transaction is complete, the credits are available for use in the database.
.. _in_app_purchase/low-credits:
@@ -170,23 +174,19 @@ Low-credit notification
It is possible to be notified when credits are low, in order to avoid running out of credits, while
using an |IAP| service. To do that, follow this process:
#. Go to the :menuselection:`Settings application`.
#. Type `IAP` in the search bar.
#. Click :guilabel:`View My Services`.
#. The available |IAP| accounts appear in a list view on the :guilabel:`IAP Account` page. From
here, click on the desired |IAP| account to view that service's :guilabel:`Account Information`
page.
#. On the :guilabel:`Account Information` page, tick the :guilabel:`Warn Me` box. Doing so reveals
two fields on the form: :guilabel:`Threshold` and :guilabel:`Warning Email`.
Go to the :menuselection:`Settings application`, and type `IAP` in the :guilabel:`Search...` bar.
Under the :guilabel:`Contacts` section, where it says :guilabel:`Odoo IAP`, click :guilabel:`View My
Services`.
.. image:: in_app_purchase/low-credits.png
:align: center
:alt: Odoo will send an email alert when credits for this service fall below the threshold.
The available |IAP| accounts appear in a list view on the :guilabel:`IAP Account` page. From here,
click on the desired |IAP| account to view that service's :guilabel:`Account Information` page.
#. In the :guilabel:`Threshold` field, enter an amount of credits Odoo should use as the minimum
threshold for this service.
#. In the :guilabel:`Warning Email` field, enter the email address that should receive the
notification.
On the :guilabel:`Account Information` page, tick the :guilabel:`Warn Me` checkbox. Doing so reveals
two fields on the form: :guilabel:`Threshold` and :guilabel:`Warning Email`.
In the :guilabel:`Threshold` field, enter an amount of credits Odoo should use as the
minimum threshold for this service. In the :guilabel:`Warning Email` field, enter the email address
that receives the notification.
Odoo sends a low-credit alert to the :guilabel:`Warning Email` when the balance of credits falls
below the amount listed as the :guilabel:`Threshold`.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.7 KiB

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.4 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.1 KiB

After

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB

+184 -70
View File
@@ -1,100 +1,214 @@
=========================
Search and filter records
=========================
=================================
Search, filter, and group records
=================================
Odoo uses filters to include only the most relevant records depending on the purpose of the view you
are on. However, you can edit the default filter or search for specific values.
.. _search/preconfigured-filters:
Preconfigured filters
=====================
You can modify the default selection of records by clicking :guilabel:`Filters` and selecting one or
several **preconfigured filters**.
.. example::
On the Sales Analysis report, only records at the sales order stage are selected by default.
However, you could *also* include records at the quotation stage by selecting
:guilabel:`Quotations`. Furthermore, you could *only* include records from a specific year, for
example *2022*, by selecting :menuselection:`Order Date --> 2022`.
.. image:: search/preconfigured-filters.png
:align: center
:alt: Using preconfigured filters on the Sales Analysis report
.. note::
If you select preconfigured filters from the same group (i.e., that are *not* separated by an
horizontal line), the records can match *any* condition to be included. However, if you select
filters from different groups, the records have to match *all* condition to be included.
.. _search/custom-filters:
Custom filters
==============
You can create custom filters using most fields present on the model by clicking
:menuselection:`Filters --> Add Custom Filter`, selecting a field, an operator, a value, and
clicking :guilabel:`Apply`.
.. example::
You could *only* include records from a single salesperson on the Sales Analysis report, for
example *Mitchell Admin*, by selecting :guilabel:`Salesperson` as the field, :guilabel:`is equal
to` as the operator, and typing `Mitchell Admin` as the value.
.. image:: search/custom-filter.png
:align: center
:alt: Using a custom filter on the Sales Analysis report
.. note::
If the records should *only* match one of several conditions, click :guilabel:`Add a condition`
before applying a custom filter. If the records should match *all* conditions, add new custom
filters instead.
Odoo allows for the searching, filtering, and grouping of records in a view to display only the most
relevant records. The search bar is located at the top of the view, start typing to :ref:`search for
values <search/values>`, or click the :guilabel:`🔽 (down arrow)` icon to access the :ref:`Filter
<search/filters>`, :ref:`Group By <search/group>`, and :ref:`Favorites <search/favorites>` drop-down
menus.
.. _search/values:
Search for values
=================
You can use the search field to quickly look for specific values and add them as a filter. Either
type the full value you are searching for and select the desired field, or type a part of the
value, click the dropdown button (:guilabel:`⏵`) before the chosen field, and select the exact
value you are looking for.
Use the search field to quickly look for specific values, and add them as a filter. Type the value
to search for, and select the desired option from the drop-down menu to apply the search filter.
.. example::
Instead of adding a custom filter to select records where *Mitchell Admin* is the salesperson on
the Sales Analysis report, you could search for `Mitch`, click the dropdown button
(:guilabel:`⏵`) next to :guilabel:`Search Salesperson for: Mitch`, and select
:guilabel:`Mitchell Admin`.
Instead of adding a :ref:`custom filter <search/custom-filters>` to select records where
*Mitchell Admin* is the salesperson on the *Sales Analysis* report (:menuselection:`Sales app -->
Reporting --> Sales`), search for `Mitch`, and click the :guilabel:`⏵ (right arrow)` next to
:guilabel:`Search Salesperson for: Mitch`, and select :guilabel:`Mitchell Admin`.
.. image:: search/search-values.png
:align: center
:alt: Searching for a specific value on the Sales Analysis report
.. note::
Using the search field is equivalent to using the *contains* operator when adding a custom
filter. If you enter a partial value and directly select the desired field, *all* records
containing the characters you typed for the selected field will be included.
Using the search field is equivalent to using the *contains* operator when adding a :ref:`custom
filter <search/custom-filters>`. If a partial value is entered, and the desired field is directly
selected (without selecting the :guilabel:`⏵ (right arrow)`), *all* records containing the typed
characters for the selected field are included.
.. _search/filters:
Filters
=======
Filters are used to select records that meet specific criteria. The default selection of records is
specific to each view, but can be modified by selecting one (or several) :ref:`preconfigured filters
<search/preconfigured-filters>`, or by adding a :ref:`custom filter <search/custom-filters>`.
.. _search/preconfigured-filters:
Preconfigured filters
---------------------
Modify the default selection of records by clicking the :guilabel:`🔽 (down arrow)` icon from the
search bar, and selecting one (or several) *preconfigured filters* from the :guilabel:`Filters`
drop-down menu.
.. example::
On the *Sales Analysis* report (:menuselection:`Sales app --> Reporting --> Sales`), only records
that are at the *sales order* stage, with an *order date* within the last 365 days, are selected
by default.
To also include records at the *quotation* stage, select :guilabel:`Quotations` from the
:guilabel:`Filters`.
Furthermore, to *only* include sales order and quotation records from a specific year, like
2024, for example, first remove the existing `Order Date: Last 365 Days` filter, by clicking the
:guilabel:`❌ (remove)` icon, then select :menuselection:`Order Date --> 2024`.
.. image:: search/preconfigured-filters.png
:align: center
:alt: Using preconfigured filters on the Sales Analysis report
.. note::
The preconfigured :guilabel:`Filters` are grouped, and each group is separated by a horizontal
line. Selecting preconfigured filters from the same group allows records to match *any* of the
applied conditions. However, selecting filters from different groups requires records to match
*all* of the applied conditions.
.. _search/custom-filters:
Custom filters
--------------
If the :ref:`preconfigured filters <search/preconfigured-filters>` are not specific enough, add a
custom filter. To do so, click the :guilabel:`🔽 (down arrow)` icon in the search bar, then select
:menuselection:`Filters --> Add Custom Filter`.
The :guilabel:`Add Custom Filter` pop-up window displays the matching option, filter rule, and a
toggle to :guilabel:`Include archived` records.
.. image:: search/custom-filter.png
:align: center
:alt: The Add Custom Filter pop-up window.
The default matching configuration is to :guilabel:`Match any of the following rules`, indicating
that each filter rule is applied independently. To change the matching configuration to
:guilabel:`Match all of the following rules`, at least two filter rules must be added to the custom
filter.
- :guilabel:`Match all 🔽 of the following rules`: **all** of the filter rules must be met.
Logically, this is an *AND* (`&`) operation.
- :guilabel:`Match any 🔽 of the following rules`: **any** of the filter rules can be met.
Logically, this is an *OR* (`|`) operation.
By default, a single filter rule is added to the custom filter. The following describes the
structure of a filter rule:
#. The first inline field is the *field name* to filter by. Some fields have refined parameters that
are nested within another field. These fields have an :guilabel:`> (arrow)` icon beside them,
which can be selected to reveal the nested fields.
#. The second inline field is the conditional *operator* used to compare the field name to the
value. The :ref:`available conditional operators <reference/orm/domains>` are specific to the
field's data type.
#. The third inline field is the variable *value* of the field name. The value input may appear as a
drop-down menu, a text input, a number input, a date/time input, a boolean selector, or it may be
blank, depending on the operator used and the field's data type.
Three inline buttons are also available to the right of the rule's filter criteria:
#. :guilabel:` (plus sign)`: adds a new rule below the existing rule.
#. :guilabel:`(Add branch)`: adds a new group of rules below the existing rule, with the
:guilabel:`any` and :guilabel:`all` matching options available to define how each rule within
this branch is applied to the filter. If the matching option is set to the same as the parent
group, the fields are moved to join the parent group.
.. example::
If the matching option is set to :guilabel:`Match all 🔽 of the following rules`, and a new
branch is added with its matching option changed from :guilabel:`any 🔽 of` to :guilabel:`all
🔽 of`, the newly-added branch disappears, and its group of rules are moved to the parent
group.
#. :guilabel:`🗑️ (garbage can)`: deletes the node. If a branch node is deleted, all children of
that node are deleted, as well.
A new filter rule can be added to the custom filter by clicking the :guilabel:`New Rule` button.
Once the filter criteria are defined, click :guilabel:`Add` to add the custom filter to the view.
.. example::
To target all leads and opportunities from the :menuselection:`CRM` app that are in the *Won*
stage, and have an expected revenue greater than $1,000, the following should be entered:
:guilabel:`Match all 🔽 (down arrow) of the following rules:`
#. :guilabel:`Stage` :guilabel:`is in` :guilabel:`Won`
#. :guilabel:`Expected Revenue` :guilabel:`>` `1,000`
#. :guilabel:`any 🔽 (down arrow)` :guilabel:`of:`
- :guilabel:`Type` :guilabel:`=` :guilabel:`Lead`
- :guilabel:`Type` :guilabel:`=` :guilabel:`Opportunity`
.. image:: search/custom-filter-example.png
:align: center
:alt: Adding a custom filter to filter specific records in CRM.
.. tip::
Activate :ref:`developer-mode` to reveal each field's technical name and data type, as well as
the :guilabel:`# Code editor` text area below the filter rules, to view and edit the domain
manually.
.. _search/group:
Group records
=============
You can click :guilabel:`Group By` below the search field to cluster records together according to
one of the **preconfigured groups**.
The display of records in a view can be clustered together, according to one of the *preconfigured
groups*. To do so, click the :guilabel:`🔽 (down arrow)` icon in the search bar, then select one of
the :guilabel:`Group By` options from the drop-down menu.
.. example::
You could group the records by salesperson on the Sales Analysis report by clicking
:guilabel:`Group By` and selecting :guilabel:`Salesperson`. No records are filtered out.
To group the records by salesperson on the *Sales Analysis* report (:menuselection:`Sales app -->
Reporting --> Sales`), click the :guilabel:`Salesperson` option from the :guilabel:`Group By`
drop-down menu. The view changes to group the records by salesperson, without filtering out any
records.
.. image:: search/group.png
:align: center
:alt: Grouping records on the Sales Analysis report
You can **customize groups** by using a wide selection of fields present on the model. To do so,
click :menuselection:`Group By --> Add Custom Group`, select a field, and click :guilabel:`Apply`.
It is possible to *customize groups* by using a field present on the model. To do so, click
:menuselection:`Add Custom Group`, and select a field from the drop-down menu.
.. note::
You can use several groups at the same time. The first group you select is the main cluster, the
next one you add further divides the main group's categories, and so on.
Several groups can be used at the same time. The first group that is selected is the main
cluster, the next one that is added further divides the main group's categories, and so on.
Furthermore, filters and groups can be used together to refine the view even more.
.. _search/favorites:
Favorites
=========
Favorites are a way to save a specific search for future use, or as the new default filter for the
view.
To save the current view as a favorite, click the :guilabel:`🔽 (down arrow)` icon in the search
bar, then select the :guilabel:`Save current search` drop-down menu to display the following
options:
- Filter name: name of the favorited search.
- :guilabel:`Default filter`: sets the favorited search as the default filter for the view.
- :guilabel:`Shared`: makes the favorited search available to all users. By default, the favorited
search is only available to the user who created it.
Once the options are set, click :guilabel:`Save` to save the favorited search.
.. image:: search/favorites.png
:align: center
:alt: Saving a favorite search on the Sales Analysis report
Saved favorites can be accessed by clicking the :guilabel:`🔽 (down arrow)` icon in the search bar,
then selecting the saved filter in the :guilabel:`Favorites` drop-down menu. To remove a saved
favorite, click the :guilabel:`🗑️ (garbage can)` icon next to the favorited search.
.. tip::
To view *all* favorited searches, first activate :ref:`developer-mode`, and navigate to
:menuselection:`Settings app --> Technical --> User Interface: User-defined Filters`. From here,
all favorited searches can be viewed, edited, archived, or deleted.
Binary file not shown.

After

Width:  |  Height:  |  Size: 7.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 8.0 KiB

@@ -27,11 +27,19 @@ Odoo supports multiple file formats to import transactions:
- Quicken Interchange Format (.QIF);
- Belgium: Coded Statement of Account (.CODA).
To import a file, go to the :guilabel:`Accounting Dashboard`, and in the :guilabel:`Bank` journal,
click on :guilabel:`Import Transactions`.
To import a file, go to the **Accounting Dashboard**, and in the :guilabel:`Bank` journal,
click on :guilabel:`Import File`.
.. image:: transactions/import-transactions.png
:alt: Import bank transactions from the bank journal
.. tip::
Alternatively, you can also:
- click :guilabel:`⋮` on the :guilabel:`Bank` journal and select :guilabel:`Import file`;
- or access the transaction list by clicking :guilabel:`⋮` on the :guilabel:`Bank` journal and
selecting :guilabel:`Transactions`, then click the gear icon :guilabel:`(⚙)` and select
:guilabel:`Import records`.
.. image:: transactions/import-transactions.png
:alt: Import bank transactions from the bank journal
Next, select the file and upload it.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.2 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 17 KiB

@@ -55,7 +55,8 @@ Generate deferral entries on validation
.. tip::
Make sure the :guilabel:`Start Date` and :guilabel:`End Date` fields are visible in the
:guilabel:`Invoice Lines` tab. In most cases, the :guilabel:`Start Date` should be in the same
month as the :guilabel:`Invoice Date`.
month as the :guilabel:`Invoice Date`. Deferred revenue entries are posted from the invoice
date and are displayed in the report accordingly.
For each line of the invoice that should be deferred, specify the start and end dates of the
deferral period.
@@ -36,8 +36,8 @@ your customers address is set correctly, including the country, before sendin
<developer-mode>`, go to :menuselection:`General Settings --> Technical --> Reporting
section: Paper Format`.
- A square of **15mm by 15mm** on the bottom left corner has to stay clear.
- The postage area has to stay clear (click :download:`here <snailmail/snailmail-template.pdf>`
to get more info about the area).
- The postage area has to stay clear (:download:`download the snailmail PDF template
<snailmail/snailmail-template.pdf>` for more details).
- Pingen (Odoo Snailmail service provider) scans the area to process the address, so if something
gets written outside the area, it is not counted as part of the address.
@@ -51,7 +51,5 @@ To buy stamps, go to :menuselection:`Accounting --> Configuration --> Settings -
invoices: Snailmail`, click on :guilabel:`Buy credits`, or go to :menuselection:`Settings --> In-App
Purchases: Odoo IAP`, and click on :guilabel:`View my Services`.
.. tip::
- If you are on Odoo Online and have the Enterprise version, you benefit from free trial credits
to test the feature.
- Click `here <https://iap.odoo.com/privacy#header_4>`_ to know about our *Privacy Policy*.
.. seealso::
`Odoo's IAP Privacy Policy <https://iap.odoo.com/privacy#header_4>`_
@@ -24,12 +24,14 @@ to reflect the change in inventory valuation. However, Odoo does **not** automat
valuation <inventory/avg_price/leaving_inventory>`.
.. note::
This document addresses a specific use case for theoretical purposes. Navigate :ref:`here
<inventory/management/inventory_valuation_config>` for instructions on how to set up and use
|AVCO| in Odoo.
This document addresses a specific use case for theoretical purposes. For instructions on how to
set up and use |AVCO|, refer to the :doc:`inventory valuation configuration
<../../../inventory_and_mrp/inventory/warehouses_storage/inventory_valuation/inventory_valuation_config>`
doc.
.. seealso::
- :ref:`Using inventory valuation <inventory/reporting/using_inventory_val>`
- :doc:`Using inventory valuation
<../../../inventory_and_mrp/inventory/warehouses_storage/inventory_valuation/using_inventory_valuation>`
- :ref:`Other inventory valuation methods <inventory/inventory_valuation_config/costing_methods>`
Configuration
@@ -41,7 +43,8 @@ product category page, set :guilabel:`Costing Method` to `Average Cost (AVCO)` a
:guilabel:`Inventory Valuation` to `Automated`.
.. seealso::
:ref:`Inventory valuation configuration <inventory/management/inventory_valuation_config>`
:doc:`Inventory valuation configuration
<../../../inventory_and_mrp/inventory/warehouses_storage/inventory_valuation/inventory_valuation_config>`
Using average cost valuation
============================
@@ -7,7 +7,7 @@ inalterable**, meaning that once an entry has been posted, it can no longer be c
To do so, Odoo can use the **SHA-256 algorithm** to create a unique fingerprint for each posted
entry. This fingerprint is called a hash. The hash is generated by taking an entry's essential data
(the values of the `date`, `journal_id`, `company_id`, `debit`, `credit`, `account_id`, and
(the values of the `name`, `date`, `journal_id`, `company_id`, `debit`, `credit`, `account_id`, and
`partner_id` fields), concatenating it, and inputting it to the SHA-256 hash function, which then
outputs a fixed size (256-bit) string of characters. The hash function is deterministic (:dfn:`the
same input always creates the same output`): any minor modification to the original data would
@@ -26,16 +26,25 @@ would break the hash chain.
.. _data-inalterability/lock:
Lock posted entries with hash
=============================
Lock entries with hash
======================
To start using the hashing function, go to :menuselection:`Accounting --> Configuration > Journals`.
Open the journal for which you want to activate the feature, go to the :guilabel:`Advanced Settings`
tab, and enable :guilabel:`Lock Posted Entries with Hash`.
tab, and enable :guilabel:`Lock Sent Invoices with Hash` for sale journals, or
:guilabel:`Lock Entries Manually` for purchase and general journals.
For sale journals, the entry is automatically locked once it is sent. You can also click on the
button :guilabel:`Lock` on the invoice to lock it without sending it. For sale, purchase, and
general journals, the locking is always done manually using the same button.
To compute the hash of an entry, Odoo retrieves the predecessor entries of the chain (i.e., the
entries with the same sequence prefix) and hashes them in a continuous way from the last hashed
entry to the new entry to hash.
.. warning::
Once you post an entry on a locked journal, you cannot disable the feature anymore, nor edit any
posted entry.
Once you lock an entry in a locked journal, you cannot disable the feature anymore, nor edit any
locked entry.
.. _data-inalterability/report:
@@ -46,9 +55,8 @@ To download the data inalterability check report, go to :menuselection:`Accounti
--> Settings --> Reporting` and click on :guilabel:`Download the Data Inalterability Check Report`.
The report's first section is an overview of all your journals and their configuration. Under the
inalterability check column, you can see whether or not a journal's posted entries are locked with
a hash (V) or not (X). The coverage column tells you when a journal's posted entries started being
locked.
inalterability check column, you can see whether or not a journal's entries are locked with a hash
(V) or not (X). The coverage column tells you when a journal's entries started being locked.
.. image:: data_inalterability/journal-overview.png
:align: center
@@ -101,8 +101,9 @@ correctly reporting a balance of zero. If that is the case, set an :guilabel:`Al
to the last day of the fiscal year by going to :menuselection:`Accounting --> Accounting --> Lock
Dates`.
.. warning::
Setting an :guilabel:`All Users Lock Date` is **irreversible** and cannot be removed.
.. tip::
Install the :guilabel:`Irreversible Lock Date` (`account_lock`) module to make the :guilabel:`All
Users Lock Date` *irreversible* once set.
.. note::
A specific year-end closing entry is **optional** in order to close out the **profit and loss
@@ -1,74 +1,440 @@
:show-content:
==================
Avatax integration
AvaTax integration
==================
Avatax is a tax calculation provider that can be integrated in Odoo.
Avalara's *AvaTax* is a cloud-based tax software. Integrating *AvaTax* with Odoo provides real-time
and region-specific tax calculations when users sell, purchase, and invoice items in Odoo. *AvaTax*
tax calculation is supported with every United Nations charted country, including inter-border
transactions.
.. important::
*AvaTax* is only available for integration with databases/companies that have locations in the
United States, Canada, and Brazil. This means the fiscal position/country of a database can only
be set to the United States, Canada, or Brazil. For more information, reference this
documentation: :ref:`avatax/fiscal_country`.
*AvaTax* accounts for location-based tax rates for each state, county, and city. It improves
remittance accuracy by paying close attention to laws, rules, jurisdiction boundaries, and special
circumstances (like, tax holidays, and product exemptions). Companies who integrate with *AvaTax*
can maintain control of tax-calculations in-house with this simple :abbr:`API (application
programming interface)` integration.
.. important::
Some limitations exist in Odoo while using *AvaTax* for tax calculation:
- *AvaTax* is **not** supported in Odoo's *Point of Sale* app, because a dynamic tax calculation
model is excessive for transactions within a single delivery address, such as stores or
restaurants.
- *AvaTax* and Odoo use the company address and **not** the warehouse address.
- Exercise tax is **not** supported. This includes tobacco/vape taxes, fuel taxes, and other
specific industries.
.. seealso::
Avalara's support documents: `About AvaTax
<https://community.avalara.com/support/s/document-item?language=en_US&bundleId=dqa1657870670369_dqa1657870670369&topicId=About_AvaTax.html&_LANG=enus>`_
Set up on AvaTax
================
To use *AvaTax*, an account with Avalara is required for the setup. If one has not been set up yet,
connect with Avalara to purchase a license: `Avalara: Let's Talk
<https://www.avalara.com/us/en/get-started.html>`_.
.. tip::
Upon account setup, take note of the *AvaTax* :guilabel:`Account ID`. This will be needed in the
:ref:`Odoo setup <avatax/credentials>`. In Odoo, this number is the :guilabel:`API ID`.
Then, `create a basic company profile
<https://community.avalara.com/support/s/document-item?bundleId=dqa1657870670369_dqa1657870670369&topicId=Create_a_Basic_company_profile.html&_LANG=enus>`_.
Create basic company profile
----------------------------
Collect essential business details for the next step: locations where tax is collected,
products/services sold (and their sales locations), and customer tax exemptions, if applicable.
Follow the Avalara documentation for creating a basic company profile:
#. `Add company information
<https://community.avalara.com/support/s/document-item?bundleId=dqa1657870670369_dqa1657870670369&topicId=Add_your_company_information.html&_LANG=enus>`_.
#. `Tell us where the company collects and pays tax
<https://community.avalara.com/support/s/document-item?bundleId=dqa1657870670369_dqa1657870670369&topicId=Tell_us_where_you_collect_and_pay_tax.html&_LANG=enus>`_.
#. `Verify jurisdictions and activate the company
<https://community.avalara.com/support/s/document-item?bundleId=dqa1657870670369_dqa1657870670369&topicId=Verify_your_jurisdictions_and_activate_your_company.html&_LANG=enus>`_.
#. `Add other company locations for location-based filing
<https://community.avalara.com/support/s/document-item?bundleId=dqa1657870670369_dqa1657870670369&topicId=Add_other_company_locations_for_location-based_filing.html&_LANG=enus>`_.
#. `Add a marketplace to the company profile
<https://community.avalara.com/support/s/document-item?bundleId=dqa1657870670369_dqa1657870670369&topicId=Add_marketplace_transactions_to_your_company_profile.html&_LANG=enus>`_.
.. _avatax/create_avalara_credentials:
Connect to AvaTax
-----------------
After creating the basic company profile in Avalara, connect to *AvaTax*. This step links Odoo and
*AvaTax* bidirectionally.
Navigate to either Avalara's `sandbox <https://sandbox.admin.avalara.com/>`_ or `production
<https://admin.avalara.com/>`_ environment. This will depend on which type of Avalara account the
company would like to integrate.
.. seealso::
`Sandbox vs production environments in Avalara
<https://knowledge.avalara.com/bundle/fzc1692293626742/page/sandbox-vs-production.html>`_.
Log in to create the :guilabel:`License Key`. Go to :menuselection:`Settings --> License and API
Keys`. Click :guilabel:`Generate License Key`.
.. note::
A warning appears stating: `If your business app is connected to Avalara solutions, the
connection will be broken until you update the app with the new license key. This action cannot
be undone.`
Generating a new license key breaks the connection with existing business apps using the *AvaTax*
integration. Make sure to update these apps with the new license key.
If this will be the first :abbr:`API (application programming interface)` integration being made
with *AvaTax* and Odoo, then click :guilabel:`Generate license key`.
If this is an additional license key, ensure the previous connection can be broken. There is
**only** one license key associated with each of the Avalara sandbox and production accounts.
.. important::
Copy this key to a safe place. It is **strongly encouraged** to backup the license key for future
reference. This key cannot be retrieved after leaving this screen.
Odoo configuration
==================
Before using *AvaTax*, there are some additional configurations in Odoo to ensure tax calculations
are made accurately.
Verify that the Odoo database contains necessary data. The country initially set up in the database
determines the fiscal position, and aids *AvaTax* in calculating accurate tax rates.
.. _avatax/fiscal_country:
Fiscal country
--------------
To set the :guilabel:`Fiscal Country`, navigate to :menuselection:`Accounting app --> Configuration
--> Settings`.
.. seealso::
:doc:`../../fiscal_localizations`
Under the :guilabel:`Taxes` section, set the :guilabel:`Fiscal Country` feature to :guilabel:`United
States`, :guilabel:`Canada`, or :guilabel:`Brazil`. Then, click :guilabel:`Save`.
Company settings
----------------
All companies operating under the Odoo database should have a full and complete address listed in
the settings. Navigate to the :menuselection:`Settings app`, and under the :guilabel:`Companies`
section, ensure there is only one company operating the Odoo database. Click :guilabel:`Update Info`
to open a separate page to update company details.
If there are multiple companies operating in the database, click :guilabel:`Manage Companies` to
load a list of companies to select from. Update company information by clicking into the specific
company.
Database administrators should ensure that the :guilabel:`Street...`, :guilabel:`Street2...`,
:guilabel:`City`, :guilabel:`State`, :guilabel:`ZIP`, and :guilabel:`Country` are all updated for
the companies.
This ensures accurate tax calculations and smooth end-of-year accounting operations.
.. seealso::
- :doc:`../../../general/companies`
- :doc:`../get_started`
Module installation
-------------------
Next, ensure that the Odoo *AvaTax* module is installed. To do so, navigate to the
:menuselection:`Apps application`. In the :guilabel:`Search...` bar, type in `avatax`, and press
:kbd:`Enter`. The following results populate:
.. list-table::
:header-rows: 1
:widths: 25 25 50
* - Name
- Technical name
- Description
* - :guilabel:`Avatax`
- `account_avatax`
- Default *AvaTax* module. This module adds the base *AvaTax* features for tax calculation.
* - :guilabel:`Avatax for geo localization`
- `account_avatax_geolocalize`
- This module includes the features required for integration of *AvaTax* into geo-localization
in Odoo.
* - :guilabel:`Avatax for SO`
- `account_avatax_sale`
- Includes the information needed for tax calculation on sales orders in Odoo.
* - :guilabel:`Avatax for Inventory`
- `account_avatax_stock`
- Includes tax calculation in Odoo Inventory.
* - :guilabel:`Amazon/Avatax Bridge`
- `sale_amazon_avatax`
- Includes tax calculation features between the *Amazon Connector* and Odoo.
* - :guilabel:`Avatax Brazil`
- `l10n_br_avatax`
- Includes information for tax calculation in the Brazil localization.
* - :guilabel:`Avatax Brazil for Services`
- `l10n_br_avatax_services`
- This module includes the required features for tax calculation for services in the Brazil
localization.
* - :guilabel:`Avatax Brazil Sale for Services`
- `l10n_br_edi_sale_services`
- This module includes the required features for tax calculation for the sale of services in
the Brazil localization. This includes electronic data interchange (EDI).
* - :guilabel:`Test SOs for the Brazilian AvaTax`
- `l10n_br_test_avatax_sale`
- This module includes the required features for test sales orders in the Brazil localization.
Click the :guilabel:`Install` button on the module labeled, :guilabel:`Avatax`: `account_avatax`.
Doing so installs the following modules:
- :guilabel:`Avatax`: `account_avatax`
- :guilabel:`Avatax for SO`: `account_avatax_sale`
- :guilabel:`Avatax for Inventory`: `account_avatax_stock`
Should *AvaTax* be needed for geo-localization, or with the *Amazon Connector*, then install those
modules individually by clicking on :guilabel:`Install` on :guilabel:`Avatax for geo localization`
and :guilabel:`Amazon/Avatax Bridge`, respectively.
.. seealso::
For localization specific *AvaTax* instructions, view the following :doc:`fiscal localization
<../../fiscal_localizations>` documentation:
- :doc:`../../fiscal_localizations/brazil`
.. _avatax/credentials:
Credential configuration
========================
Odoo AvaTax settings
--------------------
To integrate Avatax with Odoo, go to :menuselection:`Accounting --> Configuration --> Settings -->
Taxes` and add your Avatax credentials in the :guilabel:`Avatax` section.
To integrate the *AvaTax* :abbr:`API (application programming interface)` with Odoo, go to
:menuselection:`Accounting app --> Configuration --> Settings` section. The :guilabel:`AvaTax`
fields in the :guilabel:`Taxes` section is where the *AvaTax* configurations are made, and the
credentials are entered in.
.. tip::
If you do not yet have credentials, click on :guilabel:`How to Get Credentials`.
First, tick the checkbox to the left of the :guilabel:`AvaTax` settings, to activate *AvaTax* on the
database. This is a quick, convenient way to activate and deactivate *AvaTax* tax calculation on the
Odoo database.
.. image:: avatax/avatax-configuration-settings.png
:align: center
:alt: Configure Avatax settings
:alt: Configure AvaTax settings
.. _avatax/tax-mapping:
Prerequisites
~~~~~~~~~~~~~
First, select the :guilabel:`Environment` in which the company wishes to use *AvaTax* in. It can
either be :guilabel:`Sandbox` or :guilabel:`Production`.
.. seealso::
For help determining which *AvaTax* environment to use (either :guilabel:`Production` or
:guilabel:`Sandbox`), visit: `Sandbox vs Production environments
<https://knowledge.avalara.com/bundle/fzc1692293626742/page/sandbox-vs-production.html>`_.
Credentials
~~~~~~~~~~~
Now, the credentials can be entered in. The *AvaTax* :guilabel:`Account ID` should be entered in the
:guilabel:`API ID` field, and the :guilabel:`License Key` should be entered in the :guilabel:`API
Key` field.
.. important::
The :guilabel:`Account ID` can be found by logging into the *AvaTax* portal (`sandbox
<https://sandbox.admin.avalara.com/>`_ or `production <https://admin.avalara.com/>`_). In the
upper-right corner, click on the initials of the user and :guilabel:`Account`. The
:guilabel:`Account ID` is listed first.
To access the :guilabel:`License Key` see this documentation:
:ref:`avatax/create_avalara_credentials`.
For the :guilabel:`Company Code` field, enter the Avalara company code for the company being
configured. Avalara interprets this as `DEFAULT`, if it is not set. The :guilabel:`Company Code` can
be accessed in the Avalara management portal.
First, log into the *AvaTax* portal (`sandbox <https://sandbox.admin.avalara.com/>`_ or `production
<https://admin.avalara.com/>`_). Then, navigate to :menuselection:`Settings --> Manage Companies`.
The :guilabel:`Company Code` value is located in the row of the :guilabel:`Company` in the
:guilabel:`Company Code` column.
.. image:: avatax/company-code.png
:align: center
:alt: AvaTax company code highlighted on the company details page.
Transaction options
~~~~~~~~~~~~~~~~~~~
There are two transactional settings in the Odoo *AvaTax* settings that can be configured:
:guilabel:`Use UPC` and :guilabel:`Commit Transactions`.
If the checkbox next to :guilabel:`Use UPC` is ticked, the transactions will use Universal Product
Codes (UPC), instead of custom defined codes in Avalara. Consult a certified public accountant (CPA)
for specific guidance.
Should the :guilabel:`Commit Transactions` checkbox be ticked, then, the transactions in the Odoo
database will be committed for reporting in *AvaTax*.
Address validation
~~~~~~~~~~~~~~~~~~
The *Address Validation* feature ensures that the most up-to-date address by postal standards is set
on a contact in Odoo. This is important to provide accurate tax calculations for customers.
.. important::
The :guilabel:`Address Validation` feature only works with partners/customers in North America.
Additionally, tick the checkbox next to the :guilabel:`Address validation` field.
.. important::
For accurate tax calculations, it is best practice to enter a complete address for the contacts
saved in the database. However, *AvaTax* can still function by implementing a best effort attempt
using only the :guilabel:`Country`, :guilabel:`State`, and :guilabel:`Zip code`. These are the
three minimum required fields.
:guilabel:`Save` the settings to implement the configuration.
.. tip::
Manually :guilabel:`Validate` the address by navigating to the :menuselection:`Contacts app`, and
selecting a contact. Now that the *AvaTax* module has been configured on the database, a
:guilabel:`Validate` button appears directly below the :guilabel:`Address`.
Click :guilabel:`Validate`, and a pop-up window appears with a :guilabel:`Validated Address` and
:guilabel:`Original Address` listed. If the :guilabel:`Validated Address` is the correct mailing
address for tax purposes, click :guilabel:`Save Validated`.
.. image:: avatax/validate-address.png
:align: center
:alt: Validate address pop-up window in Odoo with "Save Validated" button and "Validated
Address" highlighted.
.. warning::
All previously-entered addresses for contacts in the Odoo database will need to be validated
using the manually validate process outlined above. Addresses are not automatically validated if
they were entered previously. This only occurs upon tax calculation.
Test connection
~~~~~~~~~~~~~~~
After entering all the above information into the *AvaTax* setup on Odoo, click :guilabel:`Test
connection`. This ensures the :guilabel:`API ID` and :guilabel:`API KEY` are correct, and a
connection is made between Odoo and the *AvaTax* application programming interface (API).
Sync parameters
~~~~~~~~~~~~~~~
Upon finishing the configuration and settings of the *AvaTax* section, click the :guilabel:`Sync
Parameters` button. This action synchronizes the exemption codes from *AvaTax*.
.. _avatax/fiscal_positions:
Fiscal position
---------------
Next, navigate to :menuselection:`Accounting app --> Configuration --> Accounting: Fiscal
Positions`. A :guilabel:`Fiscal Position` is listed named, :guilabel:`Automatic Tax Mapping
(AvaTax)`. Click it to open *AvaTax's* fiscal position configuration page.
Here, ensure that the :guilabel:`Use AvaTax API` checkbox is ticked.
Optionally, tick the checkbox next to the field labeled: :guilabel:`Detect Automatically`. Should
this option be ticked, then, Odoo will automatically apply this :guilabel:`Fiscal Position` for
transactions in Odoo.
Enabling :guilabel:`Detect Automatically` also makes specific parameters, such as :guilabel:`VAT
required`, :guilabel:`Foreign Tax ID`, :guilabel:`Country Group`, :guilabel:`Country`,
:guilabel:`Federal States`, or :guilabel:`Zip Range` appear. Filling these parameters filters the
:guilabel:`Fiscal Position` usage. Leaving them blank ensures all calculations are made using this
:guilabel:`Fiscal Position`.
.. warning::
Should the :guilabel:`Detect Automatically` checkbox not be ticked, each customer will need to
have the :guilabel:`Fiscal Position` set on their :guilabel:`Sales and Purchase` tab of the
contact record. To do so, navigate to :menuselection:`Sales app --> Order --> Customers`, or
:menuselection:`Contacts app --> Contacts`. Then, select a customer or contact to set the fiscal
position on.
Navigate to the :guilabel:`Sales and Purchase` tab, and down to the section labeled,
:guilabel:`Fiscal Position`. Set the :guilabel:`Fiscal Position` field to the fiscal position
for the customer.
.. seealso::
:doc:`fiscal_positions`
AvaTax accounts
~~~~~~~~~~~~~~~
Upon selecting the checkbox option for :guilabel:`Use AvaTax API` a new :guilabel:`AvaTax` tab
appears. Click into this tab to reveal two different settings.
The first setting is the :guilabel:`AvaTax Invoice Account`, while the second is, :guilabel:`AvaTax
Refund Account`. Ensure both accounts are set for smooth end-of-year record keeping. Consult a
certified public accountant (CPA) for specific guidance on setting both accounts.
Click :guilabel:`Save` to implement the changes.
Tax mapping
===========
-----------
The Avatax integration is available on Sale Orders and Invoices with the included Avatax fiscal
The *AvaTax* integration is available on sale orders and invoices with the included *AvaTax* fiscal
position.
.. tip::
Additionally, there is a :guilabel:`Tax Mapping` tab and :guilabel:`Account Mapping` tab in the
:guilabel:`Automatic Tax Mapping (AvaTax)` fiscal position, where mapping for products can also
be configured. To access :guilabel:`Fiscal Positions` navigate to :menuselection:`Accounting app
--> Configuration --> Accounting: Fiscal Positions`.
Product category mapping
~~~~~~~~~~~~~~~~~~~~~~~~
Before using the integration, specify an :guilabel:`Avatax Category` on the product categories.
Navigate to :menuselection:`Inventory app --> Configuration --> Product Categories`. Select the
product category to add the :guilabel:`AvaTax Category` to. In the :guilabel:`AvaTax Category`
field, select a category from the drop-down menu, or :guilabel:`Search More...` to open the complete
list of options.
.. image:: avatax/avatax-category.png
:align: center
:alt: Specify Avatax Category on products
:alt: Specify AvaTax Category on products.
Avatax Categories may be overridden or set on individual products as well.
Product mapping
~~~~~~~~~~~~~~~
*AvaTax* Categories may be set on individual products, as well. To set the :guilabel:`Avatax
Category` navigate to :menuselection:`Inventory app --> Products --> Products`. Select the product
to add the :guilabel:`Avatax Category` to. Under the :guilabel:`General Information` tab, on the
far-right, is a selector field labeled: :guilabel:`Avatax Category`. Finally, click the drop-down
menu, and select a category, or :guilabel:`Search More...` to find one that is not listed.
.. note::
If both the product, and its category, have an :guilabel:`AvaTax Category` set, the product's
:guilabel:`AvaTax Category` takes precedence.
.. image:: avatax/override-avatax-product-category.png
:align: center
:alt: Override product categories as needed
:alt: Override product categories as needed.
.. _avatax/address-mapping:
Address validation
==================
Manually validate customer addresses by clicking the :guilabel:`Validate address` link in the
customer form view.
.. image:: avatax/validate-customer-address.png
:align: center
:alt: Validate customer addresses
If preferred, choose to keep the newly validated address or the original address in the wizard that
pops up.
.. image:: avatax/choose-customer-address.png
:align: center
:alt: Address validation wizard
.. _avatax/tax-calculation:
Tax calculation
===============
Automatically calculate taxes on Odoo quotations and invoices with Avatax by confirming the
documents. Alternatively, calculate the taxes manually by clicking the :guilabel:`Compute taxes
using Avatax` button while these documents are in draft mode.
Use the :guilabel:`Avalara Code` field that's available on customers, quotations, and invoices to
cross-reference data in Odoo and Avatax.
.. important::
Mapping an :guilabel:`AvaTax Category` on either the *Product* or *Product Category* should be
completed for every *Product* or *Product Category*, depending the route that is chosen.
.. seealso::
- :doc:`fiscal_positions`
- :doc:`avatax/avatax_use`
- :doc:`avatax/avalara_portal`
- `US Tax Compliance: Avatax elearning video
<https://www.odoo.com/slides/slide/us-tax-compliance-avatax-2858?fullscreen=1>`_
.. toctree::
:titlesonly:
avatax/avatax_use
avatax/avalara_portal
@@ -0,0 +1,259 @@
.. _avatax/portal:
=======================
Avalara (Avatax) portal
=======================
Avalara's (*AvaTax*) management console offers account management options including: viewing/editing
the transactions sent from Odoo to *AvaTax*, details on how the taxes are calculated, tax reporting,
tax exemption management, and tax return resources.
.. tip::
Avalara is the software developer of the tax software, *AvaTax*.
To access the console, first, navigate to either Avalara's `sandbox
<https://sandbox.admin.avalara.com/>`_ or `production <https://admin.avalara.com/>`_ environment.
This will depend on which type of account was set in the :doc:`integration <../avatax>`. Log in to
the management console.
.. image:: avalara_portal/avalara-portal.png
:align: center
:alt: Avalara dashboard after logging into management portal.
.. seealso::
For more information see Avalara's documentation: `Activate your Communications Customer Portal
account
<https://community.avalara.com/support/s/document-item?language=en_US&bundleId=qvv1656594440497&topicId=Activate_your_Communications_Customer_Portal_account.html&_LANG=enus>`_.
.. _avalara/portal-transactions:
Transactions
============
To access transactions, click in the :guilabel:`Transactions` link on the main dashboard upon
logging into the :ref:`avatax/portal`. To manually access the *Transactions* page, while logged into
the Avalara console, navigate to :menuselection:`Transactions --> Transactions`.
.. image:: avalara_portal/avalara-transactions.png
:align: center
:alt: Avalara portal with the transactions shortcut highlighted.
Edit transaction
----------------
Click into a transaction to reveal more details about the transaction. These details include
sections on :guilabel:`Invoice detail`, :guilabel:`Additional info`, and :guilabel:`Customer info`.
Click :icon:`fa-pencil` :guilabel:`Edit document details` to make changes to the transaction.
A :guilabel:`Discount` can be added to adjust the invoice. This is especially useful in cases where
the transaction has already synced with Avalara / *AvaTax*, and changes need to be made afterward.
.. _avalara/portal-filter:
Filter
------
Filter transactions on the :guilabel:`Transactions` page, by setting the :guilabel:`From` and
:guilabel:`To` fields, and configuring other fields to filter by, including:
- :guilabel:`Document Status`: any of the following options, :guilabel:`All`, :guilabel:`Voided`,
:guilabel:`Committed`, :guilabel:`Uncommitted`, or :guilabel:`Locked`.
- :guilabel:`Document Code`: any of the following options, :guilabel:`Exactly match`,
:guilabel:`Starts with`, or :guilabel:`Contains`.
- :guilabel:`Customer/Vendor Code`: the customer/vendor code in Odoo (e.g. `Contact18`).
- :guilabel:`Country`: the country this tax was calculated in; this is a text field.
- :guilabel:`Region`: the region of the country, which varies based on the :guilabel:`Country`
selection.
Click :icon:`fa-plus` :guilabel:`Filters` to access the following filter conditions:
- :guilabel:`Document Type`: any of the following selections, :guilabel:`All`, :guilabel:`Sales
Invoice`, :guilabel:`Purchase Invoice`, :guilabel:`Return Invoice`, :guilabel:`Inventory Transfer
Inbound Invoice`, :guilabel:`Inventory Transfer Outbound Invoice`, or :guilabel:`Customs
Invoice`.
- :guilabel:`Import ID`: represents the import ID of the document.
Sort by
-------
On the :guilabel:`Transactions` page, transactions will be listed below, according to the set
:ref:`avalara/portal-filter`, located in the top half of the page. The following columns are
available by default, to sort by ascending or descending order:
- :guilabel:`Doc Code`: either of the following options, :guilabel:`Exactly match`,
:guilabel:`Starts with`, or :guilabel:`Contains`.
- :guilabel:`Doc Status`: either of the following options, :guilabel:`All`, :guilabel:`Voided`,
:guilabel:`Committed`, :guilabel:`Uncommitted`, or :guilabel:`Locked`.
- :guilabel:`Cust/Vendor Code` : this is the customer/vendor code in Odoo (e.g. Contact18).
- :guilabel:`Region`: this is the region of the country, this will vary based on the
:guilabel:`Country` selection.
- :guilabel:`Amount`: the numeric amount of the total amount on the Odoo document.
- :guilabel:`Tax`: the numeric amount of the tax applied to the total.
.. image:: avalara_portal/transactions.png
:align: center
:alt: Transactions page on the Avalara portal with the filter and sort-by options highlighted.
Customize columns
~~~~~~~~~~~~~~~~~
Additional columns can be added by clicking the :icon:`fa-cog` :guilabel:`Customize columns`. On the
resulting popover window, click the drop-down menu for the :guilabel:`column` that should be
changed.
The following columns can be added for additional transactional information:
- :guilabel:`AvaTax calculated`: the amount of tax calculated by *AvaTax*.
- :guilabel:`Country`: the country this tax was calculated in; this is a text field.
- :guilabel:`Cust/vendor code`: the customer/vendor code in Odoo (e.g. `Contact18`).
- :guilabel:`Currency`: the standardized abbreviation for the currency the amount total is in.
- :guilabel:`Doc date`: the document's date of creation.
- :guilabel:`Doc status`: any of the following options, :guilabel:`All`, :guilabel:`Voided`,
:guilabel:`Committed`, :guilabel:`Uncommitted`, or :guilabel:`Locked`.
- :guilabel:`Doc type`: any of the following selections, :guilabel:`All`, :guilabel:`Sales
Invoice`, :guilabel:`Purchase Invoice`, :guilabel:`Return Invoice`, :guilabel:`Inventory Transfer
Inbound Invoice`, :guilabel:`Inventory Transfer Outbound Invoice`, or :guilabel:`Customs
Invoice`.
- :guilabel:`Import ID`: represents the import ID of the document.
- :guilabel:`Last modified`: timestamp of the last time the document was modified.
- :guilabel:`Location code`: the location code used to calculate the tax, based on the delivery
address.
- :guilabel:`PO number`: the purchase order number.
- :guilabel:`Reference code`: the Odoo reference code (e.g. NV/2024/00003)
- :guilabel:`Region`: the region of the country,which varies based on the :guilabel:`Country`
selection.
- :guilabel:`Salesperson code`: the numeric ID of the user assigned to the sales order in Odoo.
- :guilabel:`Tax date`: the month/day/year of the tax calculation.
- :guilabel:`Tax override type`: where an exemption would appear, should there be none, the field
populates with :guilabel:`None`.
To add a new column click the :icon:`fa-plus` :guilabel:`Column`.
.. seealso::
For more information on *AvaTax* transactions, refer to this Avalara documentation: `Transactions
<https://community.avalara.com/support/s/document-item?language=en_US&bundleId=qvv1656594440497&topicId=transactions.html&_LANG=enus>`_.
Import-export
-------------
While on the :ref:`avalara/portal-transactions`, click :icon:`fa-download` :guilabel:`Import
transactions` or :icon:`fa-upload` :guilabel:`Export transactions` to import or export transactions.
Reports
-------
To access reporting, navigate to the :menuselection:`Reports` link in the top menu of the Avalara
management console. Next, select from one of the available reporting tabs: :guilabel:`Transactions
reports`, :guilabel:`Liability & tax return reports`, or :guilabel:`Exemption reports`.
.. tip::
Additionally, there is a :guilabel:`Favorites` tab and :guilabel:`Downloads` tab. The
:guilabel:`Favorites` tab contains any favorited report configurations for the Avalara user. The
:guilabel:`Downloads` tab contains a list view where the user can download the high-volume
transaction reports created in the last 30 days.
Make a selection for the :guilabel:`Report Category`, and the :guilabel:`Report Name`, under the
:guilabel:`Select a report` section.
Next, fill out the :guilabel:`Select report details` section. These options will vary based on the
tab selected above.
Depending on the report size, the following two options are available in the section labeled,
:guilabel:`Select the approximate number of transactions for your report`: :guilabel:`Create and
download the report instantly` (for small reports) and :guilabel:`Create and download the report in
the background` (for larger reports). Select one or the other depending on the volume of
transactions in this report.
Finally, under the section labeled, :guilabel:`Report preview and export` make a selection of the
file type to download. Either a :guilabel:`.PDF` or :guilabel:`.XLS` can be chosen. Alternatively,
the file can be previewed by selecting the :guilabel:`Preview` option.
After making all the configurations, click :guilabel:`Create report` to download the report. Click
:icon:`fa-star-o` :guilabel:`Make this report a favorite` to save the report configuration to the
user's favorites.
After the report is created, click :icon:`fa-download` :guilabel:`Download` to download the file to
the device.
.. tip::
Select a pre-configured report from the :guilabel:`Frequently used reports` section of the
reporting dashboard.
Access this list by clicking on the :guilabel:`Reports` option in the top menu of the Avalara
management console, and scroll to the bottom of the page.
.. seealso::
`See Avalara's documentation: Reports in AvaTax
<https://community.avalara.com/support/s/document-item?language=en_US&bundleId=rjq1671176624730&topicId=Reports_in_AvaTax.html&_LANG=enus>`_.
Add more jurisdictions
======================
Additional jurisdictions (tax locations) can be added in the Avalara management console. Navigate to
either Avalara's `sandbox <https://sandbox.admin.avalara.com/>`_ or `production
<https://admin.avalara.com/>`_ environment. This will depend on which type of account was set in the
:doc:`integration <../avatax>`.
Next, navigate to :menuselection:`Settings --> Where you collect tax`. Choose between the three
different tabs, depending on the business need. The first tab is :guilabel:`Sales and use tax`,
where tax can be collected for the United States. Click the :icon:`fa-plus` :guilabel:`Add to where
you collect sales and use tax` to add another location where the company collects sales and use tax.
The second option, is the :guilabel:`VAT/GST` tab where the :icon:`fa-plus` :guilabel:`Add a country
or territory where you collect VAT/GST` can be selected to add another country or territory where
the company collects VAT/GST.
Finally, on the far-right, is the :guilabel:`Customs duty` tab, where a country can be added where
the company collects customs duty. Simply click on the :icon:`fa-plus` :guilabel:`Add a country
where you calculate customs duty` icon below the tab.
.. image:: avalara_portal/where-you-collect-tax.png
:align: center
:alt: AvaTax management console, on the Where you collect tax page, with the add button and
sales and use tax tab highlighted.
.. seealso::
`See Avalara's documentation: Add local jurisdiction taxes
<https://community.avalara.com/support/s/document-item?language=en_US&bundleId=bla1700809896571_bla1700809896571&topicId=nbw1698727575499.html&_LANG=enus>`_.
Tax exemption certificate
=========================
Tax exemption certificates for customers can be added into the Avalara management console, so that
*AvaTax* is aware of which customers may be exempt from paying certain taxes. To add an *exception
certificate* navigate to :menuselection:`Exemptions --> Customer certificates`. From there, click on
the :icon:`fa-plus` :guilabel:`Add a certificate` to configure an exemption.
.. warning::
An Avalara subscription to Exemption Certificate Management (ECM) is required in order to attach
certificate images, and to be ready for an audit. For more on subscribing to this add-on, visit
`Avalara
<https://community.avalara.com/support/s/document-item?language=en_US&bundleId=hff1682048150115_hff1682048150115&topicId=fol1682356576230.html&_LANG=enus>`_.
End-of-year operations
======================
Avalara's services include tax return services, for when it is time to file taxes at the end of the
year. To access Avalara's tax services log, into the `management portal
<https://admin.avalara.com/>`_. Then, from the main dashboard, click :guilabel:`Returns`. Avalara
will prompt the Avalara user to log in for security purposes, and redirect the user to the *Returns*
portal.
.. image:: avalara_portal/avalara-returns.png
:align: center
:alt: Avalara portal with the returns shortcut highlighted.
Click :guilabel:`Get started` to begin the tax return process. For more information, refer to this
Avalara documentation: `About Managed Returns
<https://community.avalara.com/support/s/document-item?language=en_US&bundleId=hps1656397152776_hps1656397152776&topicId=Learn_about_Managed_Returns.html&_LANG=enus>`_.
.. tip::
Alternatively, click on the :menuselection:`Returns` button in the top menu of the Avalara
management console.
.. seealso::
- :doc:`../avatax`
- :doc:`avatax_use`
- `US Tax Compliance: Avatax elearning video
<https://www.odoo.com/slides/slide/us-tax-compliance-avatax-2858?fullscreen=1>`_
Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 13 KiB

@@ -0,0 +1,166 @@
==========
AvaTax use
==========
AvaTax is a tax calculation software that can be integrated with Odoo in the United States and
Canada. Once the :doc:`integration setup <../avatax>` is complete, the calculated tax is simple and
automatic.
Tax calculation
===============
Automatically calculate taxes on Odoo quotations and invoices with AvaTax by confirming the
documents during the sales flow. Alternatively, calculate the taxes manually by clicking the
:guilabel:`Compute Taxes` button, while these documents are in draft stage.
.. tip::
Clicking the :guilabel:`Compute Taxes` button recalculates taxes, if any product lines are edited
on the invoice.
.. image:: avatax_use/calculate-avatax.png
:align: center
:alt: Sales quotation with the confirm and compute taxes button highlighted.
The tax calculation is triggered during the following :ref:`automatic trigger
<avatax/automatic-triggers>` and :ref:`manual trigger <avatax/manual-triggers>` circumstances.
.. _avatax/automatic-triggers:
Automatic triggers
------------------
- When the sales rep sends the quote by email with :guilabel:`Send by email` button (pop-up).
- When the customer views the online quote on the portal.
- When a quote is confirmed and becomes a sales order.
- When the customer views the invoice on the portal.
- When a draft invoice is validated.
- When the customer views the subscription in the portal.
- When a subscription generates an invoice.
- When the customer gets to the last screen of the eCommerce checkout.
.. _avatax/manual-triggers:
Manual triggers
---------------
- :guilabel:`Compute Taxes` button at the bottom of the quote.
- :guilabel:`Compute Taxes` button at the top of the invoice.
Use each of these buttons to manually re-calculate the sales tax.
.. tip::
Use the :guilabel:`Avalara Partner Code` field that is available on customer records, quotations,
and invoices to cross-reference data in Odoo and AvaTax. This field is located under the
:menuselection:`Other info` tab of the sales order or quotation in the :guilabel:`Sales` section.
On the customer record, navigate to *Contacts app* and select a contact. Then open the
:guilabel:`Sales & Purchase` tab and the :guilabel:`Avalara Partner Code` under the
:guilabel:`Sales` section.
.. important::
The :guilabel:`Automatic Tax Mapping (AvaTax)` fiscal position is also applied on those Odoo
documents, like subscriptions.
.. seealso::
- :doc:`../fiscal_positions`
AvaTax synchronization
======================
Synchronization occurs with AvaTax, when the *invoice* is created in Odoo. This means the sales tax
is recorded with Avalara (AvaTax software developer).
To do so, navigate to :menuselection:`Sales app --> Orders --> Quotations`. Select a quotation from
the list.
After confirming a quotation and validating the delivery, click :guilabel:`Create Invoice`. Indicate
whether it is a :guilabel:`Regular invoice`, :guilabel:`Down payment (percentage)`, or
:guilabel:`Down payment (fixed amount)`.
Then click :guilabel:`Create and view invoice`. The recorded taxes can be seen in the
:guilabel:`Journal Items` tab of the invoice. There will be different taxes depending on the
location of the :guilabel:`Delivery Address`.
.. image:: avatax_use/journal-items.png
:align: center
:alt: Journal items highlighted on a invoice in Odoo.
Finally, press the :guilabel:`Confirm` button to complete the invoice and synchronize with the
AvaTax portal.
.. warning::
An invoice cannot be :guilabel:`Reset to draft` because this causes de-synchronization with the
AvaTax Portal. Instead, click :guilabel:`Add credit note` and state: `Sync with AvaTax Portal`.
See this documentation: :doc:`../../../accounting/customer_invoices/credit_notes`.
Fixed price discounts
=====================
Add a fixed price discount to a valuable customer, by clicking :guilabel:`Add a line` on the
customer's invoice. Add the product discount, and set the :guilabel:`Price` to either a positive or
negative value. To recalculate the taxes, click :guilabel:`Compute Taxes`.
.. tip::
Tax calculation can even be done on negative subtotals and credit notes.
Logging
=======
It is possible to log Avalara/*AvaTax* actions in Odoo for further analysis, or verification of
functionality. Logging is accessible through the *AvaTax* settings.
To start logging *AvaTax* actions, first, navigate to the :menuselection:`Accounting app -->
Configuration --> Settings`.
Then, in the :guilabel:`Taxes` section, under the :guilabel:`AvaTax` settings, click
:guilabel:`Start logging for 30 minutes`.
Upon starting the log process, Odoo will log all Avalara/*AvaTax* actions performed in the database.
To view the logs, click on :guilabel:`Show logs` to the right of the :guilabel:`Start logging for 30
minutes`. This reveals a detailed list of Avalara/*AvaTax* actions. This list is sortable by the
following columns:
- :guilabel:`Created on`: timestamp of the *AvaTax* calculation.
- :guilabel:`Created by`: numeric value of the user in the database.
- :guilabel:`Database name`: name of the database.
- :guilabel:`Type`: two values can be chosen for this field, :guilabel:`Server` or
:guilabel:`Client`.
- :guilabel:`Name`: Avalara service name. In this case, it will be *AvaTax*.
- :guilabel:`Level`: by default, this will be `INFO`.
- :guilabel:`Path`: indicates the path taken to make the calculation.
- :guilabel:`Line`: indicates the line the calculation is made on.
- :guilabel:`Function`: indicates the calculation taken on the line.
.. image:: avatax_use/logging.png
:align: center
:alt: Avalara logging page with top row of list highlighted.
Click into the log line to reveal another field, called :guilabel:`Message`.
This field populates a raw transcription of the transaction, which involves the creation (or
adjustment) of a sales invoice using the Avalara *AvaTax* API.
The transaction includes details, such as addresses for shipping from and to, line items describing
the products or services, tax codes, tax amounts, and other relevant information.
The :guilabel:`Message` contains the calculated taxes for different jurisdictions and confirms the
creation (or adjustment) of the transaction.
.. tip::
Custom fields can be made using Odoo *Studio*. Click the :icon:`fa-ellipsis-v`
:guilabel:`(ellipsis)` menu to the far-right of the header row. Then click :icon:`fa-plus`
:guilabel:`Add custom field`. This action opens Odoo *Studio*.
.. important::
Odoo *Studio* requires a *custom* pricing plan. Consult the database's customer success manager
for more information on switching plans. Or to see if Odoo *Studio* is included in the database's
current pricing plan. See this documentation: :doc:`../../../../studio`.
.. seealso::
- :doc:`../avatax`
- :doc:`avalara_portal`
- `US Tax Compliance: Avatax elearning video
<https://www.odoo.com/slides/slide/us-tax-compliance-avatax-2858?fullscreen=1>`_
- :doc:`../fiscal_positions`
Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

@@ -55,7 +55,8 @@ Generate deferral entries on validation
.. tip::
Make sure the :guilabel:`Start Date` and :guilabel:`End Date` fields are visible in the
:guilabel:`Invoice Lines` tab. In most cases, the :guilabel:`Start Date` should be in the same
month as the :guilabel:`Bill Date`.
month as the :guilabel:`Bill Date`. Deferred expense entries are posted from the bill date and
are displayed in the report accordingly.
For each line of the bill that should be deferred, specify the start and end dates of the deferral
period.
@@ -758,9 +758,9 @@ Cancel an own check
*******************
To cancel an own check created in Odoo, navigate to :menuselection:`Accounting --> Vendors --> Own
Checks` and select the check to be canceled, then click on the :guilabel:`Void Check` button. This
Checks` and select the check to be cancelled, then click on the :guilabel:`Void Check` button. This
will break the reconciliation with the vendor bills and the bank statements and leave the check in a
**canceled** state.
**cancelled** state.
.. image:: argentina/empty-check-button.png
:align: center
@@ -948,6 +948,73 @@ the corresponding layout and fiscal stamps stated in the :ref:`Invoice printed r
.. seealso::
:doc:`Client account creation <../../websites/ecommerce/checkout_payment_shipping/checkout>`
Liquidity product direct sales
------------------------------
Liquidity product direct sales are used for sales involving third parties. For such
sales, the seller and the proprietary company of the goods can each register their corresponding
sales and purchases.
.. note::
:ref:`Install <general/install>` the *Argentinian Electronic Invoicing* module (`l10n_ar_edi`) to
use this feature.
Configuration
~~~~~~~~~~~~~
Purchase journal
****************
A purchase journal is needed to generate an electronic vendor bill with a document type *Liquidity
Product*. This journal needs to be synchronized with the AFIP as it will be used to generate the
liquidity product electronic document.
To modify the existing purchase journal or create a new one, navigate to :menuselection:`Accounting
--> Configuration --> Journals`. Then, select the existing purchase journal or click the
:guilabel:`New` button, and fill in the following required information:
- :guilabel:`Type`: select :guilabel:`Purchase`.
- :guilabel:`Use Documents`: check this field to to be able select the electronic document type.
- :guilabel:`Is AFIP POS`: check this field to be able to generate electronic documents.
- :guilabel:`AFIP POS System`: select :guilabel:`Electronic Invoice - Web Service` from the
drop-down menu in order to send the electronic document to AFIP via web service.
- :guilabel:`AFIP POS Number`: is the number configured in the AFIP to identify the operations
related to this AFIP POS.
- :guilabel:`AFIP POS Address`: is the field related to the commercial address registered for the
POS, which is usually the same address as the company. For example, if a company has multiple
stores (fiscal locations) then the AFIP will require the company to have one AFIP POS per
location. This location will be printed in the invoice report.
.. image:: argentina/l10n-ar-purchase-journal.png
:align: center
:alt: l10n_ar Purchase Journal Configuration.
Sales journal
*************
A sales journal is needed to register the invoice when a product is sold to a third party that will
then sell the same product. This journal will not be synced with AFIP as the invoice will not be
electronic.
To modify the existing sales journal or create a new one, navigate to
:menuselection:`Accounting --> Configuration --> Journals`. Then, selecting the sales journal or
click the :guilabel:`New` button, and fill in the following required information:
- :guilabel:`Type`: select :guilabel:`Sales`.
- :guilabel:`Use Documents`: check this field on the journal to select the electronic document type
(in this case the electronic invoice).
.. image:: argentina/l10n-ar-sales-journal.png
:align: center
:alt: l10n_ar Sales Journal Configuration.
Invoicing flow
~~~~~~~~~~~~~~
Once the configurations are all set, the *Liquidity Product Vendor Bill* will be generated by the
company that is selling the product on behalf of another party. For example, a distributor of a
specific product.
Reports
=======
@@ -965,11 +1032,10 @@ VAT reports
Sales VAT book
~~~~~~~~~~~~~~
In this report, all the sales are recorded, which are taken as the basis for the accounting records
to determine the VAT (Tax Debit).
The :guilabel:`Sales VAT` book report can be exported in a `.zip` file :guilabel:`VAT BOOK (ZIP)`
button in the top left, which contains `.txt` files to upload in the AFIP portal.
This report records all the sales, which are taken as the basis for the accounting records
to determine the VAT (Tax Debit). The :guilabel:`Sales VAT` book report can be exported as a `.zip`
file using the :guilabel:`VAT BOOK (ZIP)` button at the top left, containing `.txt` files to upload
to the AFIP portal.
.. image:: argentina/sales-vat-book.png
:align: center
@@ -978,8 +1044,9 @@ button in the top left, which contains `.txt` files to upload in the AFIP portal
Purchases VAT book
~~~~~~~~~~~~~~~~~~
The :guilabel:`Purchases VAT` book report can be exported in a `.zip` file :guilabel:`VAT BOOK
(ZIP)` button in the top left, which contains `.txt` files to upload in the AFIP portal.
The :guilabel:`Purchases VAT` book report can be exported as a `.zip` file using the
:guilabel:`VAT BOOK (ZIP)` button at the top left, which contains `.txt` files to upload to the AFIP
portal.
.. image:: argentina/purchases-vat-book.png
:align: center
@@ -988,7 +1055,7 @@ The :guilabel:`Purchases VAT` book report can be exported in a `.zip` file :guil
VAT summary
~~~~~~~~~~~
Pivot table designed to check the monthly VAT totals. This report is for internal usage, it is not
Pivot table designed to check the monthly VAT totals. This report is for internal use and is not
sent to the AFIP.
.. image:: argentina/vat-summary.png
@@ -1002,7 +1069,7 @@ IIBB - Sales by jurisdiction
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Pivot table where you can validate the gross income in each jurisdiction. Affidavit for the
corresponding taxes to pay, therefore it is not sent to the AFIP.
corresponding taxes to pay; and therefore, it is not sent to the AFIP.
.. image:: argentina/iibb-sales-jurisdiction.png
:align: center
@@ -1012,7 +1079,7 @@ IIBB - Purchases by jurisdiction
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Pivot table where you can validate the gross purchases in each jurisdiction. Affidavit for the
corresponding taxes to pay, therefore it is not sent to the AFIP.
corresponding taxes to pay; and therefore, it is not sent to the AFIP.
.. image:: argentina/iibb-purchases-jurisdiction.png
:align: center
Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

@@ -522,7 +522,7 @@ is generated for each POS order and added to its receipt. This allows the govern
all revenue is declared.
.. warning::
Only the FDM from **Boîtenoire.be** with the `FDM certificate number BMC01
Only the FDM from **Boîtenoire.be** with the `FDM certificate number BMC04
<https://www.systemedecaisseenregistreuse.be/fr/systemes-certifies#FDM%20certifiés>`_ is
supported by Odoo. `Contact the manufacturer (GCV BMC) <https://www.boîtenoire.be/contact>`_ to
order one.
@@ -532,7 +532,7 @@ Configuration
Before setting up your database to work with an FDM, ensure you have the following hardware:
- a **Boîtenoire.be** (certificate number BMC01) FDM;
- a **Boîtenoire.be** (certificate number BMC04) FDM;
- an RS-232 serial null modem cable per FDM;
- an RS-232 serial-to-USB adapter per FDM;
- an :ref:`IoT Box <belgium/iotbox>` (one IoT box per FDM); and
@@ -10,12 +10,12 @@ Introduction
============
With the Brazilian localization, sales taxes can be automatically computed and electronic invoices
(NF-e) for goods can be sent using AvaTax (Avalara) through |API| calls. Moreover, taxes for
services can be configured.
for goods (NF-e) and services (NFS-e) can be sent using AvaTax (Avalara) through |API| calls.
Moreover, taxes for services can be configured.
For the goods tax computation and electronic invoicing process, you need to configure the
:ref:`contacts <brazil/contacts>`, :ref:`company <brazil/company>`, :ref:`products
<brazil/products>`, and :ref:`create an account in Avatax <brazil/avatax-account>` need to be
For the goods and services tax computation and electronic invoicing process, you need to configure
the :ref:`contacts <brazil/contacts>`, :ref:`company <brazil/company>`, :ref:`products
<brazil/products>`, and :ref:`create an account in AvaTax <brazil/avatax-account>` which needs to be
configured in the general settings.
For the services taxes, you can create and configure them from Odoo directly without computing them
@@ -27,9 +27,36 @@ needed.
Configuration
=============
Install the :guilabel:`🇧🇷 Brazil` :ref:`fiscal localization package
<fiscal_localizations/packages>` to get all the default accounting features of the Brazilian
localization, following the :abbr:`IFRS (International Financial Reporting Standards)` rules.
Modules installation
--------------------
:ref:`Install <general/install>` the following modules to get all the features of the Brazilian
localization:
.. list-table::
:header-rows: 1
:widths: 25 25 50
* - Name
- Technical name
- Description
* - :guilabel:`Brazilian - Accounting`
- `l10n_br`
- Default :ref:`fiscal localization package <fiscal_localizations/packages>`, which represents
having the Generic Brazilian chart of accounts and Taxes, together with document types and
identification types.
* - :guilabel:`Brazil - Accounting Reports`
- `l10n_br_reports`
- Accounting reports for Brazil.
* - :guilabel:`AvaTax Brazil` & :guilabel:`AvaTax Brazil for Services`
- `l10n_br_avatax` & `l10n_br_avatax_services`
- Goods and Services tax computation through Avalara.
* - :guilabel:`Brazilian Accounting EDI` & :guilabel:`Brazilian Accounting EDI for services`
- `l10n_br_edi` & `l10n_br_edi_services`
- Provides electronic invoicing for goods and services for Brazil through AvaTax.
* - :guilabel:`Brazil Pix QR codes`
- `l10n_br_pix`
- Implements Pix QR codes for Brazil.
.. _brazil/company:
@@ -42,40 +69,53 @@ given to your company.
#. Select the :guilabel:`Company` option at the top of the page. Then, configure the following
fields:
- :guilabel:`Name`.
- :guilabel:`Address` (add :guilabel:`City`, :guilabel:`State`, :guilabel:`Zip Code`,
:guilabel:`Country`).
- :guilabel:`Name`
- :guilabel:`Address`: add :guilabel:`City`, :guilabel:`State`, :guilabel:`Zip Code`,
:guilabel:`Country`
- In the :guilabel:`Street` field, enter the street name, number, and any additional address
information.
- In the :guilabel:`Street 2` field, enter the neighborhood.
- :guilabel:`Identification Number` (:guilabel:`CNPJ`, :guilabel:`CPF`).
- :guilabel:`Tax ID` (associated with the identification type).
- :guilabel:`IE` (State registration).
- :guilabel:`IM` (Municipal registration).
- :guilabel:`SUFRAMA code` (Superintendence of the Manaus Free Trade Zone - add if applicable).
- :guilabel:`Phone`.
- :guilabel:`Email`.
- :guilabel:`Identification Number`: :guilabel:`CNPJ` or :guilabel:`CPF`
- :guilabel:`Tax ID`: associated with the identification type
- :guilabel:`IE`: State registration
- :guilabel:`IM`: Municipal registration
- :guilabel:`SUFRAMA code`: Superintendence of the Manaus Free Trade Zone - add if applicable
- :guilabel:`Phone`
- :guilabel:`Email`
.. image:: brazil/contact-configuration.png
:alt: Company configuration.
#. Configure the :guilabel:`Fiscal Information` within the :guilabel:`Sales and Purchase` tab:
- Add the :guilabel:`Fiscal Position` for :ref:`Avatax Brazil <brazil/fiscal-positions>`.
- :guilabel:`Tax Regime` (Federal Tax Regime).
- :guilabel:`ICMS Taxpayer Type` (indicates ICMS regime, Exempt status, or Non-Taxpayer).
- :guilabel:`Main Activity Sector`.
- Add the :guilabel:`Fiscal Position` for :ref:`AvaTax Brazil <brazil/fiscal-positions>`.
- :guilabel:`Tax Regime`: Federal Tax Regime
- :guilabel:`ICMS Taxpayer Type`: indicates :guilabel:`ICMS regime`, :guilabel:`Exempt status`,
or :guilabel:`Non-Taxpayer`
- :guilabel:`Main Activity Sector`
.. image:: brazil/contact-fiscal-configuration.png
:alt: Company fiscal configuration.
#. Finally, upload a company logo and save the contact
#. Configure the following extra :guilabel:`Fiscal Information` if you are going to issue NFS-e:
- Add the :guilabel:`Fiscal Position` for :ref:`AvaTax Brazil <brazil/fiscal-positions>`.
- :guilabel:`COFINS Details`: :guilabel:`Taxable, Not Taxable, Taxable with rate 0%, Exempt,
Suspended`
- :guilabel:`PIS Details` :guilabel:`Taxable, Not Taxable, Taxable with rate 0%, Exempt,
Suspended`
- :guilabel:`CSLL Taxable` If the company is subject to CSLL or not
.. image:: brazil/contact-fiscal-configuration-nfse.png
:alt: Company fiscal configuration for NFSe.
#. Finally, upload a company logo and save the contact.
.. note::
If you are a simplified regime, you need to configure the ICMS rate under
:menuselection:`Accounting --> Configuration --> Settings --> Taxes --> Avatax Brazil`.
:menuselection:`Accounting --> Configuration --> Settings --> Taxes --> AvaTax Brazil`.
.. _brazil/avatax-account:
@@ -88,11 +128,14 @@ transaction information to retrieve the correct tax to be used and process the e
with the government.
Using this integration requires :doc:`In-App-Purchases (IAPs) <../../essentials/in_app_purchase>` to
compute the taxes and to send the electronic invoices. Whenever you compute taxes, an |API| call is
made using credits from your |IAP| credits balance.
compute the taxes and to send the electronic invoices. Whenever you compute taxes, send an
electronic document (NF-e, NFS-e, etc), or perform any electronic flow (NF-e Cancellation,
Correction letter, Invalidate invoice number range), an API call is made using credits from your
`IAP credits balance <https://iap.odoo.com/iap/in-app-services/819>`_.
.. note::
Odoo is a certified partner of Avalara Brazil.
- Odoo is a certified partner of Avalara Brazil.
- You can `buy IAP credit on odoo.com <https://iap.odoo.com/iap/in-app-services/819>`_.
Credential configuration
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -100,19 +143,31 @@ Credential configuration
To activate AvaTax in Odoo, you need to create an account. To do so, go to
:menuselection:`Accounting --> Configuration --> Settings --> Taxes`, and in the :guilabel:`AvaTax
Brazil` section, add the administration email address to be used for the AvaTax portal in the
:guilabel:`Avatax Portal Email`, and then click on :guilabel:`Create account`.
:guilabel:`AvaTax Portal Email`, and then click on :guilabel:`Create account`.
.. warning::
When **testing** an :guilabel:`Avatax Portal Email` integration in a testing or sandbox database,
use an alternate email address. It is **not** possible to re-use the same email address on the
production database.
When **testing** or **creating a production** :guilabel:`AvaTax Portal Email` integration in a
sandbox or production database, use a real email address, as it is needed to log in to the
Avalara Portal and set up the certificates, whether you want to test or use it on production.
There are two different Avalara Portals, one for testing and one for production:
- Sandbox: https://portal.sandbox.avalarabrasil.com.br/
- Production: https://portal.avalarabrasil.com.br/
When you create the account from Odoo, be sure to select the right environment. Moreover, the
email used to open the account cannot be used to open another account. Save your :guilabel:`API
ID` and :guilabel:`API Key` when you create the account from Odoo.
.. image:: brazil/transfer-api-credentials.png
:alt: Transfer API Credentials.
After you create the account from Odoo, you need to go to the Avalara Portal to set up your
password:
#. Access the `Avalara portal <https://portal.avalarabrasil.com.br/Login>`_.
#. Click on :guilabel:`Meu primeiro acesso`.
#. Add the email address you used in Odoo to create the Avalara/Avatax account, and then click
#. Add the email address you used in Odoo to create the Avalara/AvaTax account, and then click
:guilabel:`Solicitar Senha`.
#. You will receive an email with a token and a link to create your password. Click on this link and
copy-paste the token to allocate your desired password.
@@ -123,7 +178,7 @@ password:
invoice service, you **must** access the AvaTax portal and upload your certificate there.
.. image:: brazil/avatax-account-configuration.png
:alt: Avatax account configuration.
:alt: AvaTax account configuration.
.. note::
You can transfer |API| credentials. Use this only when you have already created an account in
@@ -139,6 +194,13 @@ The certificate will be synchronized with Odoo, as long as the external identifi
AvaTax portal matches - without special characters - with the CNPJ number, and the identification
number (CNPJ) in Odoo matches with the CNPJ in AvaTax.
.. important::
To issue NFS-e, some cities require that you link the certificate within the City Portal system
before issuing NFS-e from Odoo.
If you receive an error message from the city that says :guilabel:`Your certificate is not linked
to the user`, that means this process needs to be done in the city portal.
Configure master data
---------------------
@@ -187,15 +249,8 @@ be manually added and configured, as the rate may differ depending on the city w
offering the service.
.. important::
Taxes attached to services are not computed by AvaTax. Only goods taxes are computed.
When configuring a tax used for a service that is included in the final price (when the tax is not
added or subtracted on top of the product price), set the :guilabel:`Tax Computation` to
:guilabel:`Percentage of Price Tax Included`, and, on the :guilabel:`Advanced Options` tab, check
the :guilabel:`Included in Price` option.
.. image:: brazil/tax-configuration.png
:alt: Tax configuration.
If you decide to do service taxes manually, you won't be able to issue an NFS-e. To
electronically send an NFS-e, you need to compute taxes using Avalara.
.. warning::
Do not delete taxes, as they are used for the AvaTax tax computation. If deleted, Odoo creates
@@ -212,14 +267,17 @@ Products
~~~~~~~~
To use the AvaTax integration on sale orders and invoices, first specify the following information
on the product:
on the product depending on its intended use:
- :guilabel:`CEST Code` (Code for products subject to ICMS tax substitution).
- :guilabel:`Mercosul NCM Code` (Mercosur Common Nomenclature Product Code).
- :guilabel:`Source of Origin` (Indicates the origin of the product, which can be foreign or
domestic, among other possible options depending on the specific use case).
- :guilabel:`SPED Fiscal Product Type` (Fiscal product type according to SPED list table).
- :guilabel:`Purpose of Use` (Specify the intended purpose of use for this product).
E-Invoice for goods (NF-e)
**************************
- :guilabel:`CEST Code`: Code for products subject to ICMS tax substitution
- :guilabel:`Mercosul NCM Code`: Mercosur Common Nomenclature Product Code
- :guilabel:`Source of Origin`: Indicates the origin of the product, which can be foreign or
domestic, among other possible options depending on the specific use case
- :guilabel:`SPED Fiscal Product Type`: Fiscal product type according to SPED list table
- :guilabel:`Purpose of Use`: Specify the intended purpose of use for this product
.. image:: brazil/product-configuration.png
:alt: Product configuration.
@@ -231,6 +289,16 @@ on the product:
:guilabel:`Product Type` `Service`, :guilabel:`Transportation Cost Type` `Insurance`, `Freight`,
or `Other Costs`).
E-Invoice for services (NFS-e)
******************************
- :guilabel:`Mercosul NCM Code`: Mercosur Common Nomenclature Product Code
- :guilabel:`Purpose of Use`: Specify the intended purpose of use for this product
- :guilabel:`Service Code Origin`: City Service Code where the provider is registered
- :guilabel:`Service Codes`: City Service Code where the service will be provided, if no
code is added, the Origin City Code will be used
- :guilabel:`Labor Assignment`: Defines if your services includes labor
.. _brazil/contacts:
Contacts
@@ -242,23 +310,23 @@ Before using the integration, specify the following information on the contact:
- Select the :guilabel:`Company` option for a contact with a tax ID (CNPJ), or check
:guilabel:`Individual` for a contact with a CPF.
- :guilabel:`Name`.
- :guilabel:`Address` (add :guilabel:`City`, :guilabel:`State`, :guilabel:`Zip Code`,
:guilabel:`Country`).
- :guilabel:`Name`
- :guilabel:`Address`: add :guilabel:`City`, :guilabel:`State`, :guilabel:`Zip Code`,
:guilabel:`Country`
- In the :guilabel:`Street` field, enter the street, number, and any extra address information.
- In the :guilabel:`Street 2` field, enter the neighborhood.
- :guilabel:`Identification Number` (:guilabel:`CNPJ`, :guilabel:`CPF`).
- :guilabel:`Tax ID` (associated with the identification type).
- :guilabel:`IE`: state tax identification number.
- :guilabel:`IM`: municipal tax identification number.
- :guilabel:`SUFRAMA code`: SUFRAMA registration number.
- :guilabel:`Phone`.
- :guilabel:`Email`.
- :guilabel:`Identification Number`: :guilabel:`CNPJ` or :guilabel:`CPF`
- :guilabel:`Tax ID`: associated with the identification type
- :guilabel:`IE`: state tax identification number
- :guilabel:`IM`: municipal tax identification number
- :guilabel:`SUFRAMA code`: SUFRAMA registration number
- :guilabel:`Phone`
- :guilabel:`Email`
.. image:: brazil/contact-configuration.png
:alt: Contact configuration.
:alt: Contact configuration.
.. note::
The :guilabel:`CPF`, :guilabel:`IE`, :guilabel:`IM`, and :guilabel:`SUFRAMA code` fields are
@@ -269,13 +337,25 @@ Before using the integration, specify the following information on the contact:
- :guilabel:`Fiscal Position`: add the AvaTax fiscal position to automatically compute taxes on
sale orders and invoices automatically
- :guilabel:`Tax Regime`: federal tax regime
- :guilabel:`ICMS Taxpayer Type`: taxpayer type determines if the contact is within the ICMS
regime, if it is exempt, or if it is a non-taxpayer
- :guilabel:`ICMS Taxpayer Type`: taxpayer type determines if the contact is within the
:guilabel:`ICMS regime`, :guilabel:`Exempt status`, or :guilabel:`Non-taxpayer`
- :guilabel:`Main Activity Sector`: list of main activity sectors of the contact
.. image:: brazil/contact-fiscal-configuration.png
:alt: Contact fiscal configuration.
#. Configure the following extra :guilabel:`Fiscal Information` if you are going to issue NFS-e:
- Add the :guilabel:`Fiscal Position` for :ref:`AvaTax Brazil <brazil/fiscal-positions>`
- :guilabel:`COFINS Details`: :guilabel:`Taxable, Not Taxable, Taxable with rate 0%, Exempt,
Suspended`
- :guilabel:`PIS Details`: :guilabel:`Taxable, Not Taxable, Taxable with rate 0%, Exempt,
Suspended`
- :guilabel:`CSLL Taxable`: If the company is subject to CSLL or not
.. image:: brazil/contact-fiscal-configuration-nfse.png
:alt: Contact fiscal configuration for NFSe.
.. _brazil/fiscal-positions:
Fiscal positions
@@ -285,8 +365,8 @@ To compute taxes and send electronic invoices on sale orders and invoices, both
:guilabel:`Detect Automatically` and the :guilabel:`Use AvaTax API` options need to be enabled in
the :guilabel:`Fiscal Position`.
The :guilabel:`Fiscal Position` can be configured on the contact or selected when creating a sales
order or an invoice.
The :guilabel:`Fiscal Position` can be configured on the :ref:`contact <brazil/contacts>` or
selected when creating a sales order or an invoice.
.. image:: brazil/fiscal-position-configuration.png
:alt: Fiscal position configuration
@@ -295,8 +375,8 @@ Workflows
=========
This section provides an overview of the actions that trigger `API calls
<https://en.wikipedia.org/wiki/API>`_ for tax computation, and how to send an electronic invoice for
goods (NF-e) for government validation.
<https://en.wikipedia.org/wiki/API>`_ for tax computation, along with instructions on how to send
electronic invoices for goods (NF-e) and services (NFS-e) for government validation.
.. warning::
Please note that each |API| call incurs a cost. Be mindful of the actions that trigger these
@@ -314,7 +394,7 @@ any of the following ways:
- **Quotation confirmation**
Confirm a quotation into a sales order.
- **Manual trigger**
Click on :guilabel:`Compute Taxes Using Avatax`.
Click on :guilabel:`Compute Taxes Using AvaTax`.
- **Preview**
Click on the :guilabel:`Preview` button.
- **Email a quotation / sales order**
@@ -326,8 +406,8 @@ any of the following ways:
Tax calculations on invoices
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Trigger an |API| call to calculate taxes on a customer invoice automatically with AvaTax any of the
following ways:
Trigger an |API| call to calculate taxes on a customer invoice automatically with AvaTax in any of
the following ways:
- **Manual trigger**
Click on :guilabel:`Compute Taxes Using AvaTax`.
@@ -351,21 +431,21 @@ Electronic documents
Customer invoices
~~~~~~~~~~~~~~~~~
To process an electronic invoice for goods (NF-e), the invoice needs to be confirmed and taxes need
to be computed by Avalara. Once that step is done, click on the :guilabel:`Send \& Print` button in
the upper left corner, and a pop-up will appear. Then click on :guilabel:`Process e-invoice` and any
of the other options - :guilabel:`Download` or :guilabel:`Email`. Finally, click on :guilabel:`Send
\& Print` to process the invoice against the government.
To process an electronic invoice for goods (NF-e) or services (NFS-e), the invoice needs to be
confirmed and taxes need to be computed by Avalara. Once that step is done, click on the
:guilabel:`Send & Print` button in the upper left corner. In the pop-up that appears, click on
:guilabel:`Process e-invoice` and any of the other options - :guilabel:`Download` or
:guilabel:`Email`. Finally, click on :guilabel:`Send & Print` to process the invoice with the
government.
Before sending the electronic invoice for goods (NF-e) some fields need to be filled out on the
invoice:
Before sending the electronic invoice for goods (NF-e) or services (NFS-e), some fields need to be
filled out on the invoice:
- :guilabel:`Customer` with all the customer information
- :guilabel:`Payment Method: Brazil` (how the invoice is planned to be paid)
- :guilabel:`Customer`, with all the customer information
- :guilabel:`Payment Method: Brazil`: how the invoice is planned to be paid
- :guilabel:`Fiscal Position` set as the :guilabel:`Automatic Tax Mapping (Avalara Brazil)`
- :guilabel:`Document Type` set as :guilabel:`(55) Electronic Invoice (NF-e)`. This is the only
electronic document supported at the moment. Non-electronic invoices can be registered, and other
document types can be activated if needed
- :guilabel:`Document Type` set as :guilabel:`(55) Electronic Invoice (NF-e)` or :guilabel:`(SE)
Electronic Service Invoice (NFS-e)`
There are some other optional fields that depend on the nature of the transaction. These fields are
not required, so no errors will appear from the government if these optional fields are not
@@ -392,6 +472,9 @@ Credit notes
If a sales return needs to be registered, then a credit note can be created in Odoo to be sent to
the government for validation.
.. note::
Credit notes are only available for electronic invoices for goods (NF-e).
.. seealso::
:ref:`Issue a credit note <accounting/issue-credit-note>`
@@ -401,7 +484,9 @@ Debit Notes
If additional information needs to be included, or values need to be corrected that were not
accurately provided in the original invoice, a debit note can be issued.
.. important::
.. note::
Debit notes are only available for electronic invoices for goods (NF-e).
Only the products included in the original invoice can be part of the debit note. While changes
can be made to the product's unit price or quantity, products **cannot** be added to the debit
note. The purpose of this document is only to declare the amount that you want to add to the
@@ -415,22 +500,37 @@ Invoice cancellation
It is possible to cancel an electronic invoice that was validated by the government.
.. important::
.. note::
Check whether the electronic invoice is still within the cancellation deadline, which may vary
according to the legislation of each state.
This can be done in Odoo by clicking :guilabel:`Request Cancel` and adding a cancellation
:guilabel:`Reason` on the pop-up that appears. If you want to send this cancellation reason to the
customer via email, activate the :guilabel:`E-mail` checkbox.
E-invoices for goods (NF-e)
***************************
Cancel an e-invoice for goods (NF-e) in Odoo by clicking :guilabel:`Request Cancel` and adding a
cancellation :guilabel:`Reason` on the pop-up that appears. If you want to send this cancellation
reason to the customer via email, activate the :guilabel:`E-mail` checkbox.
.. image:: brazil/invoice-cancellation.png
:alt: Invoice cancellation reason in Odoo.
.. note::
This is an electronic cancellation, which means that Odoo will send a request to the government
to cancel the NF-e, and it will then consume one |IAP| credit, as an |API| call occurs.
E-invoices for services (NFS-e)
*******************************
Cancel an e-invoice for services (NFS-e) in Odoo by clicking :guilabel:`Request Cancel`. In this
case, there is no electronic cancellation process, as not every city has this service available. The
user needs to manually cancel this NFS-e on the city portal. Once that step is completed, they can
request the cancellation in Odoo, which will cancel the invoice.
Correction letter
~~~~~~~~~~~~~~~~~
A correction letter can be created and linked to an electronic invoice that was validated by the
government.
A correction letter can be created and linked to an electronic invoice for goods (NF-e) that was
validated by the government.
This can be done in Odoo by clicking :guilabel:`Correction Letter` and adding a correction
:guilabel:`Reason` on the pop-up that appears. To send this correction reason to a customer via
@@ -439,6 +539,9 @@ email, activate the :guilabel:`E-mail` checkbox.
.. image:: brazil/correction-letter.png
:alt: Correction letter reason in Odoo.
.. note::
Correction letters are only available for electronic invoices for goods (NF-e).
Invalidate invoice number range
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -446,7 +549,7 @@ A range of sequences that are assigned to sales journals can be invalidated with
they are not currently used, **and** will not be used in the future. To do so, navigate to the
journal, and click the :menuselection:`⚙️ (gear) icon --> Invalidate Number Range (BR)`. On the
:guilabel:`Invalidate Number Range (BR)` wizard, add the :guilabel:`Initial Number` and
:guilabel:`End Number` of the range that should be canceled, and enter an invalidation
:guilabel:`End Number` of the range that should be cancelled, and enter an invalidation
:guilabel:`Reason`.
.. image:: brazil/range-number-invalidation.png
@@ -456,7 +559,11 @@ journal, and click the :menuselection:`⚙️ (gear) icon --> Invalidate Number
:alt: Number range invalidation wizard in Odoo.
.. note::
The log of the canceled numbers along with the XML file are recorded in the chatter of the
Invalidate invoice number range documents are only available for electronic invoices for goods
(NF-e).
.. note::
The log of the cancelled numbers along with the XML file are recorded in the chatter of the
journal.
Vendor bills
@@ -468,8 +575,8 @@ is recorded on the :ref:`customer invoices <brazil/electronic-documents>`.
These Brazilian specific fields are:
- :guilabel:`Payment Method: Brazil` (how the invoice is planned to be paid).
- :guilabel:`Document Type` used by your vendor.
- :guilabel:`Document Number` (the invoice number from your supplier).
- :guilabel:`Freight Model` (how goods are planned to be transported - domestic).
- :guilabel:`Transporter Brazil` (who is doing the transportation).
- :guilabel:`Payment Method: Brazil`: how the invoice is planned to be paid
- :guilabel:`Document Type`: used by your vendor
- :guilabel:`Document Number`: the invoice number from your supplier
- :guilabel:`Freight Model`: **NF-e specific** how goods are planned to be transported - domestic
- :guilabel:`Transporter Brazil`: **NF-e specific** who is doing the transportation.
Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

@@ -617,7 +617,7 @@ Note` and select :guilabel:`Full Refund`, in this case the :abbr:`SII (Servicio
Internos)` reference code is automatically set to :guilabel:`Anula Documento de referencia`.
.. image:: chile/credit-note-cancel-ref-doc.png
:alt: Credit note canceling the referenced document.
:alt: Credit note cancelling the referenced document.
:align: center
Correct referenced document
@@ -742,7 +742,7 @@ vendor.
:align: center
If you claim a vendor bill, the status changes from :guilabel:`Draft` to :guilabel:`Cancel`
automatically. Considering this as best practice, all the claimed documents should be canceled as
automatically. Considering this as best practice, all the claimed documents should be cancelled as
they won't be valid for your accounting records.
Electronic purchase invoice
@@ -1196,7 +1196,7 @@ on the client's original order.
:alt: Selection of order for the refund process.
When the return payment is validated, Odoo generates the necessary credit note, referencing the
original receipt or invoice, partially or fully canceling the document.
original receipt or invoice, partially or fully cancelling the document.
.. seealso::
`Smart tutorial - Electronic invoicing for point of sale
@@ -61,11 +61,28 @@ localization:
<../accounting/customer_invoices/electronic_invoicing>`, based on the Technical
documentation published by the SRI. The authorized documents are: Invoices, Credit Notes,
Debit Notes, Withholdings and Purchase liquidations.
* - :guilabel:`Ecuadorian Accounting Reports`
- `l10n_ec_reports`
- Includes all the technical and functional requirements to generate forms 103 and 104.
* - :guilabel:`Ecuador - ATS Report`
- `l10n_ec_reports_ats`
- Includes all the technical and functional requirements to generate the ATS report XML file
ready to be uploaded to the *DIMM Formularios*.
* - :guilabel:`Ecuadorian Website`
- `l10n_ec_website_sale`
- Includes all the technical and functional requirements to generate automatic electronic
invoices from a Website sale.
* - :guilabel:`Ecuadorian Point of Sale`
- `l10n_ec_edi_pos`
- Includes all the technical and functional requirements to generate automatic electronic
invoices from a PoS sale.
.. note::
When you install a database from scratch selecting `Ecuador` as the country, Odoo automatically
installs the base module :guilabel:`Ecuadorian - Accounting`.
.. _l10n_ec/configure-your-company:
Configure your company
----------------------
@@ -304,8 +321,8 @@ The following options have been automatically configured:
of 103 form if it is a income tax withholding code.
- :guilabel:`Tax Name`:
- For IVA tax, format the name as: `IVA [percent] (104, [form code] [tax support code] [tax support
short name])`
- For IVA tax, format the name as: `IVA [percent] (104, [form code] [tax support code] [tax
support short name])`
- For income tax withholding code, format the name as: `Code ATS [Percent of withhold] [withhold
name]`
@@ -552,13 +569,94 @@ withholdings percentages apply.
withholding of 70% in a new line with the same tax support, the system will allow you as long as
the total of the bases matches the total from the :guilabel:`Vendor Bill`.
eCommerce
---------
The :ref:`ATS Report module <ecuador/ats>` enables the following:
- Choose the SRI Payment Method in each payment method's configuration.
- Customers can manually input their identification type and identification number during the
eCommerce checkout process.
- Automatically generate a valid electronic invoice for Ecuador at the end of the checkout process.
Configuration
~~~~~~~~~~~~~
Website
*******
To generate an invoice after the checkout process, navigate to :menuselection:`Website -->
Configuration --> Settings` and activate the :guilabel:`Automatic Invoice` option found under the
:guilabel:`Invoicing` section.
.. tip::
The invoice's email template can be modified from the :guilabel:`Invoice Email Template` field
under the :guilabel:`Automatic Invoice` option.
.. important::
The sales journal used for invoicing is the first in the sequence of priority in the
:guilabel:`Journal` menu.
Payment providers
*****************
To activate the payment providers that should be used to capture eCommerce payments, navigate to
:menuselection:`Website --> Configuration --> Payment Providers` section and then click on the
:guilabel:`View other providers` button under the :guilabel:`Activate Payments` heading. From here,
each payment provider can be configured by selecting a provider record. Refer to the :doc:`payment
provider <../payment_providers>` documentation for more information.
Payment methods
^^^^^^^^^^^^^^^
To activate one or more payment methods for a payment provider, click :guilabel:`→ Enable Payment
Methods` within the :guilabel:`Configuration` tab of each provider.
When configuring the payment method, it is **mandatory** to set the :guilabel:`SRI Payment Method`
for each method. This field appears after you create and save the payment method for the first
time.
.. note::
Adding the :guilabel:`SRI Payment Method` is necessary to generate correctly the electronic
invoice from an eCommerce sale. Select a **payment method** to access its configuration menu and
the field.
.. seealso::
:doc:`Payment provider <../payment_providers>`
.. image:: ecuador/l10n-ec-sri-payment-method.png
:align: center
:alt: l10n_ec SRI Payment Method.
eCommerce workflow
~~~~~~~~~~~~~~~~~~
Type and identification number
******************************
The client who is making a purchase will have the option to indicate their identification type and
number during the checkout process. This information is required to correctly generate the
electronic invoice after the checkout is completed.
.. image:: ecuador/website-checkout-form.png
:align: center
:alt: Website checkout form.
.. note::
Verification is done to ensure the *Identification Number* field is completed and has the correct
number of digits. For RUC identification, 13 digits are required. For Cédula, 9 digits are
required.
After finishing the checkout process, a confirmed invoice is generated, ready to be sent manually or
asynchronously to the SRI.
Financial Reports
=================
In Ecuador, there are fiscal reports that the company presents to SRI. In Odoo, we have two of the
main financial reports used by companies. These are the reports 103 and 104.
In Ecuador, there are fiscal reports that the company presents to SRI. Odoo supports two of the main
financial reports used by companies: **reports 103** and **104**.
To get these reports go to the :guilabel:`Accounting` app and select :menuselection:`Reporting -->
To get these reports, go to the **Accounting** app and select :menuselection:`Reporting -->
Statements Reports --> Tax Report` and then filter by `Tax Report 103` or `Tax Report 104`.
Report 103
@@ -567,8 +665,8 @@ Report 103
This report contains information of income tax withholdings in a given period, this can be reported
monthly or semi-annually.
You can see the information needed to report, which includes base and tax amounts, which also
includes the tax code within the parenthesis in order to report it to the SRI.
You can see the information needed to report, which includes base and tax amounts, but also includes
the tax code within the parenthesis in order to report it to the SRI.
.. image:: ecuador/103-form.png
:align: center
@@ -580,9 +678,67 @@ Report 104
This report contains information on VAT tax and VAT withholding for a given period, this can be
monthly or semi-annually.
You can see the information needed to report, which includes base and tax amounts, which also
includes the tax code within the parenthesis in order to report it to the SRI.
You can see the information needed to report, which includes base and tax amounts, but also includes
the tax code within the parenthesis to report it to the SRI.
.. image:: ecuador/104-form.png
:align: center
:alt: Report 104 form for Ecuador.
.. _ecuador/ats:
ATS report
----------
:ref:`Install <general/install>` the *ATS Report* (`l10n_ec_reports_ats`) module to enable
downloading the ATS report in XML format.
.. note::
The Ecuadorian *ATS Report* module depends on the previous installation of the *Accounting* app
and the *Ecuadorian EDI module*.
Configuration
~~~~~~~~~~~~~
To issue electronic documents, ensure your company is configured as explained in the
:ref:`electronic invoice <l10n_ec/configure-your-company>` section.
In the :abbr:`ATS (Anexo Transaccional Simplificado)`, every document generated in Odoo (invoices,
vendor bills, sales and purchases withholdings, credit notes, and debit notes) will be included.
Vendor bills
************
When generating a vendor bill, it is necessary to register the authorization number from the
invoice that the vendor generated for the purchase. To do so, go to :menuselection:`Accounting
--> Vendors --> Bills` and select the bill. Then, enter the number from the vendor's invoice in the
:guilabel:`Authorization Number` field.
Credit and debit notes
**********************
When generating a credit note or debit note manually or through importation, it is necessary to link
this note to the sales invoice that is being modified by it.
.. note::
Remember to add all required information to the documents before downloading the :abbr:`ATS
(Anexo Transaccional Simplificado)` file. For example, add the *Authorization Number* and the
*SRI Payment Method* on documents, when needed.
XML generation
~~~~~~~~~~~~~~
To generate the :abbr:`ATS (Anexo Transaccional Simplificado)` report, go to
:menuselection:`Accounting --> Reports --> Tax Report` and choose a time period for the desired
:abbr:`ATS (Anexo Transaccional Simplificado)` report, then click :guilabel:`ATS`.
The downloaded XML file is ready to be uploaded to *DIMM Formularios*.
.. image:: ecuador/ats-report.png
:align: center
:alt: ATS report download for Ecuador in Odoo Accounting.
.. note::
When downloading the :abbr:`ATS (Anexo Transaccional Simplificado)` report, Odoo generates a
warning pop-up alerting the user if a document(s) has missing or incorrect data. Nevertheless,
the user can still download the XML file.
Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

@@ -2,8 +2,35 @@
Hong Kong
=========
Add FPS QR codes to invoices
============================
Configuration
=============
:ref:`Install <general/install>` the following modules to get the latest features of the Hong Kong
localization:
.. list-table::
:header-rows: 1
* - Name
- Technical name
- Description
* - :guilabel:`Hong Kong - Accounting`
- `l10n_hk`
- The base module to manage chart of accounting and localization for Hong Kong.
* - :guilabel:`Hong Kong - Payroll`
- `l10n_hk_hr_payroll`
- Enables :ref:`payroll <hong_kong/payroll>` specific localization features for Odoo *Payroll*
app. This module also installs :guilabel:`Hong Kong - Payroll with Accounting` and
:guilabel:`Documents - Hong Kong Payroll`.
* - :guilabel:`Hong Kong - Payroll with Accounting`
- `l10n_hk_hr_payroll_account`
- Installs the link between Hong Kong payroll and accounting.
* - :guilabel:`Documents - Hong Kong Payroll`
- `documents_l10n_hk_hr_payroll`
- Integrates employee ir56 forms in the Odoo *Documents* app.
FPS QR codes on invoices
========================
:abbr:`FPS (Faster Payment System)` is a payment service platform that allows customers to make
instant domestic payments to individuals and merchants in Hong Kong dollars or Renminbi via online
@@ -12,23 +39,26 @@ and mobile banking.
Activate QR codes
-----------------
Go to :menuselection:`Accounting --> Configuration --> Settings`. Under the :guilabel:`Customer
Payments` section, activate the :guilabel:`QR Codes` feature.
Go to :menuselection:`Accounting app --> Configuration --> Settings`. Under the :guilabel:`Customer
Payments` section, tick the checkbox beside the :guilabel:`QR Codes` feature. Then, click
:guilabel:`Save`.
FPS bank account configuration
------------------------------
Go to :menuselection:`Contacts --> Configuration --> Bank Accounts` and select the bank account for
which you want to activate FPS. Set the :guilabel:`Proxy Type` and fill in the :guilabel:`Proxy
Value` field depending on the type you chose.
Go to :menuselection:`Contacts app --> Configuration --> Bank Accounts section --> Bank Accounts`.
Then select the bank account for FPS activation. Proceed to set the :guilabel:`Proxy Type` and fill
in the :guilabel:`Proxy Value` field, depending on the type chosen.
.. important::
- The account holder's country must be set to Hong Kong on its contact form.
- You could also include the invoice number in the QR code by checking the :guilabel:`Include
Reference` checkbox.
Remember to include the invoice number in the QR code, by ticking the :guilabel:`Include Reference`
checkbox.
.. image:: hong_kong/hk-fps-bank-setting.png
:alt: FPS bank account configuration
:align: center
:alt: FPS bank account configuration.
.. important::
The account holder's country **must** be set to `Hong Kong` on their contact form.
.. seealso::
:doc:`../accounting/bank`
@@ -36,20 +66,475 @@ Value` field depending on the type you chose.
Bank journal configuration
--------------------------
Go to :menuselection:`Accounting --> Configuration --> Journals`, open the bank journal, then fill
out the :guilabel:`Account Number` and :guilabel:`Bank` under the :guilabel:`Journal Entries` tab.
Go to :menuselection:`Accounting app --> Configuration --> Journals` and open the bank journal.
Then, fill out the :guilabel:`Account Number` and :guilabel:`Bank` fields, located in the
:guilabel:`Journal Entries` tab.
.. image:: hong_kong/hk-bank-account-journal-setting.png
:alt: Bank Account's journal configuration
:align: center
:alt: Bank Account's journal configuration.
Issue invoices with FPS QR codes
--------------------------------
When creating a new invoice, open the :guilabel:`Other Info` tab and set the :guilabel:`Payment
QR-code` option to *EMV Merchant-Presented QR-code*.
QR-code` option to :guilabel:`EMV Merchant-Presented QR-code`.
.. image:: hong_kong/hk-qr-code-invoice-setting.png
:alt: Select EMV Merchant-Presented QR-code option
:align: center
:alt: Select EMV Merchant-Presented QR-code option.
Ensure that the :guilabel:`Recipient Bank` is the one you configured, as Odoo uses this field to
generate the FPS QR code.
Ensure that the :guilabel:`Recipient Bank` is configured, as Odoo uses this field to generate the
FPS QR code.
.. _hong_kong/payroll:
Payroll
=======
.. important::
Ensure the :guilabel:`Hong Kong - Payroll` (`l10n_hk_hr_payroll`) module is installed before
proceeding.
Create employees
----------------
Go to the :menuselection:`Employees` app and click :guilabel:`New`. Then, configure the following
fields:
- Under the :guilabel:`Work Information` tab
- :guilabel:`Working Hours`: :guilabel:`HK Standard 40 hours/week` option **must** be selected.
- Under the :guilabel:`Private Information` tab
- :guilabel:`Surname, Given Name, Name in Chinese`: name of the employee.
- :guilabel:`Private Address`: address of the employee.
- :guilabel:`Bank Account Number`: employee's bank account number.
- :guilabel:`Current Rental`: employee's rental records (if rental allowance is applicable).
- :guilabel:`Autopay Type`: :guilabel:`BBAN`, :guilabel:`SVID`, :guilabel:`EMAL`, etc.
- :guilabel:`Autopay Reference`: autopay reference number.
- :guilabel:`Identification No`: HKID of the employee.
- :guilabel:`Gender`: gender of the employee.
.. important::
For the :guilabel:`Bank Account Number`, this account should be set as :guilabel:`Trusted`
before further processing.
To achieve this, click on the right-arrow button next to :guilabel:`Bank Account Number` field.
Set the :guilabel:`Send Money` to :guilabel:`Trusted` by clicking on the toggle.
.. note::
To populate the :guilabel:`Current Rental`, click on the :guilabel:`History` button.
Then, click on :guilabel:`New`. Fill in the relevant details and save the rental record. Upon
saving the record, the rental contract :guilabel:`state` will be visible (at the top-right
corner) and can be set to :guilabel:`Running`.
- Under the :guilabel:`HR Settings` tab:
- :guilabel:`Volunteer Contribution Option`: select either :guilabel:`Only Mandatory
Contribution`, :guilabel:`With Fixed %VC`, or :guilabel:`Cap 5% VC`.
- :guilabel:`MPF Manulife Account`: account number, if applicable.
.. _hong_kong/manage_contracts:
Manage contracts
----------------
Once the new employee has been created, click the :guilabel:`Contracts` smart button on the
employee record, or navigate to :menuselection:`Employees app --> Employees --> Contracts`.
.. note::
Only **one** contract can be active simultaneously per employee, but an employee can be assigned
consecutive contracts during their employment.
The following are critical for setting up a contract:
- :guilabel:`Salary Structure Type`: set as :guilabel:`CAP57: Hong Kong Employee`.
- :guilabel:`Contract Start Date`: start date of employment.
- :guilabel:`Working Schedule`: set as :guilabel:`HK Standard 40 hours/week` (from employee record).
- :guilabel:`Work Entry Source`: select either :guilabel:`Working Schedule`, :guilabel:`Attendances`
or :guilabel:`Planning`. This field determines how the work entries are accounted for in the
payslip.
- :guilabel:`Working Schedule`: the work entries are generated automatically based on the
employee's working schedule.
- :guilabel:`Attendances`: the work entries are generated based on the check-in/out period logged
in the *Attendances*.
- :guilabel:`Planning`: the work entries are generated from planning shifts only.
- Under the :guilabel:`Salary Information` tab
- :guilabel:`Wage Type`: select :guilabel:`Fixed Wage` for Full-time or Part-time employees, or
:guilabel:`Hourly Wage` for employees who are paid hourly.
- :guilabel:`Schedule Pay`: the frequency of payslip issuance.
- :guilabel:`Wage`: :guilabel:`Monthly` or :guilabel:`Hourly` depending on the :guilabel:`Wage
Type`.
- :guilabel:`Internet Subscription`: this is an **optional** field to provide additional internet
allowance on top of the current salary package.
.. important::
Timesheets do **not** impact work entries in Odoo.
Once all information has been setup, set the contract status to :guilabel:`Running` by clicking the
:guilabel:`Running` button in the top-right of the page.
.. image:: hong_kong/hk-contract.png
:align: center
:alt: Hong Kong employment contract.
.. _hong_kong/running_payslips:
Generate payslips
-----------------
Once the employees, and their contracts, are configured, payslips can be generated in the *Payroll*
app.
Odoo provides **four** different salary structures under CAP57 regulation:
#. :guilabel:`CAP57: Employees Monthly Pay`: to process the monthly employee salary.
#. :guilabel:`CAP57: Payment in Lieu of Notice`: to process final payment upon contract termination
using :abbr:`ADW (Average Daily Wage)`.
#. :guilabel:`CAP57: Long Service Payment`: applicable to employees with more than five years of
service upon contract termination.
#. :guilabel:`CAP57: Severance Payment`: applicable to employees with more than two years of service
upon contract termination.
Before running the payslips, the accounts used in the salary rule can be adjusted by navigating to
:menuselection:`Payroll app --> Configuration --> Rules`.
.. image:: hong_kong/hk-salary-rules.png
:align: center
:alt: Hong Kong Salary Rules.
Odoo can create pay runs in two ways: via :ref:`batch <hong_kong/batch_payslips>` or
:ref:`individual <hong_kong/individual_payslips>` payslips.
.. _hong_kong/batch_payslips:
Batch payslips
~~~~~~~~~~~~~~
This method of payslip generation is used for recurring payments, since multiple employee payslips
can be managed at once. Go to :menuselection:`Payroll app --> Payslips --> Batches`.
#. Click on :guilabel:`New`.
#. Enter a :guilabel:`Batch Name` (e.g. `2024 - Jan`) and :guilabel:`Period` (e.g. `01/01/2024` -
`01/31/2024`).
#. Click on :guilabel:`Generate Payslips`.
#. Choose which :guilabel:`Salary Structure` to use for this batch. The department filter allows the
batch to only apply to a specific group of employees.
#. Click on :guilabel:`Generate`.
#. A :guilabel:`Payslips` smart button is created automatically.
Next, click :guilabel:`Create Draft Entry` to generate a draft journal entry found in the
:guilabel:`Other Info` tab of each payslip. A :guilabel:`Confirmation` pop-up window appears asking
:guilabel:`Are you sure you want to proceed?`. Click :guilabel:`Ok` to create the journal entries.
.. _hong_kong/individual_payslips:
Individual payslips
~~~~~~~~~~~~~~~~~~~
Go to :menuselection:`Payroll app --> Payslips --> All Payslips`.
This method of payslip generation is commonly used to handle non-recurring payments (e.g.
:guilabel:`CAP57: Payment in Lieu of Notice`, :guilabel:`CAP57: Long Service Payment` or
:guilabel:`CAP57: Severance Payment`).
#. Click on :guilabel:`New`.
#. Select an :guilabel:`Employee`. When selected, the :guilabel:`Contract` is filled out
automatically.
#. Add a pay :guilabel:`Period`.
#. Select a salary :guilabel:`Structure` (e.g. :guilabel:`CAP57: Employees Monthly Pay`).
#. The :guilabel:`Worked Days & Inputs` tab automatically compute the worked days/hours and time off
leaves that are applicable.
#. Additional payslip items can be added at this time (e.g. :guilabel:`Commissions`,
:guilabel:`Deductions`) under the :guilabel:`Other Inputs` section.
#. Click on :guilabel:`Compute Sheet` button to generate the payslip lines. This button updates
the :guilabel:`Salary Computation` tab.
.. note::
If the work entry for an employee was amended, click the :icon:`fa-cog` :guilabel:`(gear)` icon,
then click :guilabel:`Recompute Whole Sheet` to refresh the payslip's :guilabel:`Worked Days &
Inputs` tab.
The :guilabel:`Salary Computation` tab shows the detailed breakdown of the computation, based on
the salary rules configured for each structure type.
#. :guilabel:`Rent Allowance`: amount derived from the employee's active rental record.
#. :guilabel:`Basic Salary`: amount of base salary provided (after rent allowance deduction).
#. :guilabel:`713 Gross`: net payable amount considering *Commission*, *Internet Allowance*,
*Reimbursements*, *Back-pay*, *Deduction*, etc.
#. :guilabel:`MPF Gross`: net payable amount from 713 gross after consideration of additional
allowances, deductions, and end-of-year payment.
#. :guilabel:`Employee Mandatory Contribution`: employee MPF Contribution.
#. :guilabel:`Employer Mandatory Contribution`: employer MPF Contribution.
#. :guilabel:`Gross`: net payable amount from MPF gross after consideration of MPF deductions.
#. :guilabel:`Net Salary`: final payable amount to be paid to the employee.
.. important::
There are no MPF contributions for the first month. Both employee and employer contribution
starts on second month.
.. image:: hong_kong/hk-salary-computation.png
:align: center
:alt: Hong Kong Salary computation.
Under the :guilabel:`Other Inputs` section in :guilabel:`Worked Days & Inputs` tab, there are
additional manual input types:
- :guilabel:`Back Pay`: additional salary payout can be included under this category.
- :guilabel:`Commission`: the commission earned during the period can be manually entered here.
- :guilabel:`Global Deduction`: a lump-sum deduction from the entire payslip.
- :guilabel:`Global Reimbursement`: a lump-sum reimbursement to the entire payslip.
- :guilabel:`Referral Fee`: the additional bonus offered for any form of business-related referral.
- :guilabel:`Moving Daily Wage`: to override the :abbr:`ADW (Average Daily Wage)` value used for
leaves computation.
- :guilabel:`Skip Rent Allowance`: if set, the rental allowance is excluded from the current
payslip.
- :guilabel:`Custom Average Monthly Salary`: to override the average monthly salary used for
end-of-year payment (rule is only applicable to payslips generated in December).
- :guilabel:`Lieu of Notice Period (Months)`: only applicable to :guilabel:`CAP57: Payment in Lieu
of Notice` salary structure. By default, the final payout is set as 1-month. Use the
:guilabel:`Count` field under the :guilabel:`Other Inputs` section to set a different notice
period duration.
Once the payslips are ready, click on :guilabel:`Compute Sheet`, followed by :guilabel:`Create Draft
entry` to generate a draft journal entry found in the :guilabel:`Other Info` tab of the payslip.
Pay employees
-------------
Once the draft journal entries have been posted, the company can now pay the employees. The user can
choose between **two** different *payment methods*:
- From the employee's payslip (:menuselection:`Payroll app --> Payslips --> All Payslips`), once the
payslip's journal entry has been posted, click :guilabel:`Register Payment`. The process is the
same as :doc:`paying vendor bills <../accounting/payments>`. Select the desired bank journal and
payment method, then later reconcile the payment with the corresponding bank statement.
- For batch payments (:menuselection:`Payroll app --> Payslips --> Batches`), once all draft journal
entries from the batch are confirmed, click :guilabel:`Mark as Paid` to post the payment journal
entry. Then :doc:`create a payment <../accounting/payments>` in the *Accounting* app, and
reconcile accordingly.
Attendances and hourly wage
---------------------------
To configure the contract for an employee paid hourly using the *Attendances* app for hours
tracking, navigate to :menuselection:`Payroll app --> Contracts --> Contracts`.
Create a new :ref:`contract <hong_kong/manage_contracts>`. It is important to remember to set the
:guilabel:`Work Entry Source` as :guilabel:`Attendances`, and :guilabel:`Wage Type` as
:guilabel:`Hourly Wage`.
To record the hours logged by the employee using *Attendances* app:
#. Go to :menuselection:`Attendances app`.
#. The employee can check-in/out, via the kiosk mode and the time will be logged automatically.
#. In the :menuselection:`Payroll app`, review the attendance work entries generated from
:menuselection:`Payroll app --> Work Entries --> Work Entries`.
#. Next, generate the :ref:`payslips <hong_kong/running_payslips>` and process the payment.
.. image:: hong_kong/hk-attendance-work-entry.png
:align: center
:alt: Hong Kong Attendance Work Entry.
.. image:: hong_kong/hk-attendance-payslip.png
:align: center
:alt: Hong Kong Attendance Payslip.
Time Off with Payroll
---------------------
The work entry types and time off types are fully integrated between the *Time Off* and
*Payroll* apps. There are several default time off types and work entry types specific to
Hong Kong which are installed automatically along with the *Hong Kong - Payroll* module.
Go to :menuselection:`Payroll app --> Configuration --> Work Entry Types` and click :guilabel:`New`.
There are two checkboxes to be considered when setting up the work entry type:
- :guilabel:`Use 713`: Include this leave type as part of 713 computation.
- :guilabel:`Non-full pay`: 80% of the :abbr:`ADW (Average Daily Wage)`.
.. image:: hong_kong/hk-work-entry-type.png
:align: center
:alt: Hong Kong Work Entry Type.
.. seealso::
:ref:`Creating and configuring work entry types <payroll/work-entries>`
Understanding 713 Ordinance
---------------------------
The *Hong Kong - Payroll* module is compliant with 713 Ordinance which relates to the
:abbr:`ADW (Average Daily Wage)` computation to ensure fair compensation for employees.
The ADW computation is as follows:
.. figure:: hong_kong/hk-adw.png
:alt: Hong Kong ADW Formula.
:abbr:`ADW (Average Daily Wage)` equals the total wage in a 12-month period, minus the wages of
non-full pay, divided by the total days in a 12-month period minus the days of non-full pay.
.. note::
For 418 compliance, there is no automated allocation of the *Statutory Holiday* entitlement to
the employees. As soon as 418 requirements are met, manually allocate the leaves, via the *Time
Off* app.
.. note::
Before generating payslips, ensure the statuses are :guilabel:`Done` to validate the outcome.
.. list-table::
:header-rows: 1
* - Period
- Days
- Wage
- Commission
- Total
- ADW
- Leave Value
* - Jan
- 31
- $20200
- $0
- $20200
- $651.61 ($20200/31)
- N/A
* - Feb
- 28
- $20200
- $5000
- $25200
- $769.49 ($45400/59)
- N/A
* - Mar (One Day Annual Leave)
- 31
- $20324.33
- $0
- $20324.33
- $730.27 ($65724.33/90)
- $769.49
* - Apr (One Day 80% Sick Leave)
- 30
- $20117.56
- $0
-
-
- $584.22 ($730.27*0.8)
.. example::
Here is an example demonstrating the 713 logic:
- **Jan**: Generate a payslip with a monthly wage of $20200. The :abbr:`ADW (Average Daily Wage)`
is always computed on a cumulative basis of the trailing 12-months.
- **Feb**: Generate a similar payslip, but add an :guilabel:`Other Input Type` for the
:guilabel:`Commission`.
- **Mar**: Apply for **one** full-paid annual leave in March. The salary compensation for the
leave taken is based on :abbr:`ADW (Average Daily Wage)` thus far.
.. image:: hong_kong/hk-march-713.png
:align: center
:alt: Hong Kong March 713.
- **Apr**: Apply for a 1-day non-full pay leave in April. Since this is a non-full pay leave, the
:abbr:`ADW (Average Daily Wage)` is computed accordingly.
.. image:: hong_kong/hk-apr-713.png
:align: center
:alt: Hong Kong April 713.
.. note::
The value of :abbr:`ADW (Average Daily Wage)` is computed in the backend, and not be visible to
the user.
.. seealso::
- `HK 713 Ordinance <https://www.labour.gov.hk/eng/public/wcp/ConciseGuide/Appendix1.pdf>`_
- `HK 418 Ordinance <https://www.workstem.com/hk/en/blog/418-regulations/>`_
Generate reports
----------------
Before generating the below reports, setup the following in :menuselection:`Settings app -->
Payroll`.
Configure the following in the :guilabel:`Accounting` section:
- Tick the :guilabel:`Payroll HSBC Autopay` checkbox.
- :guilabel:`Autopay Type`: Set as :guilabel:`H2H Submission`.
- Select the :guilabel:`Bank Account` to use.
Configure the following in the :guilabel:`HK Localization` section:
- :guilabel:`Employer's Name shows on reports`
- :guilabel:`Employer's File Number`
- :guilabel:`Manulife MPF Scheme`
.. image:: hong_kong/hk-report-setup.png
:align: center
:alt: Hong Kong Payroll Settings.
IRD report
~~~~~~~~~~
There are a total of **four** IRD reports available:
- :guilabel:`IR56B`: employer's Return of Remuneration and Pensions.
- :guilabel:`IR56E`: notification of Commencement of Employment.
- :guilabel:`IR56F`: notification of Ceasation of Employment (remaining in HK).
- :guilabel:`IR56G`: notification of Ceasation of Employment (departing from HK permanently).
Go to :menuselection:`Payroll app --> Reporting`, and select one of the :guilabel:`IR56B/E/F/G
Sheet` options:
#. Click on :guilabel:`New`.
#. Fill in the relevant information for the IRD report.
#. Click on :guilabel:`Populate`, and the :guilabel:`Eligible Employees` smart button appears.
#. The :guilabel:`Employee Declarations` status is :guilabel:`Draft` and changed to
:guilabel:`Generated PDF` status once the schedule runs.
#. Once the PDF is generated, the IRD form may be downloaded.
.. image:: hong_kong/hk-ir56b.png
:align: center
:alt: Hong Kong IR56B report.
.. note::
The scheduled action called *Payroll: Generate pdfs* can be manually triggered. It is set by
default to run the PDF generation monthly.
Manulife MPF sheet
~~~~~~~~~~~~~~~~~~
Go to :menuselection:`Payroll app --> Reporting --> Manulife MPF Sheet`.
#. Click on :guilabel:`New`.
#. Select the relevant :guilabel:`Year`, :guilabel:`Month`, and :guilabel:`Sequence No.`.
#. Click on :guilabel:`Create XLSX`.
#. The *Manulife MPF XLSX* file is then generated, and available for download.
.. image:: hong_kong/hk-manulife-sheet.png
:align: center
:alt: Hong Kong Manulife Sheet.
.. note::
Odoo will not be developing further reports for other MPF trustee as there will soon be an
eMPF platform setup by the local government.
.. seealso::
`eMPF <https://www.mpfa.org.hk/en/empf/overview>`_
HSBC autopay report
~~~~~~~~~~~~~~~~~~~
If *HSBC Autopay* is selected as the batch payment method, click on :guilabel:`Create HSBC Autopay
Report`, and fill in the mandatory fields:
.. image:: hong_kong/hk-generate-autopay.png
:align: center
:alt: Hong Kong HSBC Autopay wizard.
This creates an :file:`.apc` file format which can be uploaded to the HSCB portal for processing.
Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

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