Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 116 additions & 0 deletions partner_display_ref/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
.. image:: https://odoo-community.org/readme-banner-image
:target: https://odoo-community.org/get-involved?utm_source=readme
:alt: Odoo Community Association

=========================
Partner Display Reference
=========================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:415030fc2095e1354294c1a59521c1b2f556abd37880cf124b251a8ae3cfc7c7
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fpartner--contact-lightgray.png?logo=github
:target: https://github.com/OCA/partner-contact/tree/19.0/partner_display_ref
:alt: OCA/partner-contact
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/partner-contact-19-0/partner-contact-19-0-partner_display_ref
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/partner-contact&target_branch=19.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module prefixes the customer reference (``res.partner.ref``) to a
partner's ``display_name`` whenever it is rendered inside an opted-in
view — shown as ``[C00123] Acme Corp`` in the dropdown, the selected
value, and list cells alike.

The decoration is a generic mechanism: it activates only when a view
injects the ``partner_display_ref_field`` context key naming the field
to prefix on a ``res.partner`` field. Contacts, CRM, Invoicing and any
other view that does not opt in continue to see the plain partner name.
Companion modules (e.g. ``sale_partner_display_ref``) wire this
mechanism into specific apps.

**Table of contents**

.. contents::
:local:

Usage
=====

To opt a view into the reference prefix, add the
``partner_display_ref_field`` context key naming the ``res.partner``
field to prefix:

::

<field name="partner_id" context="{'partner_display_ref_field': 'ref'}" />

Any ``res.partner`` field can be named (e.g. ``ref``, ``supplier_ref``).
Set a value on that field for a contact. In the opted-in view, the value
is prefixed wherever the partner is shown — the autocomplete dropdown,
the selected value, and list cells:

::

[C00123] Acme Corp

Views that do not opt in keep the plain partner name, so reports and
exports stay clean. If the named field is not installed, no prefix is
applied.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/partner-contact/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/partner-contact/issues/new?body=module:%20partner_display_ref%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* ForgeFlow

Contributors
------------

- `ForgeFlow <https://www.forgeflow.com>`__

- Jasmin Solanki <jasmin.solanki@forgeflow.com>

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/partner-contact <https://github.com/OCA/partner-contact/tree/19.0/partner_display_ref>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions partner_display_ref/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
14 changes: 14 additions & 0 deletions partner_display_ref/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Copyright 2026 ForgeFlow S.L.
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

{
"name": "Partner Display Reference",
"summary": "Prefix the customer reference to partner labels in opted-in views.",
"version": "19.0.1.0.0",
"category": "Tools",
"author": "ForgeFlow, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/partner-contact",
"license": "AGPL-3",
"depends": ["contacts"],
"installable": True,
}
1 change: 1 addition & 0 deletions partner_display_ref/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import res_partner
23 changes: 23 additions & 0 deletions partner_display_ref/models/res_partner.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Copyright 2026 ForgeFlow S.L.
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

from odoo import api, models


class ResPartner(models.Model):
_inherit = "res.partner"

@api.depends("ref")
@api.depends_context("partner_display_ref_field")
def _compute_display_name(self):
super()._compute_display_name()
ctx = self.env.context
field_name = ctx.get("partner_display_ref_field")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a little explanation on why computing the value on context value in this case ?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now, this case OCA/purchase-workflow#3094

and for the same kind of case where the field name is different, to handle it with any particular app

if not field_name:
return
if field_name not in self._fields:
return
for partner in self:
value = partner[field_name]
if value:
partner.display_name = f"[{value}] {partner.display_name}"
3 changes: 3 additions & 0 deletions partner_display_ref/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
2 changes: 2 additions & 0 deletions partner_display_ref/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- [ForgeFlow](https://www.forgeflow.com)
- Jasmin Solanki \<<jasmin.solanki@forgeflow.com>\>
10 changes: 10 additions & 0 deletions partner_display_ref/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
This module prefixes the customer reference (`res.partner.ref`) to a partner's
`display_name` whenever it is rendered inside an opted-in view — shown as
`[C00123] Acme Corp` in the dropdown, the selected value, and list cells alike.

The decoration is a generic mechanism: it activates only when a view injects
the `partner_display_ref_field` context key naming the field to prefix on a
`res.partner` field. Contacts, CRM,
Invoicing and any other view that does not opt in continue to see the plain
partner name. Companion modules (e.g. `sale_partner_display_ref`) wire this
mechanism into specific apps.
14 changes: 14 additions & 0 deletions partner_display_ref/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
To opt a view into the reference prefix, add the `partner_display_ref_field`
context key naming the `res.partner` field to prefix:

<field name="partner_id" context="{'partner_display_ref_field': 'ref'}" />

Any `res.partner` field can be named (e.g. `ref`, `supplier_ref`). Set a value
on that field for a contact. In the opted-in view, the value is prefixed
wherever the partner is shown — the autocomplete dropdown, the selected value,
and list cells:

[C00123] Acme Corp

Views that do not opt in keep the plain partner name, so reports and exports
stay clean. If the named field is not installed, no prefix is applied.
Loading
Loading