diff --git a/pms_downpayment_autoinvoice/README.rst b/pms_downpayment_autoinvoice/README.rst new file mode 100644 index 0000000000..8f7d882add --- /dev/null +++ b/pms_downpayment_autoinvoice/README.rst @@ -0,0 +1,118 @@ +============================== +PMS Downpayment Auto-Invoicing +============================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:9c1d4e1c60decd091b242953941dfd2e9bd95ad34218d9d05634b52006cae0ca + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/licence-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/16.0/pms_downpayment_autoinvoice + :alt: OCA/pms +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/pms-16-0/pms-16-0-pms_downpayment_autoinvoice + :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=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +# PMS Downpayment Auto-Invoicing + +Automates **downpayment (advance) invoicing** for PMS payments, **per company** configuration. + +## What it does + +- Adds a **“Downpayment Automation”** tab on the *Company* form. +- Lets you enable automatic downpayment invoicing and choose a **schedule**: + - **Daily** (every day) + - **Weekly** (on a chosen weekday) + - **Monthly** (on first/last/penultimate or a fixed day 1..28) + - **Quarterly** (on the **last day of each quarter**: Mar 31, Jun 30, Sep 30, Dec 31) +- A single **cron job with no parameters** runs daily and, for each company enabled: + + - Decides if it **should run today** based on that company’s schedule. + - Computes a **time window** `(last theoretical run, today]`. + - Selects **payments** with posted moves in that window, linked to folios with `last_checkout > today`, + and **not already invoiced** as downpayments. + +## Business logic recap + +- A payment is considered a *downpayment candidate* if: + - Its accounting move is **posted** within the computed window. + - The journal is **not** marked *avoid_auto_invoice_downpayment*. + - It is linked to at least one folio and **at least one** linked folio has `last_checkout > today`. + - It has **no reconciled downpayment invoice yet**. + +> This module does **not** change your existing downpayment definition. It only automates the invoicing workflow based on timing rules. + +## Configuration + +Open **Settings → Companies → Your Company → Downpayment Automation**: +- **Enable Auto Downpayment Invoicing** +- **Schedule Mode**: daily, weekly, monthly, quarterly +- **Weekly Day** (if weekly) +- **Monthly Marker & Day** (if monthly) +- **Batch Size** (performance control) + +## Notes + +- The cron runs daily at a fixed time, but **the method decides** whether it should act for each company based on its schedule. +- Multi-company aware: the process runs **per company** and uses each company’s configuration. + +**Table of contents** + +.. contents:: + :local: + +Bug Tracker +=========== + +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Roomdoo + +Contributors +~~~~~~~~~~~~ + +* Dario Lodeiros (dario@roomdoo.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/pms `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/pms_downpayment_autoinvoice/__init__.py b/pms_downpayment_autoinvoice/__init__.py new file mode 100644 index 0000000000..0650744f6b --- /dev/null +++ b/pms_downpayment_autoinvoice/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/pms_downpayment_autoinvoice/__manifest__.py b/pms_downpayment_autoinvoice/__manifest__.py new file mode 100644 index 0000000000..1289bd68a1 --- /dev/null +++ b/pms_downpayment_autoinvoice/__manifest__.py @@ -0,0 +1,22 @@ +{ + "name": "PMS Downpayment Auto-Invoicing", + "summary": ( + "Automated downpayment invoicing for PMS by company schedule " + "(daily/weekly/monthly/quarterly)." + ), + "version": "16.0.1.0.0", + "category": "Accounting/Hotel PMS", + "license": "AGPL-3", + "author": ("Odoo Community Association (OCA), " "Roomdoo"), + "website": "https://github.com/OCA/pms", + "depends": [ + "account", + "pms", + ], + "data": [ + "views/res_company_views.xml", + "data/ir_cron.xml", + ], + "installable": True, + "application": False, +} diff --git a/pms_downpayment_autoinvoice/data/ir_cron.xml b/pms_downpayment_autoinvoice/data/ir_cron.xml new file mode 100644 index 0000000000..9b0d940c5b --- /dev/null +++ b/pms_downpayment_autoinvoice/data/ir_cron.xml @@ -0,0 +1,24 @@ + + + + + PMS Auto Downpayment Invoicing + + code + +# Runs daily. For each company with automation enabled, it evaluates and runs if scheduled today. +model.pms_run_downpayment_autoinvoice_cron() + + days + 1 + -1 + + + + + + + diff --git a/pms_downpayment_autoinvoice/i18n/es.po b/pms_downpayment_autoinvoice/i18n/es.po new file mode 100644 index 0000000000..587429a9e0 --- /dev/null +++ b/pms_downpayment_autoinvoice/i18n/es.po @@ -0,0 +1,154 @@ +# Translation of PMS Downpayment Auto-Invoicing to Spanish +# Copyright (C) 2025 Roomdoo +# This file is distributed under the same license as the module. +# +msgid "" +msgstr "" +"Project-Id-Version: pms_downpayment_autoinvoice 16.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2025-10-02 12:00+0000\n" +"PO-Revision-Date: 2025-10-02 12:00+0000\n" +"Last-Translator: Roomdoo Tech \n" +"Language-Team: Spanish\n" +"Language: es\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields,field_description:pms_downpayment_autoinvoice.field_res_company__downpayment_auto_enabled +msgid "Enable Auto Downpayment Invoicing" +msgstr "Activar facturación automática de anticipos" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields,help:pms_downpayment_autoinvoice.field_res_company__downpayment_auto_enabled +msgid "If enabled, the daily cron will evaluate and run downpayment invoicing for this company according to the schedule below." +msgstr "Si está activado, el cron diario evaluará y ejecutará la facturación de anticipos para esta compañía según la configuración indicada." + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields,field_description:pms_downpayment_autoinvoice.field_res_company__downpayment_auto_mode +msgid "Schedule Mode" +msgstr "Modo de programación" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields,help:pms_downpayment_autoinvoice.field_res_company__downpayment_auto_mode +msgid "Select how often the automation should run." +msgstr "Selecciona cada cuánto tiempo debe ejecutarse la automatización." + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_mode__daily +msgid "Daily" +msgstr "Diario" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_mode__weekly +msgid "Weekly" +msgstr "Semanal" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_mode__monthly +msgid "Monthly" +msgstr "Mensual" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_mode__quarterly +msgid "Quarterly (last day of each quarter)" +msgstr "Trimestral (último día de cada trimestre)" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields,field_description:pms_downpayment_autoinvoice.field_res_company__downpayment_auto_weekday +msgid "Weekly Day" +msgstr "Día de la semana" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields,field_description:pms_downpayment_autoinvoice.field_res_company__downpayment_auto_monthly_marker +msgid "Monthly Marker" +msgstr "Marcador mensual" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields,field_description:pms_downpayment_autoinvoice.field_res_company__downpayment_auto_monthly_day +msgid "Monthly Day" +msgstr "Día del mes" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields,field_description:pms_downpayment_autoinvoice.field_res_company__downpayment_auto_batch_size +msgid "Batch Size" +msgstr "Tamaño de lote" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields,field_description:pms_downpayment_autoinvoice.field_res_company__downpayment_auto_dry_run +msgid "Dry Run" +msgstr "Simulación (Dry Run)" + +#. module: pms_downpayment_autoinvoice +#: model_terms:ir.ui.view,arch_db:pms_downpayment_autoinvoice.view_company_form_inherit_downpayment_auto +msgid "Downpayment Automation" +msgstr "Automatización de anticipos" + +#. module: pms_downpayment_autoinvoice +#: model_terms:ir.ui.view,arch_db:pms_downpayment_autoinvoice.view_company_form_inherit_downpayment_auto +msgid "Quarterly will run on the last day of each quarter (Mar 31, Jun 30, Sep 30, Dec 31)." +msgstr "La ejecución trimestral se realizará el último día de cada trimestre (31 marzo, 30 junio, 30 septiembre, 31 diciembre)." + +#. module: pms_downpayment_autoinvoice +#: model:ir.cron,name:pms_downpayment_autoinvoice.cron_pms_downpayment_autoinvoice +msgid "PMS Auto Downpayment Invoicing" +msgstr "PMS - Facturación automática de anticipos" + +# ---- Weekly day ---- +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_weekday__mon +msgid "Monday" +msgstr "Lunes" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_weekday__tue +msgid "Tuesday" +msgstr "Martes" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_weekday__wed +msgid "Wednesday" +msgstr "Miércoles" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_weekday__thu +msgid "Thursday" +msgstr "Jueves" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_weekday__fri +msgid "Friday" +msgstr "Viernes" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_weekday__sat +msgid "Saturday" +msgstr "Sábado" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_weekday__sun +msgid "Sunday" +msgstr "Domingo" + +# ---- Monthly marker ---- +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_monthly_marker__first +msgid "First" +msgstr "Primero" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_monthly_marker__last +msgid "Last" +msgstr "Último" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_monthly_marker__penultimate +msgid "Penultimate" +msgstr "Penúltimo" + +#. module: pms_downpayment_autoinvoice +#: model:ir.model.fields.selection,name:pms_downpayment_autoinvoice.selection__res_company__downpayment_auto_monthly_marker__fixed +msgid "Fixed Day (1..28)" +msgstr "Día fijo (1..28)" diff --git a/pms_downpayment_autoinvoice/models/__init__.py b/pms_downpayment_autoinvoice/models/__init__.py new file mode 100644 index 0000000000..f308365339 --- /dev/null +++ b/pms_downpayment_autoinvoice/models/__init__.py @@ -0,0 +1,2 @@ +from . import res_company +from . import account_payment diff --git a/pms_downpayment_autoinvoice/models/account_payment.py b/pms_downpayment_autoinvoice/models/account_payment.py new file mode 100644 index 0000000000..1ff8ada798 --- /dev/null +++ b/pms_downpayment_autoinvoice/models/account_payment.py @@ -0,0 +1,329 @@ +import calendar +import logging +from collections import defaultdict + +from dateutil.relativedelta import relativedelta + +from odoo import api, fields, models + +_logger = logging.getLogger(__name__) + + +class AccountPayment(models.Model): + _inherit = "account.payment" + + # ------------------------------ + # Main cron entry (no arguments) + # ------------------------------ + @api.model + def pms_run_downpayment_autoinvoice_cron(self): + """ + Daily cron with no arguments. + For each company with automation enabled, evaluate + schedule and run auto-invoicing if due. + """ + companies = self.env["res.company"].search( + [("downpayment_auto_enabled", "=", True)] + ) + today = fields.Date.context_today(self) + _logger.info( + "Downpayment cron: evaluating %s companies on %s", + len(companies), + today, + ) + + # Fallback partner once + try: + fallback_partner = self.env.ref("pms.various_pms_partner") + except ValueError: + fallback_partner = False + + for company in companies: + # Work in company context + self_company = self.with_company(company) + + mode = (company.downpayment_auto_mode or "monthly").strip().lower() + batch_size = company.downpayment_auto_batch_size or 200 + + # Resolve value by mode + if mode == "weekly": + value = (company.downpayment_auto_weekday or "").strip().lower() + elif mode == "monthly": + marker = company.downpayment_auto_monthly_marker or "last" + if marker == "fixed": + value = int(company.downpayment_auto_monthly_day or 1) + else: + value = marker + else: + value = None # quarterly ignores value + + # Decide whether to run + try: + should_run = self_company._should_run_today(mode, value, today) + except Exception as exc: + _logger.exception( + "Company %s schedule evaluation failed: %s", + company.name, + exc, + ) + continue + + if not should_run: + _logger.info( + "Company %s: skip (mode=%s, value=%s)", + company.name, + mode, + value, + ) + continue + + # Compute window + try: + win_start, win_end = self_company._compute_window(mode, value, today) + except Exception as exc: + _logger.exception( + "Company %s window computation failed: %s", + company.name, + exc, + ) + continue + + _logger.info( + "Company %s: running downpayment auto-invoicing window %s..%s " + "(mode=%s, value=%s, batch=%s)", + company.name, + win_start, + win_end, + mode, + value, + batch_size, + ) + + # Candidates: posted moves in window, allowed journal, + # linked folios with checkout > today + domain = [ + ("company_id", "=", company.id), + ("move_id.state", "=", "posted"), + ("move_id.journal_id.avoid_autoinvoice_downpayment", "=", False), + ("folio_ids", "!=", False), + ("move_id.date", ">=", win_start), + ("move_id.date", "<=", win_end), + ("folio_ids.last_checkout", ">", today), + ] + candidates = self_company.search(domain) + pending = candidates.filtered( + lambda p, sc=self_company: not sc._has_downpayment_invoice(p) + ) + _logger.info( + "Company %s: candidates=%s, pending=%s", + company.name, + len(candidates), + len(pending), + ) + + ok = 0 + fail = 0 + + def _iter_batches(recs, size): + total = len(recs) + for i in range(0, total, size): + yield recs[i : i + size] + + for batch in _iter_batches(pending, batch_size): + for payment in batch: + partner = ( + payment.partner_id + or fallback_partner + or payment.company_id.partner_id + ) + if not partner: + _logger.warning( + "[SKIP] Company %s Payment %s: cannot resolve partner", + company.name, + payment.id, + ) + fail += 1 + continue + _logger.info( + "[DRY] Company %s Payment %s amount=%s partner='%s'", + company.name, + payment.id, + payment.amount, + partner.display_name, + ) + ok += 1 + + with self.env.cr.savepoint(): + try: + move = self_company._create_downpayment_invoice( + payment=payment, + partner_id=partner.id, + ) + _logger.info( + "[OK] Company %s Payment %s -> invoice %s posted", + company.name, + payment.id, + move.id, + ) + ok += 1 + except Exception as e: + _logger.exception( + "[ERR] Company %s Payment %s: %s", + company.name, + payment.id, + e, + ) + fail += 1 + + _logger.info( + "Company %s: finished ok=%s fail=%s", + company.name, + ok, + fail, + ) + + return True + + # -------------------------- + # Scheduling/date utilities + # -------------------------- + @api.model + def _should_run_today(self, mode, value, ref_date): + """ + Return True if the job should execute on ref_date. + - daily: always true + - weekly: run on the given weekday ('mon'..'sun' or 0..6) + - monthly: run on day (first|last|penultimate|1..28) + - quarterly: run on the LAST day of each quarter + (Mar 31, Jun 30, Sep 30, Dec 31) + """ + ms = str(mode).strip().lower() + if ms == "daily": + return True + if ms == "weekly": + return ref_date.weekday() == self._weekday_from_value(value) + if ms == "monthly": + return ref_date.day == self._resolve_month_day(value, ref_date) + if ms == "quarterly": + return (ref_date.month, ref_date.day) in [ + (3, 31), + (6, 30), + (9, 30), + (12, 31), + ] + raise ValueError("Unknown mode: %s" % mode) + + @api.model + def _compute_window(self, mode, value, ref_date): + """ + Compute [start_date_inclusive, end_date_inclusive] as + (last theoretical run, ref_date]. + Start is the day AFTER the last scheduled date <= ref_date. + """ + ms = str(mode).strip().lower() + if ms == "daily": + return ref_date - relativedelta(days=1), ref_date + if ms == "weekly": + wd = self._weekday_from_value(value) + delta = (ref_date.weekday() - wd) % 7 + last_sched = ref_date - relativedelta(days=delta) + return last_sched + relativedelta(days=1), ref_date + if ms == "monthly": + day = self._resolve_month_day(value, ref_date) + last_day_curr = calendar.monthrange(ref_date.year, ref_date.month)[1] + cand = ref_date.replace(day=min(day, last_day_curr)) + if cand > ref_date: + prev = ref_date.replace(day=1) - relativedelta(days=1) + last_day_prev = calendar.monthrange(prev.year, prev.month)[1] + cand = prev.replace(day=min(day, last_day_prev)) + return cand + relativedelta(days=1), ref_date + if ms == "quarterly": + # Window = (end of previous quarter, ref_date] + q_months = [3, 6, 9, 12] + prev_q_month = max([m for m in q_months if m <= ref_date.month]) + q_end = ref_date.replace( + month=prev_q_month, + day=calendar.monthrange(ref_date.year, prev_q_month)[1], + ) + if q_end > ref_date: + q_end = ref_date.replace(year=ref_date.year - 1, month=12, day=31) + return q_end + relativedelta(days=1), ref_date + raise ValueError("Unknown mode: %s" % mode) + + @api.model + def _weekday_from_value(self, v): + """Return 0..6 for Mon..Sun. Accepts 'mon'..'sun' or int 0..6.""" + if isinstance(v, int): + return v + m = {"mon": 0, "tue": 1, "wed": 2, "thu": 3, "fri": 4, "sat": 5, "sun": 6} + return m[str(v).strip().lower()] + + @api.model + def _resolve_month_day(self, value, ref_date): + """ + Resolve monthly trigger to a concrete day number for ref_date's month. + Accepts: 'first' | 'last' | 'penultimate' | int 1..28 + """ + if isinstance(value, int) and 1 <= value <= 28: + return value + value_s = str(value).strip().lower() + last = calendar.monthrange(ref_date.year, ref_date.month)[1] + if value_s == "first": + return 1 + if value_s == "last": + return last + if value_s == "penultimate": + return max(1, last - 1) + raise ValueError("Invalid monthly value: %s" % value) + + # -------------------------------------- + # Business logic & invoice creation + # -------------------------------------- + @api.model + def _has_downpayment_invoice(self, payment): + """ + Return True if the payment already has a reconciled 'downpayment' invoice. + """ + return bool( + payment.folio_ids + and payment.reconciled_invoice_ids.filtered( + lambda inv: inv._is_downpayment() + ) + ) + + @api.model + def _create_downpayment_invoice(self, payment, partner_id): + """ + Create a downpayment invoice for the given payment and reconcile it. + """ + invoice_wizard = self.env["folio.advance.payment.inv"].create( + { + "partner_invoice_id": partner_id, + "advance_payment_method": "fixed", + "fixed_amount": payment.amount, + } + ) + move = invoice_wizard.with_context( + active_ids=payment.folio_ids.ids, + return_invoices=True, + ).create_invoices() + if payment.payment_type == "outbound": + move.action_switch_invoice_into_refund_credit_note() + move.action_post() + # Reconcile invoice and payment move lines + for invoice, payment_move in zip(move, payment.move_id, strict=True): + group = defaultdict(list) + for line in (invoice.line_ids + payment_move.line_ids).filtered( + lambda r: not r.reconciled + ): + group[(line.account_id, line.currency_id)].append(line.id) + for (account, _dummy), line_ids in group.items(): + if account.reconcile or account.account_type == "liquidity": + self.env["account.move.line"].browse(line_ids).reconcile() + # Default recipient for subsequent folio sale lines + for folio in payment.folio_ids: + for sale_line in folio.sale_line_ids.filtered( + lambda r: not r.default_invoice_to + ): + sale_line.default_invoice_to = move.partner_id.id + return move diff --git a/pms_downpayment_autoinvoice/models/res_company.py b/pms_downpayment_autoinvoice/models/res_company.py new file mode 100644 index 0000000000..77ed641edd --- /dev/null +++ b/pms_downpayment_autoinvoice/models/res_company.py @@ -0,0 +1,62 @@ +from odoo import fields, models + + +class ResCompany(models.Model): + _inherit = "res.company" + + downpayment_auto_enabled = fields.Boolean( + string="Enable Auto Downpayment Invoicing", + default=False, + help="""If enabled, the daily cron will evaluate and run + downpayment invoicing for this company according to the schedule below.""", + ) + + downpayment_auto_mode = fields.Selection( + [ + ("daily", "Daily"), + ("weekly", "Weekly"), + ("monthly", "Monthly"), + ("quarterly", "Quarterly (last day of each quarter)"), + ], + string="Schedule Mode", + default="monthly", + help="Select how often the automation should run.", + ) + + downpayment_auto_weekday = fields.Selection( + [ + ("mon", "Monday"), + ("tue", "Tuesday"), + ("wed", "Wednesday"), + ("thu", "Thursday"), + ("fri", "Friday"), + ("sat", "Saturday"), + ("sun", "Sunday"), + ], + string="Weekly Day", + help="Required if mode is Weekly.", + ) + + downpayment_auto_monthly_marker = fields.Selection( + [ + ("first", "First"), + ("last", "Last"), + ("penultimate", "Penultimate"), + ("fixed", "Fixed Day (1..28)"), + ], + string="Monthly Marker", + default="last", + help=""" + Monthly trigger: first/last/penultimate day, + or a fixed day (enter below). + """, + ) + + downpayment_auto_monthly_day = fields.Integer( + string="Monthly Day", + help="If Monthly Marker is 'Fixed Day', set a day between 1 and 28.", + ) + + downpayment_auto_batch_size = fields.Integer( + string="Batch Size", default=200, help="How many payments to process per batch." + ) diff --git a/pms_downpayment_autoinvoice/readme/CONTRIBUTORS.rst b/pms_downpayment_autoinvoice/readme/CONTRIBUTORS.rst new file mode 100644 index 0000000000..9bdfa1b0c6 --- /dev/null +++ b/pms_downpayment_autoinvoice/readme/CONTRIBUTORS.rst @@ -0,0 +1,2 @@ +* Dario Lodeiros (dario@roomdoo.com) + diff --git a/pms_downpayment_autoinvoice/readme/DESCRIPTION.rst b/pms_downpayment_autoinvoice/readme/DESCRIPTION.rst new file mode 100644 index 0000000000..cf26104159 --- /dev/null +++ b/pms_downpayment_autoinvoice/readme/DESCRIPTION.rst @@ -0,0 +1,42 @@ +# PMS Downpayment Auto-Invoicing + +Automates **downpayment (advance) invoicing** for PMS payments, **per company** configuration. + +## What it does + +- Adds a **“Downpayment Automation”** tab on the *Company* form. +- Lets you enable automatic downpayment invoicing and choose a **schedule**: + - **Daily** (every day) + - **Weekly** (on a chosen weekday) + - **Monthly** (on first/last/penultimate or a fixed day 1..28) + - **Quarterly** (on the **last day of each quarter**: Mar 31, Jun 30, Sep 30, Dec 31) +- A single **cron job with no parameters** runs daily and, for each company enabled: + + - Decides if it **should run today** based on that company’s schedule. + - Computes a **time window** `(last theoretical run, today]`. + - Selects **payments** with posted moves in that window, linked to folios with `last_checkout > today`, + and **not already invoiced** as downpayments. + +## Business logic recap + +- A payment is considered a *downpayment candidate* if: + - Its accounting move is **posted** within the computed window. + - The journal is **not** marked *avoid_auto_invoice_downpayment*. + - It is linked to at least one folio and **at least one** linked folio has `last_checkout > today`. + - It has **no reconciled downpayment invoice yet**. + +> This module does **not** change your existing downpayment definition. It only automates the invoicing workflow based on timing rules. + +## Configuration + +Open **Settings → Companies → Your Company → Downpayment Automation**: +- **Enable Auto Downpayment Invoicing** +- **Schedule Mode**: daily, weekly, monthly, quarterly +- **Weekly Day** (if weekly) +- **Monthly Marker & Day** (if monthly) +- **Batch Size** (performance control) + +## Notes + +- The cron runs daily at a fixed time, but **the method decides** whether it should act for each company based on its schedule. +- Multi-company aware: the process runs **per company** and uses each company’s configuration. diff --git a/pms_downpayment_autoinvoice/static/description/icon.png b/pms_downpayment_autoinvoice/static/description/icon.png new file mode 100644 index 0000000000..3a0328b516 Binary files /dev/null and b/pms_downpayment_autoinvoice/static/description/icon.png differ diff --git a/pms_downpayment_autoinvoice/static/description/index.html b/pms_downpayment_autoinvoice/static/description/index.html new file mode 100644 index 0000000000..8f66f46ebb --- /dev/null +++ b/pms_downpayment_autoinvoice/static/description/index.html @@ -0,0 +1,461 @@ + + + + + +PMS Downpayment Auto-Invoicing + + + +
+

