| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Discuss (mail)
• Employees (hr) • Invoicing (account) |
| Lines of code | 3234 |
| Technical Name |
l10n_sa_wps_payroll |
| License | OPL-1 |
| Website | https://gencbaris.com |
| Versions | 18.0 19.0 |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Discuss (mail)
• Employees (hr) • Invoicing (account) |
| Lines of code | 3234 |
| Technical Name |
l10n_sa_wps_payroll |
| License | OPL-1 |
| Website | https://gencbaris.com |
| Versions | 18.0 19.0 |
Saudi Arabia WPS Payroll Module for Odoo 18 & 19
SAMA-compliant SIF generation, GOSI computation, and EOSB accrual + settlement — all in one module.
What is WPS?
Saudi Arabia's Wage Protection System (WPS) is mandated
by the Ministry of Human Resources and Social Development since 2013
and was fully expanded in 2020. Employers must pay employee salaries
through SAMA-supervised banks via a standardized SIF (Salary
Information File) submitted monthly. This Odoo module integrates
cleanly with hr.payroll to generate compliant SIF files
directly from payslips.
Banks Supported
| Bank | SAMA Code | Format | Status |
|---|---|---|---|
| Al Rajhi Bank | 80 | XML | PRODUCTION |
| Saudi National Bank (SNB) | 10 | XML | PRODUCTION |
| Riyad Bank | 20 | Pipe-delimited | BETA |
| Alinma Bank | 55 | XML | BETA |
| Bank AlBilad | 15 | CSV | BETA |
| Arab National Bank (ANB) | 30 | XML | BETA |
| Bank AlJazira | 60 | CSV | BETA |
| 5 more SAMA banks | — | Generic SAMA CSV | FALLBACK |
GOSI Calculation (General Organization for Social Insurance)
Saudi & GCC Nationals
9% employee + 9% employer on subject wage (basic + housing), capped at SAR 45,000.
Expatriates
2% employer-only (Occupational Hazards branch), no employee deduction.
Cap & Subject Wage
SAR 45,000 cap on contribution base. Subject wage = basic + housing allowance only (Article 19).
EOSB Accrual + Settlement
The module accrues End of Service Benefits (EOSB) monthly via a cron job, computing the tier-based amount per Saudi Labor Law Articles 84-87:
- Years 1-5: 0.5 month of last basic salary per year
- Years 6+: 1.0 month of last basic salary per year
On termination, the EOSB Settlement Wizard computes the final payout based on reason:
| Reason | Tenure | Multiplier |
|---|---|---|
| Resignation | < 2 years | 0% |
| Resignation | 2-5 years | 1/3 |
| Resignation | 5-10 years | 2/3 |
| Resignation | ≥ 10 years | 100% |
| Dismissal for cause (Art. 80) | Any | 0% |
| Redundancy / End of contract / Retirement / Death / Disability | Any | 100% |
How to Set Up
- Install the module from the Odoo Apps store.
- Go to Employees → Configuration → Banks and mark your payroll bank as WPS-supported with the correct SIF format.
- On each employee form, set the Saudi IBAN, nationality (Saudi / GCC / Expat / Other), and GOSI number.
- Run your monthly payroll as usual (Payroll → Payslip Batches).
- Click the Generate WPS Batch button on the payslip run, fill in the wizard, and download the SIF file for upload to your bank's portal.
Compliance & Validation
- Pure-Python IBAN mod-97 validator — Saudi IBAN must start with SA, be exactly 24 characters, and pass the ISO 13616-1 checksum.
- SAR-only currency enforcement (SIF rejects non-SAR submissions).
- Total reconciliation: sum of batch line nets must equal the payroll run total ± SAR 0.01.
- Per-employee WPS opt-out for probationary or off-cycle employees.
- Audit trail via
mail.threadon every batch.
Bilingual AR / EN
All UI labels, model fields, error messages, and reports are translated to Arabic following ZATCA-official HR terminology (الراتب الأساسي, البدلات, مكافأة نهاية الخدمة, etc.). Bilingual PDF cover sheets (Arabic and English side-by-side) are generated for HR review before bank-portal upload.
FAQ
Does this submit to the bank automatically?
No. WPS bank portals don't expose a universal API, so the module generates the SIF file ready for manual upload via each bank's web portal. Some banks offer OAuth APIs separately — we may add native integration in a future release.
Does it submit to GOSI directly?
No. GOSI is a separate authority with its own portal. This module computes the GOSI contributions on each payslip and can produce a standard CSV export for manual upload.
What about Nitaqat (Saudization) reporting?
Out of scope for v1.0 — Nitaqat is a separate compliance domain.
Compatible with Odoo 18 and 19?
Yes — both branches are maintained.
Roadmap
- v1.1: Bank API integration (OAuth submissions for banks that support it)
- v1.2: GOSI portal CSV export with full field validation
- v1.3: Mol/Nitaqat reporting module (separate)
- v1.4: Additional BETA bank format hardening based on field reports
Support
Issues, bank-format reports, and feature requests welcome at gencbaris.com. License: OPL-1 (Odoo Proprietary License v1).
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module