invoiceum 1.0.0__tar.gz

invoiceum-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Asinerum Conlang Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

invoiceum-1.0.0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: invoiceum
+Version: 1.0.0
+Summary: Literp Invoicing Web Tool
+Home-page: https://github.com/asinerum/invoiceum
+Author: Asinerum Conlang Project
+Author-email: asinerum.com@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tagrepo>=1.0.15
+Requires-Dist: orderum>=1.0.1
+Dynamic: license-file
+
+# Literp Invoicing Tool
+
+## Installation
+```bash
+pip install invoiceum
+```
+
+## Sample Usage [Nov 1, 2026]
+```bash
+## nano invoiceum.sh
+export LLM_TRANSFORMER_MODEL="./all-MiniLM-L6-v2"
+export SETUPKEY_ENCRYPT_SECRET="very-strong-password"
+export JWT_SECRET="very-strong-password"
+export TOKEN_EXPIRE_MINUTES=30
+export ADMIN_AUTHENTICATOR_EMAIL_LIST=someone@company.com
+export SUPERVISOR_AUTHENTICATOR_EMAIL_LIST=""
+export STAFF_AUTHENTICATOR_EMAIL_LIST=""
+export FINANCE_SUPERVISOR_AUTHENTICATOR_EMAIL_LIST=""
+export FINANCE_STAFF_AUTHENTICATOR_EMAIL_LIST=""
+export FILE_AVRO_DATA="./users/setupkeys.avro"
+export FILE_AVRO_FINANCE_SUPERVISORS="./users/rolefbksupervisors.avro"
+export FILE_AVRO_FINANCE_STAFF="./users/rolefbkstaff.avro"
+export FILE_AVRO_SUPERVISORS="./users/rolecrmsupervisors.avro"
+export FILE_AVRO_STAFF="./users/rolecrmstaff.avro"
+export FILE_DUCKDB_VECTOR="./temp.db"
+uvia -a vapp -m invoiceum [-p <PORT>] [-H <HOST>]
+## The <PORT> is 21911 by default, but can be edited
+## The <HOST> should be 127.0.0.1 for security reason
+## chmod +x invoiceum.sh
+## ./invoiceum.sh
+```
+
+Detailed tips, tricks, and examples, can be found at project's repository
+https://github.com/asinerum/invoiceum
+
+(C) 2026 Asinerum Conlang Project

invoiceum-1.0.0/README.md

@@ -0,0 +1,36 @@
+# Literp Invoicing Tool
+
+## Installation
+```bash
+pip install invoiceum
+```
+
+## Sample Usage [Nov 1, 2026]
+```bash
+## nano invoiceum.sh
+export LLM_TRANSFORMER_MODEL="./all-MiniLM-L6-v2"
+export SETUPKEY_ENCRYPT_SECRET="very-strong-password"
+export JWT_SECRET="very-strong-password"
+export TOKEN_EXPIRE_MINUTES=30
+export ADMIN_AUTHENTICATOR_EMAIL_LIST=someone@company.com
+export SUPERVISOR_AUTHENTICATOR_EMAIL_LIST=""
+export STAFF_AUTHENTICATOR_EMAIL_LIST=""
+export FINANCE_SUPERVISOR_AUTHENTICATOR_EMAIL_LIST=""
+export FINANCE_STAFF_AUTHENTICATOR_EMAIL_LIST=""
+export FILE_AVRO_DATA="./users/setupkeys.avro"
+export FILE_AVRO_FINANCE_SUPERVISORS="./users/rolefbksupervisors.avro"
+export FILE_AVRO_FINANCE_STAFF="./users/rolefbkstaff.avro"
+export FILE_AVRO_SUPERVISORS="./users/rolecrmsupervisors.avro"
+export FILE_AVRO_STAFF="./users/rolecrmstaff.avro"
+export FILE_DUCKDB_VECTOR="./temp.db"
+uvia -a vapp -m invoiceum [-p <PORT>] [-H <HOST>]
+## The <PORT> is 21911 by default, but can be edited
+## The <HOST> should be 127.0.0.1 for security reason
+## chmod +x invoiceum.sh
+## ./invoiceum.sh
+```
+
+Detailed tips, tricks, and examples, can be found at project's repository
+https://github.com/asinerum/invoiceum
+
+(C) 2026 Asinerum Conlang Project

invoiceum-1.0.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"

invoiceum-1.0.0/setup.cfg

