📋 Overview
Top REST API is a comprehensive Odoo 18 module that transforms your Odoo instance into a powerful RESTful API platform. Perfect for mobile apps, third-party integrations, and automated workflows. Includes an advanced Employee Commission Management System with formula-based calculations, rule-based processing, and flexible settlement options.
✨ Key Features
🌐 RESTful API Core
- Full CRUD operations
- GraphQL-like queries
- Flexible filtering
- Pagination support
- Nested relations
💰 Commission Management
- Rule-based calculations
- Formula-based commissions
- Multiple commission types
- Settlement options
- Multi-company support
📦 Stock Management
- Picking operations
- Move line updates
- Validation APIs
- Related data access
- Search capabilities
🛒 Sales & Invoices
- Quotation creation
- Order confirmation
- Invoice generation
- Payment processing
- Workflow automation
👥 HR Management
- Employee management
- Loan tracking
- Excuse management
- Business trips
- Project tasks
📊 Reporting
- Partner ledger PDF
- Commission reports
- Payment statistics
- Custom reports
- Export capabilities
💼 Advanced Commission System
Commission Rules
Create flexible commission rules based on:
- Sale Orders
- Invoices
- Payments
- Margins (Sale Order & Invoice)
Commission Types
Fixed Amount
Set a fixed commission amount
Percentage
Percentage-based calculations
Formula-Based
Python formulas for complex logic
Formula Examples
# Simple percentage
0.025 * base_amount
# Conditional commission
0.025 * base_amount if margin > 100 else 0.02 * base_amount
# Partner-based fixed
100 if partner_id in [1, 2, 3] else 0
# Tiered commission
0.01 * base_amount if amount
Settlement Options
- Vendor Bill: Create vendor bills for commission payments
- Payslip: Include commissions in employee payslips
- Batch Settlement: Settle multiple commissions at once
💻 API Examples
Authentication
POST /auth/
{
"params": {
"login": "user@example.com",
"password": "password",
"db": "database"
}
}
Get Records
GET /api/product.product/?query={id, name, list_price}&filter=[["sale_ok", "=", true]]
Create Record
POST /api/res.partner/
{
"params": {
"data": {
"name": "New Customer",
"email": "customer@example.com"
}
}
}
Get Commissions
GET /api/commission/unsettled/employee/5
💡 Benefits
Easy Integration
Connect with any system using standard REST APIs
Mobile Ready
Build mobile apps that interact with Odoo
Automation
Automate business processes and workflows
Commission Tracking
Advanced commission management system
Multi-Company
Full support for multi-company environments
Secure
Built-in security and access control
🎯 Use Cases
📱 Mobile Apps
Build mobile applications that sync with Odoo in real-time. Perfect for sales teams, field workers, and remote employees.
🛒 E-Commerce
Connect e-commerce platforms to Odoo. Automatic order processing, inventory synchronization, and customer management.
🔗 Third-Party Systems
Integrate with ERP systems, CRM platforms, accounting software, and other business applications.
🤖 Automation
Automate workflows, scheduled tasks, data migration, and business process automation.
💰 Commission Management
Track sales team commissions, automate calculations, and streamline settlement processes.
📊 Reporting
Generate custom reports, export data, and integrate with business intelligence tools.
📦 Installation
- Install dependencies:
pip install -r requirements.txt - Copy module to Odoo addons directory
- Update apps list in Odoo
- Install "Top REST API" module
- Configure access rights and commission settings
🚀 Ready to Transform Your Odoo?
Get started with Top REST API today and unlock the full potential of your Odoo instance.
Install Now
Please log in to comment on this module