PMS Downpayment Auto-Invoicing

+ + +

Beta License: AGPL-3 OCA/pms Translate me on Weblate Try me on Runboat

+

# PMS Downpayment Auto-Invoicing

+

Automates downpayment (advance) invoicing for PMS payments, per company configuration.

+

## What it does

+
    +
  • Adds a “Downpayment Automation” tab on the Company form.
    • +
  • Lets you enable automatic downpayment invoicing and choose a schedule: +- Daily (every day) +- Weekly (on a chosen weekday) +- Monthly (on first/last/penultimate or a fixed day 1..28) +- Quarterly (on the last day of each quarter: Mar 31, Jun 30, Sep 30, Dec 31)
    • +
  • A single cron job with no parameters runs daily and, for each company enabled:
      +
    • Decides if it should run today based on that company’s schedule.
      • +
    • Computes a time window (last theoretical run, today].
      • +
    • Selects payments with posted moves in that window, linked to folios with last_checkout > today, +and not already invoiced as downpayments.
      • +
    +
    • +
+

## Business logic recap

+
    +
  • A payment is considered a downpayment candidate if: +- Its accounting move is posted within the computed window. +- The journal is not marked avoid_auto_invoice_downpayment. +- It is linked to at least one folio and at least one linked folio has last_checkout > today. +- It has no reconciled downpayment invoice yet.
    • +
