Skip to content

Model Reference

This page provides a comprehensive reference of all base models implemented across Netforce modules. Each model includes its module location, model name, and a brief description of its purpose.

Contact Management (netforce_contact)

Model Name Python Class Description
contact Contact Core contact model for customers, suppliers, and business partners
contact.categ ContactCateg Contact categories for grouping and classification
contact.group ContactGroup Contact groups for organizing contacts
contact.relation ContactRelation Relationships between contacts (parent company, etc.)
contact.relation.type ContactRelationType Types of relationships between contacts
business.area BusinessArea Business areas for categorizing contacts
industry Industry Industry classifications for contacts
region Region Geographic regions for contacts
fleet.size FleetSize Fleet size categories for transportation companies
merge.contact Merge Wizard for merging duplicate contacts
report.contact ReportContact Contact reports and analytics

Product Management (netforce_product)

Core Product Models

Model Name Python Class Description
product Product Core product model for inventory items
product.categ ProductCateg Product categories for classification
product.brand ProductBrand Product brands and manufacturers
product.group ProductGroup Product groups for organization
product.supplier ProductSupplier Supplier information per product
product.customer ProductCustomer Customer-specific product information

Pricing and Costs

Model Name Python Class Description
price.list PriceList Price lists for different customer segments
price.list.item PriceListItem Individual price list entries
price.list.categ PriceListCateg Price list categories
price.type PriceType Types of pricing (retail, wholesale, etc.)
product.cost ProductCost Product cost tracking
cost.type CostType Types of costs (material, labor, overhead)

Product Attributes and Variants

Model Name Python Class Description
product.attribute Attribute Product attributes (color, size, etc.)
product.attribute.value AttributeValue Values for product attributes
product.attribute.option AttributeOption Attribute options for variants
product.variant.values VariantValue Values for product variants
product.custom.option CustomOption Custom options for products
product.custom.option.value OptionValue Values for custom options

Product Components and Manufacturing

Model Name Python Class Description
product.component ProductComponent Bill of materials components
production.process ProductionProcess Manufacturing processes
product.location ProductLocation Product-specific location settings

Specialized Product Types

Model Name Python Class Description
machine Machine Manufacturing machines
machine.parts MachineParts Machine parts and components
material.categ MaterialCateg Material categories
defect.categ DefectCateg Defect categories for quality control

Accounting (netforce_account)

Core Accounting Models

Model Name Python Class Description
account.account Account Chart of accounts
account.move Move Journal entries
account.move.line MoveLine Individual journal entry lines
account.journal Journal Accounting journals
account.balance Balance Account balances

Invoicing and Payments

Model Name Python Class Description
account.invoice Invoice Customer and supplier invoices
account.invoice.line InvoiceLine Invoice line items
account.invoice.tax InvoiceTax Tax calculations on invoices
account.payment Payment Payments and receipts
account.payment.line PaymentLine Payment line items
payment.method PaymentMethod Payment methods (cash, check, transfer)
payment.term PaymentTerm Payment terms and conditions

Banking and Reconciliation

Model Name Python Class Description
account.statement Statement Bank statements
account.statement.line StatementLine Bank statement lines
account.bank.reconcile BankReconcile Bank reconciliation process
account.reconcile Reconcile Account reconciliation

Tax Management

Model Name Python Class Description
account.tax.rate TaxRate Tax rates and configurations
account.tax.component TaxComponent Tax components for complex taxes
tax.period TaxPeriod Tax reporting periods

Fixed Assets

Model Name Python Class Description
account.fixed.asset FixedAsset Fixed asset management
account.fixed.asset.type FixedAssetType Fixed asset types
account.fixed.asset.depreciation Depreciation Depreciation calculations
account.fixed.asset.period FixedAssetPeriod Depreciation periods

Currency and Exchange

Model Name Python Class Description
currency Currency Currency definitions
currency.rate CurrencyRate Exchange rates
custom.currency.rate CustomCurrencyRate Custom exchange rates

Budgeting and Tracking

Model Name Python Class Description
account.budget Budget Budget planning
account.budget.line BudgetLine Budget line items
account.track.categ TrackCateg Tracking categories
account.track.entry TrackEntry Tracking entries

Stock Management (netforce_stock)

Core Stock Models

