Скачать или смотреть Odoo GOSI Integration

Overview
This module integrates Odoo 17 HR and Payroll with the General Organization for Social Insurance (GOSI) API for Saudi Arabia. It automatically fetches and applies employee and employer deduction rates based on real-time GOSI data.
Key Features
✅ Real-Time GOSI Integration - Direct API connection with DPoP security
✅ Automatic Deduction Calculation - Employee & employer rates from GOSI
✅ Smart Employee Classification - Auto-detects Saudi/Non-Saudi contributors
✅ Seamless Payroll Integration - Automatic salary rule application
✅ Multi-Company Support - Different GOSI configs per company
✅ Scheduled Synchronization - Automatic daily/weekly sync
✅ Error Tracking - Comprehensive sync status monitoring
✅ No Controllers Needed - Clean model-based architecture

🎯 Supported Employee Types
TypeDescriptionNID Prefix (Sandbox)
Saudi PR Ineligible (Private) Private sector employees10xxxxxxxx
Saudi PR Ineligible (Public) Public sector employees11xxxxxxxxSaudi PR EligiblePension eligible12xxxxxxxxNon-SaudiForeign workers20xxxxxxxx

⚙️ Configuration
Step 1: GOSI API Configuration
Navigate to: HR → GOSI → GOSI Configuration
Create a new configuration with your GOSI credentials:
FieldValueDescriptionCompanyYour CompanySelect companyEnvironmentSandbox / ProductionTesting or liveRegistration Number123456788-digit GOSI numberClient ID9DWuKXmJbyGJJkHCv7RsbzTDzsGG4FjzFrom GOSIClient SecretQu7n4SuBxaUzzQj7OFrom GOSIAPI KeyL6LK4GEAAIVrQbVo4AOVrQk781kvIT3XFrom GOSIPrivate KeyRSA Private KeyFull PEM format
Private Key Format:
----BEGIN PRIVATE KEY----
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSk...
...
----END PRIVATE KEY----
Step 2: Test Connection
Click "Test Connection" button to verify credentials.
✅ Success message indicates proper configuration.
Step 3: Configure Security Groups
Assign users to appropriate groups:

GOSI User - View GOSI data, sync employees
GOSI Manager - Full configuration access

Navigate to: Settings → Users & Companies → Users

📊 Usage
Employee Setup

Open Employee Record:

Go to HR → Employees
Select or create employee


Enter National ID:

Go to GOSI Information tab
Enter National ID / Iqama / Border Number (10 digits)
System auto-detects contributor type


Sync GOSI Data:

Click "Sync" button
Or use stat button in top-right



Batch Synchronization
Sync Multiple Employees:

Go to HR → GOSI → GOSI Employees
Select employees (checkboxes)
Action → Sync GOSI Data

Sync All Employees:

Go to HR → GOSI → GOSI Configuration
Open your configuration
Click "Sync All Employees"

Automatic Synchronization
Enable Scheduled Jobs:
Navigate to: Settings → Technical → Scheduled Actions

GOSI: Auto Sync Employee Data

Runs daily
Syncs employees with errors or not synced
Set Active = True


GOSI: Refresh Access Tokens

Runs every 50 minutes
Keeps tokens fresh
Set Active = True (optional)

GOSI: Weekly Data Validation

Runs weekly (Sunday 2 AM)
Re-syncs all employees
Set Active = True (recommended)

💼 Payroll Integration
The module automatically integrates with Odoo Payroll:
Salary Rules Created

GOSI Employee Deduction (GOSI_EMP)

Category: GOSI (Social Insurance)
Type: Deduction (negative)
Appears on payslip: ✅
Calculated from: contract.gosi_employee_deduction

GOSI Employer Contribution (GOSI_EMP_CONT)

Category: GOSI (Social Insurance)
Type: Company expense (positive)
Appears on payslip: ✅
Calculated from: contract.gosi_employer_contribution


Adding to Salary Structure
To add GOSI rules to your salary structure:

Go to Payroll → Configuration → Salary Structures
Open your structure (e.g., "Saudi Employee Salary")
Add rules:

GOSI Employee Deduction
GOSI Employer Contribution


Viewing in Payslips
When you generate payslips:

GOSI deductions appear automatically
View detailed info in GOSI Information tab
Employee deduction reduces net salary
Employer contribution is company expense


🧪 Sandbox Testing
For testing in Sandbox environment, use these National ID patterns:
Test National IDs

Configure GOSI with sandbox credentials
Test connection successful
Create test employee with NID starting with 10
Sync GOSI data
Verify rates populated (employee & employer)
Create contract for employee
Check deduction amounts calculated
Generate payslip
Verify GOSI rules applied correctly


🔐 Security & Access Rights
Security Groups
GroupAccess LevelCapabilitiesGOSI ManagerFullConfigure API, sync all, manage settingsGOSI UserRead/ExecuteView data, sync own employeesHR ManagerInheritedAll GOSI User capabilitiesHR UserRead-onlyView GOSI data only
Data Security

✅ API credentials encrypted in database
✅ Tokens auto-refresh before expiry
✅ DPoP tokens unique per request
✅ Multi-company data isolation
✅ Audit trail via message chatter


Contact & Support

Website: icloud-solutions.net
Email: [email protected]
WhatsApp: +216 50 271 737