<h1 class="title">Integration with PostcodeApi.nu</h1> <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/l10n-netherlands/tree/12.0/l10n_nl_postcodeapi"><img alt="OCA/l10n-netherlands" src="https://img.shields.io/badge/github-OCA%2Fl10n--netherlands-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/l10n-netherlands-12-0/l10n-netherlands-12-0-l10n_nl_postcodeapi"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/176/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p>This module contains integration of the excellent address completion service 'PostcodeAPI'. The service allows lookups by zip code and house number, providing street name and city. The lookups will be triggered in the partner form views when a zip code or house number is entered or modified. Only Dutch addresses (which is assumed to include addresses with no country) are auto-completed.</p> <p>More info about the lookup service here: <a class="reference external" href="http://www.postcodeapi.nu/">http://www.postcodeapi.nu/</a></p> <p><strong>Table of contents</strong></p> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#installation" id="id2">Installation</a></li> <li><a class="reference internal" href="#configuration" id="id3">Configuration</a></li> <li><a class="reference internal" href="#changelog" id="id4">Changelog</a></li> <li><a class="reference internal" href="#bug-tracker" id="id5">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id6">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id7">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li> <li><a class="reference internal" href="#maintainers" id="id9">Maintainers</a></li> </ul> </li> </ul> </div> <a name="installation"></a> <h2><a class="toc-backref" href="#id2">Installation</a></h2> <p>This module depends on the standard Odoo module base_address_extended, which will split up the street field into separate fields for street name and number.</p> <p>It now also depends on l10n_nl_country_states, to provide the names of the provinces, that will be added to the res_country_state model.</p> <p>You also need to have the 'pyPostcode' Python library by Stefan Jansen installed (<a class="reference external" href="https://pypi.python.org/pypi/pyPostcode">https://pypi.python.org/pypi/pyPostcode</a>).</p> <a name="configuration"></a> <h2><a class="toc-backref" href="#id3">Configuration</a></h2> <p>Please enter the API key that you request from PostcodeAPI into the system parameter 'l10n_nl_postcodeapi.apikey'</p> <p>Provinces are auto-completed if a country state with the exact name is found in the system.</p> <a name="changelog"></a> <h2 class="with-subtitle"><a class="toc-backref" href="#id4">Changelog</a></h2> <h2 class="section-subtitle" id="id1"><span class="section-subtitle">11.0.2.0.0 (2021-08-21)</span></h2> <ul class="simple"> <li>Now depend on l10n_nl_country_states to prevent conflicts with that module;</li> <li>No manual caching of province data. It complicates code and performance gain will almost certainly be negligible;</li> <li>Check valid Api Key in configuration immediately when setting or updating key;</li> <li>Take into account that with l10n_nl_country_states installed, state_id on partner will in many cases be set, even if postcode api not active, or cannot find address;</li> <li>Adjust tests to run properly on databases already containing data.</li> </ul> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id5">Bug Tracker</a></h2> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/l10n-netherlands/issues">GitHub Issues</a>. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed <a class="reference external" href="https://github.com/OCA/l10n-netherlands/issues/new?body=module:%20l10n_nl_postcodeapi%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <p>Do not contact contributors directly about support or help with technical issues.</p> <a name="credits"></a> <h2><a class="toc-backref" href="#id6">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id7">Authors</a></h3> <ul class="simple"> <li>Therp BV</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id8">Contributors</a></h3> <ul class="simple"> <li>Stefan Rijnhart (Therp BV) &lt;<a class="reference external" href="mailto:stefan&#64;therp.nl">stefan&#64;therp.nl</a>&gt;</li> <li>Andrea Stirpe &lt;<a class="reference external" href="mailto:a.stirpe&#64;onestein.nl">a.stirpe&#64;onestein.nl</a>&gt;</li> <li>Jan Verbeek &lt;<a class="reference external" href="mailto:jverbeek&#64;therp.nl">jverbeek&#64;therp.nl</a>&gt;</li> <li>Ronald Portier &lt;<a class="reference external" href="mailto:ronald&#64;therp.nl">ronald&#64;therp.nl</a>&gt;</li> </ul> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id9">Maintainers</a></h3> <p>This module is maintained by the OCA.</p> <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> <p>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.</p> <p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p> <p><a class="reference external" href="https://github.com/NL66278"><img alt="NL66278" src="https://github.com/NL66278.png?size=40px" /></a></p> <p>This module is part of the <a class="reference external" href="https://github.com/OCA/l10n-netherlands/tree/12.0/l10n_nl_postcodeapi">OCA/l10n-netherlands</a> project on GitHub.</p> <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>