Metadata-Version: 2.1
Name: odoo-addon-pms_base
Version: 19.0.1.0.0.3
Requires-Dist: odoo==19.0.*
Summary: Manage properties
Home-page: https://github.com/OCA/pms
License: AGPL-3
Author: Commit [Sun], Open Source Integrators, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 19.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Development Status :: 4 - Beta
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

==========================
Property Management System
==========================

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

.. |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%2Fpms-lightgray.png?logo=github
    :target: https://github.com/OCA/pms/tree/19.0/pms_base
    :alt: OCA/pms
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/pms-19-0/pms-19-0-pms_base
    :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/pms&target_branch=19.0
    :alt: Try me on Runboat

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

This module is the base module for the Property Management System (PMS)
suite.

It provides the foundation for managing real estate properties,
including:

- **Properties**: Track residential and commercial properties with
  address, timezone, area, floor information, tags, and images.
- **Rooms**: Define rooms within each property with type, capacity, and
  area.
- **Amenities**: Catalog amenities grouped by type (toiletries,
  connectivity, kitchen facilities, laundry, parking, pets, etc.).
- **Services**: Link service products (cleaning, internet, parking,
  etc.) to properties for operational tracking.
- **Stages**: Configure lifecycle stages (New, Available, Cancelled) for
  property pipelines with Kanban support.
- **Teams**: Organize properties into teams for management and
  reporting.
- **Tags**: Classify properties with color-coded tags.
- **Settings**: Enable or disable features (rooms, amenities, services,
  teams) per company and configure the unit of measure for areas.

This module also provides access rights (User / Manager), security rules
scoped per company, and integration points for optional PMS extensions
(accounting, contracts, reservations, website, CRM, and more).

**Table of contents**

.. contents::
   :local:

Configuration
=============

Initial Setup
-------------

1. Go to **Properties ‣ Configuration ‣ Settings**.
2. Under **Property Information**, enable the features you need:

   - **Show Rooms** — manage rooms within each property.
   - **Show Amenities** — catalog amenities by type and assign them to
     properties.
   - **Show Services** — link service products to properties.
   - **Show Teams** — organise properties into management teams.
   - **Area (UoM)** — select the unit of measure used when entering area
     values.

3. Under **Accounting**, **Reservations**, and **Integrations**, install
   optional PMS extension modules as needed.
4. Click **Save**.

Managing Stages
---------------

Default stages (New, Available, Cancelled) are created on installation.
To customise them, go to **Properties ‣ Configuration ‣ Stages**. Stages
with **Folded in Kanban** checked will be collapsed in the Kanban view.

Usage
=====

Creating Your First Property
----------------------------

1. Go to **Properties ‣ Properties** and click **New**.
2. Fill in the property name, reference, address, timezone, and area.
3. Assign an owner (a contact from your address book).
4. Add tags and amenities as needed.
5. Set the stage to **Available** once the property is ready.

Properties
----------

Navigate to **Properties ‣ Properties** to view and manage your property
portfolio. The list and Kanban views let you filter by stage, team,
owner, and tags. Use the search panel to filter by team directly from
the Kanban view.

Click on a property to open its form and access:

- **Information** tab: area, floor, number of rooms by type, amenities.
- **Chatter**: log notes and track changes.

Rooms
-----

If **Show Rooms** is enabled, navigate to **Properties ‣ Properties ‣
Rooms** to manage rooms within a property. Each room has a type,
capacity, and area.

Amenities
---------

If **Show Amenities** is enabled, navigate to **Properties ‣
Configuration ‣ Amenities** to define amenities. Amenities are grouped
by type (Toiletries, Connectivity, Kitchen facilities, etc.) and can be
assigned to properties.

Services
--------

If **Show Services** is enabled, navigate to **Properties ‣
Configuration ‣ Services** to link service products to properties.
Services represent recurring or on-demand offerings such as internet
access, cleaning, or parking.

Teams
-----

If **Show Teams** is enabled, navigate to **Properties ‣ Teams** to
group properties by management team. The team Kanban dashboard shows a
property count button that opens the filtered property list for that
team.

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/pms/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/pms/issues/new?body=module:%20pms_base%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
-------

* Commit [Sun]
* Open Source Integrators

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

- Alexandre Díaz
- Pablo Quesada
- Jose Luis Algara
- `Commit [Sun] <https://www.commitsun.com>`__:

  - Dario Lodeiros
  - Eric Antones
  - Sara Lago
  - Brais Abeijon
  - Miguel Padin

- `Gray Matter Logic <https://www.graymatterlogic.com>`__:

  - Maxime Chambreuil <maxime.chambreuil@graymatterlogic.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.

.. |maintainer-max3903| image:: https://github.com/max3903.png?size=40px
    :target: https://github.com/max3903
    :alt: max3903

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-max3903| 

This module is part of the `OCA/pms <https://github.com/OCA/pms/tree/19.0/pms_base>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