+

> This module does not change your existing downpayment definition. It only automates the invoicing workflow based on timing rules.

+

## Configuration

+

Open Settings → Companies → Your Company → Downpayment Automation: +- Enable Auto Downpayment Invoicing +- Schedule Mode: daily, weekly, monthly, quarterly +- Weekly Day (if weekly) +- Monthly Marker & Day (if monthly) +- Batch Size (performance control)

+

## Notes

+
    +
  • The cron runs daily at a fixed time, but the method decides whether it should act for each company based on its schedule.
    • +
  • Multi-company aware: the process runs per company and uses each company’s configuration.
    • +
+

Table of contents

+ +
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Roomdoo
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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/pms project on GitHub.

+

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

+
+
+
+ + diff --git a/pms_downpayment_autoinvoice/views/res_company_views.xml b/pms_downpayment_autoinvoice/views/res_company_views.xml new file mode 100644 index 0000000000..a05dd31b2a --- /dev/null +++ b/pms_downpayment_autoinvoice/views/res_company_views.xml @@ -0,0 +1,33 @@ + + + + res.company.form.pms.downpayment.auto + res.company + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/setup/pms_downpayment_autoinvoice/odoo/addons/pms_downpayment_autoinvoice b/setup/pms_downpayment_autoinvoice/odoo/addons/pms_downpayment_autoinvoice new file mode 120000 index 0000000000..ec5566f17a --- /dev/null +++ b/setup/pms_downpayment_autoinvoice/odoo/addons/pms_downpayment_autoinvoice @@ -0,0 +1 @@ +../../../../pms_downpayment_autoinvoice \ No newline at end of file diff --git a/setup/pms_downpayment_autoinvoice/setup.py b/setup/pms_downpayment_autoinvoice/setup.py new file mode 100644 index 0000000000..28c57bb640 --- /dev/null +++ b/setup/pms_downpayment_autoinvoice/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)