User guide
This guide describes how to work with Insurance Broker Core in the ERPNext Desk, in the order of a broker's working day. It is a description of the product as it exists in the source repository, not a statement about any running installation.
Status of this guide
| Item | Value |
|---|---|
| Product version | Version 1.0.0, repo-ready |
| What "repo-ready" means | The source tree and its automated checks describe this behaviour. It says nothing about a running site. |
| Productive claims | None. The guide describes forms, checks, and API calls. It does not assert that a process is productively validated. |
| Language | English only |
| Screenshots | The guide screenshot manifest contains 36 scene images; the public-doc asset gate selects five assets across two documents. |
Where a page touches a business process, it contains a short Capability status section. The status values come from the overview: validated, supported, manual_only, model_only, blocked, and not_applicable. Only validated allows a productive claim.
Capability status at a glance
The table below lists conditions, not claims. The binding rule is the capability matrix contract: claim_rule is only_validated_is_publicly_claimable, the default status is model_only, and the list validated_claims is empty. The capability claims document names the following conditions for a public assertion together with the verifier that would back each of them. No claim exists today.
| Capability | Condition that would have to be met before a claim | Evidence script |
|---|---|---|
| Product classes | 51 classes validated (not met as a claim: validated_claims is empty) | verify_product_scope_matrix.py |
| Special classes Fonds and Diverse | model_only, advice and placement blocked | verify_fonds_diverse_boundary.py |
| Money and time contract | Binary floats forbidden, UTC | verify_money_time_contract.py |
| Approval proofs | Three proof types, consume-once | verify_approval_proofs.py |
| AI capability | Blocked by default, no domain mutation without admission | verify_ai_capability_admission.py |
| CRA baseline | draft_legal_review_required | verify_cra_readiness.py |
The matrix lists these processes: inventory, servicing, advice, quote comparison, placement, commission automation, and claims. Each defaults to model_only. For the special product class KVG the matrix sets inventory and servicing to supported and commission automation and claims to manual_only. On a concrete site, an Insurance Broker Capability Admission record per company, country, and product class decides which capability is admitted; a missing admission is rejected with an error.
How the guide is organised
| Chapter | Page | What you do there |
|---|---|---|
| Orientation | Getting started | Find the workspace and the cockpit, choose a company |
| Orientation | Roles and access | Understand roles and company permissions |
| Master data | Parties | Record customers and other parties |
| Master data | Mandates | Record the authority to act for a party |
| Master data | Product catalog | Read the product classes and the capability report |
| Contracts | Policies | Policies, terms, risk objects, coverages |
| Advice | Advice and quotes | Advice cases, recommendations, quotes |
| Tender | Tender overview | What tender is and what it does not do |
| Tender | Tender states and commands | The state machine and the command API |
| Tender | Prepare and invite | Prerequisites, tender record, invitations |
| Tender | Responses and comparison | Record answers, build the comparison |
| Tender | Recommendation and decision | Today's limits at the end of a tender |
| Follow-up | Renewals and deadlines | Renewal cases and deadline reports |
| Follow-up | Claims | Claim assistance and complaint cases |
| Money | Commissions | Import, reconcile, approve, draft postings |
| Governance | Privacy, evidence, documents | Privacy requests, evidence, document intake |
| Data | Migration and import | Import batches and migration contracts |
| Help | Troubleshooting | Common messages and next steps |
| Help | Glossary | Terms used in this guide |
Generated lookup pages are in the reference section: Role matrix, State machines, and Error codes.
Before you start
Installation, activation, and the first company setup are covered in First steps and activation. The data model is summarised in Core domains. Security and privacy controls are described in Security and privacy.