Prerequisites

• base module — already required by everything; provides basepartner, basepartnercategory, basepartnertitle, plus the partner type infrastructure.
• core_purchase — install if you want vendor-side fields (vendor code, vendor created on) on partners flagged as Vendor.
• master_sale — install if you want customer-side enhancements on partners flagged as Customer.
• partners module is optional — only install if you want the widget showcase / demo data. It is NOT required for partner management.

First-time setup

Module install order

• base ships basepartner, basepartnercategory, basepartnertitle, plus the Partner Type records (Customer, Vendor) referenced via base.base_partner_type_customer and base.base_partner_type_vendor.
• core_purchase extends basepartner with vendor_code and vendor_creation_time; auto-stamped when the Vendor type is added.
• master_sale extends basepartner with the customer-side counterparts.
• The partners module declares "category": "Hidden" and is intentionally a sandbox — its partner model is unrelated to basepartner and ships test rules and demo widgets.

What is a Contact?

A Contact in HMX is a single record on the basepartner model. It holds identity (name, mobile, phone, email — all unique), address (street, city, state, country, ZIP), and classification (Individual or Company; Customer, Vendor, or Both). The same record is referenced by Sales Orders, Purchase Orders, Invoices, and HR records — change the email here, it propagates everywhere.

Contacts can be tagged with multiple Categories (e.g. VIP, Reseller, Strategic) and addressed with a Title (Mr., Dr., Bapak). Both Categories and Titles are master lists you control.

How to create a contact

Contact rules to know

basepartner model essentials

The classification model

HMX uses a partner_types M2M field instead of a single boolean. This means one record can carry multiple type tags simultaneously: a partner is a Customer, a Vendor, or Both. The Sales menu filters on is_customer = True; the Purchase menu filters on is_vendor = True; both flags are computed from partner_types.

Three classification states

How to change classification

How is_customer / is_vendor are computed

Both flags are compute-based and depend on partner_types. The compute method (in the respective extending module — master_sale for customer, core_purchase for vendor) resolves the partner type record once per batch and sets the boolean. See the Purchase scope's Vendors chapter for the full create/write lifecycle.

Categories

A Partner Category is a free-form tag you can attach to any partner: VIP, Strategic, Reseller, Past Due. Categories are hierarchical (parent / children) so you can nest VIP > VIP — Gold > VIP — Platinum. Each category has a colour for visual distinction in lists.

How to create a category

Titles

A Partner Title is the honorific used when addressing a contact: Mr., Ms., Dr., Bapak, Ibu. Each title has a long form (Name) and an optional Shortcut for compact display.

How to create a title

Master models

Capability status

partners module manifest

{
    "name": "Partners",
    "category": "Hidden",
    "active_rule": True,
    "version": "1.0",
    "depends": ["base", "onboarding", "webx"],
    "data": [
        "data/base_report_data.xml",
        "data/onboarding_data.xml",
        "security/base.model.access.csv",
        "views/partners_views.xml",
        "views/test_rule_views.xml",
        "data/base_report_excel_data.xml",
        "wizard/partner_barcode_scanner_views.xml",
    ],
    "assets": { ... }
}

Models in the CRM scope

Permissions

There are no CRM-specific roles. Partner CRUD is controlled by the base.group_user ACLs that ship with the base module. When the dedicated crm module lands, expect a CRM Manager / Sales Rep tier similar to the HR or Inventory pattern.

Source files (partners module)