@@ -0,0 +1,31 @@
+[metadata]
+name = invoiceum
+version = 1.0.0
+author = Asinerum Conlang Project
+author_email = asinerum.com@gmail.com
+description = Literp Invoicing Web Tool
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/asinerum/invoiceum
+license = MIT
+classifiers = 
+	Programming Language :: Python :: 3
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+
+[options]
+package_dir = 
+	= src
+packages = find:
+python_requires = >=3.7
+install_requires = 
+	tagrepo >= 1.0.15
+	orderum >= 1.0.1
+
+[options.packages.find]
+where = src
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

invoiceum-1.0.0/src/invoiceum/__init__.py

@@ -0,0 +1,3 @@
+from .cinvoice import *
+
+__version__ = "1.0.0"

invoiceum-1.0.0/src/invoiceum/cinvoice.py

@@ -0,0 +1,251 @@
+"""
+Literp Invoicing Tool
+Dependencies:
+  pip install [tagrepo] uvia vapp invoiceum
+Start daemon:
+  export LLM_TRANSFORMER_MODEL="./all-MiniLM-L6-v2"
+  export SETUPKEY_ENCRYPT_SECRET="very-strong-password"
+  export JWT_SECRET="very-strong-password"
+  export TOKEN_EXPIRE_MINUTES=30
+  export ADMIN_AUTHENTICATOR_EMAIL_LIST=someone@company.com
+  export SUPERVISOR_AUTHENTICATOR_EMAIL_LIST=""
+  export STAFF_AUTHENTICATOR_EMAIL_LIST=""
+  export FINANCE_SUPERVISOR_AUTHENTICATOR_EMAIL_LIST=""
+  export FINANCE_STAFF_AUTHENTICATOR_EMAIL_LIST=""
+  export FILE_AVRO_DATA="./users/setupkeys.avro"
+  export FILE_AVRO_FINANCE_SUPERVISORS="./users/rolefbksupervisors.avro"
+  export FILE_AVRO_FINANCE_STAFF="./users/rolefbkstaff.avro"
+  export FILE_AVRO_SUPERVISORS="./users/rolecrmsupervisors.avro"
+  export FILE_AVRO_STAFF="./users/rolecrmstaff.avro"
+  export FILE_DUCKDB_VECTOR="./temp.db"
+  uvia -a vapp -m invoiceum [-p <PORT>] [-H <HOST>]
+VAPP routes:
+  Route: /callback -> callbackpage()
+  Route: /login -> loginpage()
+  Route: /call -> callpage()
+  GET -> request.query_params = {function, access_token, jsondata, module}
+"""
+
+from tagrepo.format import first_date_of_current_year, first_date_of_current_month
+
+from orderum import *
+
+from .param import get_request_invoice_options, get_request_payment_options, get_request_tax_options
+
+from .task import *
+from .title import *
+
+APP_PORT = 21911 ## for <uvia> and <vapp>
+
+## core <uvia> functions
+
+def homepage():
+  async def submit(request: Request):
+    return HTMLResponse(Template(APP_TMP_DIRECTORY_MENU).render(
+      APP_CHARSET=APP_CHARSET,
+      APP_VIEWPORT=APP_VIEWPORT,
+      APP_TITLE=APP_DESC,
+      FORM_TITLE=FORM_TITLE,
+      directory_items=[
+        {"href": "/login", "name": LABEL_MENU_LOGIN},
+        {"href": call_function(FUNCTION_INVOICE_INSERT), "name": LABEL_INVOICE_INSERT},
+        {"href": call_function(FUNCTION_DRAFT_INVOICES_SELECT), "name": LABEL_DRAFT_INVOICES_SELECT},
+        {"href": call_function(FUNCTION_NO_DRAFT_INVOICES_SELECT), "name": LABEL_NO_DRAFT_INVOICES_SELECT},
+        {"href": call_function(FUNCTION_INVOICES_REVIEW), "name": LABEL_INVOICES_REVIEW},
+        {"href": call_function(FUNCTION_PAYMENT_INSERT), "name": LABEL_PAYMENT_INSERT},
+        {"href": call_function(FUNCTION_DRAFT_PAYMENTS_SELECT), "name": LABEL_DRAFT_PAYMENTS_SELECT},
+        {"href": call_function(FUNCTION_NO_DRAFT_PAYMENTS_SELECT), "name": LABEL_NO_DRAFT_PAYMENTS_SELECT},
+        {"href": call_function(FUNCTION_PAYMENTS_REVIEW), "name": LABEL_PAYMENTS_REVIEW},
+        {"href": call_function(FUNCTION_TAX_COLLECT), "name": LABEL_TAX_COLLECT},
+        {"href": call_function(FUNCTION_INVOICES_SEARCH), "name": LABEL_INVOICES_SEARCH},
+        {"href": call_function("logout"), "name": LABEL_MENU_LOGOUT},
+      ]
+    ))
+  return submit
+
+def callpage():
+  async def submit(request: Request):
+    return await process_function_call(request, auth_functions, HTMLResponse, _callpage)
+  return submit
+
+async def _callpage(request, func: str):
+  if func == FUNCTION_CUSTOMERS_POPUP:
+    search = request.query_params.get("search")
+    return HTMLResponse(popup_customers_page(request, search))
+  elif func == FUNCTION_PRODUCTS_POPUP:
+    search = request.query_params.get("search")
+    return HTMLResponse(popup_products_page(request, search))
+  elif func == FUNCTION_INVOICES_POPUP:
+    search = request.query_params.get("search")
+    return HTMLResponse(popup_invoices_page(request, search))
+  elif func == FUNCTION_TYPE_POPUP:
+    return HTMLResponse(popup_type_page(request))
+  elif func == FUNCTION_INVOICE_INSERT:
+    if request.method == 'GET':
+      return HTMLResponse(insert_invoice_page(request))
+    else:
+      form = await request.form()
+      dated = form.get(DATED) or nowdate()
+      due = form.get(DUE) or ""
+      form = inputfilter(dstrip(form), Invoices, excludes=[])
+      form[DATED] = dated
+      form[DUE] = due
+      insert = insert_invoice_page(request, **form)
+      if insert == CALLBACK: return RedirectResponseGet(url=call_function(FUNCTION_INVOICES_SELECT))
+      return HTMLResponse(insert)
+  elif func == FUNCTION_INVOICES_SELECT:
+    return HTMLResponse(select_invoices_page(request, **get_request_invoice_options(request)))
+  elif func == FUNCTION_DRAFT_INVOICES_SELECT:
+    return HTMLResponse(select_draft_invoices_page(request, **get_request_invoice_options(request)))
+  elif func == FUNCTION_NO_DRAFT_INVOICES_SELECT:
+    return HTMLResponse(select_no_draft_invoices_page(request, **get_request_invoice_options(request)))
+  elif func == FUNCTION_INVOICE_SELECT:
+    invoice_id = request.query_params.get("id")
+    return HTMLResponse(select_invoice_page(request, invoice_id))
+  elif func == FUNCTION_CUSTOMER_SELECT:
+    customer_id = request.query_params.get("id")
+    return HTMLResponse(select_customer_page(request, customer_id))
+  elif func == FUNCTION_PRODUCT_SELECT:
+    product_id = request.query_params.get("id")
+    return HTMLResponse(select_product_page(request, product_id))
+  elif func == FUNCTION_INVOICE_NOTE_UPDATE: ## hidden
+    invoice_id = request.query_params.get("id")
+    if request.method == 'GET':
+      return HTMLResponse(update_invoice_note_page(request, invoice_id))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Invoices, includes=UPDATE_INPUTS["Invoices"])
+      update = update_invoice_note_page(request, invoice_id, **form)
+      if update == CALLBACK: return RedirectResponseGet(url=call_function(f"{FUNCTION_INVOICE_SELECT}&id={invoice_id}"))
+      return HTMLResponse(update)
+  elif func == FUNCTION_INVOICE_UPDATE: ## hidden
+    invoice_id = request.query_params.get("id")
+    if request.method == 'GET':
+      return HTMLResponse(update_invoice_page(request, invoice_id))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Invoices, includes=UPDATE_INPUTS[Invoices])
+      update = update_invoice_page(request, invoice_id, **form)
+      if update == CALLBACK: return RedirectResponseGet(url=call_function(f"{FUNCTION_INVOICE_SELECT}&id={invoice_id}"))
+      return HTMLResponse(update)
+  elif func == FUNCTION_INVOICE_UPGRADE:
+    invoice_id = request.query_params.get("id")
+    if request.method == 'GET':
+      return HTMLResponse(upgrade_invoice_page(request, invoice_id))
+    else:
+      form = await request.form()
+      status = form.get(STATUS)
+      update = upgrade_invoice_page(request, invoice_id, status=status)
+      if update == CALLBACK: return RedirectResponseGet(url=call_function(f"{FUNCTION_INVOICE_SELECT}&id={invoice_id}"))
+      return HTMLResponse(update)
+  elif func == FUNCTION_INVOICEITEM_INSERT:
+    invoice_id = request.query_params.get("invoice_id")
+    if request.method == 'GET':
+      return HTMLResponse(insert_invoiceitem_page(request, invoice_id=invoice_id))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Invoiceitems, excludes=[DATED])
+      insert = insert_invoiceitem_page(request, invoice_id=invoice_id, **form)
+      if insert == CALLBACK: return RedirectResponseGet(url=call_function(f"{FUNCTION_INVOICEITEMS_SELECT}&invoice_id={invoice_id}"))
+      return HTMLResponse(insert)
+  elif func == FUNCTION_INVOICEITEMS_SELECT:
+    invoice_id = request.query_params.get("invoice_id")
+    return HTMLResponse(select_invoiceitems_page(request, invoice_id))
+  elif func == FUNCTION_INVOICEITEM_SELECT:
+    invoiceitem_id = request.query_params.get("id")
+    return HTMLResponse(select_invoiceitem_page(request, invoiceitem_id))
+  elif func == FUNCTION_INVOICEITEM_UPDATE: ## hidden
+    invoiceitem_id = request.query_params.get("id")
+    if request.method == 'GET':
+      return HTMLResponse(update_invoiceitem_page(request, invoiceitem_id))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Invoiceitems, includes=UPDATE_INPUTS[Invoiceitems])
+      update = update_invoiceitem_page(request, invoiceitem_id, **form) ## refresh subtotal
+      if update == CALLBACK: return RedirectResponseGet(url=call_function(f"{FUNCTION_INVOICEITEM_SELECT}&id={invoiceitem_id}"))
+      return HTMLResponse(update)
+  elif func == FUNCTION_INVOICES_REVIEW:
+    if request.method == 'GET':
+      return HTMLResponse(review_invoices_page(request))
+    else:
+      form = await request.form()
+      status = form.get(STATUS)
+      return RedirectResponseGet(url=call_function(f"{FUNCTION_INVOICES_SELECT}&status={status}"))
+  elif func == FUNCTION_INVOICES_SEARCH:
+    author = request.query_params.get("author")
+    if request.method == 'GET':
+      return HTMLResponse(search_invoices_page(request))
+    else:
+      form = await request.form()
+      search = form.get("search")
+      seek = form.get("seek")
+      reset = form.get("reset")
+      search = search_invoices_page(request, search=search, reset=boolean(reset), seek=seek, author=author)
+      return HTMLResponse(search)
+  elif func == FUNCTION_INVOICES_AUTHOR_SEARCH: ## hidden
+    if request.method == 'GET':
+      return HTMLResponse(search_invoices_author_page(request))
+    else:
+      form = await request.form()
+      search = form.get("search")
+      seek = form.get("seek")
+      reset = form.get("reset")
+      search = search_invoices_author_page(request, search=search, reset=boolean(reset), seek=seek)
+      return HTMLResponse(search)
+  elif func == FUNCTION_PAYMENT_INSERT:
+    if request.method == 'GET':
+      return HTMLResponse(insert_payment_page(request))
+    else:
+      form = await request.form()
+      dated = form.get(DATED) or nowdate()
+      form = inputfilter(dstrip(form), Payments, excludes=[])
+      form[DATED] = dated
+      insert = insert_payment_page(request, **form)
+      if insert == CALLBACK: return RedirectResponseGet(url=call_function(FUNCTION_PAYMENTS_SELECT))
+      return HTMLResponse(insert)
+  elif func == FUNCTION_PAYMENTS_SELECT:
+    return HTMLResponse(select_payments_page(request, **get_request_payment_options(request)))
+  elif func == FUNCTION_PAYMENT_SELECT:
+    payment_id = request.query_params.get("id")
+    return HTMLResponse(select_payment_page(request, payment_id))
+  elif func == FUNCTION_PAYMENT_UPDATE: ## hidden
+    payment_id = request.query_params.get("id")
+    if request.method == 'GET':
+      return HTMLResponse(update_payment_page(request, payment_id))
+    else:
+      form = await request.form()
+      form = inputfilter(dstrip(form), Payments, includes=UPDATE_INPUTS[Payments])
+      update = update_payment_page(request, payment_id, **form)
+      if update == CALLBACK: return RedirectResponseGet(url=call_function(f"{FUNCTION_PAYMENT_SELECT}&id={payment_id}"))
+      return HTMLResponse(update)
+  elif func == FUNCTION_PAYMENT_UPGRADE:
+    payment_id = request.query_params.get("id")
+    if request.method == 'GET':
+      return HTMLResponse(upgrade_payment_page(request, payment_id))
+    else:
+      form = await request.form()
+      status = form.get(STATUS)
+      update = upgrade_payment_page(request, payment_id, status=status)
+      if update == CALLBACK: return RedirectResponseGet(url=call_function(f"{FUNCTION_PAYMENT_SELECT}&id={payment_id}"))
+      return HTMLResponse(update)
+  elif func == FUNCTION_DRAFT_PAYMENTS_SELECT:
+    return HTMLResponse(select_draft_payments_page(request, **get_request_payment_options(request)))
+  elif func == FUNCTION_NO_DRAFT_PAYMENTS_SELECT:
+    return HTMLResponse(select_no_draft_payments_page(request, **get_request_payment_options(request)))
+  elif func == FUNCTION_PAYMENTS_REVIEW:
+    if request.method == 'GET':
+      return HTMLResponse(review_payments_page(request))
+    else:
+      form = await request.form()
+      status = form.get(STATUS)
+      return RedirectResponseGet(url=call_function(f"{FUNCTION_PAYMENTS_SELECT}&status={status}"))
+  elif func == FUNCTION_TAX_COLLECT:
+    if request.method == 'GET':
+      return HTMLResponse(collect_tax_invoices_page(request))
+    else:
+      form = await request.form()
+      dated = form.get(DATED) or first_date_of_current_month()
+      dated_end = form.get(DATED_END) or nowdate()
+      return HTMLResponse(collect_tax_invoices_page(request, dated, dated_end))
+  else:
+    return HTMLResponse("Function not found or not accessible")