Model Name Python Class Description
stock.location Location Warehouse locations
stock.move Move Stock movements
stock.balance StockBalance Stock quantity balances
stock.lot StockLot Lot and serial number tracking

Inventory Operations

Model Name Python Class Description
stock.picking Picking Pick lists and shipments
stock.count StockCount Physical inventory counts
stock.count.line StockCountLine Inventory count lines
stock.transfer Transfer Stock transfers between locations
stock.transform Transform Product transformations

Barcode and Mobile

Model Name Python Class Description
stock.barcode Barcode Barcode scanning operations
stock.barcode.item BarcodeItem Barcode item entries
barcode.receive BarcodeReceive Barcode receiving
barcode.issue BarcodeIssue Barcode issuing
barcode.station BarcodeStation Barcode scanning stations

Quality Control

Model Name Python Class Description
qc.result QCResult Quality control results
qc.reason QCReason Quality control failure reasons
product.claim Claim Product claims and returns

Shipping and Logistics

Model Name Python Class Description
ship.method ShipMethod Shipping methods
ship.rate ShipRate Shipping rates
ship.term ShipTerm Shipping terms
courier Courier Courier services

Sales Management (netforce_sale)

Core Sales Models

Model Name Python Class Description
sale.order SaleOrder Sales orders
sale.order.line SaleOrderLine Sales order lines
sale.quot SaleQuot Sales quotations
sale.quot.line SaleQuotLine Quotation lines

Sales Process Management

Model Name Python Class Description
sale.lead Lead Sales leads
sale.opportunity Opportunity Sales opportunities
lead.source LeadSource Lead sources
sale.stage SaleStage Sales process stages

Sales Analytics and Reporting

Model Name Python Class Description
sale.forecast SaleForecast Sales forecasting
sale.target SaleTarget Sales targets
sale.cost SaleCost Sales cost tracking

Sales Support

Model Name Python Class Description
seller Seller Sales representatives
competitor Competitor Competitor information
sale.channel SaleChannel Sales channels
delivery.term DeliveryTerm Delivery terms

Promotions and Discounts

Model Name Python Class Description
sale.promotion Promotion Sales promotions
sale.coupon Coupon Discount coupons
sale.coupon.master CouponMaster Coupon master data

Purchase Management (netforce_purchase)

Core Purchase Models

Model Name Python Class Description
purchase.order PurchaseOrder Purchase orders
purchase.order.line PurchaseOrderLine Purchase order lines
purchase.request PurchaseRequest Purchase requisitions
purchase.request.line PurchaseRequestLine Purchase request lines

Purchase Process

Model Name Python Class Description
purchase.type PurchaseType Purchase order types
purchase.return PurchaseReturn Purchase returns
purchase.return.line PurchaseReturnLine Purchase return lines

Purchase Analytics

Model Name Python Class Description
report.purchase ReportPurchase Purchase reports and analytics
report.commission.po ReportCommissionPO Commission reports for purchase orders

General System Models

Framework and Configuration

Model Name Python Class Description
company Company Multi-company configuration
sequence Sequence Auto-numbering sequences
field.cache FieldCache Field value caching
theme Theme UI themes and styling

User Management and Security

Model Name Python Class Description
base.user User System users
profile Profile User profiles and roles
permission Permission Access permissions

System Administration

Model Name Python Class Description
module Module Installed modules
view View UI view definitions
translation Translation Multi-language translations
activity Activity System activity logging

Model Naming Conventions

Netforce follows consistent naming patterns for models:

  • Master Data: Simple names like contact, product, account
  • Categories: Pattern entity.categ (e.g., contact.categ, product.categ)
  • Related Data: Pattern entity.relation (e.g., contact.relation, product.supplier)
  • Transaction Documents: Pattern module.document (e.g., sale.order, purchase.order)
  • Lines: Pattern document.line (e.g., sale.order.line, account.move.line)
  • Reports: Pattern report.entity (e.g., report.contact, report.stock)

Integration Patterns

Most models share common integration points:

  • Multi-company Support: Models with _multi_company = True support multi-company operations
  • Audit Logging: Models with _audit_log = True track all changes
  • History Tracking: Models with _history = True maintain change history
  • Workflow States: Business documents follow standard state patterns (draft → confirmed → done)
  • Comments: Many models support comments via message relationships
  • Attachments: File attachments via attach model relationships