invoiceum-1.0.0/src/invoiceum/data.py

@@ -0,0 +1,117 @@
+from tagrepo.dataframe import _get_row_html, _get_row_dict
+from tagrepo.database import avro_sql_select_combo
+
+from orderum.data import *
+
+from .syslogin import *
+from .environ import *
+from .schema import *
+
+## data constants
+
+INVOICE_INSERT_FIELDS = arrayfilter(INSERT_INPUTS[Invoices], excludes=[])
+## EX_INVOICE_INSERT_FIELDS = arrayfilter(["customer"]+INSERT_INPUTS[Invoices], excludes=[])
+INVOICEITEM_INSERT_FIELDS = arrayfilter(INSERT_INPUTS[Invoiceitems], excludes=[INVOICE_ID, DATED, SUBTOTAL])
+## EX_INVOICEITEM_INSERT_FIELDS = arrayfilter(["product"]+INSERT_INPUTS[Invoiceitems], excludes=[INVOICE_ID, DATED, SUBTOTAL])
+PAYMENT_INSERT_FIELDS = arrayfilter(INSERT_INPUTS[Payments], excludes=[])
+
+## selecting derivatives
+
+def calculate_invoice_amount(invoice_id: str) -> float:
+  df = sql_simple_query_model("Invoiceitems", select="quantity,price,subtotal", where=f"invoice_id='{invoice_id}'")
+  return 0 if df is None or not len(df) else numfloat((df['quantity'] * df['price']).sum())
+
+def get_invoice_name(invoice_id: str) -> str:
+  return select_name_by_id(invoice_id, model="Invoices")
+
+def get_invoice(invoice_id: str) -> dict:
+  return _get_row_dict("Invoices", invoice_id)
+
+def select_pure_invoice(invoice_id: str) -> str:
+  return _get_row_html("Invoices", invoice_id)
+
+def select_invoice(invoice_id: str) -> str:
+  return select_pure_row("Invoices",
+    linkfields=SELECT_LINK_FIELDS[Invoices],
+    linkrefs={CUSTOMER_ID: call_function(f"{FUNCTION_CUSTOMER_SELECT}&id=")},
+    where=f"id='{invoice_id}'", limit=1)
+
+def select_invoiceitem(invoiceitem_id: str) -> str:
+  return select_pure_row("Invoiceitems",
+    linkfields=SELECT_LINK_FIELDS[Invoiceitems],
+    linkrefs={INVOICE_ID: call_function(f"{FUNCTION_INVOICE_SELECT}&id="), PRODUCT_ID: call_function(f"{FUNCTION_PRODUCT_SELECT}&id=")},
+    where=f"id='{invoiceitem_id}'", limit=1)
+
+def get_invoiceitem(invoiceitem_id: str) -> dict:
+  return _get_row_dict("Invoiceitems", invoiceitem_id)
+
+def invoice_not_updatable(invoice: any) -> bool:
+  if type(invoice) is dict: return invoice.get(STATUS) not in UPDATABLE_INVOICES
+  return not check_record_exist(invoice, model="Invoices", field=ID, where=INVOICE_IS_UPDATABLE)
+
+def invoice_closed(invoice: any) -> bool:
+  if type(invoice) is dict: return invoice.get(STATUS) in CLOSED_INVOICES
+  return check_record_exist(invoice, model="Invoices", field=ID, where=INVOICE_CLOSED)
+
+def invoice_item_duplicated(name: str, invoice_id: str) -> bool:
+  return check_record_exist(name, model="Invoiceitems", field=NAME, where=f"invoice_id='{invoice_id}'")
+
+def select_payment(payment_id: str) -> str:
+  return select_pure_row("Payments",
+    linkfields=SELECT_LINK_FIELDS[Payments],
+    linkrefs={INVOICE_ID: call_function(f"{FUNCTION_INVOICE_SELECT}&id=")},
+    where=f"id='{payment_id}'", limit=1)
+
+def get_payment(payment_id: str) -> dict:
+  return _get_row_dict("Payments", payment_id)
+
+def payment_not_updatable(payment: any) -> bool:
+  if type(payment) is dict: return payment.get(STATUS) not in UPDATABLE_PAYMENTS
+  return not check_record_exist(payment, model="Payments", field=ID, where=PAYMENT_IS_UPDATABLE)
+
+def payment_closed(payment: any) -> bool:
+  if type(payment) is dict: return payment.get(STATUS) in CLOSED_PAYMENTS
+  return check_record_exist(payment, model="Payments", field=ID, where=PAYMENT_CLOSED)
+
+## listing derivatives
+
+def list_invoices(popindex: int=1, **kwargs) -> str:
+  model = "Invoices"
+  show = LISTING_FIELDS[Invoices][popindex:]
+  df = sql_simple_query_model(model, **kwargs)
+  return df_list_insert_rows(df, show,
+    header=LISTING_HEADERS[Invoices][popindex:],
+    open_func=LISTING_LINK_BUTTON_FUNCTIONS[Invoices][popindex:],
+    callfunction=LISTING_LINK_CALL_FUNCTIONS[Invoices][popindex:],
+    idfield=LISTING_LINK_ID_FIELDS[Invoices][popindex:],
+    linkfield=LISTING_LINK_REF_FIELDS[Invoices][popindex:])
+
+def list_invoices_to_insert_invoiceitem(**kwargs) -> str:
+  return list_invoices(0, **kwargs) ## remove add_item
+
+def list_invoiceitems(invoice_id: str) -> str:
+  return list_review_rows("Invoiceitems",
+    show=LISTING_FIELDS[Invoiceitems],
+    callfunction="select-invoiceitem",
+    where=f"invoice_id='{invoice_id}'")
+
+def list_pick_invoices(**kwargs) -> str:
+  return list_select_rows(model="Invoices", show=SELECT_LISTING_FIELDS[Invoices], header=LISTING_HEADERS["Invoices"], **kwargs) ## ambiguous "Invoices"
+
+def list_select_payments(**kwargs) -> str:
+  return list_review_rows(model="Payments", show=LISTING_FIELDS[Payments], callfunction=FUNCTION_PAYMENT_SELECT, **kwargs)
+
+list_payments = list_select_payments
+
+def list_tax_invoices(dated: str, dated_end: str, statuses: str=INVOICE_TAXABLE_STATUSES, join_clause="db_main.customer_id=db_sub.id") -> str:
+  df = avro_sql_select_combo(model_main="Invoices", model_sub="Customers",
+    select=f"db_main.id, db_main.dated, db_sub.name AS customer, db_sub.{CUSTOMER_TAX_CODE} AS taxcode, db_main.tax, db_main.taxrate",
+    where=f"{join_clause} AND db_main.status IN {statuses} AND db_main.dated BETWEEN '{dated}' AND '{dated_end}'",
+    sort="db_main.dated,db_sub.name", asc=True, limit=LIST_MAX_ROWS)
+  if df is None or not len(df): return NO_DATA_AVAILABLE
+  return df_list_review_rows(df, show=REVIEW_LISTING_FIELDS[Invoices], callfunction=FUNCTION_INVOICE_SELECT)
+
+## vector search
+
+def get_search_invoice_option(request, seek: str="", author: str="") -> dict:
+  return get_search_status_option(request=request, seek=seek, author=author, status_list=INVOICE_STATUS_LIST)

invoiceum-1.0.0/src/invoiceum/environ.py

@@ -0,0 +1,17 @@
+from orderum.environ import *
+
+set_environ('CONFIRM_INVOICE_COMPLETED', 'Confirm: this invoice was completed?')
+set_environ('CONFIRM_INVOICE_CANCELLED', 'Confirm: this invoice was cancelled?')
+
+set_environ('WRONG_INVOICE_ID', 'Error: invalid invoice id')
+set_environ('BAD_INVOICE_ID', 'Error: invalid invoice id, or invoice is not updatable')
+set_environ('INVOICE_ITEM_DUPLICATED', 'Error: invoice line item is duplicated')
+
+set_environ('INVOICE_NOT_EXIST', 'Warning: invoice does not exist')
+set_environ('INVOICE_NOT_EXIST_OR_CLOSED', 'Warning: invoice does not exist or was closed')
+set_environ('INVOICE_NO_REVERSE_TO_DRAFT', 'Warning: invoice cannot be reversed to draft')
+set_environ('INVOICE_ALREADY_EXISTS', 'Warning: invoice with this name already exists')
+
+set_environ('PAYMENT_ALREADY_EXISTS', 'Warning: payment with this name already exists')
+set_environ('PAYMENT_NOT_EXIST_OR_CLOSED', 'Warning: payment does not exist or was closed')
+set_environ('BAD_PAYMENT_ID', 'Error: invalid payment id, or payment is not updatable')

invoiceum-1.0.0/src/invoiceum/param.py

@@ -0,0 +1,18 @@
+from orderum.param import *
+
+from .schema import INVOICE_SORT_FIELDS, PAYMENT_SORT_FIELDS, TAX_SORT_FIELDS, NAME
+
+def adjust_invoice_listing_options(where: str, author: str, sort: str, asc: str, limit: str, request=None) -> tuple:
+  return adjust_listing_options(where, author, sort, asc, limit, sort_fields=INVOICE_SORT_FIELDS, request=request)
+
+def adjust_payment_listing_options(where: str, author: str, sort: str, asc: str, limit: str, request=None) -> tuple:
+  return adjust_listing_options(where, author, sort, asc, limit, sort_fields=PAYMENT_SORT_FIELDS, request=request)
+
+def adjust_tax_listing_options(where: str, author: str, sort: str, asc: str, limit: str, request=None) -> tuple:
+  return adjust_listing_options(where, author, sort, asc, limit, sort_fields=TAX_SORT_FIELDS, request=request)
+
+get_request_invoice_options = get_request_data_options ## sort:DATED.desc
+
+get_request_payment_options = get_request_data_options ## sort:DATED.desc
+
+get_request_tax_options = get_request_data_options ## sort:DATED.desc

invoiceum-1.0.0/src/invoiceum/schema.py

@@ -0,0 +1,97 @@
+from tagrepo.schema15 import *
+from orderum.schema import *
+
+from .syslogin import *
+
+_CUSTOMER = "customer"
+_TAXCODE = "taxcode"
+
+INVOICE_SORT_FIELDS = [NAME, DATED, DUE, AMOUNT, DISCOUNT, TAXRATE, TAX, AUTHOR_ID, STATUS]
+PAYMENT_SORT_FIELDS = [NAME, DATED, AMOUNT, REF, TYPE, AUTHOR_ID, STATUS]
+TAX_SORT_FIELDS = [_CUSTOMER, _TAXCODE, TAX, TAXRATE, DATED]
+
+UPDATABLE_INVOICES = [INVOICE_DRAFT]
+CLOSED_INVOICES = [INVOICE_PAID, INVOICE_CANCELLED]
+OPEN_INVOICES = [INVOICE_SENT, INVOICE_OVERDUE] ## USABLE
+
+INVOICE_CLOSED = f"status IN ('{INVOICE_PAID}', '{INVOICE_CANCELLED}')"
+INVOICE_NOT_CLOSED = f"status NOT IN ('{INVOICE_PAID}', '{INVOICE_CANCELLED}')"
+INVOICE_IS_LISTABLE = f"status NOT IN ('{INVOICE_DRAFT}', '{INVOICE_CANCELLED}')"
+INVOICE_IS_UPDATABLE = f"status IN ('{INVOICE_DRAFT}')"
+INVOICE_IS_USABLE = f"status IN ('{INVOICE_SENT}', '{INVOICE_OVERDUE}')"
+
+UPDATABLE_PAYMENTS = [PAYMENT_DRAFT]
+CLOSED_PAYMENTS = [PAYMENT_COMPLETED, PAYMENT_CANCELLED]
+
+PAYMENT_CLOSED = f"status IN ('{PAYMENT_COMPLETED}', '{PAYMENT_CANCELLED}')"
+PAYMENT_NOT_CLOSED = f"status NOT IN ('{PAYMENT_COMPLETED}', '{PAYMENT_CANCELLED}')"
+PAYMENT_IS_LISTABLE = f"status NOT IN ('{PAYMENT_DRAFT}', '{PAYMENT_CANCELLED}')"
+PAYMENT_IS_UPDATABLE = f"status IN ('{PAYMENT_DRAFT}')"
+
+INVOICE_TAXABLE_STATUSES = f"('{INVOICE_SENT}', '{INVOICE_OVERDUE}', '{INVOICE_PAID}')"
+
+## complex data view: use with caution
+
+REVIEW_LISTING_FIELDS |= { ## complex view
+  Invoices: [HEADER_REVIEW, DATED, _CUSTOMER, _TAXCODE, TAXRATE, TAX],
+}
+
+LISTING_LINK_BUTTON_FUNCTIONS |= { ## complex view
+  Invoices: [add_button, view_button],
+}
+
+LISTING_LINK_CALL_FUNCTIONS |= { ## complex view
+  Invoices: [FUNCTION_INVOICEITEM_INSERT, FUNCTION_INVOICE_SELECT],
+}
+
+LISTING_LINK_ID_FIELDS |= { ## complex view
+  Invoices: [ID, ID],
+}
+
+LISTING_LINK_REF_FIELDS |= { ## complex view
+  Invoices: [INVOICE_ID, ID], ## add-item-line/view-item
+}
+
+## common data frame show
+
+LISTING_FIELDS |= { ## dataset viewer: all columns
+  Invoices: [HEADER_INSERT, HEADER_REVIEW, DATED, NAME, AMOUNT, DISCOUNT, DUE, TAXRATE, STATUS],
+  Invoiceitems: [HEADER_REVIEW, NAME, QUANTITY, PRICE, SUBTOTAL],
+  Payments: [HEADER_REVIEW, DATED, NAME, AMOUNT, TYPE, REF, STATUS],
+}
+
+SELECT_LINK_FIELDS |= { ## single record viewer: vertical view with links
+  Invoices: [CUSTOMER_ID],
+  Invoiceitems: [INVOICE_ID, PRODUCT_ID],
+  Payments: [INVOICE_ID],
+}
+
+SELECT_LISTING_FIELDS |= { ## dataset viewer for popup picker
+  Invoices: [HEADER_SELECT, NAME, STATUS, ID],
+}
+
+LISTING_HEADERS |= { ## dataset viewer: headers of extra columns
+  Invoices: [HEADER_INSERT, HEADER_REVIEW],
+  "Invoices": HEADER_SELECT, ## popup picker
+}
+
+## common data input options
+
+INSERT_INPUTS |= {
+  Invoices: [DATED, DUE, CUSTOMER_ID, NAME, AMOUNT, DISCOUNT, TAXRATE, ORDER_ID, NOTE],
+  InvoicesStatus: [ID, STATUS],
+  Invoiceitems: [INVOICE_ID, PRODUCT_ID, DATED, NAME, QUANTITY, PRICE, SUBTOTAL, NOTE],
+  Payments: [DATED, INVOICE_ID, NAME, AMOUNT, TYPE, REF, NOTE],
+}
+
+UPDATE_INPUTS |= {
+  Invoices: [AUTHOR_ID, NOTE, AMOUNT, DISCOUNT, TAXRATE],
+  "Invoices": [AUTHOR_ID, NOTE],
+  InvoicesStatus: [STATUS],
+  Invoiceitems: [NAME, QUANTITY, PRICE, NOTE],
+  Payments: [NAME, AUTHOR_ID, REF, TYPE, NOTE],
+}
+
+SEARCH_INPUTS |= {
+  Invoices: [NAME, NOTE, AUTHOR_ID],
+}