diff --git a/.gitignore b/.gitignore index 949bd26..fb81ae2 100644 --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,5 @@ tags node_modules __pycache__ -.env \ No newline at end of file +.env +changai/changai/api/v2/data \ No newline at end of file diff --git a/changai/changai/api/business_tables.py b/changai/changai/api/business_tables.py index a242daa..a8780db 100644 --- a/changai/changai/api/business_tables.py +++ b/changai/changai/api/business_tables.py @@ -1,31 +1,23 @@ import frappe import json -OUTPUT_FILE = "/content/changai_table_names.json" - BUSINESS_MODULES = [ - "Selling", - "Buying", - "Stock", - "Accounts", - "HR", - "CRM", - "Support", - "Projects", - "Assets", - "Manufacturing" + "Selling","Buying","Stock","Accounts","HR","CRM","Support","Projects","Assets","Manufacturing" ] -# Fetch doctypes from these modules -doctypes = frappe.get_all( - "DocType", - filters={"module": ["in", BUSINESS_MODULES]}, - fields=["name", "module"] -) +def business_doctypes(): + return frappe.get_all( + "DocType", + filters={"module": ["in", BUSINESS_MODULES]}, + fields=["name", "module"], + ) -table_names = [f"tab{d.name}" for d in doctypes] +def export_table_names(): + doctypes = business_doctypes() + table_names = [f"tab{d['name']}" for d in doctypes] -with open(OUTPUT_FILE, "w", encoding="utf-8") as f: - json.dump(table_names, f, indent=2) + output_file = frappe.get_site_path("private", "files", "changai_table_names.json") + with open(output_file, "w", encoding="utf-8") as f: + json.dump(table_names, f, indent=2) -print(f"✅ Saved {len(table_names)} table names to {OUTPUT_FILE}") + return {"count": len(table_names), "path": output_file} diff --git a/changai/changai/api/v1/predict_v1.py b/changai/changai/api/v1/predict_v1.py index 32bce79..6f8e87c 100644 --- a/changai/changai/api/v1/predict_v1.py +++ b/changai/changai/api/v1/predict_v1.py @@ -6,10 +6,17 @@ T5ForConditionalGeneration, ) import torch - +import frappe torch._dynamo.config.suppress_errors = True -import torch +meta_path = frappe.get_app_path( + "changai", "changai", "api", "v1", "meta.json" +) + +id2label_path = frappe.get_app_path( + "changai", "changai", "api", "v1", "id2label.json" +) + # Load the HF_Models Repo IDs. ROBERTO_REPO = "hyrinmansoor/text2frappe-s1-roberta" @@ -31,10 +38,9 @@ def setup(self): self.tokenizer_s3 = T5Tokenizer.from_pretrained(FLANS3_REPO) self.model_s3 = T5ForConditionalGeneration.from_pretrained(FLANS3_REPO) - with open("meta.json") as f: + with open(meta_path, "r", encoding="utf-8") as f: self.meta = json.load(f) - # Load Meta and Dcotypes IDs. - with open("id2label.json") as f: + with open(id2label_path, "r", encoding="utf-8") as f: self.id2label = json.load(f) def predict_doctype(self, question): diff --git a/changai/changai/api/v1/prediction_pipeline_v1.py b/changai/changai/api/v1/prediction_pipeline_v1.py index ff51611..a3db0c2 100644 --- a/changai/changai/api/v1/prediction_pipeline_v1.py +++ b/changai/changai/api/v1/prediction_pipeline_v1.py @@ -11,29 +11,24 @@ import frappe import spacy import jinja2 +from typing import Any, Dict, Optional from symspellpy.symspellpy import SymSpell, Verbosity from changai.changai.api.v2.text2sql_pipeline import get_settings CONFIG=get_settings() - +pleasantry_file_path = frappe.get_app_path("changai", "changai", "api", "pleasantry.json") +business_keywords_file = frappe.get_app_path("changai", "changai", "api", "business_keywords.json") +custom_dictionary = frappe.get_app_path("changai", "changai", "api", "erp_dictionary.txt") nlp = spacy.load("en_core_web_sm", disable=["tagger", "parser"]) sym_spell = SymSpell(max_dictionary_edit_distance=2, prefix_length=7) -custom_dictionary = f"{CONFIG['ROOT_PATH']}/changai/changai/changai/api/erp_dictionary.txt" -# custom_dictionary=os.get_env("ERP_DICTIONARY") sym_spell.load_dictionary(custom_dictionary, term_index=0, count_index=1) - -# Load pleasantries once -pleasantry_file_path = f"{CONFIG['ROOT_PATH']}/changai/changai/changai/api/pleasantry.json" -# pleasantry_file_path=os.get_env("PLEASANTRY") with open(pleasantry_file_path, "r", encoding="utf-8") as f: PLEASANTRIES = sorted(json.load(f).items(), key=lambda x: len(x[0]), reverse=True) -# Cache compiled patterns once at startup COMPILED_PLEASANTRIES = [ (re.compile(pattern, re.IGNORECASE), response) for pattern, response in PLEASANTRIES ] STOP_WORDS = { - # Pronouns "tell","as","a","all", "i", "me", "my", "mine", "myself", "you", "your", "yours", "yourself", "yourselves", @@ -42,34 +37,27 @@ "it", "its", "itself", "we", "us", "our", "ours", "ourselves", "they", "them", "their", "theirs", "themselves", - # Articles & determiners "a", "an", "the", "this", "that", "these", "those", "such", - # Auxiliary & modal verbs "is", "am", "are", "was", "were", "be", "being", "been", "do", "does", "did", "doing", "have", "has", "had", "having", "will", "would", "shall", "should", "can", "could", "may", "might", "must", - # Conjunctions "and", "or", "but", "if", "because", "while", "although", "though", "unless", "until", "since", "so", "yet", - # Prepositions "in", "on", "at", "by", "for", "with", "about", "against", "between", "into", "through", "during", "before", "after", "above", "below", "to", "from", "up", "down", "out", "off", "over", "under","of", - # Question words "what", "which", "who", "whom", "whose", "when", "where", "why", "how", - # Degree / comparison "than", "more", "most", "much", "many", "few", "less", "least", "enough", - # Common fillers "ok", "okay", "well", "like", "just", "really", "very", "also", "too", "still", - # Contractions / informal "what's", "that's", "it's", "there's", "here's", "let's", "who's", "where's", "how's", "i'm", "you're", "he's", "she's", "we're", "they're", "i've", "you've", "we've", "they've", "i'll", "you'll", "he'll", "she'll", "we'll", "they'll", "i'd", "you'd", "he'd", "she'd", "we'd", "they'd","did" } + stop_words=list(STOP_WORDS) stop_word_pattern = r'^(?:' + '|'.join(re.escape(word) for word in stop_words) + r')$' stop_word_regex = re.compile(stop_word_pattern, re.IGNORECASE) @@ -186,8 +174,6 @@ def is_stopword(token): # Load business keywords once -business_keywords_file = f"{CONFIG['ROOT_PATH']}/changai/changai/changai/api/business_keywords.json" -# business_keywords_file=os.get_env("BUSINESS_KEYWORDS") with open(business_keywords_file, "r", encoding="utf-8") as f: BUSINESS_KEYWORDS = {kw.lower() for kw in json.load(f)["business_keywords"]} @@ -199,7 +185,7 @@ def is_stopword(token): "I'm designed to handle ERP queries. Could you rephrase that in a business context?" ] -@frappe.whitelist(allow_guest=True) +@frappe.whitelist(allow_guest=False) def correct_sentence(text): doc = nlp(text) entities = [(ent.text, ent.start_char, ent.end_char) for ent in doc.ents] @@ -234,7 +220,7 @@ def correct_sentence(text): return corrected_text -@frappe.whitelist(allow_guest=True) +@frappe.whitelist(allow_guest=False) def run_query(query): """Run a query.""" try: @@ -248,7 +234,7 @@ def run_query(query): # To convert the Python Date Objects into an ISO format. -@frappe.whitelist(allow_guest=True) +@frappe.whitelist(allow_guest=False) def sanitize_dates(obj): if isinstance(obj, list): return [sanitize_dates(i) for i in obj] @@ -260,8 +246,8 @@ def sanitize_dates(obj): return obj -@frappe.whitelist(allow_guest=True) -def fetch_data_from_server(qstn): +@frappe.whitelist(allow_guest=False) +def fetch_data_from_server(qstn: str) -> dict: """ Handles a user question by detecting greetings or sending it to a prediction API. Returns either a greeting response, ERP query results, or an error message. @@ -318,14 +304,12 @@ def fetch_data_from_server(qstn): return {"error": str(e)} -# Corrects user qstn and maps to ERP or Small Talk. -@frappe.whitelist(allow_guest=True) -def fuzzy_intent_router(text): +@frappe.whitelist(allow_guest=False) +def fuzzy_intent_router(text: str) -> Dict[str, Any]: """Responds to a user question with a fuzzy match""" corrected_text = correct_sentence(text) corrected_text_lower = corrected_text.lower() corrected_words = set(re.findall(r"\b\w+\b", corrected_text_lower)) - # ERP keywords if BUSINESS_KEYWORDS & corrected_words: return {"type": "ERP", "response": 0, "corrected": corrected_text} safe_text = re.sub(r"[^\w\s]", "", corrected_text_lower) @@ -339,8 +323,8 @@ def fuzzy_intent_router(text): } -@frappe.whitelist(allow_guest=True) -def format_data_conversationally(user_data, doctype=None): +@frappe.whitelist(allow_guest=False) +def format_data_conversationally(user_data: Any, doctype: Optional[str] = None) -> str: """ Formats user data using the single, powerful conversational Jinja2 template. """ diff --git a/changai/changai/api/v2/auto_gen_api.py b/changai/changai/api/v2/auto_gen_api.py index 5aeff61..3572416 100644 --- a/changai/changai/api/v2/auto_gen_api.py +++ b/changai/changai/api/v2/auto_gen_api.py @@ -1,71 +1,125 @@ -from changai.changai.api.v2.text2sql_pipeline_v2 import call_gemini -from frappe.utils import nowdate, add_days,now_datetime,add_to_date -import json,os,frappe,yaml,re,openai,time -from anthropic import Anthropic -import anthropic +from __future__ import annotations +from typing import Any, Dict, List, Optional, Set +import datetime import gc +import json +import os +import time +import yaml +import frappe +from frappe import _ +from frappe.utils import now_datetime, add_to_date +from anthropic import Anthropic +import openai +from changai.changai.api.v2.text2sql_pipeline_v2 import call_gemini + +def safe_path_in_dir(base_dir: str, filename: str) -> str: + """ + Build a safe path inside base_dir using only a filename (no folders). + Prevents ../ traversal. + """ + base_dir_abs = os.path.abspath(base_dir) + filename_only = os.path.basename(filename) + full = os.path.abspath(os.path.join(base_dir_abs, filename_only)) + if not full.startswith(base_dir_abs + os.sep): + raise frappe.ValidationError(_("Invalid file path")) + return full + -BASE_DIR = os.path.dirname(__file__) -DATA_DIR = os.path.join(BASE_DIR, "data") -TABLES_JSON = os.path.join(DATA_DIR, "tables.json") -SCHEMA_YAML = os.path.join(DATA_DIR, "schema.yaml") -# Fieldtypes to ignore when building schema.yaml (not useful for embedding / SQL) -IGNORED_FIELDTYPES = { - # Layout / UI - "Section Break", - "Column Break", - "Tab Break", - "Table Break", - "Fold", - "Heading", - - # Display-only content - "HTML", - "HTML Editor", - "Text Editor", - "Markdown Editor", - "Code", - - # Action / UI controls - "Button", - - # Attachments / media (usually not part of analytical queries) - "Attach", - "Attach Image", - "Image", - "Signature", - - # Visual selectors / scans (rarely needed for reporting) - "Icon", - "Barcode", +def _get_data_dir() -> str: + d = frappe.get_app_path("changai", "changai", "api", "v2", "data") + os.makedirs(d, exist_ok=True) + return d + + +def _path(name: str) -> str: + return safe_path_in_dir(_get_data_dir(), name) + + +TABLES_JSON = "tables.json" +SCHEMA_YAML = "schema.yaml" +META_SCHEMA_YAML = "meta_schema.yaml" + +IGNORED_FIELDTYPES: Set[str] = { + "Section Break", "Column Break", "Tab Break", "Page Break", "Table Break", + "Fold", "Heading", "HTML", "HTML Editor", "Text Editor", "Markdown Editor", + "Code", "Button", "Attach", "Attach Image", "Image", "Signature", "Icon", "Barcode", } -@frappe.whitelist(allow_guest=False) -def sync_master_data_smart(): - BASE_DIR = os.path.dirname(__file__) - DATA_DIR = os.path.join(BASE_DIR, "data") - os.makedirs(DATA_DIR, exist_ok=True) - file_path = os.path.join(DATA_DIR, "meta_schema.yaml") # ✅ define + +def _load_yaml(filename: str) -> Dict[str, Any]: + path = _path(filename) try: - with open(file_path, "r") as f: - payload = yaml.safe_load(f) or {} - except (FileNotFoundError, yaml.YAMLError): - payload = {} + with open(path, "r", encoding="utf-8") as f: + obj = yaml.safe_load(f) or {} + return obj if isinstance(obj, dict) else {} + except FileNotFoundError: + return {} + except Exception: + return {} + + +def _save_yaml(filename: str, obj: Dict[str, Any]) -> None: + """ + Atomic write to prevent corruption. + """ + path = _path(filename) + tmp = f"{path}.tmp" + with open(tmp, "w", encoding="utf-8") as f: + yaml.safe_dump(obj, f, sort_keys=False, allow_unicode=True) + os.replace(tmp, path) - if not isinstance(payload, dict): - payload = {} +def _load_json_list(filename: str) -> List[str]: + path = _path(filename) + try: + with open(path, "r", encoding="utf-8") as f: + data = json.load(f) + return data if isinstance(data, list) else [] + except FileNotFoundError: + return [] + except Exception: + return [] + + +def _save_json_list(filename: str, items: List[str]) -> None: + path = _path(filename) + tmp = f"{path}.tmp" + with open(tmp, "w", encoding="utf-8") as f: + json.dump(items, f, ensure_ascii=False, indent=2) + os.replace(tmp, path) + + +def _field_dict(df) -> Dict[str, Any]: + return { + "name": df.fieldname, + "description": (df.description or "").strip(), + "type": df.fieldtype, + "options": df.options, + } + + +def _tab(dt: str) -> str: + dt = (dt or "").strip() + return f"tab{dt}" + + +def _strip_tab(t: str) -> str: + t = (t or "").strip() + return t[3:] if t.startswith("tab") else t + + +@frappe.whitelist(allow_guest=False) +def sync_master_data_smart() -> Dict[str, Any]: + payload = _load_yaml(META_SCHEMA_YAML) meta = payload.get("_meta") or {} data = payload.get("data") or [] - if not isinstance(meta, dict): meta = {} if not isinstance(data, list): data = [] - last_sync = meta.get("last_sync") - - existing_keys = set() + existing_keys: Set[tuple] = set() for row in data: if isinstance(row, dict): dt = row.get("entity_type") @@ -75,13 +129,13 @@ def sync_master_data_smart(): modules = ["Customer", "Item", "Currency", "Supplier"] - base_filters = {} + base_filters: Dict[str, Any] = {} if last_sync: base_filters = {"creation": [">", last_sync]} added_total = 0 - added_by_module = {} - fetched_by_module = {} + added_by_module: Dict[str, int] = {} + fetched_by_module: Dict[str, int] = {} for mod in modules: entity_type = f"tab{mod}" @@ -97,7 +151,7 @@ def sync_master_data_smart(): data.append({ "entity_type": entity_type, "entity_id": rec.name, - "filters": {"field": "name", "value": rec.name} + "filters": {"field": "name", "value": rec.name}, }) existing_keys.add(key) added_count += 1 @@ -106,119 +160,65 @@ def sync_master_data_smart(): added_by_module[mod] = added_count meta["last_sync"] = str(now_datetime()) - payload = {"_meta": meta, "data": data} + payload_out = {"_meta": meta, "data": data} + _save_yaml(META_SCHEMA_YAML, payload_out) - with open(file_path, "w") as f: - yaml.safe_dump(payload, f, default_flow_style=False, sort_keys=False) + msg = ( + _("Sync complete ✅ Added {0} new records.").format(added_total) + if added_total + else _("Sync complete ✅ No new records to add.") + ) return { "ok": True, - "message": ( - f"Sync complete ✅ Added {added_total} new records." - if added_total else - "Sync complete ✅ No new records to add." - ), + "message": msg, "added_total": added_total, "added_by_module": added_by_module, "fetched_by_module": fetched_by_module, "last_sync_used": last_sync or "FIRST_RUN(full_fetch)", - "new_last_sync": meta["last_sync"] + "new_last_sync": meta["last_sync"], } -def _tab(dt: str) -> str: - """Convert DocType name -> MariaDB table name used by Frappe.""" - dt = (dt or "").strip() - return f"tab{dt}" - -def _strip_tab(t: str) -> str: - """Convert table name like 'tabSales Invoice' -> 'Sales Invoice'.""" - t = (t or "").strip() - return t[3:] if t.startswith("tab") else t -def _load_json_list(path): - try: - with open(path, "r", encoding="utf-8") as f: - data = json.load(f) - - return data if isinstance(data, list) else [] - - except FileNotFoundError: - return [] - - except json.JSONDecodeError: - # corrupted / partially-written file - return [] - - except Exception: - return [] +@frappe.whitelist(allow_guest=False) +def get_doctypes_changed_since(last_sync: Optional[str]) -> List[str]: + SKIP_MODULES = {"Core", "Custom", "Website", "Desk", "Email", "Integration", "Automation", "Workflow", ""} -def get_doctypes_changed_since(last_sync): - filters = {} - SKIP_MODULES = { - "Core", - "Custom", - "Website", - "Desk", - "Email", - "Integration", - "Automation", + filters: Dict[str, Any] = { + "module": ["not in", list(SKIP_MODULES)], + "issingle": 0, + "is_virtual": 0, } + if last_sync: try: since = add_to_date(last_sync, minutes=-2) + filters["modified"] = [">=", since] except Exception: - since = last_sync - filters["modified"] = [">=", since] + pass - doctypes = frappe.get_all("DocType", filters=filters, pluck="name") - out = [] + return frappe.get_all("DocType", filters=filters, pluck="name") - for dt in doctypes: - meta = frappe.get_meta(dt) - # Skip system/internal modules - if meta.module in SKIP_MODULES: - continue - - # Skip virtual doctypes - if getattr(meta, "is_virtual", 0): - continue - - # Skip Single doctypes (settings) - if getattr(meta, "issingle", 0): - continue - - out.append(dt) - - return out - -def _save_json_list(path, items): - os.makedirs(os.path.dirname(path), exist_ok=True) - with open(path, "w", encoding="utf-8") as f: - json.dump(items, f, indent=2, ensure_ascii=False) @frappe.whitelist(allow_guest=False) -def sync_tables_and_schema_smart(): - os.makedirs(DATA_DIR, exist_ok=True) +def sync_tables_and_schema_smart() -> Dict[str, Any]: payload = _load_yaml(SCHEMA_YAML) meta = payload.get("_meta") or {} tables_blocks = payload.get("tables") or [] - - if not isinstance(meta, dict): - meta = {} if not isinstance(tables_blocks, list): tables_blocks = [] - last_doctype_sync = meta.get("last_doctype_sync") - changed_doctypes = get_doctypes_changed_since(last_doctype_sync) + last_sync_raw = meta.get("last_doctype_sync") + changed_doctypes = get_doctypes_changed_since(last_sync_raw) + + if not changed_doctypes: + return {"ok": True, "message": _("No changes detected")} + changed_tables = sorted({_tab(dt) for dt in changed_doctypes}) existing_tables = _load_json_list(TABLES_JSON) - existing_set = set(existing_tables) - new_tables = [t for t in changed_tables if t not in existing_set] - merged = sorted(existing_set | set(new_tables)) - - if new_tables: - _save_json_list(TABLES_JSON, merged) + merged_tables = sorted(set(existing_tables) | set(changed_tables)) + _save_json_list(TABLES_JSON, merged_tables) by_table = { b.get("table"): b @@ -226,19 +226,15 @@ def sync_tables_and_schema_smart(): if isinstance(b, dict) and b.get("table") } - created_table_blocks = 0 - new_fields_added = 0 - removed_fields_total = 0 - for table in changed_tables: dt = _strip_tab(table) if not frappe.db.exists("DocType", dt): continue + frappe.clear_cache(doctype=dt) meta_dt = frappe.get_meta(dt) - current_fieldnames = ["name"] - current_fields = [{"name": "name", "description": ""}] + current_fields: List[Dict[str, Any]] = [{"name": "name", "description": ""}] for df in meta_dt.fields: if not df.fieldname: continue @@ -246,11 +242,9 @@ def sync_tables_and_schema_smart(): continue if df.fieldname == "name": continue - current_fieldnames.append(df.fieldname) current_fields.append(_field_dict(df)) - current_fieldnames = _dedup_keep_order(current_fieldnames) - current_set = set(current_fieldnames) + current_set = {f["name"] for f in current_fields} block = by_table.get(table) if not block: @@ -260,124 +254,71 @@ def sync_tables_and_schema_smart(): "fields": current_fields, } tables_blocks.append(block) - by_table[table] = block - created_table_blocks += 1 - new_fields_added += len(current_fieldnames) - continue - - # EXISTING TABLE: remove missing fields + add new fields - fields_list = block.get("fields") or [] - if not isinstance(fields_list, list): - fields_list = [] - - before = len(fields_list) - fields_list = [ - f for f in fields_list - if isinstance(f, dict) and f.get("name") in current_set - ] - removed_fields_total += (before - len(fields_list)) - - existing_fieldnames = { - f.get("name") for f in fields_list if isinstance(f, dict) - } - - add_map = {f["name"]: f for f in current_fields if f.get("name")} - new_fieldnames = [ - fn for fn in current_fieldnames if fn not in existing_fieldnames - ] - - if new_fieldnames: - for fn in new_fieldnames: - fields_list.append(add_map.get(fn, {"name": fn, "description": ""})) - new_fields_added += len(new_fieldnames) - - # ensure 'name' stays first - name_entry = [f for f in fields_list if f.get("name") == "name"] - rest = [f for f in fields_list if f.get("name") != "name"] - block["fields"] = name_entry + rest - - meta["last_sync"] = str(now_datetime()) - meta["last_doctype_sync"] = meta["last_sync"] - - payload = {"_meta": meta, "tables": tables_blocks} - _save_yaml(SCHEMA_YAML, payload) - - return { - "ok": True, - "message": "Skeleton sync done ✅ (includes child tables + options + join_hint, no OpenAI)", - "new_tables_added": len(new_tables), - "new_table_blocks_created": created_table_blocks, - "new_fields_added": new_fields_added, - "removed_fields_total": removed_fields_total, - "new_last_doctype_sync": meta["last_doctype_sync"], - } + else: + existing_fields = block.get("fields") or [] + filtered_existing = [f for f in existing_fields if isinstance(f, dict) and f.get("name") in current_set] + + existing_names = {f.get("name") for f in filtered_existing} + for f in current_fields: + if f["name"] not in existing_names: + filtered_existing.append(f) + block["fields"] = sorted(filtered_existing, key=lambda x: x.get("name") != "name") + frappe.local.meta_cache = {} + if len(changed_tables) > 10: + gc.collect() -@frappe.whitelist(allow_guest=False) -def generate_response(user_query): - if not user_query or not user_query.strip(): - return { - "ok": False, - "message": "I can help you with your queries. Please ask something." - } + meta["last_doctype_sync"] = str(now_datetime()) + _save_yaml(SCHEMA_YAML, {"_meta": meta, "tables": tables_blocks}) - try: - response = call_gemini(user_query.strip()) - return { - "ok": True, - "response": response - } + return {"ok": True, "message": _("Synced {0} tables").format(len(changed_tables))} - except Exception as e: - frappe.log_error( - title="generate_response failed", - message=frappe.get_traceback() - ) - return { - "ok": False, - "message": "Something went wrong while generating the response." - } -def _load_yaml(path): +def _get_openai_client(): + settings = frappe.get_single("ChangAI Settings") + api_key = None try: - with open(path, "r") as f: - x = yaml.safe_load(f) or {} - return x if isinstance(x, dict) else {} + api_key = settings.get_password("openai_api_key") except Exception: - return {} + api_key = None + if not api_key: + api_key = os.getenv("OPENAI_API_KEY") -def _save_yaml(path, obj): - os.makedirs(os.path.dirname(path), exist_ok=True) - with open(path, "w") as f: - yaml.safe_dump(obj, f, sort_keys=False, allow_unicode=True) + if not api_key: + frappe.throw(_("OpenAI API key is not set in ChangAI Settings")) + + return openai.OpenAI(api_key=api_key) -def _get_openai_client(): +def _get_claude_client() -> Optional[Anthropic]: settings = frappe.get_single("ChangAI Settings") + api_key = None try: - api_key = settings.get_password("openai_api_key") + api_key = settings.get_password("claude_api_key") except Exception: api_key = None if not api_key: - api_key = os.getenv("OPENAI_API_KEY") + api_key = os.getenv("ANTHROPIC_API_KEY") if not api_key: - frappe.throw("OpenAI API key is not set in ChangAI Settings") + frappe.logger().error("Claude API key missing. Set ChangAI Settings claude_api_key or env ANTHROPIC_API_KEY.") + return None - return openai.OpenAI(api_key=api_key) + return Anthropic(api_key=api_key) -def _extract_json_object(text: str): +def _extract_json_object(text: str) -> Optional[Dict[str, Any]]: if not text or not str(text).strip(): return None - text = str(text).strip() + try: obj = json.loads(text) return obj if isinstance(obj, dict) else None except Exception: pass + start = text.find("{") end = text.rfind("}") if start != -1 and end != -1 and end > start: @@ -391,79 +332,50 @@ def _extract_json_object(text: str): return None -def _get_claude_client(): - settings = frappe.get_single("ChangAI Settings") - api_key = None - try: - api_key = settings.get_password("claude_api_key") - except Exception: - api_key = None - - if not api_key: - api_key = os.getenv("ANTHROPIC_API_KEY") - - if not api_key: - frappe.logger().error( - "Claude API key missing. Set ChangAI Settings claude_api_key or env ANTHROPIC_API_KEY." - ) - return None - - return Anthropic(api_key=api_key) - - -def _smart_desc_map(client, table_name, fields): - """ - Shorter prompt to reduce tokens + faster + less memory. - """ +def _smart_desc_map(client: Optional[Anthropic], table_name: str, fields: List[Dict[str, Any]]) -> Dict[str, str]: if not client: return {} - minimal = [{"name": f.get("name"), "description": (f.get("description") or "")} for f in fields] + field_names = [f.get("name") for f in fields if isinstance(f, dict) and f.get("name")] + if not field_names: + return {} prompt = f""" -You are generating SHORT, HIGH-SIGNAL field descriptions for an ERP schema embedding model. +Generate SHORT, HIGH-SIGNAL ERP field descriptions for embedding retrieval. Table: {table_name} -GOAL: -Help an embedding model correctly match user questions to the right field. - -STRICT RULES: -- Do NOT rename field names. -- Do NOT explain database concepts (primary key, immutable, system-generated, etc). -- Do NOT add generic phrases like "used for reporting" or "stores data". -- Output ONLY a JSON object in this format: - {{"field_name": "description"}} +Rules: +- Do NOT rename fields. +- 1 sentence per field. +- Focus on WHEN/WHY this field is used in business questions. +- Output ONLY JSON object: {{"field_name": "description"}} -DESCRIPTION GUIDELINES (VERY IMPORTANT): -- 1 sentence only (max 2 if absolutely necessary). -- Focus on WHEN and WHY a user would reference this field in a question. -- Mention how it differs from similar fields ONLY if useful for disambiguation. -- Write as if the description will be embedded, not read by humans. - -Fields JSON: -{json.dumps(minimal, ensure_ascii=False)} +Fields: +{json.dumps(field_names, ensure_ascii=False)} """.strip() - for attempt in range(3): try: msg = client.messages.create( model="claude-sonnet-4-5", - max_tokens=900, + max_tokens=500, temperature=0.2, system="Return ONLY a JSON object. No markdown. No extra text.", - messages=[{"role": "user", "content": prompt}] ) + messages=[{"role": "user", "content": prompt}], + timeout=180, + ) - text_parts = [] + text_parts: List[str] = [] for b in getattr(msg, "content", []) or []: if getattr(b, "type", None) == "text" and getattr(b, "text", None): text_parts.append(b.text) - text = "\n".join(text_parts).strip() + text = "\n".join(text_parts).strip() parsed = _extract_json_object(text) + if isinstance(parsed, dict): - out = {} + out: Dict[str, str] = {} for k, v in parsed.items(): if isinstance(k, str) and isinstance(v, str) and k.strip() and v.strip(): out[k.strip()] = v.strip() @@ -474,120 +386,237 @@ def _smart_desc_map(client, table_name, fields): ) time.sleep(2 * (attempt + 1)) - except anthropic.RateLimitError as e: - frappe.logger().warning(f"Claude RateLimit table={table_name} attempt={attempt+1}: {e}") - time.sleep(2 * (attempt + 1)) - - except anthropic.APIConnectionError as e: - frappe.logger().warning(f"Claude ConnectionError table={table_name} attempt={attempt+1}: {e}") - time.sleep(2 * (attempt + 1)) - - except anthropic.APIStatusError as e: - status = getattr(e, "status_code", None) - frappe.logger().warning(f"Claude StatusError table={table_name} attempt={attempt+1} status={status}: {e}") - if status in (401, 403): - break - time.sleep(2 * (attempt + 1)) - except Exception as e: - frappe.logger().error(f"Claude unknown error table={table_name} attempt={attempt+1}: {e}") + frappe.logger().error(f"Claude error table={table_name} attempt={attempt+1}: {e}") time.sleep(2 * (attempt + 1)) return {} - @frappe.whitelist(allow_guest=False) def fill_missing_field_descriptions( - batch_size: int = 3, + batch_size: int = 15, # Lowered for token safety max_tables: int = 0, - checkpoint_every_table: int = 1, -): - frappe.logger().info("Description job started") - + checkpoint_every_table: int = 10, # Increased to reduce Disk I/O load +) -> Dict[str, Any]: payload = _load_yaml(SCHEMA_YAML) meta = payload.get("_meta") or {} tables_blocks = payload.get("tables") or [] + if not isinstance(tables_blocks, list): - return {"ok": False, "message": "schema.yaml invalid"} + return {"ok": False, "message": _("schema.yaml invalid")} - client = _get_claude_client() + client = _get_openai_client() if not client: - return {"ok": False, "message": "Claude API key not configured (claude_api_key / ANTHROPIC_API_KEY)"} + return {"ok": False, "message": _("OpenAI API key missing")} - BATCH_SIZE = max(1, int(batch_size)) + # Stats tracking updated_tables = 0 updated_fields = 0 - processed_updated_tables = 0 + tables_since_last_save = 0 + consecutive_errors = 0 for block in tables_blocks: - if not isinstance(block, dict): + # Prevent Memory Bloat: Clear Frappe caches every iteration + frappe.local.meta_cache = {} + if hasattr(frappe.local, 'docs'): frappe.local.docs = {} + + if not isinstance(block, dict) or block.get("desc_done"): continue table = block.get("table") fields = block.get("fields") or [] - if not table or not isinstance(fields, list): - continue - + pending_fields = [ f for f in fields - if isinstance(f, dict) - and f.get("name") - and not (f.get("description") or "").strip() + if isinstance(f, dict) and f.get("name") and not (f.get("description") or "").strip() ] + if not pending_fields: + block["desc_done"] = True continue - frappe.logger().info(f"Table={table} pending_fields={len(pending_fields)}") updated_in_table = 0 + try: + for i in range(0, len(pending_fields), batch_size): + batch = pending_fields[i:i + batch_size] + desc_map = _smart_desc_map_1(client, table, batch) + + if not desc_map: + consecutive_errors += 1 + continue + + consecutive_errors = 0 # Reset on success + for f in batch: + fn = f.get("name") + if fn in desc_map: + f["description"] = desc_map[fn].strip() + updated_fields += 1 + updated_in_table += 1 + + # DB Heartbeat: keep the SQL connection alive + frappe.db.commit() - for i in range(0, len(pending_fields), BATCH_SIZE): - batch = pending_fields[i:i + BATCH_SIZE] - frappe.logger().info(f"Table={table} batch={i//BATCH_SIZE + 1} size={len(batch)}") - - desc_map = _smart_desc_map(client, table, batch) or {} - - for f in batch: - fn = f.get("name") - if fn and fn in desc_map and desc_map[fn].strip(): - f["description"] = desc_map[fn] - updated_fields += 1 - updated_in_table += 1 - gc.collect() + except Exception as e: + frappe.logger().error(f"Critical error in table {table}: {e}") + consecutive_errors += 1 if updated_in_table: updated_tables += 1 processed_updated_tables += 1 - if int(checkpoint_every_table) >= 1: - meta["last_desc_sync_partial"] = str(now_datetime()) - payload = {"_meta": meta, "tables": tables_blocks} - _save_yaml(SCHEMA_YAML, payload) - frappe.logger().info(f"Checkpoint saved after table={table} updated_fields_in_table={updated_in_table}") - if int(max_tables) and processed_updated_tables >= int(max_tables): - frappe.logger().info(f"Stopping early due to max_tables={max_tables}") - break + tables_since_last_save += 1 + # Mark table as done if no empty descriptions remain + block["desc_done"] = not any(isinstance(x, dict) and not (x.get("description") or "").strip() for x in block.get("fields", [])) - meta["last_desc_sync"] = str(now_datetime()) - payload = {"_meta": meta, "tables": tables_blocks} - _save_yaml(SCHEMA_YAML, payload) + # Checkpoint: Save to disk every X tables + if tables_since_last_save >= checkpoint_every_table: + _save_yaml(SCHEMA_YAML, {"_meta": meta, "tables": tables_blocks}) + tables_since_last_save = 0 + gc.collect() # Garbage collection + + # Safety: If API fails 5 times in a row, stop to save credits/time + if consecutive_errors > 5: + frappe.logger().error("Stopping job: Too many consecutive API errors.") + break - frappe.logger().info(f"Description job finished tables={updated_tables} fields={updated_fields}") + if max_tables and processed_updated_tables >= max_tables: + break + + # Final Save and cleanup + meta["last_desc_sync"] = str(now_datetime()) + _save_yaml(SCHEMA_YAML, {"_meta": meta, "tables": tables_blocks}) + frappe.db.commit() return { "ok": True, - "message": "Field descriptions generated ✅", "tables_updated": updated_tables, "fields_updated": updated_fields, - "last_desc_sync": meta["last_desc_sync"], + "status": "Complete" if consecutive_errors <= 5 else "Partial Failure" } - @frappe.whitelist() -def sync_schema_and_enqueue_descriptions(): +def sync_schema_and_enqueue_descriptions() -> Dict[str, Any]: sync_tables_and_schema_smart() frappe.enqueue( "changai.changai.api.v2.auto_gen_api.fill_missing_field_descriptions", queue="long", - timeout=14400 + timeout=14400, ) - return {"ok": True, "message": "Schema updated ✅ Field descriptions running in background 🧠"} + return {"ok": True, "message": _("Schema updated ✅ Field descriptions running in background 🧠")} + + +def _smart_desc_map_1(client, table_name: str, fields: List[Dict[str, Any]]) -> Dict[str, str]: + if not client: + return {} + + field_names = [f.get("name") for f in fields if isinstance(f, dict) and f.get("name")] + if not field_names: + return {} + + prompt = f""" +Generate SHORT, HIGH-SIGNAL ERP field descriptions for embedding retrieval. + +Table: {table_name} + +Rules: +- Do NOT rename fields. +- 1 sentence per field. +- Focus on WHEN/WHY this field is used in business questions. +- Output ONLY JSON object: {{"field_name": "description"}} + +Fields: +{json.dumps(field_names, ensure_ascii=False)} +""".strip() + + for attempt in range(3): + try: + response = client.chat.completions.create( + model="gpt-4o-mini", # fast + cheap + stable + messages=[ + {"role": "system", "content": "Return ONLY a valid JSON object. No markdown. No extra text."}, + {"role": "user", "content": prompt} + ], + temperature=0.2, + max_tokens=800, + timeout=180, + ) + + text = response.choices[0].message.content.strip() + + parsed = _extract_json_object(text) + + if isinstance(parsed, dict): + out: Dict[str, str] = {} + for k, v in parsed.items(): + if isinstance(k, str) and isinstance(v, str) and k.strip() and v.strip(): + out[k.strip()] = v.strip() + return out + + frappe.logger().warning( + f"OpenAI returned non-JSON table={table_name} attempt={attempt+1} preview={text[:200]!r}" + ) + time.sleep(2 * (attempt + 1)) + + except Exception as e: + frappe.logger().error(f"OpenAI error table={table_name} attempt={attempt+1}: {e}") + time.sleep(2 * (attempt + 1)) + + return {} + + +@frappe.whitelist(allow_guest=True) +def test_openai_connection(api_key: str = None) -> dict: + """ + Simple OpenAI connectivity test. + Verifies: + - API key validity + - Network connectivity + - Model availability + - JSON response parsing + """ + + try: + # 1️⃣ Get API key + if not api_key: + settings = frappe.get_single("ChangAI Settings") + try: + api_key = settings.get_password("openai_api_key") + except Exception: + api_key = None + + if not api_key: + api_key = os.getenv("OPENAI_API_KEY") + + if not api_key: + return {"ok": False, "error": "No OpenAI API key found"} + + # 2️⃣ Create client + from openai import OpenAI + client = OpenAI(api_key=api_key) + + # 3️⃣ Make simple request + response = client.chat.completions.create( + model="gpt-4o-mini", + messages=[ + {"role": "system", "content": "Return ONLY JSON."}, + {"role": "user", "content": "Reply exactly with {\"status\":\"ok\"}"} + ], + temperature=0, + max_tokens=50, + timeout=60, + ) + + content = response.choices[0].message.content.strip() + + return { + "ok": True, + "model": "gpt-4o-mini", + "response": content + } + + except Exception as e: + frappe.logger().exception("OpenAI test failed") + return { + "ok": False, + "error": str(e) + } diff --git a/changai/changai/api/v2/build_cards_faiss_index_v2.py b/changai/changai/api/v2/build_cards_faiss_index_v2.py index 7642ba7..570e3f1 100644 --- a/changai/changai/api/v2/build_cards_faiss_index_v2.py +++ b/changai/changai/api/v2/build_cards_faiss_index_v2.py @@ -1,4 +1,5 @@ import os +from pathlib import Path import glob import json import yaml @@ -25,6 +26,13 @@ EF_CONSTRUCTION = 256 EF_SEARCH = 64 +def _assert_file_inside_base(file_path: str, base_dir: str) -> str: + base = Path(base_dir).resolve() + p = Path(file_path).resolve() + if base != p and base not in p.parents: + raise ValueError(f"Unsafe file path (outside base dir): {p}") + return str(p) + def load_yaml_dir(path: str) -> List[Dict[str, Any]]: """ Loads all *.yaml in a folder. @@ -32,8 +40,10 @@ def load_yaml_dir(path: str) -> List[Dict[str, Any]]: Returns a flat list of dict items. """ out: List[Dict[str, Any]] = [] - for fp in sorted(glob.glob(os.path.join(path, "*.yaml"))): - with open(fp, "r", encoding="utf-8") as f: + base_dir = Path(path).resolve() + for fp in sorted(glob.glob(os.path.join(str(base_dir), "*.yaml"))): + safe_fp = _assert_file_inside_base(fp, str(base_dir)) + with open(safe_fp, "r", encoding="utf-8") as f: doc = yaml.safe_load(f) if doc is None: @@ -148,7 +158,7 @@ def build_schema_docs(schema_cards: List[Dict[str, Any]]) -> List[Document]: ] if enum_vals: - parts.append(f"[ENUM] {', '.join(map(str, enum_vals))}") + parts.append(f"[ENUM] {', '.join([str(v) for v in enum_vals])}") opt_text = _serialize_options(options) if opt_text: @@ -213,20 +223,26 @@ def build_entity_docs(entity_cards: List[Dict[str, Any]]) -> List[Document]: return docs +def _assert_dir_inside_base(dir_path: str, base_dir: str) -> Path: + base = Path(base_dir).resolve() + d = Path(dir_path).resolve() + if base != d and base not in d.parents: + raise ValueError(f"Unsafe output dir (outside base): {d}") + return d + + def build_faiss_store( docs: List[Document], embeddings: HuggingFaceEmbeddings, out_dir: str, ) -> None: - """ - Builds FAISS HNSW index + LangChain FAISS store and saves to out_dir. - """ if not docs: raise RuntimeError(f"No documents provided for FAISS build: {out_dir}") - os.makedirs(out_dir, exist_ok=True) + safe_out_dir = _assert_dir_inside_base(out_dir, OUT_BASE) + safe_out_dir.mkdir(parents=True, exist_ok=True) - print(f"Encoding {len(docs)} documents for: {out_dir}") + print(f"Encoding {len(docs)} documents for: {safe_out_dir}") doc_texts = [d.page_content for d in docs] vectors = embeddings.embed_documents(doc_texts) @@ -245,14 +261,14 @@ def build_faiss_store( normalize_L2=True, ) - store.save_local(out_dir) + store.save_local(str(safe_out_dir)) - # helpful mapping (optional) mapping = {docs[i].metadata.get("source_id", i): i for i in range(len(docs))} - with open(os.path.join(out_dir, "source_id_to_idx.json"), "w", encoding="utf-8") as f: + mapping_path = safe_out_dir / "source_id_to_idx.json" + with mapping_path.open("w", encoding="utf-8") as f: json.dump(mapping, f, ensure_ascii=False) - print(f"✅ Saved FAISS store to: {out_dir}") + print(f"✅ Saved FAISS store to: {safe_out_dir}") print(f" Docs: {len(docs)} | Dim: {dim} | M:{HNSW_M} | efC:{EF_CONSTRUCTION} | efS:{EF_SEARCH}") def build_all_indexes(): diff --git a/changai/changai/api/v2/data/master_data.yaml b/changai/changai/api/v2/data/meta_schema.yaml similarity index 93% rename from changai/changai/api/v2/data/master_data.yaml rename to changai/changai/api/v2/data/meta_schema.yaml index 23598fb..b50f6bd 100644 --- a/changai/changai/api/v2/data/master_data.yaml +++ b/changai/changai/api/v2/data/meta_schema.yaml @@ -1,6 +1,11 @@ _meta: - last_sync: '2026-02-10 07:43:23.011805' + last_sync: '2026-02-12 20:16:33.990116' data: +- entity_type: tabCustomer + entity_id: test + filters: + field: name + value: test - entity_type: tabCustomer entity_id: Deepika filters: @@ -161,6 +166,11 @@ data: filters: field: name value: West View Software Ltd. +- entity_type: tabItem + entity_id: test + filters: + field: name + value: test - entity_type: tabItem entity_id: Tops filters: @@ -187,12 +197,12 @@ data: field: name value: Pen123 - entity_type: tabItem - entity_id: "3M N95 Particulate Respirator 8210 \u2013 Box of 20 Masks \u2013 NIOSH\ - \ Approved, Industrial Dust Protection, Elastic Headbands" + entity_id: 3M N95 Particulate Respirator 8210 – Box of 20 Masks – NIOSH Approved, + Industrial Dust Protection, Elastic Headbands filters: field: name - value: "3M N95 Particulate Respirator 8210 \u2013 Box of 20 Masks \u2013 NIOSH\ - \ Approved, Industrial Dust Protection, Elastic Headbands" + value: 3M N95 Particulate Respirator 8210 – Box of 20 Masks – NIOSH Approved, + Industrial Dust Protection, Elastic Headbands - entity_type: tabItem entity_id: chair 27 filters: @@ -214,33 +224,33 @@ data: field: name value: HP-M479FDW - entity_type: tabItem - entity_id: "Bosch Serie 6 Front-Load Washing Machine 9 kg \u2013 1400 RPM, Inverter\ - \ Motor, AllergyPlus Mode, Silver Finish" + entity_id: Bosch Serie 6 Front-Load Washing Machine 9 kg – 1400 RPM, Inverter Motor, + AllergyPlus Mode, Silver Finish filters: field: name - value: "Bosch Serie 6 Front-Load Washing Machine 9 kg \u2013 1400 RPM, Inverter\ - \ Motor, AllergyPlus Mode, Silver Finish" + value: Bosch Serie 6 Front-Load Washing Machine 9 kg – 1400 RPM, Inverter Motor, + AllergyPlus Mode, Silver Finish - entity_type: tabItem - entity_id: "Dell Latitude 7440 Ultralight 14\u2033 Business Laptop \u2013 Intel\ - \ Core i7-1365U 13th Gen, 32 GB RAM, 1 TB SSD, Windows 11 Pro, FHD Display" + entity_id: Dell Latitude 7440 Ultralight 14″ Business Laptop – Intel Core i7-1365U + 13th Gen, 32 GB RAM, 1 TB SSD, Windows 11 Pro, FHD Display filters: field: name - value: "Dell Latitude 7440 Ultralight 14\u2033 Business Laptop \u2013 Intel Core\ - \ i7-1365U 13th Gen, 32 GB RAM, 1 TB SSD, Windows 11 Pro, FHD Display" + value: Dell Latitude 7440 Ultralight 14″ Business Laptop – Intel Core i7-1365U + 13th Gen, 32 GB RAM, 1 TB SSD, Windows 11 Pro, FHD Display - entity_type: tabItem - entity_id: "HP LaserJet Pro MFP M479fdw Color Wireless All-in-One Printer \u2013\ - \ Duplex, Fax, Wi-Fi, USB, 27 ppm, 512 MB RAM" + entity_id: HP LaserJet Pro MFP M479fdw Color Wireless All-in-One Printer – Duplex, + Fax, Wi-Fi, USB, 27 ppm, 512 MB RAM filters: field: name - value: "HP LaserJet Pro MFP M479fdw Color Wireless All-in-One Printer \u2013 Duplex,\ - \ Fax, Wi-Fi, USB, 27 ppm, 512 MB RAM" + value: HP LaserJet Pro MFP M479fdw Color Wireless All-in-One Printer – Duplex, + Fax, Wi-Fi, USB, 27 ppm, 512 MB RAM - entity_type: tabItem - entity_id: "Samsung 55-Inch QLED Smart TV Model QN90D \u2014 4K Ultra HD, HDR10+,\ - \ Voice Control, Wi-Fi 6," + entity_id: Samsung 55-Inch QLED Smart TV Model QN90D — 4K Ultra HD, HDR10+, Voice + Control, Wi-Fi 6, filters: field: name - value: "Samsung 55-Inch QLED Smart TV Model QN90D \u2014 4K Ultra HD, HDR10+,\ - \ Voice Control, Wi-Fi 6," + value: Samsung 55-Inch QLED Smart TV Model QN90D — 4K Ultra HD, HDR10+, Voice + Control, Wi-Fi 6, - entity_type: tabItem entity_id: ITEM890 filters: @@ -1091,16 +1101,6 @@ data: filters: field: name value: Zuckerman Security Ltd. -- entity_type: tabItem - entity_id: test - filters: - field: name - value: test -- entity_type: tabCustomer - entity_id: test - filters: - field: name - value: test - entity_type: tabSupplier entity_id: test filters: diff --git a/changai/changai/api/v2/data/schema.yaml b/changai/changai/api/v2/data/schema.yaml index d2a5f4f..0ef4084 100644 --- a/changai/changai/api/v2/data/schema.yaml +++ b/changai/changai/api/v2/data/schema.yaml @@ -1,7 +1,8 @@ _meta: - last_sync: '2026-02-11 09:20:33.296896' - last_doctype_sync: '2026-02-11 09:20:33.296896' - last_desc_sync_partial: '2026-02-11 10:20:16.275247' + last_sync: '2026-02-12 14:44:02.882616' + last_doctype_sync: '2026-02-12 14:44:02.882616' + last_desc_sync_partial: '2026-02-11 18:03:00.028676' + last_desc_sync: '2026-02-12 19:50:38.738950' tables: - table: tabAbout Us Settings description: Settings for the About Us Page @@ -30,6 +31,7 @@ tables: or bios shown in the About Us section - name: footer description: Footer text or content displayed at the bottom of the About Us page + desc_done: true - table: tabAbout Us Team Member description: '' fields: @@ -42,16 +44,20 @@ tables: - name: bio description: Biographical text or profile description about the team member including their background, expertise, role details, and accomplishments. + desc_done: true - table: tabAccount description: Heads (or groups) against which Accounting Entries are made and balances are maintained. fields: - name: name - description: '' + description: Unique identifier or code for the account used when searching for + specific account records or filtering transactions by account. - name: disabled - description: '' + description: Indicates whether the account is inactive or no longer in use, relevant + when filtering for active accounts or analyzing historical account status changes. - name: account_name - description: '' + description: Full descriptive name of the account used when users search by account + description, generate financial reports, or need human-readable account identification. - name: account_number description: Unique identifier for the account used in financial transactions and reporting queries. @@ -154,6 +160,7 @@ tables: - name: include_in_gross description: Whether this account's balance is included in gross profit or gross margin calculations. + desc_done: true - table: tabAccount Closing Balance description: '' fields: @@ -218,18 +225,22 @@ tables: - name: is_period_closing_voucher_entry description: Indicates whether this balance entry was created by the period closing process. + desc_done: true - table: tabAccounting Dimension description: '' fields: - name: name - description: '' + description: Unique identifier or code for the accounting dimension used to filter + and group financial transactions by business segments. - name: document_type - description: '' + description: Specifies the category or type of accounting dimension such as cost + center, department, or project for organizing financial data. join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: label - description: '' + description: Human-readable display name for the accounting dimension used in + reports and user interfaces when presenting financial breakdowns. - name: fieldname description: Name or code identifying the accounting dimension used for financial segmentation and reporting analysis @@ -239,6 +250,7 @@ tables: - name: disabled description: Indicates whether the accounting dimension is currently inactive and unavailable for use in transactions + desc_done: true - table: tabAccounting Dimension Detail description: '' fields: @@ -274,6 +286,7 @@ tables: join_hint: table: tabAccount 'on': offsetting_account = tabAccount.name + desc_done: true - table: tabAccounting Dimension Filter description: '' fields: @@ -308,15 +321,19 @@ tables: - name: dimensions description: The dimension values or combinations that are allowed or restricted for the specified accounts + desc_done: true - table: tabAccounting Period description: '' fields: - name: name - description: '' + description: Unique identifier for the accounting period used when filtering financial + reports by specific time periods. - name: period_name - description: '' + description: Human-readable label for the accounting period used when users reference + periods like 'Q1 2024' or 'January 2024' in queries. - name: start_date - description: '' + description: Beginning date of the accounting period used when determining which + transactions fall within a specific fiscal timeframe. - name: end_date description: The final date of the accounting period, used when filtering or identifying periods by their closing boundary. @@ -329,6 +346,7 @@ tables: - name: closed_documents description: Indicates whether documents can still be posted to this period or if it has been locked for further transactions. + desc_done: true - table: tabAccounts Settings description: '' fields: @@ -517,6 +535,7 @@ tables: - name: create_pr_in_draft_status description: Whether new purchase requisitions are created in draft status requiring approval before submission + desc_done: true - table: tabActivity Cost description: '' fields: @@ -550,30 +569,38 @@ tables: resource allocation. - name: title description: Name or label identifying the specific activity being costed. + desc_done: true - table: tabActivity Type description: '' fields: - name: name - description: '' + description: Unique identifier or label for the activity type used when filtering + or grouping activities by their classification. - name: activity_type - description: '' + description: Category or classification of the activity used when analyzing work + types, resource allocation, or project phases. - name: costing_rate - description: '' + description: Standard rate applied to calculate costs for this activity type used + when determining project expenses or billing amounts. - name: billing_rate description: Rate charged to customers for this activity type when billing for time or services. - name: disabled description: Whether this activity type is currently inactive and unavailable for selection in new transactions. + desc_done: true - table: tabAddress description: '' fields: - name: name - description: '' + description: Unique identifier for the address record, used when searching for + or referencing a specific address entry. - name: address_title - description: '' + description: Display name or label for the address, used when users need to identify + addresses by a friendly name rather than full address details. - name: address_type - description: '' + description: Classification of the address purpose such as billing, shipping, + or office location, used when filtering addresses by their business function. options: - Billing - Shipping @@ -641,6 +668,7 @@ tables: - name: links description: Related records or documents connected to this address such as contacts, transactions, or delivery notes. + desc_done: true - table: tabAddress Template description: '' fields: @@ -659,6 +687,7 @@ tables: - name: template description: Address format template defining the layout and field order for displaying addresses in a specific country or region + desc_done: true - table: tabAdvance Payment Ledger Entry description: '' fields: @@ -701,18 +730,21 @@ tables: - name: delinked description: Indicates whether this advance payment ledger entry has been disconnected or unlinked from its original invoice or payment document. + desc_done: true - table: tabAdvance Tax description: '' fields: - name: name - description: '' + description: Unique identifier for the advance tax payment record. - name: reference_type - description: '' + description: Specifies the document type (e.g., Sales Invoice, Purchase Invoice) + against which advance tax was paid or allocated. join_hint: table: tabDocType 'on': reference_type = tabDocType.name - name: reference_name - description: '' + description: Links to the specific document number where this advance tax payment + was applied or originated. - name: reference_detail description: Identifies the specific tax payment voucher or transaction reference for the advance tax entry @@ -724,6 +756,7 @@ tables: - name: allocated_amount description: Amount of advance tax that has been applied or adjusted against actual tax liability + desc_done: true - table: tabAdvance Taxes and Charges description: '' fields: @@ -790,6 +823,7 @@ tables: - name: base_total description: Total amount of advance taxes and charges in base currency before any adjustments or conversions + desc_done: true - table: tabAllowed Dimension description: '' fields: @@ -804,6 +838,7 @@ tables: - name: dimension_value description: The specific value within the dimension that is allowed, such as a particular cost center code or department name + desc_done: true - table: tabAllowed To Transact With description: '' fields: @@ -816,6 +851,7 @@ tables: join_hint: table: tabCompany 'on': company = tabCompany.name + desc_done: true - table: tabAmended Document Naming Settings description: '' fields: @@ -834,18 +870,23 @@ tables: options: - Amend Counter - Default Naming + desc_done: true - table: tabApplicable On Account description: '' fields: - name: name - description: '' + description: Unique identifier or label for the applicability rule or configuration + being defined. - name: applicable_on_account - description: '' + description: Specifies the account type, category, or GL account where this rule + or setting applies for transaction processing or validation. join_hint: table: tabAccount 'on': applicable_on_account = tabAccount.name - name: is_mandatory - description: '' + description: Indicates whether the account applicability is required or optional + when processing transactions or applying business rules. + desc_done: true - table: tabAppointment description: '' fields: @@ -888,6 +929,7 @@ tables: join_hint: table: tabEvent 'on': calendar_event = tabEvent.name + desc_done: true - table: tabAppointment Booking Settings description: '' fields: @@ -917,13 +959,16 @@ tables: - name: success_redirect_url description: URL where users are redirected after successfully completing an appointment booking. + desc_done: true - table: tabAppointment Booking Slots description: '' fields: - name: name - description: '' + description: Unique identifier for the appointment slot, used when referencing + or searching for specific booking time slots. - name: day_of_week - description: '' + description: Day when the appointment slot is available, used to filter bookings + by weekday or analyze appointment patterns across the week. options: - Sunday - Monday @@ -933,10 +978,12 @@ tables: - Friday - Saturday - name: from_time - description: '' + description: Start time of the appointment slot, used to find available slots + within specific time ranges or analyze booking distribution throughout the day. - name: to_time description: End time of the appointment booking slot, used when searching for availability windows or filtering slots by when they finish. + desc_done: true - table: tabAsset description: '' fields: @@ -1168,18 +1215,22 @@ tables: join_hint: table: tabAsset 'on': amended_from = tabAsset.name + desc_done: true - table: tabAsset Activity description: '' fields: - name: name - description: '' + description: Description or identifier of the specific activity performed on the + asset, used when tracking maintenance events, inspections, or operational changes. - name: asset - description: '' + description: Reference to the asset on which the activity was performed, used + when filtering or analyzing activities for specific equipment or property. join_hint: table: tabAsset 'on': asset = tabAsset.name - name: date - description: '' + description: Timestamp when the asset activity occurred, used when analyzing activity + history, scheduling patterns, or finding recent maintenance events. - name: user description: Person who performed or logged the activity on the asset join_hint: @@ -1187,6 +1238,7 @@ tables: 'on': user = tabUser.name - name: subject description: Brief title or summary describing what the asset activity was about + desc_done: true - table: tabAsset Capitalization description: '' fields: @@ -1314,18 +1366,25 @@ tables: join_hint: table: tabAccount 'on': target_fixed_asset_account = tabAccount.name + desc_done: true - table: tabAsset Capitalization Asset Item description: '' fields: - name: name - description: '' + description: Unique identifier for the asset capitalization item record, used + when tracking specific capitalization transactions or referencing individual + line items in asset acquisition queries. - name: asset - description: '' + description: Links to the parent asset being capitalized, used when analyzing + capitalization details for a specific fixed asset or rolling up costs to the + asset level. join_hint: table: tabAsset 'on': asset = tabAsset.name - name: asset_name - description: '' + description: Display name of the asset being capitalized, used when searching + or filtering capitalization records by asset description without joining to + the asset table. - name: finance_book description: Identifies which financial book or accounting entity this asset capitalization belongs to for multi-book accounting scenarios. @@ -1364,6 +1423,7 @@ tables: join_hint: table: tabAccount 'on': fixed_asset_account = tabAccount.name + desc_done: true - table: tabAsset Capitalization Service Item description: '' fields: @@ -1402,6 +1462,7 @@ tables: join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name + desc_done: true - table: tabAsset Capitalization Stock Item description: '' fields: @@ -1462,6 +1523,7 @@ tables: join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name + desc_done: true - table: tabAsset Category description: '' fields: @@ -1483,6 +1545,7 @@ tables: description: Defines the default general ledger accounts used for asset transactions in this category, such as asset account, depreciation account, and accumulated depreciation account. + desc_done: true - table: tabAsset Category Account description: '' fields: @@ -1518,6 +1581,7 @@ tables: join_hint: table: tabAccount 'on': capital_work_in_progress_account = tabAccount.name + desc_done: true - table: tabAsset Depreciation Schedule description: '' fields: @@ -1602,18 +1666,22 @@ tables: join_hint: table: tabAsset Depreciation Schedule 'on': amended_from = tabAsset Depreciation Schedule.name + desc_done: true - table: tabAsset Finance Book description: '' fields: - name: name - description: '' + description: Unique identifier for the asset finance book record, used when querying + specific asset depreciation configurations. - name: finance_book - description: '' + description: Links to the finance book entity to track depreciation separately + for different accounting standards or legal entities. join_hint: table: tabFinance Book 'on': finance_book = tabFinance Book.name - name: depreciation_method - description: '' + description: Defines the calculation method for asset depreciation (straight-line, + declining balance, etc.) used when analyzing depreciation expense patterns. options: - Straight Line - Double Declining Balance @@ -1650,6 +1718,7 @@ tables: - name: rate_of_depreciation description: Percentage rate applied annually or per period to calculate depreciation expense for the asset in this finance book. + desc_done: true - table: tabAsset Maintenance description: '' fields: @@ -1687,18 +1756,21 @@ tables: - name: asset_maintenance_tasks description: Tasks or activities performed during maintenance of an asset, such as inspection, repair, or replacement work. + desc_done: true - table: tabAsset Maintenance Log description: '' fields: - name: name - description: '' + description: description - name: asset_maintenance - description: '' + description: Links to the parent asset maintenance schedule to track which equipment + or asset this maintenance activity belongs to. join_hint: table: tabAsset Maintenance 'on': asset_maintenance = tabAsset Maintenance.name - name: naming_series - description: '' + description: Defines the auto-numbering pattern used to generate unique identifiers + for maintenance log entries. options: - ACC-AML-.YYYY.- - name: asset_name @@ -1758,15 +1830,19 @@ tables: join_hint: table: tabAsset Maintenance Log 'on': amended_from = tabAsset Maintenance Log.name + desc_done: true - table: tabAsset Maintenance Task description: '' fields: - name: name - description: '' + description: Unique identifier for the asset maintenance task record, used when + referencing or searching for specific maintenance assignments. - name: maintenance_task - description: '' + description: Links to the specific maintenance procedure or checklist being performed, + used when querying what work is being done on assets. - name: maintenance_type - description: '' + description: Categorizes maintenance as preventive, corrective, or breakdown, + used when analyzing maintenance strategies or filtering tasks by service approach. options: - Preventive Maintenance - Calibration @@ -1813,6 +1889,7 @@ tables: - name: description description: Details what maintenance work needs to be performed on the asset, such as inspection, repair, or replacement tasks. + desc_done: true - table: tabAsset Maintenance Team description: '' fields: @@ -1838,6 +1915,7 @@ tables: - name: maintenance_team_members description: List of individuals assigned to this maintenance team who perform repair and upkeep work on assets. + desc_done: true - table: tabAsset Movement description: '' fields: @@ -1878,6 +1956,7 @@ tables: join_hint: table: tabAsset Movement 'on': amended_from = tabAsset Movement.name + desc_done: true - table: tabAsset Movement Item description: '' fields: @@ -1919,6 +1998,7 @@ tables: join_hint: table: tabEmployee 'on': to_employee = tabEmployee.name + desc_done: true - table: tabAsset Repair description: '' fields: @@ -2005,18 +2085,22 @@ tables: join_hint: table: tabAsset Repair 'on': amended_from = tabAsset Repair.name + desc_done: true - table: tabAsset Repair Consumed Item description: '' fields: - name: name - description: '' + description: Unique identifier for the consumed item record in the asset repair + transaction. - name: item_code - description: '' + description: Identifies which spare part or consumable was used during the asset + repair process. join_hint: table: tabItem 'on': item_code = tabItem.name - name: warehouse - description: '' + description: Specifies the storage location from which the repair item was issued + or consumed. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name @@ -2036,6 +2120,7 @@ tables: join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name + desc_done: true - table: tabAsset Shift Allocation description: '' fields: @@ -2066,6 +2151,7 @@ tables: - name: depreciation_schedule description: Links to the specific depreciation schedule affected by this shift allocation for tracking depreciation changes across shifts. + desc_done: true - table: tabAsset Shift Factor description: '' fields: @@ -2079,6 +2165,7 @@ tables: - name: default description: Indicates whether this shift factor is the default selection for asset depreciation calculations. + desc_done: true - table: tabAsset Value Adjustment description: '' fields: @@ -2138,6 +2225,7 @@ tables: join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name + desc_done: true - table: tabAssignment Rule description: Automatically Assign Documents to Users fields: @@ -2191,6 +2279,7 @@ tables: join_hint: table: tabUser 'on': last_user = tabUser.name + desc_done: true - table: tabAssignment Rule Day description: '' fields: @@ -2206,6 +2295,7 @@ tables: - Friday - Saturday - Sunday + desc_done: true - table: tabAssignment Rule User description: '' fields: @@ -2217,24 +2307,31 @@ tables: join_hint: table: tabUser 'on': user = tabUser.name + desc_done: true - table: tabAudit Trail description: '' fields: - name: name - description: '' + description: Unique identifier for each audit trail entry, used when tracking + specific change events or retrieving individual audit records. - name: doctype_name - description: '' + description: The type of document being audited (e.g., Sales Order, Invoice), + used when filtering audit history by entity type or analyzing changes across + specific modules. join_hint: table: tabDocType 'on': doctype_name = tabDocType.name - name: document - description: '' + description: The specific document instance being tracked, used when investigating + change history for a particular transaction or record. + desc_done: true - table: tabAuthorization Control description: '' fields: - name: name description: Authorization control name or identifier used to reference specific access permissions, approval workflows, or security controls + desc_done: true - table: tabAuthorization Rule description: '' fields: @@ -2317,6 +2414,7 @@ tables: join_hint: table: tabUser 'on': approving_user = tabUser.name + desc_done: true - table: tabAuto Email Report description: '' fields: @@ -2408,6 +2506,7 @@ tables: - CSV - name: description description: Text explaining the purpose or content of the automated email report. + desc_done: true - table: tabAuto Repeat description: '' fields: @@ -2486,6 +2585,7 @@ tables: - Active - Disabled - Completed + desc_done: true - table: tabAuto Repeat Day description: '' fields: @@ -2502,6 +2602,7 @@ tables: - Friday - Saturday - Sunday + desc_done: true - table: tabAvailability Of Slots description: '' fields: @@ -2521,6 +2622,7 @@ tables: description: Start time when the availability slot begins - name: to_time description: End time of an available slot or time period when availability concludes + desc_done: true - table: tabBOM description: '' fields: @@ -2708,6 +2810,7 @@ tables: join_hint: table: tabBOM 'on': amended_from = tabBOM.name + desc_done: true - table: tabBOM Creator description: '' fields: @@ -2817,6 +2920,7 @@ tables: join_hint: table: tabBOM Creator 'on': amended_from = tabBOM Creator.name + desc_done: true - table: tabBOM Creator Item description: '' fields: @@ -2905,6 +3009,7 @@ tables: - name: instruction description: Manufacturing or assembly instructions specific to this BOM item for production guidance. + desc_done: true - table: tabBOM Explosion Item description: '' fields: @@ -2962,6 +3067,7 @@ tables: description: Whether this BOM item is procured from an external supplier rather than manufactured in-house, used to distinguish purchased components from manufactured subassemblies. + desc_done: true - table: tabBOM Item description: '' fields: @@ -3054,15 +3160,16 @@ tables: - name: sourced_by_supplier description: Indicates whether this BOM item is procured from an external supplier rather than manufactured internally + desc_done: true - table: tabBOM Operation description: '' fields: - name: name - description: '' + description: name - name: sequence_id - description: '' + description: Order in which this operation is performed in the manufacturing process - name: operation - description: '' + description: The specific manufacturing task or work step to be performed join_hint: table: tabOperation 'on': operation = tabOperation.name @@ -3113,6 +3220,7 @@ tables: - name: description description: Detailed explanation or notes about what work is performed in this manufacturing operation step. + desc_done: true - table: tabBOM Scrap Item description: '' fields: @@ -3145,15 +3253,19 @@ tables: - name: base_amount description: Total value of the scrap item in the company's base currency, calculated from quantity and rate. + desc_done: true - table: tabBOM Update Batch description: '' fields: - name: name - description: '' + description: Unique identifier for the BOM update batch record, used when tracking + or referencing specific batch update operations. - name: level - description: '' + description: Indicates the BOM hierarchy depth or processing stage of the batch, + used when filtering updates by structural level or priority. - name: batch_no - description: '' + description: Sequential or generated batch number for grouping related BOM updates + together, used when querying or reporting on specific update batches. - name: boms_updated description: Number of bill of materials records that were modified or refreshed in this batch update operation. @@ -3163,6 +3275,7 @@ tables: options: - Pending - Completed + desc_done: true - table: tabBOM Update Log description: BOM Update Tool Log with job status maintained fields: @@ -3213,6 +3326,7 @@ tables: join_hint: table: tabBOM Update Log 'on': amended_from = tabBOM Update Log.name + desc_done: true - table: tabBOM Update Tool description: 'Replace a particular BOM in all other BOMs where it is used. It will replace the old BOM link, update cost and regenerate "BOM Explosion Item" table @@ -3234,6 +3348,7 @@ tables: join_hint: table: tabBOM 'on': new_bom = tabBOM.name + desc_done: true - table: tabBOM Website Item description: '' fields: @@ -3253,18 +3368,22 @@ tables: materials. - name: qty description: Quantity of the website item required in the bill of materials. + desc_done: true - table: tabBOM Website Operation description: '' fields: - name: name - description: '' + description: Unique identifier for the BOM website operation record, used when + referencing specific manufacturing operations in bills of materials. - name: operation - description: '' + description: Defines the manufacturing operation or process step to be performed, + used when querying production workflows and routing sequences. join_hint: table: tabOperation 'on': operation = tabOperation.name - name: workstation - description: '' + description: Specifies the workstation or work center where the operation is executed, + used when analyzing capacity, scheduling, or location-specific production activities. join_hint: table: tabWorkstation 'on': workstation = tabWorkstation.name @@ -3274,15 +3393,19 @@ tables: - name: thumbnail description: Image preview or icon representing this website operation for visual identification in the BOM. + desc_done: true - table: tabBank description: '' fields: - name: name - description: '' + description: Unique identifier or code for the bank account used to distinguish + between multiple company bank accounts in transactions and reconciliations. - name: bank_name - description: '' + description: Official name of the financial institution where the account is held, + used when filtering or reporting on transactions by specific banks. - name: swift_number - description: '' + description: International bank identifier code used for cross-border payments, + wire transfers, and validating international banking relationships. - name: website description: Bank's official website URL for reference or online banking access - name: bank_transaction_mapping @@ -3291,311 +3414,399 @@ tables: - name: plaid_access_token description: Authentication token for connecting to bank accounts through Plaid API integration + desc_done: true - table: tabBank Account description: '' fields: - name: name - description: '' + description: Unique identifier for the bank account record used when referencing + specific bank accounts in transactions or reports. - name: account_name - description: '' + description: Display name of the bank account used when users search for or filter + by specific bank accounts in financial queries. - name: account - description: '' + description: Link to the chart of accounts GL account used when reconciling bank + transactions to the general ledger or analyzing cash positions. join_hint: table: tabAccount 'on': account = tabAccount.name - name: bank - description: '' + description: The financial institution where the account is held, used when filtering + or searching accounts by banking provider. join_hint: table: tabBank 'on': bank = tabBank.name - name: account_type - description: '' + description: The primary classification of the bank account such as checking, + savings, or credit, used to distinguish broad account categories. join_hint: table: tabBank Account Type 'on': account_type = tabBank Account Type.name - name: account_subtype - description: '' + description: The specific subcategory within the account type providing more granular + classification, used when the main account type needs further refinement. join_hint: table: tabBank Account Subtype 'on': account_subtype = tabBank Account Subtype.name - name: disabled - description: '' + description: Whether the bank account is inactive and no longer available for + transactions or selection - name: is_default - description: '' + description: Whether this bank account is automatically selected as the primary + account for payments and receipts - name: is_company_account - description: '' + description: Whether the bank account belongs to the company itself rather than + a customer, supplier, or employee - name: company - description: '' + description: The company that owns or operates this bank account. join_hint: table: tabCompany 'on': company = tabCompany.name - name: party_type - description: '' + description: The type of entity linked to this bank account, such as Customer, + Supplier, or Employee. join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: party - description: '' + description: The specific entity (customer, supplier, employee, etc.) associated + with this bank account. - name: iban - description: '' + description: International Bank Account Number for cross-border payments and international + banking transactions - name: branch_code - description: '' + description: Bank branch identifier for routing domestic transactions to specific + branch locations - name: bank_account_no - description: '' + description: Local bank account number for domestic banking operations and internal + account identification - name: integration_id - description: '' + description: Identifier linking this bank account to an external banking system + or financial institution integration. - name: last_integration_date - description: '' + description: Most recent date when bank account data was synchronized or updated + from the connected external system. - name: mask - description: '' + description: Partially hidden or obscured bank account number showing only last + few digits for security purposes. + desc_done: true - table: tabBank Account Subtype description: '' fields: - name: name - description: '' + description: Name of the bank account subtype for display and identification purposes - name: account_subtype - description: '' + description: Specific classification or category of the bank account within its + broader account type + desc_done: true - table: tabBank Account Type description: '' fields: - name: name - description: '' + description: Name or label identifying the bank account type for selection and + reference - name: account_type - description: '' + description: Classification of the bank account such as savings, checking, or + current account + desc_done: true - table: tabBank Clearance description: '' fields: - name: name - description: '' + description: Unique identifier or reference name for the bank clearance transaction + record - name: account - description: '' + description: Bank account being reconciled or cleared against bank statements join_hint: table: tabAccount 'on': account = tabAccount.name - name: account_currency - description: '' + description: Currency denomination of the bank account involved in the clearance join_hint: table: tabCurrency 'on': account_currency = tabCurrency.name - name: from_date - description: '' + description: Start date of the bank clearance period for reconciling transactions. - name: to_date - description: '' + description: End date of the bank clearance period for reconciling transactions. - name: bank_account - description: '' + description: Specific bank account being reconciled or cleared in this clearance + record. join_hint: table: tabBank Account 'on': bank_account = tabBank Account.name - name: include_reconciled_entries - description: '' + description: Whether to include bank transactions that have already been matched + and reconciled in the clearance view. - name: include_pos_transactions - description: '' + description: Whether to include point-of-sale transactions in the bank clearance + process. - name: payment_entries - description: '' + description: List of payment transaction records being reviewed for bank statement + matching and clearance. + desc_done: true - table: tabBank Clearance Detail description: '' fields: - name: name - description: '' + description: Unique identifier for the bank clearance detail record, used when + tracking specific clearance transactions or referencing individual line items + in reconciliation queries. - name: payment_document - description: '' + description: Links to the source payment document being cleared, used when investigating + which invoices, expense claims, or payment vouchers are included in bank reconciliation. join_hint: table: tabDocType 'on': payment_document = tabDocType.name - name: payment_entry - description: '' + description: References the payment entry transaction being reconciled, used when + matching bank statement lines to actual payment records or tracking clearance + status of outgoing payments. - name: against_account - description: '' + description: The account being reconciled or matched against in the bank clearance + transaction, such as the ledger account corresponding to the bank entry. - name: amount - description: '' + description: The monetary value of the transaction being cleared or reconciled + in the bank clearance process. - name: posting_date - description: '' + description: The date when the bank clearance transaction was recorded in the + accounting system. - name: cheque_number - description: '' + description: Identifies the specific cheque being cleared, used when tracking + or reconciling individual cheque transactions. - name: cheque_date - description: '' + description: Date the cheque was issued or written, used when searching for cheques + by their original issuance date rather than when they cleared. - name: clearance_date - description: '' + description: Date the cheque was actually cleared by the bank, used when reconciling + bank statements or finding when funds were actually debited. + desc_done: true - table: tabBank Guarantee description: '' fields: - name: name - description: '' + description: Unique identifier or number assigned to the bank guarantee document - name: bg_type - description: '' + description: Category of bank guarantee such as performance guarantee, bid bond, + advance payment guarantee, or financial guarantee options: - Receiving - Providing - name: reference_doctype - description: '' + description: Type of source document linked to this bank guarantee such as Sales + Order, Purchase Order, or Project join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_docname - description: '' + description: The document ID or name of the transaction (like sales order, purchase + order, or contract) that this bank guarantee secures or relates to. - name: customer - description: '' + description: The customer for whom this bank guarantee is issued, typically when + the company provides a performance or payment guarantee to a client. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: supplier - description: '' + description: The supplier who issued this bank guarantee to the company, typically + when a vendor provides a guarantee for their performance or advance payment. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: project - description: '' + description: The project for which the bank guarantee is issued or associated + with. join_hint: table: tabProject 'on': project = tabProject.name - name: amount - description: '' + description: The monetary value or sum of the bank guarantee. - name: start_date - description: '' + description: The date when the bank guarantee becomes effective or valid. - name: validity - description: '' + description: Duration period or number of days the bank guarantee remains valid + from its start date. - name: end_date - description: '' + description: Expiration date when the bank guarantee terminates and is no longer + enforceable. - name: bank - description: '' + description: Financial institution that issued or underwrites the bank guarantee. join_hint: table: tabBank 'on': bank = tabBank.name - name: bank_account - description: '' + description: The bank account from which the bank guarantee is issued or secured, + used when identifying the guaranteeing bank relationship. join_hint: table: tabBank Account 'on': bank_account = tabBank Account.name - name: account - description: '' + description: The general ledger account for recording bank guarantee transactions + and liabilities in financial statements. join_hint: table: tabAccount 'on': account = tabAccount.name - name: bank_account_no - description: '' + description: The specific account number at the bank associated with the guarantee, + used when referencing exact banking details or account identifiers. - name: iban - description: '' + description: International Bank Account Number for the bank guarantee account + used in cross-border transactions and international banking operations. - name: branch_code - description: '' + description: Specific bank branch identifier where the bank guarantee was issued + or is maintained. - name: swift_number - description: '' + description: Bank Identifier Code (BIC/SWIFT) for international wire transfers + and identifying the financial institution in the bank guarantee. - name: more_information - description: '' + description: Additional notes or details about the bank guarantee terms, conditions, + or special instructions. - name: bank_guarantee_number - description: '' + description: Unique identifier assigned by the bank to this specific guarantee + instrument. - name: name_of_beneficiary - description: '' + description: Party or entity entitled to claim payment under the bank guarantee. - name: margin_money - description: '' + description: Amount of collateral or security deposit provided to the bank for + issuing the bank guarantee. - name: charges - description: '' + description: Fees or commission charged by the bank for issuing and maintaining + the bank guarantee. - name: fixed_deposit_number - description: '' + description: Reference number of the fixed deposit pledged as security for the + bank guarantee. - name: amended_from - description: '' + description: Links to the original bank guarantee document that this amended version + replaces or modifies. join_hint: table: tabBank Guarantee 'on': amended_from = tabBank Guarantee.name + desc_done: true - table: tabBank Reconciliation Tool description: '' fields: - name: name - description: '' + description: Unique identifier or label for this specific bank reconciliation + tool instance - name: company - description: '' + description: Company entity for which this bank reconciliation is being performed join_hint: table: tabCompany 'on': company = tabCompany.name - name: bank_account - description: '' + description: Specific bank account being reconciled against internal records join_hint: table: tabBank Account 'on': bank_account = tabBank Account.name - name: bank_statement_from_date - description: '' + description: Start date of the bank statement period being reconciled against + company records. - name: bank_statement_to_date - description: '' + description: End date of the bank statement period being reconciled against company + records. - name: from_reference_date - description: '' + description: Starting reference date for filtering or comparing reconciliation + entries, distinct from the bank statement period dates. - name: to_reference_date - description: '' + description: End date for filtering bank transactions or reconciliation entries + within a specific date range. - name: filter_by_reference_date - description: '' + description: Indicates whether to apply date-based filtering to bank reconciliation + records using reference dates. - name: account_currency - description: '' + description: Currency of the bank account being reconciled, used when matching + transactions or checking currency-specific balances. join_hint: table: tabCurrency 'on': account_currency = tabCurrency.name - name: account_opening_balance - description: '' + description: Starting balance of the bank account at the beginning of the reconciliation + period. - name: bank_statement_closing_balance - description: '' + description: Ending balance shown on the bank statement for the reconciliation + period. + desc_done: true - table: tabBank Statement Import description: '' fields: - name: name - description: '' + description: Unique identifier or reference name for the bank statement import + transaction - name: company - description: '' + description: Company entity associated with this bank statement import join_hint: table: tabCompany 'on': company = tabCompany.name - name: bank_account - description: '' + description: Specific bank account from which the statement data was imported join_hint: table: tabBank Account 'on': bank_account = tabBank Account.name - name: bank - description: '' + description: The bank account from which the statement is being imported. join_hint: table: tabBank 'on': bank = tabBank.name - name: custom_delimiters - description: '' + description: User-defined separator characters used to parse imported bank statement + files when standard delimiters don't apply. - name: delimiter_options - description: '' + description: Available separator character choices (comma, tab, semicolon, etc.) + for parsing the imported bank statement file format. - name: google_sheets_url - description: '' + description: URL of the Google Sheets document containing bank transactions to + import into the system. - name: status - description: '' + description: Current processing state of the bank statement import (pending, completed, + failed, or in progress). options: - Pending - Success - Partial Success - Error - name: template_options - description: '' + description: Configuration settings or mapping rules that define how columns in + the import file correspond to transaction fields. - name: template_warnings - description: '' + description: Warnings or validation messages generated during bank statement import + template processing. - name: show_failed_logs - description: '' + description: Controls visibility of failed transaction logs during bank statement + import review. - name: reference_doctype - description: '' + description: The document type that imported bank statement transactions are linked + to or reconciled against. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: import_type - description: '' + description: Specifies the format or method of the bank statement being imported + (e.g., CSV, OFX, manual entry). options: - Insert New Records - Update Existing Records - name: submit_after_import - description: '' + description: Indicates whether the imported bank statement should be automatically + submitted for processing after import completion. - name: mute_emails - description: '' + description: Controls whether email notifications are suppressed during or after + the bank statement import process. + desc_done: true - table: tabBank Transaction description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the bank transaction - name: naming_series - description: '' + description: Prefix pattern used to auto-generate transaction names or reference + numbers options: - ACC-BTN-.YYYY.- - name: date - description: '' + description: Date when the bank transaction occurred or was recorded - name: status - description: '' + description: Current state of the bank transaction such as pending, cleared, reconciled, + or cancelled. options: - Pending - Settled @@ -3603,783 +3814,994 @@ tables: - Reconciled - Cancelled - name: bank_account - description: '' + description: The specific bank account where this transaction occurred or was + recorded. join_hint: table: tabBank Account 'on': bank_account = tabBank Account.name - name: company - description: '' + description: The company entity that owns the bank account and to which this transaction + belongs. join_hint: table: tabCompany 'on': company = tabCompany.name - name: amended_from - description: '' + description: References the original bank transaction that was corrected or modified + by this transaction. join_hint: table: tabBank Transaction 'on': amended_from = tabBank Transaction.name - name: deposit - description: '' + description: Amount of money added to the bank account in this transaction. - name: withdrawal - description: '' + description: Amount of money removed from the bank account in this transaction. - name: currency - description: '' + description: Currency code for the transaction amount, used when filtering or + analyzing transactions by monetary denomination. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: description - description: '' + description: Textual details or memo about the transaction purpose or nature, + used when searching for specific transaction types or vendors. - name: reference_number - description: '' + description: Unique identifier or check number for the transaction, used when + looking up specific transactions by their reference code. - name: transaction_id - description: '' + description: Unique identifier for referencing a specific bank transaction in + queries about transaction details, reconciliation, or audit trails. - name: transaction_type - description: '' + description: Category of bank transaction such as deposit, withdrawal, transfer, + or fee, used when filtering or analyzing transactions by their nature. - name: payment_entries - description: '' + description: Links to associated payment records that were processed through this + bank transaction, relevant for matching payments to bank activity or reconciliation. - name: allocated_amount - description: '' + description: Amount from the bank transaction that has been matched or reconciled + to invoices, payments, or other accounting documents. - name: unallocated_amount - description: '' + description: Amount from the bank transaction that remains unmatched and needs + to be reconciled or assigned to accounting entries. - name: party_type - description: '' + description: Type of entity involved in the transaction such as Customer, Supplier, + Employee, or Shareholder. join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: party - description: '' + description: Internal party (customer/supplier) linked to this transaction when + matched to an invoice or payment. - name: bank_party_name - description: '' + description: External party name as it appears on the bank statement from the + bank's records. - name: bank_party_account_number - description: '' + description: External party's bank account number as shown on the bank statement. - name: bank_party_iban - description: '' + description: International Bank Account Number of the counterparty involved in + the transaction, used when searching for transactions by recipient or sender + account number. + desc_done: true - table: tabBank Transaction Mapping description: '' fields: - name: name - description: '' + description: Unique identifier for the mapping configuration between bank transaction + fields and import file columns. - name: bank_transaction_field - description: '' + description: Target field in the bank transaction record where imported data will + be mapped. - name: file_field - description: '' + description: Source column name from the imported file that provides data for + the bank transaction field. + desc_done: true - table: tabBank Transaction Payments description: '' fields: - name: name - description: '' + description: Unique identifier for the bank transaction payment record, used when + tracking specific payment reconciliation entries or referencing individual payment + allocations. - name: payment_document - description: '' + description: Links to the source document being paid (invoice, expense claim, + journal entry), used when identifying which receivable or payable is being settled + by this bank transaction. join_hint: table: tabDocType 'on': payment_document = tabDocType.name - name: payment_entry - description: '' + description: References the formal payment entry record created in the system, + used when tracing bank transactions back to their corresponding payment vouchers + or reconciling payments with accounting entries. - name: allocated_amount - description: '' + description: Amount from the bank transaction that has been allocated or matched + to this specific payment entry. - name: clearance_date - description: '' + description: Date when the bank transaction payment was cleared or reconciled + in the banking system. + desc_done: true - table: tabBatch description: '' fields: - name: name - description: '' + description: Unique identifier or code for the batch - name: disabled - description: '' + description: Whether the batch is inactive and cannot be used in transactions - name: use_batchwise_valuation - description: '' + description: Whether inventory valuation is calculated separately for this specific + batch rather than aggregated - name: batch_id - description: '' + description: Unique identifier for a specific production or inventory batch used + when tracking lot numbers or batch-specific information. - name: item - description: '' + description: Item code or SKU associated with this batch used when querying which + product a batch contains. join_hint: table: tabItem 'on': item = tabItem.name - name: item_name - description: '' + description: Human-readable product name for the item in this batch used when + searching batches by product description rather than code. - name: parent_batch - description: '' + description: Identifies the source or originating batch from which this batch + was derived or split. join_hint: table: tabBatch 'on': parent_batch = tabBatch.name - name: manufacturing_date - description: '' + description: The date when the batch was produced or manufactured. - name: batch_qty - description: '' + description: The quantity of items or units contained in this batch. - name: stock_uom - description: '' + description: Unit of measurement for inventory quantities in this batch, relevant + when users ask about batch quantities, stock levels, or unit conversions. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: expiry_date - description: '' + description: Date when the batch expires or becomes unusable, relevant when users + ask about expired inventory, shelf life, or batches nearing expiration. - name: supplier - description: '' + description: Vendor or supplier who provided this batch, relevant when users ask + about batch sourcing, supplier-specific inventory, or tracing product origins. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: reference_doctype - description: '' + description: Type of document this batch is linked to, such as Purchase Receipt + or Stock Entry, used when tracing batch origin or transactions. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_name - description: '' + description: Specific document ID this batch was created from, used when finding + which receipt or entry generated a particular batch. - name: description - description: '' + description: Free-text notes or details about the batch characteristics, quality, + or special handling instructions. - name: qty_to_produce - description: '' + description: Target quantity planned for manufacturing in this batch. - name: produced_qty - description: '' + description: Actual quantity completed or manufactured from this batch. + desc_done: true - table: tabBin description: '' fields: - name: name - description: '' + description: name - name: item_code - description: '' + description: The product or material identifier stored in this bin location join_hint: table: tabItem 'on': item_code = tabItem.name - name: warehouse - description: '' + description: The warehouse facility where this bin is physically located join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: actual_qty - description: '' + description: Current physical quantity of items available in the bin for inventory + checks and stock availability queries - name: planned_qty - description: '' + description: Quantity expected to be in the bin after pending stock entries or + transfers are completed - name: indented_qty - description: '' + description: Quantity requested or reserved through material requests that will + reduce available stock - name: ordered_qty - description: '' + description: Quantity of items on purchase orders not yet received into this bin. - name: projected_qty - description: '' + description: Future available quantity accounting for current stock plus incoming + orders minus reservations and commitments. - name: reserved_qty - description: '' + description: Quantity allocated or reserved for specific sales orders, work orders, + or customer commitments that cannot be used elsewhere. - name: reserved_qty_for_production - description: '' + description: Quantity allocated for manufacturing orders or work orders that cannot + be used for other purposes. - name: reserved_qty_for_sub_contract - description: '' + description: Quantity set aside for subcontracting operations where external vendors + perform manufacturing work. - name: reserved_qty_for_production_plan - description: '' + description: Quantity reserved for planned production activities that have not + yet been converted to firm manufacturing orders. - name: reserved_stock - description: '' + description: Quantity of stock allocated or committed for pending orders, sales, + or production that cannot be used for new transactions. - name: stock_uom - description: '' + description: Unit of measurement used for tracking inventory quantities in this + bin, such as pieces, kilograms, or liters. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: valuation_rate - description: '' + description: Per-unit cost or value assigned to inventory in this bin for accounting + and financial reporting purposes. - name: stock_value - description: '' + description: Monetary value of inventory currently stored in this bin location, + used when analyzing warehouse asset worth or bin-level inventory valuation. + desc_done: true - table: tabBisect Accounting Statements description: '' fields: - name: name - description: '' + description: Unique identifier or label for the specific bisect accounting statement + record - name: company - description: '' + description: Company entity to which this bisect accounting statement belongs join_hint: table: tabCompany 'on': company = tabCompany.name - name: from_date - description: '' + description: Starting date of the accounting period covered by this bisect statement - name: to_date - description: '' + description: End date for the accounting statement period or bisection range being + analyzed. - name: algorithm - description: '' + description: Bisection method or calculation approach used to reconcile or analyze + accounting discrepancies. options: - BFS - DFS - name: current_node - description: '' + description: Current position or iteration point in the bisection process for + identifying accounting issues. join_hint: table: tabBisect Nodes 'on': current_node = tabBisect Nodes.name - name: current_from_date - description: '' + description: Start date of the current accounting period being analyzed or compared + in the statement. - name: current_to_date - description: '' + description: End date of the current accounting period being analyzed or compared + in the statement. - name: p_l_summary - description: '' + description: Profit and loss summary data or totals for the accounting statement + period. - name: b_s_summary - description: '' + description: Balance sheet summary or aggregated financial statement data for + high-level financial position analysis. - name: difference - description: '' + description: Variance or discrepancy amount between compared accounting values, + such as budget vs actual or period-over-period changes. + desc_done: true - table: tabBisect Nodes description: '' fields: - name: name - description: '' + description: name - name: root - description: '' + description: Identifies the top-level parent node in a hierarchical bisect structure join_hint: table: tabBisect Nodes 'on': root = tabBisect Nodes.name - name: left_child - description: '' + description: References the left branch node in a binary tree traversal or bisection + hierarchy join_hint: table: tabBisect Nodes 'on': left_child = tabBisect Nodes.name - name: right_child - description: '' + description: References the right branch node in a hierarchical bisect structure + for navigating organizational or data tree relationships. join_hint: table: tabBisect Nodes 'on': right_child = tabBisect Nodes.name - name: period_from_date - description: '' + description: Start date of the time period or date range covered by this bisect + node. - name: period_to_date - description: '' + description: End date of the time period or date range covered by this bisect + node. - name: difference - description: '' + description: Variance or delta between two compared values in the bisect analysis. - name: balance_sheet_summary - description: '' + description: Aggregated balance sheet data used when analyzing asset, liability, + or equity discrepancies. - name: profit_loss_summary - description: '' + description: Aggregated income statement data used when analyzing revenue, expense, + or net income discrepancies. - name: generated - description: '' + description: Indicates whether the bisect node was automatically created by the + system or manually defined by a user. + desc_done: true - table: tabBlanket Order description: '' fields: - name: name - description: '' + description: Unique identifier for the blanket order, used when searching for + or referencing a specific blanket order agreement - name: naming_series - description: '' + description: Prefix pattern that determines how blanket order names are automatically + formatted and numbered options: - MFG-BLR-.YYYY.- - name: blanket_order_type - description: '' + description: Indicates whether the blanket order is for purchasing from suppliers + or selling to customers options: - Selling - Purchasing - name: customer - description: '' + description: Customer account identifier for blanket orders sold to a customer. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: customer_name - description: '' + description: Customer's display name for blanket orders sold to a customer. - name: supplier - description: '' + description: Supplier account identifier for blanket orders purchased from a supplier. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: supplier_name - description: '' + description: Vendor or supplier providing goods or services under this blanket + purchase agreement. - name: order_no - description: '' + description: Unique identifier for the blanket order used to reference or track + the agreement. - name: order_date - description: '' + description: Date when the blanket order agreement was created or established. - name: from_date - description: '' + description: Start date of the blanket order validity period for querying when + coverage begins. - name: to_date - description: '' + description: End date of the blanket order validity period for querying when coverage + expires. - name: company - description: '' + description: Company entity associated with the blanket order for filtering orders + by organizational unit. join_hint: table: tabCompany 'on': company = tabCompany.name - name: items - description: '' + description: Child table containing the individual products, quantities, and pricing + details included in the blanket order agreement. - name: amended_from - description: '' + description: References the original blanket order document that this current + version amends or replaces. join_hint: table: tabBlanket Order 'on': amended_from = tabBlanket Order.name - name: tc_name - description: '' + description: The terms and conditions template applied to this blanket order for + contractual agreements. join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Payment terms negotiated for the blanket order, such as net 30 or + payment on delivery. + desc_done: true - table: tabBlanket Order Item description: '' fields: - name: name - description: '' + description: Unique identifier for the blanket order item record - name: item_code - description: '' + description: SKU or product code for the item on the blanket order join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Descriptive product name for the item on the blanket order - name: party_item_code - description: '' + description: The customer's or supplier's own product code or SKU for this blanket + order item, used when matching external item references. - name: qty - description: '' + description: The total quantity committed or agreed upon for this item in the + blanket order. - name: rate - description: '' + description: The unit price agreed upon for this blanket order item. - name: ordered_qty - description: '' + description: Quantity of items ordered under this blanket order line for matching + questions about total committed volumes or order quantities. - name: terms_and_conditions - description: '' + description: Legal terms, payment conditions, delivery requirements, or contractual + clauses governing this blanket order item for questions about agreement terms + or contract conditions. + desc_done: true - table: tabBlock Module description: '' fields: - name: name - description: '' + description: Name or title of the block - name: module - description: '' + description: Module or application that the block belongs to or is associated + with + desc_done: true - table: tabBlog Category description: '' fields: - name: name - description: '' + description: Internal identifier or slug used to reference the blog category in + queries and filtering operations. - name: published - description: '' + description: Indicates whether the blog category is active and visible to users, + used to filter live versus draft categories. - name: title - description: '' + description: Display name of the blog category shown to end users, used when searching + or grouping blog content by topic. - name: description - description: '' + description: Detailed explanation or summary text of what the blog category covers + or represents. - name: route - description: '' + description: URL path or slug used to access the blog category page on the website. + desc_done: true - table: tabBlog Post description: '' fields: - name: name - description: '' + description: Unique identifier for the blog post record used when referencing + or filtering specific posts. - name: title - description: '' + description: The headline or subject of the blog post used when searching for + content topics or analyzing post themes. - name: blog_category - description: '' + description: Classification grouping for the blog post used when filtering, reporting, + or analyzing content by topic area. join_hint: table: tabBlog Category 'on': blog_category = tabBlog Category.name - name: blogger - description: '' + description: The author or writer who created the blog post. join_hint: table: tabBlogger 'on': blogger = tabBlogger.name - name: route - description: '' + description: The URL path or slug used to access the blog post on the website. - name: read_time - description: '' + description: The estimated time in minutes required to read the entire blog post. - name: published_on - description: '' + description: Date when the blog post was published or went live to readers. - name: published - description: '' + description: Whether the blog post is currently published and visible to readers, + as opposed to draft or unpublished status. - name: featured - description: '' + description: Whether the blog post is marked as featured or highlighted for prominent + display. - name: hide_cta - description: '' + description: Whether the call-to-action button or section is hidden on the blog + post. - name: enable_email_notification - description: '' + description: Whether subscribers receive email notifications when this blog post + is published or updated. - name: disable_comments - description: '' + description: Whether the comment section is turned off for this blog post. - name: disable_likes - description: '' + description: Whether the blog post allows readers to like or react to it, relevant + when filtering posts by engagement features enabled or disabled. - name: blog_intro - description: '' + description: The introductory or summary text of the blog post, used when searching + for preview content or excerpt information. - name: content_type - description: '' + description: The format or category of the blog post content such as article, + video, tutorial, or announcement, used when filtering posts by their media or + structural type. options: - Markdown - Rich Text - HTML - name: content - description: '' + description: HTML-formatted blog post body content for display and rendering purposes. - name: content_md - description: '' + description: Markdown source of the blog post content for editing and version + control. - name: email_sent - description: '' + description: Whether notification emails have been sent to subscribers about this + blog post. - name: meta_title - description: '' + description: SEO page title displayed in browser tabs and search engine results + for the blog post. - name: meta_description - description: '' + description: SEO summary text displayed in search engine results snippets below + the title. + desc_done: true - table: tabBlog Settings description: Settings to control blog categories and interactions like comments and likes fields: - name: name - description: '' + description: Unique identifier for the blog settings configuration - name: blog_title - description: '' + description: Main title displayed at the top of the blog or blog homepage - name: blog_introduction - description: '' + description: Introductory text or welcome message shown on the blog landing page - name: enable_social_sharing - description: '' + description: Controls whether blog posts can be shared on social media platforms. - name: allow_guest_to_comment - description: '' + description: Controls whether users without accounts can post comments on blog + posts. - name: browse_by_category - description: '' + description: Controls whether blog visitors can filter or navigate posts by category. - name: show_cta_in_blog - description: '' + description: Controls whether call-to-action elements are displayed within blog + posts. - name: title - description: '' + description: Main title or heading displayed for the blog. - name: subtitle - description: '' + description: Secondary descriptive text shown below the main blog title. - name: cta_label - description: '' + description: Text displayed on the blog call-to-action button that prompts reader + engagement. - name: cta_url - description: '' + description: Destination link where users are directed when clicking the blog + call-to-action button. - name: like_limit - description: '' + description: Maximum number of likes allowed per user or post on blog content. - name: comment_limit - description: '' + description: Maximum number of comments allowed per blog post or within a specific + timeframe + desc_done: true - table: tabBlogger description: User ID of a Blogger fields: - name: name - description: '' + description: Full name or title of the blogger - name: disabled - description: '' + description: Whether the blogger account is inactive or deactivated - name: short_name - description: '' + description: Abbreviated or display name of the blogger, distinct from the full + name - name: full_name - description: '' + description: The blogger's complete display name used when searching for or identifying + specific bloggers by their real name. - name: user - description: '' + description: The blogger's username or handle used for login, mentions, and unique + identification in the system. join_hint: table: tabUser 'on': user = tabUser.name - name: bio - description: '' + description: The blogger's biographical description or profile summary containing + information about their background, interests, and expertise. + desc_done: true - table: tabBranch description: '' fields: - name: name - description: '' + description: Branch name or descriptive label for the location - name: branch - description: '' + description: Branch code or identifier used to reference the specific branch location + desc_done: true - table: tabBrand description: '' fields: - name: name - description: '' + description: Primary identifier for the brand record, used when searching for + or referencing a specific brand by its official name. - name: brand - description: '' + description: Brand code or alternate identifier, used when filtering or grouping + data by brand in sales, inventory, or product analysis. - name: description - description: '' + description: Detailed brand information or notes, used when users need context + about brand characteristics, positioning, or attributes beyond the name. - name: brand_defaults - description: '' + description: Default settings and configurations applied to this brand such as + pricing rules, tax settings, or operational parameters. + desc_done: true - table: tabBudget description: '' fields: - name: name - description: '' + description: Budget name or title identifying the specific budget record - name: naming_series - description: '' + description: Prefix pattern used to generate the budget identifier code options: - BUDGET-.YYYY.- - name: budget_against - description: '' + description: Entity type the budget is allocated for, such as Cost Center or Project options: - Cost Center - Project - name: company - description: '' + description: Identifies which company entity the budget belongs to in multi-company + environments. join_hint: table: tabCompany 'on': company = tabCompany.name - name: cost_center - description: '' + description: Identifies the department or organizational unit responsible for + the budget allocation. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Links the budget to a specific project for project-based budget tracking + and analysis. join_hint: table: tabProject 'on': project = tabProject.name - name: fiscal_year - description: '' + description: The fiscal year period this budget applies to, used when filtering + or comparing budgets across different years. join_hint: table: tabFiscal Year 'on': fiscal_year = tabFiscal Year.name - name: monthly_distribution - description: '' + description: Breakdown of budget amounts allocated across individual months within + the fiscal year. join_hint: table: tabMonthly Distribution 'on': monthly_distribution = tabMonthly Distribution.name - name: amended_from - description: '' + description: Reference to the original budget document that this budget revises + or replaces, used to track budget revision history. join_hint: table: tabBudget 'on': amended_from = tabBudget.name - name: applicable_on_material_request - description: '' + description: Whether this budget applies to and controls spending on material + requests. - name: action_if_annual_budget_exceeded_on_mr - description: '' + description: What happens when a material request would exceed the annual budget + limit (warn, stop, or ignore). options: - Stop - Warn - Ignore - name: action_if_accumulated_monthly_budget_exceeded_on_mr - description: '' + description: What happens when a material request would exceed the accumulated + monthly budget limit (warn, stop, or ignore). options: - Stop - Warn - Ignore - name: applicable_on_purchase_order - description: '' + description: Whether this budget applies to and controls purchase order transactions. - name: action_if_annual_budget_exceeded_on_po - description: '' + description: What happens when a purchase order would exceed the annual budget + limit (ignore, warn, or stop). options: - Stop - Warn - Ignore - name: action_if_accumulated_monthly_budget_exceeded_on_po - description: '' + description: What happens when a purchase order would exceed the cumulative monthly + budget limit (ignore, warn, or stop). options: - Stop - Warn - Ignore - name: applicable_on_booking_actual_expenses - description: '' + description: Whether this budget applies when recording actual expense transactions, + used to determine if budget controls activate during expense entry. - name: action_if_annual_budget_exceeded - description: '' + description: What happens when total spending exceeds the yearly budget limit, + such as blocking transactions, warning users, or allowing overruns. options: - Stop - Warn - Ignore - name: action_if_accumulated_monthly_budget_exceeded - description: '' + description: What happens when cumulative monthly spending exceeds the accumulated + monthly budget threshold, controlling whether transactions are stopped, warned, + or permitted. options: - Stop - Warn - Ignore - name: accounts - description: '' + description: Accounts or account codes associated with this budget entry for tracking + financial allocations by general ledger account + desc_done: true - table: tabBudget Account description: '' fields: - name: name - description: '' + description: Budget account name or label used to identify and search for specific + budget line items - name: account - description: '' + description: General ledger account code or identifier that this budget is allocated + to join_hint: table: tabAccount 'on': account = tabAccount.name - name: budget_amount - description: '' + description: Planned or allocated monetary amount for this budget account + desc_done: true - table: tabBulk Transaction Log Detail description: '' fields: - name: name - description: '' + description: Unique identifier for each bulk transaction log detail record, used + when tracking specific entries in bulk processing operations. - name: from_doctype - description: '' + description: Source document type that originated the bulk transaction, used when + filtering or analyzing which modules or forms generated bulk operations. join_hint: table: tabDocType 'on': from_doctype = tabDocType.name - name: transaction_name - description: '' + description: Descriptive name of the bulk transaction being logged, used when + searching for or reporting on specific bulk processing activities. - name: date - description: '' + description: Date when the bulk transaction was processed or logged. - name: time - description: '' + description: Time when the bulk transaction was processed or logged. - name: transaction_status - description: '' + description: Current status of the bulk transaction such as pending, completed, + failed, or in progress. - name: error_description - description: '' + description: Error message or failure reason when a bulk transaction operation + fails for this record. - name: to_doctype - description: '' + description: Target document type that this bulk transaction is creating or updating. join_hint: table: tabDocType 'on': to_doctype = tabDocType.name - name: retried - description: '' + description: Indicates whether a failed bulk transaction operation was retried + or reattempted. + desc_done: true - table: tabBulk Update description: '' fields: - name: name - description: '' + description: Unique identifier or label for the bulk update operation, used when + tracking or referencing specific mass data change activities. - name: document_type - description: '' + description: Specifies which ERP document or module (e.g., Sales Order, Purchase + Invoice) the bulk update targets, used when filtering update operations by entity + type. join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: field - description: '' + description: Identifies the specific data field or column being modified in the + bulk update, used when analyzing what attributes are being changed across multiple + records. - name: update_value - description: '' + description: New value to set for records during bulk update operation - name: condition - description: '' + description: Filter criteria determining which records will be updated in the + bulk operation - name: limit - description: '' + description: Maximum number of records to update in a single bulk operation + desc_done: true - table: tabBuying Settings description: '' fields: - name: name - description: '' + description: Unique identifier for the buying settings configuration record - name: supp_master_name - description: '' + description: Default naming series or template used when creating new supplier + master records options: - Supplier Name - Naming Series - Auto Name - name: supplier_group - description: '' + description: Default supplier group automatically assigned to new suppliers during + creation join_hint: table: tabSupplier Group 'on': supplier_group = tabSupplier Group.name - name: buying_price_list - description: '' + description: Default price list applied to purchase transactions and supplier + quotations. join_hint: table: tabPrice List 'on': buying_price_list = tabPrice List.name - name: maintain_same_rate_action - description: '' + description: Action taken when item rate changes between purchase orders and receipts + (warn, stop, or allow). options: - Stop - Warn - name: role_to_override_stop_action - description: '' + description: User role permitted to bypass stop actions in purchasing workflows + when validation rules are violated. join_hint: table: tabRole 'on': role_to_override_stop_action = tabRole.name - name: po_required - description: '' + description: Whether purchase orders must be created before receiving goods or + making purchases. options: - 'No' - 'Yes' - name: blanket_order_allowance - description: '' + description: Percentage or amount allowed for over-ordering against blanket purchase + orders. - name: pr_required - description: '' + description: Whether purchase requisitions must be approved before creating purchase + orders. options: - 'No' - 'Yes' - name: project_update_frequency - description: '' + description: How often project costs and progress are automatically updated from + purchase transactions options: - Each Transaction - Manual - name: set_landed_cost_based_on_purchase_invoice_rate - description: '' + description: Whether landed costs use the exchange rate from the purchase invoice + instead of the landed cost voucher rate - name: allow_zero_qty_in_supplier_quotation - description: '' + description: Whether supplier quotations can be created with zero quantity line + items - name: use_transaction_date_exchange_rate - description: '' + description: Apply currency exchange rate from the transaction date rather than + posting date for purchase documents. - name: allow_zero_qty_in_request_for_quotation - description: '' + description: Permit creating RFQ line items with zero quantity for price inquiry + purposes. - name: maintain_same_rate - description: '' + description: Keep the same item rate across multiple purchase transactions from + the same supplier. - name: allow_multiple_items - description: '' + description: Whether the system permits adding the same item multiple times in + a single purchase transaction. - name: bill_for_rejected_quantity_in_purchase_invoice - description: '' + description: Whether rejected quantities from quality inspection are included + in the purchase invoice billing amount. - name: set_valuation_rate_for_rejected_materials - description: '' + description: Whether rejected materials receive a specific inventory valuation + rate separate from accepted materials. - name: disable_last_purchase_rate - description: '' + description: Controls whether the last purchase rate is automatically populated + when creating new purchase transactions. - name: show_pay_button - description: '' + description: Determines if payment button appears on purchase documents for direct + payment processing. - name: allow_zero_qty_in_purchase_order - description: '' + description: Permits creation of purchase orders with zero quantity line items. - name: backflush_raw_materials_of_subcontract_based_on - description: '' + description: Determines the trigger event for automatically consuming raw materials + in subcontracting workflows, such as upon receipt or based on BOM. options: - BOM - Material Transferred for Subcontract - name: over_transfer_allowance - description: '' + description: Maximum percentage by which material transfers can exceed the ordered + quantity in purchasing and subcontracting transactions. - name: auto_create_subcontracting_order - description: '' + description: Controls whether subcontracting purchase orders are automatically + generated when subcontracted items are required. - name: auto_create_purchase_receipt - description: '' + description: Whether purchase receipts are automatically generated when purchase + orders are submitted or fulfilled - name: fixed_email - description: '' + description: Email address automatically used for all purchase-related communications + or notifications to suppliers join_hint: table: tabEmail Account 'on': fixed_email = tabEmail Account.name + desc_done: true - table: tabCRM Note description: '' fields: - name: name - description: '' + description: Short title or subject line of the CRM note - name: note - description: '' + description: Full text content or body of the CRM note - name: added_by - description: '' + description: User or employee who created or authored the CRM note join_hint: table: tabUser 'on': added_by = tabUser.name - name: added_on - description: '' + description: Date and time when the CRM note was created or first added to the + system + desc_done: true - table: tabCRM Settings description: Settings for Selling Module fields: - name: name - description: '' + description: name - name: campaign_naming_by - description: '' + description: Defines the convention or method used to automatically name campaigns + in the CRM system. options: - Campaign Name - Naming Series - name: allow_lead_duplication_based_on_emails - description: '' + description: Controls whether multiple lead records can exist with the same email + address. - name: auto_creation_of_contact - description: '' + description: Whether contacts are automatically created from leads or other sources + in the CRM. - name: close_opportunity_after_days - description: '' + description: Number of days after which inactive opportunities are automatically + closed. - name: default_valid_till - description: '' + description: Default number of days a quotation or opportunity remains valid from + creation date. - name: carry_forward_communication_and_comments - description: '' + description: Controls whether communication history and comments from previous + interactions are automatically transferred to new CRM records or opportunities. - name: update_timestamp_on_new_communication - description: '' + description: Determines if the last modified timestamp is refreshed when new communication + entries are added to a CRM record. + desc_done: true - table: tabCalendar View description: '' fields: - name: name - description: '' + description: name - name: reference_doctype - description: '' + description: The document type (e.g., Event, Task, Leave Application) whose records + are displayed as calendar entries. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: subject_field - description: '' + description: The field from the reference document type that provides the title + or label shown for each calendar entry. - name: start_date_field - description: '' + description: When the calendar event or period begins, used to find events starting + on or after a specific date. - name: end_date_field - description: '' + description: When the calendar event or period ends, used to find events ending + on or before a specific date or to calculate duration. - name: all_day - description: '' + description: Whether the event spans the entire day without specific times, used + to distinguish full-day events from timed appointments. + desc_done: true - table: tabCall Log description: '' fields: - name: name - description: '' + description: Unique identifier or title of the call log entry - name: id - description: '' + description: System identifier for the specific call log record - name: from - description: '' + description: Phone number or contact name of the person who initiated the call - name: to - description: '' + description: Phone number or contact identifier that was called or received the + call - name: call_received_by - description: '' + description: Name or identifier of the person who answered or handled the incoming + call join_hint: table: tabEmployee 'on': call_received_by = tabEmployee.name - name: employee_user_id - description: '' + description: User ID of the employee associated with making or logging the call join_hint: table: tabUser 'on': employee_user_id = tabUser.name - name: medium - description: '' + description: Communication channel or method used for the call such as phone, + video conference, or VoIP platform - name: start_time - description: '' + description: When the call began or was initiated - name: end_time - description: '' + description: When the call concluded or was terminated - name: type - description: '' + description: category or classification of the call such as support, sales, complaint, + or inquiry options: - Incoming - Outgoing - name: customer - description: '' + description: the customer or account associated with this call join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: status - description: '' + description: current state of the call such as open, closed, pending, or resolved options: - Ringing - In Progress @@ -4390,216 +4812,286 @@ tables: - Queued - Canceled - name: duration - description: '' + description: Length of the call in time units, used when filtering or analyzing + calls by how long they lasted - name: recording_url - description: '' + description: Link to access the audio or video recording of the call - name: type_of_call - description: '' + description: Category or classification of the call such as inbound, outbound, + support, sales, or follow-up join_hint: table: tabTelephony Call Type 'on': type_of_call = tabTelephony Call Type.name - name: summary - description: '' + description: Brief overview or title of the call describing its main purpose or + outcome. - name: links - description: '' + description: Related records or documents connected to this call such as contacts, + accounts, cases, or opportunities. + desc_done: true - table: tabCampaign description: Keep Track of Sales Campaigns. Keep track of Leads, Quotations, Sales Order etc from Campaigns to gauge Return on Investment. fields: - name: name - description: '' + description: Unique identifier for the campaign record, used when referencing + a specific campaign by its system ID. - name: campaign_name - description: '' + description: The marketing or business name of the campaign, used when searching + for campaigns by their display title or promotional label. - name: naming_series - description: '' + description: The prefix pattern used to generate campaign identifiers, relevant + when filtering campaigns by their numbering scheme or organizational convention. options: - SAL-CAM-.YYYY.- - name: campaign_schedules - description: '' + description: Timing and frequency details for when the campaign runs or sends + communications. - name: description - description: '' + description: Detailed explanation of the campaign's purpose, goals, target audience, + or messaging strategy. + desc_done: true - table: tabCampaign Email Schedule description: '' fields: - name: name - description: '' + description: Unique identifier or label for the scheduled campaign email - name: email_template - description: '' + description: Template used for the email content in this campaign schedule join_hint: table: tabEmail Template 'on': email_template = tabEmail Template.name - name: send_after_days - description: '' + description: Number of days to wait before sending this campaign email + desc_done: true - table: tabCampaign Item description: '' fields: - name: name - description: '' + description: Name or identifier of the specific item, product, or service included + in the campaign - name: campaign - description: '' + description: Reference to the parent marketing campaign that this item belongs + to join_hint: table: tabCampaign 'on': campaign = tabCampaign.name + desc_done: true - table: tabCashier Closing description: '' fields: - name: name - description: '' + description: Unique identifier for the cashier closing transaction or shift closure + record - name: naming_series - description: '' + description: Prefix pattern used to auto-generate the cashier closing document + name options: - POS-CLO- - name: user - description: '' + description: Cashier or employee who performed the cash register closing join_hint: table: tabUser 'on': user = tabUser.name - name: date - description: '' + description: Date of the cashier closing event or shift reconciliation. - name: from_time - description: '' + description: Start time of the cashier shift or period being closed. - name: time - description: '' + description: End time when the cashier closing was completed or recorded. - name: expense - description: '' + description: Amount of cash paid out for expenses during the cashier shift or + closing period. - name: custody - description: '' + description: Cash amount held in custody or safekeeping, typically representing + funds set aside or reserved from the cashier drawer. - name: returns - description: '' + description: Total value of cash refunds or returns processed during the cashier + closing period. - name: outstanding_amount - description: '' + description: Amount remaining unpaid or uncollected at the time of cashier closing. - name: payments - description: '' + description: Total payments received or processed during the cashier shift being + closed. - name: net_amount - description: '' + description: Final calculated amount after reconciling payments and outstanding + balances for the cashier closing. - name: amended_from - description: '' + description: Links to the original cashier closing document that this amended + version replaces or corrects. join_hint: table: tabCashier Closing 'on': amended_from = tabCashier Closing.name + desc_done: true - table: tabCashier Closing Payments description: '' fields: - name: name - description: '' + description: Unique identifier for the cashier closing payment transaction record - name: mode_of_payment - description: '' + description: Payment method used for the transaction, queried when analyzing payment + type distribution or reconciling cash versus card payments join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: amount - description: '' + description: Monetary value of the payment, used when calculating total collections, + variances, or reconciling cashier closing balances + desc_done: true - table: tabChangAI Chat History description: '' fields: - name: name - description: '' + description: name - name: session_id - description: '' + description: session_id - name: timestamp - description: '' + description: timestamp - name: content - description: '' + description: The actual message text or conversation content exchanged in the + ChangAI chat, used when searching for specific dialogue, questions asked, or + responses given. + desc_done: true - table: tabChangAI Logs description: '' fields: - name: name - description: '' + description: Identifier or label for the AI interaction log entry, used when filtering + or referencing specific conversation sessions. - name: user_question - description: '' + description: Original question asked by the user, used when analyzing actual user + intent or troubleshooting query patterns. - name: rewritten_question - description: '' + description: AI-optimized version of the user's question, used when comparing + query transformations or evaluating AI interpretation accuracy. - name: schema_retrieved - description: '' + description: Database tables and columns identified as relevant to answer the + user's natural language question - name: sql_generated - description: '' + description: SQL query automatically created from the user's question to retrieve + the requested data - name: result - description: '' + description: Output data or error message returned after executing the generated + SQL query - name: formatted_result - description: '' + description: Final output or response generated by the AI system after processing + a request - name: error - description: '' + description: Error message or exception details when AI processing fails or encounters + issues - name: validation - description: '' + description: Validation status or checks performed on AI inputs or outputs to + ensure correctness - name: tries - description: '' + description: Number of attempts or retries made for a ChangAI operation or request + desc_done: true - table: tabChangAI Settings description: '' fields: - name: name - description: '' + description: Name or identifier for the AI configuration or integration being + set up - name: remote - description: '' + description: Whether the AI service is accessed remotely or runs locally - name: langsmith_api_key - description: '' + description: API authentication key for connecting to LangSmith service for AI + tracing and monitoring - name: langsmith_endpoint - description: '' + description: API endpoint URL for LangSmith integration to send tracing and monitoring + data - name: langsmith_tracing - description: '' + description: Toggle to enable or disable LangSmith tracing for AI model execution + monitoring - name: langsmith_project - description: '' + description: Project name or identifier in LangSmith where traces and logs are + organized - name: embedder - description: '' + description: Model or service used to convert text into vector embeddings for + semantic search and similarity matching. - name: qwen3_4b_instruct - description: '' + description: Specific Qwen 3 4B instruction-tuned language model configuration + or endpoint. - name: llm - description: '' + description: Large language model used for text generation, completion, and conversational + AI tasks. options: - QWEN3 - Gemini - name: dataset_repo - description: '' + description: Repository location or identifier where training or reference datasets + are stored for AI model operations - name: qwen25_15b - description: '' + description: Configuration or enablement flag for the Qwen 2.5 1.5B language model + integration - name: gemini_location - description: '' + description: Geographic region or endpoint location for Google Gemini API service + deployment - name: gemini_file_path - description: '' + description: Path to the Gemini AI configuration or credentials file used for + AI integration. - name: gemini_project_id - description: '' + description: Google Cloud project identifier for Gemini AI API authentication + and billing. - name: root_path - description: '' + description: Base directory path where ChangAI application files and resources + are located. - name: retain_memory - description: '' + description: Whether the AI retains conversation history and context across interactions - name: vite_api_url - description: '' + description: API endpoint URL for Vite integration or service connection - name: retriever_structure - description: '' + description: Configuration defining how the AI retrieves and organizes information + from data sources options: - single line - multi line - name: ollama_url - description: '' + description: URL endpoint for connecting to Ollama AI service for local language + model inference. - name: local_llm - description: '' + description: Indicates whether a local language model is enabled instead of cloud-based + AI services. - name: local_schema_retriever - description: '' + description: Indicates whether schema retrieval uses local processing instead + of external AI services. - name: local_entity_retriever - description: '' + description: Configuration for retrieving entities locally within ChangAI system + instead of from external sources. - name: prediction_url - description: '' + description: API endpoint URL where ChangAI sends requests to get AI model predictions + or inference results. - name: deploy_url - description: '' + description: API endpoint URL for deploying or publishing ChangAI models and configurations + to production environments. - name: llm_version_id - description: '' + description: Identifies which large language model version is configured for AI-powered + features and natural language processing tasks. - name: embedder_version_id - description: '' + description: Identifies which embedding model version is used for semantic search + and vector similarity operations. - name: api_token - description: '' + description: Authentication credential for connecting to external AI services + and APIs. - name: deploy - description: '' + description: Indicates whether ChangAI features are deployed or enabled for use + in the system. - name: entity_retriever - description: '' + description: Specifies the retrieval method or engine used to fetch entities for + ChangAI processing. - name: openai_api_key - description: '' + description: The API key credential used to authenticate and connect to OpenAI + services. - name: claude_api_key - description: '' + description: API key for authenticating with Claude AI service for natural language + processing features. - name: support_url - description: '' + description: URL endpoint where users can access customer support or help resources. - name: get_ticket_details_url - description: '' + description: URL endpoint for retrieving detailed information about support tickets + or service requests. - name: choose_module - description: '' + description: Specifies which AI module or functionality is selected for configuration + or activation. options: - Accounts - CRM @@ -4611,144 +5103,185 @@ tables: - Support - Assets - name: choose_file_size - description: '' + description: Defines the file size limit or threshold for AI processing operations. options: - '100' - '200' - '300' - '400' - 500+ + desc_done: true - table: tabChangelog Feed description: '' fields: - name: name - description: '' + description: Unique identifier for the changelog entry, used when filtering or + referencing specific system changes or updates. - name: title - description: '' + description: Human-readable description of the change, used when searching for + what was modified or released in the system. - name: app_name - description: '' + description: Application or module where the change occurred, used when filtering + changelog entries by specific ERP functional area or subsystem. - name: link - description: '' + description: URL or reference path to view the full details of the changelog entry + or related document - name: posting_timestamp - description: '' + description: Date and time when the changelog entry was created or published + desc_done: true - table: tabChart of Accounts Importer description: Import Chart of Accounts from a csv file fields: - name: name - description: '' + description: Name or identifier of the chart of accounts being imported - name: company - description: '' + description: Company entity to which the imported chart of accounts belongs join_hint: table: tabCompany 'on': company = tabCompany.name + desc_done: true - table: tabCheque Print Template description: '' fields: - name: name - description: '' + description: Unique identifier or title of the cheque print template used to distinguish + between different cheque layouts or formats - name: has_print_format - description: '' + description: Indicates whether this cheque template has an associated custom print + format configured for rendering the cheque - name: bank_name - description: '' + description: Name of the bank for which this cheque template is designed, used + when filtering or selecting templates for specific banking institutions - name: cheque_size - description: '' + description: Standard cheque paper size format used when printing cheques from + this template. options: - Regular - A4 - name: starting_position_from_top_edge - description: '' + description: Vertical offset distance from the top edge of the paper where cheque + printing begins. - name: cheque_width - description: '' + description: Horizontal width dimension of the cheque on the printed template. - name: cheque_height - description: '' + description: Physical height dimension of the printed cheque template for layout + and printing configuration. - name: is_account_payable - description: '' + description: Indicates whether this cheque template is designated for accounts + payable transactions versus other payment types. - name: acc_pay_dist_from_top_edge - description: '' + description: Vertical distance from the top edge of the cheque to where the accounts + payable amount should be printed. - name: acc_pay_dist_from_left_edge - description: '' + description: Distance in measurement units from the left edge of the cheque to + where the payee account number prints. - name: message_to_show - description: '' + description: Custom message or memo text that appears on the printed cheque. - name: date_dist_from_top_edge - description: '' + description: Distance in measurement units from the top edge of the cheque to + where the date prints. - name: date_dist_from_left_edge - description: '' + description: Horizontal position in millimeters or inches from the left edge of + the cheque where the date should be printed. - name: payer_name_from_top_edge - description: '' + description: Vertical position in millimeters or inches from the top edge of the + cheque where the payer name should be printed. - name: payer_name_from_left_edge - description: '' + description: Horizontal position in millimeters or inches from the left edge of + the cheque where the payer name should be printed. - name: amt_in_words_from_top_edge - description: '' + description: Vertical position measurement from the top of the cheque where the + amount in words should be printed. - name: amt_in_words_from_left_edge - description: '' + description: Horizontal position measurement from the left edge of the cheque + where the amount in words should be printed. - name: amt_in_word_width - description: '' + description: Maximum width allocated for printing the amount in words on the cheque. - name: amt_in_words_line_spacing - description: '' + description: Vertical spacing between lines when printing the cheque amount in + words across multiple lines. - name: amt_in_figures_from_top_edge - description: '' + description: Distance from the top edge of the cheque to where the numeric amount + is printed. - name: amt_in_figures_from_left_edge - description: '' + description: Distance from the left edge of the cheque to where the numeric amount + is printed. - name: acc_no_dist_from_top_edge - description: '' + description: Vertical spacing from top of cheque to where account number prints, + used when positioning account number on printed cheques. - name: acc_no_dist_from_left_edge - description: '' + description: Horizontal spacing from left edge of cheque to where account number + prints, used when positioning account number on printed cheques. - name: signatory_from_top_edge - description: '' + description: Vertical spacing from top of cheque to where signature line or signatory + name prints, used when positioning signature area on printed cheques. - name: signatory_from_left_edge - description: '' + description: Horizontal position measurement for placing the signatory signature + or name on a printed cheque, measured from the left edge of the cheque. + desc_done: true - table: tabClient Script description: Adds a custom client script to a DocType fields: - name: name - description: '' + description: Unique identifier or label for the client script used to reference + or search for specific scripts - name: dt - description: '' + description: Date and time when the client script was created or last modified join_hint: table: tabDocType 'on': dt = tabDocType.name - name: view - description: '' + description: Form view or UI context where the client script executes (e.g., desktop, + mobile, service portal) options: - List - Form - name: module - description: '' + description: Specifies which application module or functional area the client + script applies to, used when filtering or searching scripts by module context. join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: enabled - description: '' + description: Indicates whether the client script is currently active and will + execute, used when troubleshooting why scripts are or aren't running. - name: script - description: '' + description: Contains the actual JavaScript code that executes on the client side, + used when searching for specific logic, functions, or code patterns. + desc_done: true - table: tabClosed Document description: '' fields: - name: name - description: '' + description: Unique identifier or reference number of the closed document - name: document_type - description: '' + description: Category or type of the closed document such as invoice, purchase + order, or sales order join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: closed - description: '' + description: Indicates whether the document has been finalized and locked from + further modifications + desc_done: true - table: tabClosing Stock Balance description: '' fields: - name: name - description: '' + description: Unique identifier for the closing stock balance record - name: naming_series - description: '' + description: Prefix pattern used to generate the closing stock balance record + name options: - CBAL-.##### - name: company - description: '' + description: Company entity to which this closing stock balance belongs join_hint: table: tabCompany 'on': company = tabCompany.name - name: status - description: '' + description: Current state of the closing stock balance record, such as draft, + submitted, or cancelled. options: - Draft - Queued @@ -4757,77 +5290,98 @@ tables: - Failed - Canceled - name: from_date - description: '' + description: Start date of the period for which the closing stock balance is calculated. - name: to_date - description: '' + description: End date of the period for which the closing stock balance is calculated. - name: item_code - description: '' + description: Unique identifier for the specific product or material whose closing + stock balance is being tracked. join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_group - description: '' + description: Category or classification of the item, used when querying stock + balances by product type or family. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: include_uom - description: '' + description: Unit of measurement for the stock quantity, relevant when users need + to know whether stock is measured in pieces, kilograms, liters, or other units. join_hint: table: tabUOM 'on': include_uom = tabUOM.name - name: warehouse - description: '' + description: The specific warehouse location where the closing stock balance is + recorded. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: warehouse_type - description: '' + description: The category or classification of the warehouse (e.g., finished goods, + raw materials, transit) for the closing stock balance. join_hint: table: tabWarehouse Type 'on': warehouse_type = tabWarehouse Type.name - name: amended_from - description: '' + description: Reference to the previous closing stock balance document that this + record corrects or replaces. join_hint: table: tabClosing Stock Balance 'on': amended_from = tabClosing Stock Balance.name + desc_done: true - table: tabCode List description: '' fields: - name: name - description: '' + description: Unique identifier or code value used to reference specific entries + in standardized code lists for data validation and classification. - name: title - description: '' + description: Human-readable label or display name used when presenting code list + values in user interfaces and reports. - name: canonical_uri - description: '' + description: Standardized URI reference used to link code list entries to external + standards or master data definitions for data integration and compliance. - name: url - description: '' + description: Web address or link associated with the code list entry for external + reference or documentation - name: default_common_code - description: '' + description: Standard or fallback code value used when no specific code is assigned + or for cross-system mapping join_hint: table: tabCommon Code 'on': default_common_code = tabCommon Code.name - name: version - description: '' + description: Version number or identifier of the code list to track changes and + updates over time - name: publisher - description: '' + description: Name or identifier of the entity that publishes or maintains this + code list - name: publisher_id - description: '' + description: Unique identifier for the publisher entity associated with this code + list - name: description - description: '' + description: Textual explanation of what this code list represents or contains + desc_done: true - table: tabColor description: '' fields: - name: name - description: '' + description: Color name or label used to identify and reference the color in user + queries and selections - name: color - description: '' + description: Hexadecimal or RGB color code value representing the actual visual + color appearance + desc_done: true - table: tabComment description: '' fields: - name: name - description: '' + description: The identifier or title of the comment, used when searching for specific + comments or filtering comment records by name. - name: comment_type - description: '' + description: Categorizes comments by type (e.g., customer feedback, internal note, + issue), used when filtering or analyzing comments by their classification. options: - Comment - Like @@ -4849,57 +5403,73 @@ tables: - Relinked - Edit - name: comment_email - description: '' + description: The email address associated with the comment author or recipient, + used when tracking comment sources or routing notifications to specific users. - name: subject - description: '' + description: Topic or title of the comment describing what the comment is about - name: comment_by - description: '' + description: Person or user who wrote or authored the comment - name: published - description: '' + description: Whether the comment is visible or publicly available versus draft + or hidden - name: seen - description: '' + description: Whether the comment has been viewed or read by the relevant user - name: reference_doctype - description: '' + description: The type of document or record that this comment is attached to join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_name - description: '' + description: The specific document ID or record name that this comment is attached + to - name: reference_owner - description: '' + description: User or entity who created or owns the comment, used when filtering + comments by author or ownership - name: ip_address - description: '' + description: Network address of the device from which the comment was submitted, + used for security auditing or geographic tracking + desc_done: true - table: tabCommon Code description: '' fields: - name: name - description: '' + description: Common code name or label that users reference when asking about + specific code values or code meanings - name: code_list - description: '' + description: Identifier of the code list or code group that this common code belongs + to, used when filtering or searching codes by category or type join_hint: table: tabCode List 'on': code_list = tabCode List.name - name: canonical_uri - description: '' + description: Unique URI identifier for the common code used when integrating with + external systems or referencing codes across different platforms - name: title - description: '' + description: Short display name or label for the common code entry used in dropdowns + and lists. - name: common_code - description: '' + description: Unique identifier code value used to reference standardized lookup + values across the system. - name: description - description: '' + description: Detailed explanation of what the common code represents and when + it should be used. - name: additional_data - description: '' + description: Supplementary information or notes attached to the common code entry + for context or special instructions. - name: applies_to - description: '' + description: Entity type or module scope where this common code is valid or can + be used. + desc_done: true - table: tabCommunication description: Keeps track of all communications fields: - name: name - description: '' + description: Unique identifier or title of the communication record - name: subject - description: '' + description: Topic or main content summary of the communication - name: communication_medium - description: '' + description: Channel or method used for the communication such as email, phone, + meeting, or chat options: - Email - Chat @@ -4910,17 +5480,20 @@ tables: - Visit - Other - name: sender - description: '' + description: Person or entity who originated and sent the communication - name: recipients - description: '' + description: Primary addressees intended to receive and act on the communication - name: cc - description: '' + description: Secondary recipients copied for informational awareness without direct + action expected - name: bcc - description: '' + description: Email addresses included as blind carbon copy recipients on the communication - name: phone_no - description: '' + description: Phone number associated with the communication when sent via SMS + or phone call - name: delivery_status - description: '' + description: Current delivery state of the communication indicating whether it + was successfully sent, failed, or is pending options: - Sent - Bounced @@ -4937,11 +5510,12 @@ tables: - Read - Scheduled - name: content - description: '' + description: Full HTML or rich-formatted message body including markup and styling - name: text_content - description: '' + description: Plain text version of the message body without HTML formatting or + markup - name: communication_type - description: '' + description: Category of communication such as email, SMS, phone call, or meeting options: - Communication - Comment @@ -4950,7 +5524,8 @@ tables: - Feedback - Automated Message - name: comment_type - description: '' + description: Type or category of communication such as email, phone call, meeting, + or note options: - Comment - Like @@ -4970,137 +5545,169 @@ tables: - Unshared - Relinked - name: status - description: '' + description: Current state of the communication such as draft, sent, delivered, + or failed options: - Open - Replied - Closed - Linked - name: sent_or_received - description: '' + description: Direction of communication indicating whether it was outgoing or + incoming options: - Sent - Received - name: communication_date - description: '' + description: Date and time when the communication was sent or occurred - name: read_receipt - description: '' + description: Indicates whether the recipient has opened or read the communication - name: send_after - description: '' + description: Scheduled date and time for delayed or future delivery of the communication - name: sender_full_name - description: '' + description: Full name of the person who sent the communication, used when searching + for messages from specific individuals. - name: read_by_recipient - description: '' + description: Whether the recipient has opened or viewed the communication, used + to check if messages have been read. - name: read_by_recipient_on - description: '' + description: Date and time when the recipient opened or viewed the communication, + used to track when messages were actually read. - name: reference_doctype - description: '' + description: Type of document this communication is linked to such as Lead, Customer, + Issue, or Sales Order. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_name - description: '' + description: Specific document ID or name this communication is associated with. - name: reference_owner - description: '' + description: User who owns or is responsible for the referenced document. - name: email_account - description: '' + description: Email address or account used to send or receive the communication join_hint: table: tabEmail Account 'on': email_account = tabEmail Account.name - name: company - description: '' + description: Company associated with or mentioned in the communication join_hint: table: tabCompany 'on': company = tabCompany.name - name: in_reply_to - description: '' + description: Reference to the previous communication this message is replying + to join_hint: table: tabCommunication 'on': in_reply_to = tabCommunication.name - name: user - description: '' + description: The person who sent or received this communication message or notification. join_hint: table: tabUser 'on': user = tabUser.name - name: email_template - description: '' + description: The predefined template used to format and generate this email communication. join_hint: table: tabEmail Template 'on': email_template = tabEmail Template.name - name: unread_notification_sent - description: '' + description: Whether a notification has been sent to alert the recipient about + this unread communication. - name: seen - description: '' + description: Indicates whether the communication has been viewed or read by the + recipient or relevant user. - name: _user_tags - description: '' + description: Custom tags assigned by users to categorize or label the communication + for filtering and organization. - name: timeline_links - description: '' + description: References to related documents or records connected to this communication + in the activity timeline. - name: message_id - description: '' + description: Unique identifier for an email or communication message used to track + specific conversations or threads. - name: uid - description: '' + description: User or contact identifier associated with the communication sender + or recipient. - name: imap_folder - description: '' + description: Email folder location such as Inbox, Sent, Drafts, or custom folders + where the communication is stored. - name: email_status - description: '' + description: Status of email delivery such as sent, opened, bounced, or failed + for tracking communication outcomes. options: - Open - Spam - Trash - name: has_attachment - description: '' + description: Indicates whether the communication includes attached files or documents. - name: rating - description: '' + description: User-assigned quality or satisfaction score for the communication + interaction. - name: feedback_request - description: '' + description: Indicates whether this communication is requesting feedback or a + response from the recipient. + desc_done: true - table: tabCommunication Link description: '' fields: - name: name - description: '' + description: Unique identifier or title of the communication record - name: link_doctype - description: '' + description: Type of document this communication is linked to (e.g., Customer, + Sales Order, Issue) join_hint: table: tabDocType 'on': link_doctype = tabDocType.name - name: link_name - description: '' + description: Specific document ID or name that this communication is associated + with - name: link_title - description: '' + description: Title or subject line of the communication such as email subject, + phone call topic, or meeting agenda name + desc_done: true - table: tabCommunication Medium description: '' fields: - name: name - description: '' + description: Unique identifier or label for the communication medium instance - name: communication_channel - description: '' + description: Specific channel or platform used for communication such as email, + phone, SMS, or social media - name: communication_medium_type - description: '' + description: Category or classification of the communication medium distinguishing + between types like inbound, outbound, or automated options: - Voice - Email - Chat - name: catch_all - description: '' + description: Email address that receives all incoming messages when no specific + recipient matches, typically used for general inquiries or fallback routing. join_hint: table: tabEmployee Group 'on': catch_all = tabEmployee Group.name - name: provider - description: '' + description: Third-party service or platform used to send and receive communications + through this medium (e.g., Twilio, SendGrid, SMTP server). join_hint: table: tabSupplier 'on': provider = tabSupplier.name - name: disabled - description: '' + description: Indicates whether this communication medium is currently inactive + and cannot be used for sending or receiving messages. - name: timeslots - description: '' + description: Time periods or scheduling slots when this communication medium is + available or active for contact. + desc_done: true - table: tabCommunication Medium Timeslot description: '' fields: - name: name - description: '' + description: Unique identifier for the communication medium timeslot, used when + filtering or referencing specific time windows for customer outreach scheduling. - name: day_of_week - description: '' + description: Specifies which day of the week this timeslot applies to, used when + analyzing communication patterns by day or scheduling campaigns for specific + weekdays. options: - Monday - Tuesday @@ -5110,45 +5717,58 @@ tables: - Saturday - Sunday - name: from_time - description: '' + description: Start time of the communication timeslot window, used when determining + available hours for outbound communications or analyzing response rates by time + of day. - name: to_time - description: '' + description: End time of the communication availability window or timeslot period - name: employee_group - description: '' + description: Group or category of employees for whom this communication timeslot + applies join_hint: table: tabEmployee Group 'on': employee_group = tabEmployee Group.name + desc_done: true - table: tabCompany description: Legal Entity / Subsidiary with a separate Chart of Accounts belonging to the Organization. fields: - name: name - description: '' + description: Unique identifier code for the company used in system references + and technical queries - name: company_name - description: '' + description: Full legal or display name of the company used when searching by + how the company is commonly known or officially registered - name: abbr - description: '' + description: Short abbreviated form of the company name used when users reference + companies by their acronym or shortened version - name: default_currency - description: '' + description: Currency used for financial transactions and reporting when users + ask about monetary values or exchange rates for this company. join_hint: table: tabCurrency 'on': default_currency = tabCurrency.name - name: country - description: '' + description: Geographic location of the company when users ask about regional + operations, tax jurisdiction, or location-based filtering. join_hint: table: tabCountry 'on': country = tabCountry.name - name: is_group - description: '' + description: Indicates whether the company is a parent/holding company when users + ask about corporate structure or consolidated reporting. - name: default_holiday_list - description: '' + description: Holiday calendar applied to employees and operations for this company + when calculating working days and leave. join_hint: table: tabHoliday List 'on': default_holiday_list = tabHoliday List.name - name: custom__company_name_in_arabic__ - description: '' + description: Company name in Arabic script for multilingual documents, reports, + and regional compliance requirements. - name: custom_registration_type - description: '' + description: Legal registration classification of the company such as LLC, corporation, + sole proprietorship, or partnership. options: - CRN - MOM @@ -5157,363 +5777,456 @@ tables: - SAG - OTH - name: custom_company_registration - description: '' + description: Company registration number or identifier used for legal and tax + compliance queries. - name: custom_zatca__location_for_csr_configuratoin - description: '' + description: Geographic location associated with ZATCA CSR certificate configuration + for Saudi Arabia e-invoicing compliance. - name: custom_zatca__company_category_for_csr_configuration - description: '' + description: Company business category classification required for ZATCA CSR setup + in Saudi Arabia tax authority integration. - name: default_letter_head - description: '' + description: Letterhead template used on printed documents like invoices, quotes, + and official correspondence for this company. join_hint: table: tabLetter Head 'on': default_letter_head = tabLetter Head.name - name: tax_id - description: '' + description: Government-issued tax identification number or employer identification + number for tax reporting and compliance. - name: domain - description: '' + description: Industry sector or business domain that the company operates in, + such as manufacturing, retail, or services. - name: date_of_establishment - description: '' + description: When the company began operating or doing business, used for queries + about company founding or operational history. - name: parent_company - description: '' + description: The owning or controlling company entity, used for queries about + corporate structure, subsidiaries, or organizational hierarchy. join_hint: table: tabCompany 'on': parent_company = tabCompany.name - name: date_of_incorporation - description: '' + description: When the company was legally registered or incorporated, used for + queries about legal formation date or compliance requirements. - name: phone_no - description: '' + description: Primary contact phone number for reaching the company. - name: email - description: '' + description: Primary contact email address for the company. - name: company_description - description: '' + description: Textual overview of the company's business, industry, or purpose. - name: date_of_commencement - description: '' + description: Date when the company officially started business operations or was + established. - name: fax - description: '' + description: Company's fax number for document transmission. - name: website - description: '' + description: Company's web address or URL for their online presence. - name: registration_details - description: '' + description: Company registration information including registration number, tax + ID, incorporation date, and legal entity details - name: lft - description: '' + description: Left boundary value in nested set model for company hierarchy positioning - name: rgt - description: '' + description: Right boundary value in nested set model for company hierarchy positioning - name: old_parent - description: '' + description: Previous parent company before a corporate restructuring or ownership + change. - name: create_chart_of_accounts_based_on - description: '' + description: Template or source company used to initialize the chart of accounts + structure. options: - Standard Template - Existing Company - name: existing_company - description: '' + description: Reference company to copy configuration settings from during company + setup. join_hint: table: tabCompany 'on': existing_company = tabCompany.name - name: chart_of_accounts - description: '' + description: The accounting framework defining all general ledger accounts used + by this company for financial transactions and reporting. - name: default_bank_account - description: '' + description: The primary bank account automatically used for electronic payments, + wire transfers, and bank-related transactions. join_hint: table: tabAccount 'on': default_bank_account = tabAccount.name - name: default_cash_account - description: '' + description: The primary cash account automatically used for cash payments, petty + cash transactions, and cash-based operations. join_hint: table: tabAccount 'on': default_cash_account = tabAccount.name - name: default_receivable_account - description: '' + description: Account where customer invoices and amounts owed to the company are + recorded by default. join_hint: table: tabAccount 'on': default_receivable_account = tabAccount.name - name: default_payable_account - description: '' + description: Account where vendor bills and amounts the company owes to suppliers + are recorded by default. join_hint: table: tabAccount 'on': default_payable_account = tabAccount.name - name: write_off_account - description: '' + description: Account used to record bad debts, uncollectible receivables, or other + amounts being removed from the books. join_hint: table: tabAccount 'on': write_off_account = tabAccount.name - name: unrealized_profit_loss_account - description: '' + description: Account where unrealized gains or losses from foreign exchange, investments, + or intercompany transactions are recorded before realization. join_hint: table: tabAccount 'on': unrealized_profit_loss_account = tabAccount.name - name: allow_account_creation_against_child_company - description: '' + description: Whether financial accounts can be created directly for subsidiary + or child companies in the organizational hierarchy. - name: default_expense_account - description: '' + description: The standard account automatically assigned for general expense transactions + when no specific expense account is specified. join_hint: table: tabAccount 'on': default_expense_account = tabAccount.name - name: default_income_account - description: '' + description: Account where revenue from sales is recorded when no specific income + account is specified on transactions. join_hint: table: tabAccount 'on': default_income_account = tabAccount.name - name: default_discount_account - description: '' + description: Account where discounts given to customers are recorded when no specific + discount account is specified. join_hint: table: tabAccount 'on': default_discount_account = tabAccount.name - name: payment_terms - description: '' + description: Standard payment due date terms applied to customer invoices, such + as net 30 or due on receipt. join_hint: table: tabPayment Terms Template 'on': payment_terms = tabPayment Terms Template.name - name: cost_center - description: '' + description: Cost center assigned to the company for expense tracking and allocation + across departments or business units. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: default_finance_book - description: '' + description: Primary finance book used for this company's accounting entries when + multiple books are configured. join_hint: table: tabFinance Book 'on': default_finance_book = tabFinance Book.name - name: exchange_gain_loss_account - description: '' + description: Account where foreign exchange gains or losses from currency conversions + are recorded. join_hint: table: tabAccount 'on': exchange_gain_loss_account = tabAccount.name - name: unrealized_exchange_gain_loss_account - description: '' + description: Account for recording foreign currency valuation differences that + have not yet been realized through actual transactions or settlements. join_hint: table: tabAccount 'on': unrealized_exchange_gain_loss_account = tabAccount.name - name: round_off_account - description: '' + description: Account where small rounding differences in monetary calculations + are posted to balance transactions. join_hint: table: tabAccount 'on': round_off_account = tabAccount.name - name: round_off_cost_center - description: '' + description: Cost center assigned to rounding adjustment entries for tracking + and allocation purposes. join_hint: table: tabCost Center 'on': round_off_cost_center = tabCost Center.name - name: round_off_for_opening - description: '' + description: Rounding adjustment account used when entering opening balances to + handle minor discrepancies in initial account setup. join_hint: table: tabAccount 'on': round_off_for_opening = tabAccount.name - name: default_deferred_revenue_account - description: '' + description: Account where revenue received in advance is recorded until it is + earned and can be recognized. join_hint: table: tabAccount 'on': default_deferred_revenue_account = tabAccount.name - name: default_deferred_expense_account - description: '' + description: Account where prepaid expenses are recorded until they are consumed + or the benefit is realized. join_hint: table: tabAccount 'on': default_deferred_expense_account = tabAccount.name - name: book_advance_payments_in_separate_party_account - description: '' + description: Whether advance payments from customers or to suppliers are tracked + in dedicated accounts separate from regular receivables/payables. - name: reconcile_on_advance_payment_date - description: '' + description: Whether to perform account reconciliation using the date when the + advance payment was made rather than when it was applied. - name: reconciliation_takes_effect_on - description: '' + description: The date or timing basis when reconciliation between payments and + invoices becomes effective in the accounting records. options: - Advance Payment Date - Oldest Of Invoice Or Advance - Reconciliation Date - name: default_advance_received_account - description: '' + description: Account used when recording customer advance payments or prepayments + received before invoicing. join_hint: table: tabAccount 'on': default_advance_received_account = tabAccount.name - name: default_advance_paid_account - description: '' + description: Account used when recording supplier advance payments or prepayments + made before receiving goods or services. join_hint: table: tabAccount 'on': default_advance_paid_account = tabAccount.name - name: auto_exchange_rate_revaluation - description: '' + description: Whether the system automatically revalues foreign currency balances + when exchange rates change. - name: auto_err_frequency - description: '' + description: Frequency setting for automatic error checking or validation runs + in the company's financial processes. options: - Daily - Weekly - Monthly - name: submit_err_jv - description: '' + description: Whether the company allows submission of journal vouchers that contain + errors or validation warnings. - name: exception_budget_approver_role - description: '' + description: Role authorized to approve budget transactions that exceed normal + limits or violate standard budget rules. join_hint: table: tabRole 'on': exception_budget_approver_role = tabRole.name - name: accumulated_depreciation_account - description: '' + description: Account where total depreciation accumulated over an asset's life + is recorded, used when querying cumulative depreciation balances or contra-asset + accounts. join_hint: table: tabAccount 'on': accumulated_depreciation_account = tabAccount.name - name: depreciation_expense_account - description: '' + description: Account where periodic depreciation expense is charged, used when + analyzing depreciation costs for a specific period or profit and loss impact. join_hint: table: tabAccount 'on': depreciation_expense_account = tabAccount.name - name: series_for_depreciation_entry - description: '' + description: Naming or numbering pattern applied to depreciation journal entries, + used when searching for or filtering depreciation transactions by their entry + series identifier. - name: expenses_included_in_asset_valuation - description: '' + description: Expenses that are capitalized into the asset cost basis rather than + expensed immediately, relevant for asset acquisition and valuation queries. join_hint: table: tabAccount 'on': expenses_included_in_asset_valuation = tabAccount.name - name: disposal_account - description: '' + description: General ledger account where gains or losses from asset disposals + and sales are recorded. join_hint: table: tabAccount 'on': disposal_account = tabAccount.name - name: depreciation_cost_center - description: '' + description: Cost center to which depreciation expenses are allocated for internal + accounting and profitability analysis. join_hint: table: tabCost Center 'on': depreciation_cost_center = tabCost Center.name - name: capital_work_in_progress_account - description: '' + description: Account for tracking assets under construction or development that + are not yet ready for use. join_hint: table: tabAccount 'on': capital_work_in_progress_account = tabAccount.name - name: asset_received_but_not_billed - description: '' + description: Account for recording assets that have been physically received but + for which supplier invoices have not yet arrived. join_hint: table: tabAccount 'on': asset_received_but_not_billed = tabAccount.name - name: default_buying_terms - description: '' + description: Standard payment terms and conditions automatically applied to purchase + orders and supplier transactions. join_hint: table: tabTerms and Conditions 'on': default_buying_terms = tabTerms and Conditions.name - name: sales_monthly_history - description: '' + description: Historical sales data broken down by month for trend analysis and + year-over-year comparisons. - name: monthly_sales_target - description: '' + description: Target or goal amount set for sales in a given month, used to measure + performance against objectives. - name: total_monthly_sales - description: '' + description: Actual sales amount achieved in a month, used to compare against + targets or calculate performance metrics. - name: default_selling_terms - description: '' + description: Default payment terms and conditions applied to sales transactions + with customers. join_hint: table: tabTerms and Conditions 'on': default_selling_terms = tabTerms and Conditions.name - name: default_warehouse_for_sales_return - description: '' + description: Warehouse location where returned goods from customers are received + and processed. join_hint: table: tabWarehouse 'on': default_warehouse_for_sales_return = tabWarehouse.name - name: credit_limit - description: '' + description: Maximum outstanding amount allowed for customer purchases on credit + before payment is required. - name: transactions_annual_history - description: '' + description: Number of years of historical transaction data retained for the company. - name: enable_perpetual_inventory - description: '' + description: Whether inventory quantities and values are updated in real-time + with each transaction. - name: enable_provisional_accounting_for_non_stock_items - description: '' + description: Whether non-stock items like services or expenses create provisional + accounting entries before final invoice posting. - name: default_inventory_account - description: '' + description: Account used for recording inventory asset value when no specific + inventory account is specified for items or warehouses. join_hint: table: tabAccount 'on': default_inventory_account = tabAccount.name - name: stock_adjustment_account - description: '' + description: Account used for recording gains or losses from inventory quantity + adjustments, cycle counts, or write-offs. join_hint: table: tabAccount 'on': stock_adjustment_account = tabAccount.name - name: default_in_transit_warehouse - description: '' + description: Warehouse location assigned to goods during transfer between warehouses + before they reach their destination. join_hint: table: tabWarehouse 'on': default_in_transit_warehouse = tabWarehouse.name - name: stock_received_but_not_billed - description: '' + description: Account for inventory received from suppliers but not yet invoiced, + used when querying accrued liabilities or goods-in-transit reconciliation. join_hint: table: tabAccount 'on': stock_received_but_not_billed = tabAccount.name - name: default_provisional_account - description: '' + description: Default account for temporary postings or provisional entries before + final allocation is determined. join_hint: table: tabAccount 'on': default_provisional_account = tabAccount.name - name: expenses_included_in_valuation - description: '' + description: Account for additional costs (freight, duties, handling) capitalized + into inventory value rather than expensed immediately. join_hint: table: tabAccount 'on': expenses_included_in_valuation = tabAccount.name - name: default_operating_cost_account - description: '' + description: Account used for recording general operating expenses when no specific + expense account is specified. join_hint: table: tabAccount 'on': default_operating_cost_account = tabAccount.name - name: custom_zatca_invoice_enabled - description: '' + description: Indicates whether ZATCA (Saudi Arabia e-invoicing) compliance is + activated for this company's invoicing. - name: custom_costcenter - description: '' + description: Default cost center assigned to transactions for this company when + tracking departmental or divisional expenses. - name: custom_submit_line_item_discount_to_zatca - description: '' + description: Whether line-level discounts are submitted to ZATCA (Saudi tax authority) + for e-invoicing compliance. - name: custom_phase_1_or_2 - description: '' + description: Indicates which ZATCA e-invoicing implementation phase the company + is operating under. options: - Phase-1 - Phase-2 - name: custom_send_einvoice_background - description: '' + description: Whether e-invoices are sent to ZATCA asynchronously in the background + rather than in real-time. - name: custom_select - description: '' + description: User selection or choice made for company-specific custom configuration + or workflow option. options: - Simulation - Sandbox - Production - name: custom_send_invoice_to_zatca - description: '' + description: Whether invoices for this company are submitted to ZATCA (Saudi Arabian + tax authority) for e-invoicing compliance. options: - Live - Batches - Background - name: custom_submit_or_not - description: '' + description: Controls whether documents or transactions for this company require + submission to external systems or approval workflows. - name: custom_start_time - description: '' + description: Start time for company's custom business hours or operational period. - name: custom_end_time - description: '' + description: End time for company's custom business hours or operational period. - name: custom_start_time_session - description: '' + description: Start time for a specific company session or shift period, distinct + from general business hours. - name: custom_end_time_session - description: '' + description: Time when a user session or work period ends for the company. - name: custom_csr_config - description: '' + description: Configuration settings for corporate social responsibility programs + or customer service representative system setup. - name: custom_csr_data - description: '' + description: Corporate social responsibility metrics, initiatives, or customer + service representative activity data. - name: custom_attach_xml_with_invoice - description: '' + description: Whether XML files are automatically attached when generating or sending + invoices. - name: custom_attach_xml_with_qr_code - description: '' + description: Whether QR codes are included when attaching XML files to documents. - name: custom_attach_qr_code_doctype - description: '' + description: Specific document types that should include QR codes when XML attachments + are generated. - name: custom_attach_e_invoice_send_status_with_invoice - description: '' + description: Whether electronic invoice send status is attached when sending invoices + to customers or partners. - name: custom_pih - description: '' + description: PIH identifier or code associated with the company for regulatory + or integration purposes. - name: custom_private_key - description: '' + description: Private cryptographic key used for electronic invoice signing, encryption, + or secure authentication. - name: custom_public_key - description: '' + description: Public key credential for authenticating external API integrations + or encrypted data exchanges with the company. - name: custom_certificate - description: '' + description: Digital certificate for SSL/TLS security or third-party service authentication + associated with the company. - name: custom_sandbox_url - description: '' + description: Testing or development environment URL for the company to validate + integrations before production deployment. - name: custom_simulation_url - description: '' + description: URL endpoint for testing or simulation environment access for this + company. - name: custom_production_url - description: '' + description: URL endpoint for live production environment access for this company. - name: custom_otp - description: '' + description: One-time password or OTP configuration setting for company authentication. - name: custom_basic_auth_from_csid - description: '' + description: Authentication identifier from customer system ID for API or integration + access. - name: custom_compliance_request_id_ - description: '' + description: Unique identifier linking company to specific compliance or regulatory + request submissions. - name: custom_validation_type - description: '' + description: Type of validation method applied to company data such as tax ID + verification, address validation, or credit check. options: - Simplified Invoice - Standard Invoice @@ -5522,234 +6235,310 @@ tables: - Simplified Debit Note - Standard Debit Note - name: custom_sample_invoice_number_to_test - description: '' + description: Sample invoice number used for testing invoice generation or validation + workflows - name: custom_basic_auth_from_production - description: '' + description: Basic authentication credentials or settings copied from production + environment for integration or API access - name: custom_zatca_offline_machines - description: '' + description: Machines or devices configured for offline ZATCA (Saudi e-invoicing) + compliance when internet connectivity is unavailable + desc_done: true - table: tabCompany History description: '' fields: - name: name - description: '' + description: Company name for identifying which organization's historical milestone + or event is being referenced. - name: year - description: '' + description: Year when the historical event occurred, used for filtering company + milestones by time period or chronological analysis. - name: highlight - description: '' + description: Description of the significant company event or achievement, used + when searching for specific milestones, accomplishments, or historical context. + desc_done: true - table: tabCompetitor description: '' fields: - name: name - description: '' + description: Unique identifier or code for the competitor record - name: competitor_name - description: '' + description: Full business name of the competing company - name: website - description: '' + description: Web address or URL of the competitor's online presence + desc_done: true - table: tabCompetitor Detail description: '' fields: - name: name - description: '' + description: Identifies the specific product, service, or business unit being + compared against competitors in competitive analysis and market positioning + assessments. - name: competitor - description: '' + description: Specifies the competing company or product being tracked for benchmarking, + market share analysis, and competitive intelligence reporting. join_hint: table: tabCompetitor 'on': competitor = tabCompetitor.name + desc_done: true - table: tabConnected App description: '' fields: - name: name - description: '' + description: Name or identifier of the connected application or integration - name: provider_name - description: '' + description: Identity or service provider powering the connected app authentication - name: openid_configuration - description: '' + description: OpenID Connect configuration endpoint URL or settings for the connected + app - name: client_id - description: '' + description: Unique identifier for the connected application used in OAuth authentication + flows. - name: redirect_uri - description: '' + description: URL where users are redirected after authorizing the connected application. - name: client_secret - description: '' + description: Confidential key used to authenticate the connected application during + OAuth token exchanges. - name: scopes - description: '' + description: OAuth permissions or access levels granted to the connected application + for API operations - name: authorization_uri - description: '' + description: OAuth endpoint URL where users are redirected to authorize the connected + application - name: token_uri - description: '' + description: OAuth endpoint URL used to exchange authorization codes for access + tokens or refresh tokens - name: revocation_uri - description: '' + description: OAuth endpoint URL for revoking access tokens or refresh tokens for + the connected application. - name: userinfo_uri - description: '' + description: OAuth endpoint URL for retrieving authenticated user profile information + from the connected application. - name: introspection_uri - description: '' + description: OAuth endpoint URL for validating and retrieving metadata about access + tokens issued to the connected application. - name: query_parameters - description: '' + description: URL query string parameters passed to the connected app during authentication + or API requests. + desc_done: true - table: tabConsole Log description: '' fields: - name: name - description: '' + description: Identifies the specific console log entry for troubleshooting and + tracking system events or errors. - name: script - description: '' + description: References the script or code that generated this console log entry + for debugging purposes. - name: type - description: '' + description: Categorizes the console log entry by severity level such as error, + warning, or info for filtering and prioritization. - name: committed - description: '' + description: Indicates whether the console log entry has been permanently saved + or finalized in the system + desc_done: true - table: tabContact description: '' fields: - name: name - description: '' + description: Full name or complete display name of the contact, typically used + when searching for a contact by their entire name - name: first_name - description: '' + description: Given name of the contact, used when searching or filtering by first + name only - name: middle_name - description: '' + description: Middle name of the contact, used when full name details are needed + or to distinguish between contacts with similar first and last names - name: last_name - description: '' + description: Family name or surname of the contact, used when searching by last + name only or sorting contacts alphabetically by surname. - name: full_name - description: '' + description: Complete name of the contact including first and last name, used + when searching for a contact by their full name or displaying their complete + identity. - name: email_id - description: '' + description: Email address of the contact, used when searching for contacts by + email or needing to retrieve contact communication details. - name: user - description: '' + description: The system user account associated with or owning this contact record join_hint: table: tabUser 'on': user = tabUser.name - name: address - description: '' + description: Physical mailing or location address for the contact join_hint: table: tabAddress 'on': address = tabAddress.name - name: sync_with_google_contacts - description: '' + description: Whether this contact is synchronized with Google Contacts integration - name: status - description: '' + description: Current state of the contact such as active, inactive, or lead to + filter contacts by availability or engagement level. options: - Passive - Open - Replied - name: salutation - description: '' + description: Formal greeting title like Mr., Ms., Dr., or Prof. used when addressing + the contact in communications. join_hint: table: tabSalutation 'on': salutation = tabSalutation.name - name: designation - description: '' + description: Job title or professional role of the contact such as Manager, Director, + or Engineer within their organization. - name: gender - description: '' + description: Gender identity of the contact person used for demographic segmentation + and personalized communication. join_hint: table: tabGender 'on': gender = tabGender.name - name: phone - description: '' + description: Primary landline or office telephone number for contacting the person + at their workplace or fixed location. - name: mobile_no - description: '' + description: Mobile or cell phone number for direct personal contact, typically + used for urgent communications or SMS. - name: company_name - description: '' + description: Company or organization name associated with the contact, used when + searching for contacts by their employer or business affiliation. - name: google_contacts - description: '' + description: Indicates whether the contact is synced with or imported from Google + Contacts. join_hint: table: tabGoogle Contacts 'on': google_contacts = tabGoogle Contacts.name - name: google_contacts_id - description: '' + description: Unique identifier linking this contact to a specific entry in Google + Contacts for sync purposes. - name: pulled_from_google_contacts - description: '' + description: Indicates whether this contact was imported or synced from Google + Contacts. - name: email_ids - description: '' + description: Collection of all email addresses associated with this contact. - name: phone_nos - description: '' + description: Collection of all phone numbers associated with this contact. - name: links - description: '' + description: Relationships connecting this contact to customers, suppliers, sales + orders, or other entities they are associated with. - name: is_primary_contact - description: '' + description: Indicates whether this contact is the main point of contact for their + associated entity. - name: is_billing_contact - description: '' + description: Indicates whether this contact receives invoices and handles payment-related + communications. - name: department - description: '' + description: Department or division where the contact works within their organization. - name: unsubscribed - description: '' + description: Whether the contact has opted out of receiving marketing emails or + communications. + desc_done: true - table: tabContact Email description: '' fields: - name: name - description: '' + description: description - name: email_id - description: '' + description: Used to identify or search for contacts by their email address in + customer communications and outreach queries. - name: is_primary - description: '' + description: Used to filter for the main contact email when multiple emails exist + for a single contact. + desc_done: true - table: tabContact Phone description: '' fields: - name: name - description: '' + description: Contact name used to identify the person or entity associated with + the phone number in customer inquiries and relationship management. - name: phone - description: '' + description: Phone number value used when searching for contact methods, validating + customer information, or initiating outbound communications. - name: is_primary_phone - description: '' + description: Indicates the preferred or main phone number for a contact, used + when determining which number to call first or display prominently. - name: is_primary_mobile_no - description: '' + description: Indicates whether this mobile phone number is the primary contact + method for the person, used when filtering for main mobile contacts. + desc_done: true - table: tabContact Us Settings description: Settings for Contact Us Page fields: - name: name - description: '' + description: Unique identifier for the contact form configuration, used when referencing + specific contact settings across the system. - name: forward_to_email - description: '' + description: Email address where contact form submissions are forwarded, used + when routing customer inquiries to specific departments or recipients. - name: heading - description: '' + description: Display title shown on the contact form page, used when customizing + customer-facing contact interface branding. - name: introduction - description: '' + description: Introductory text or message displayed on the contact us page or + form - name: query_options - description: '' + description: Available categories or topics users can select when submitting a + contact inquiry - name: address_title - description: '' + description: Label or heading text displayed above the contact address information - name: address_line1 - description: '' + description: Primary street address for contact us inquiries, typically containing + street number and name. - name: address_line2 - description: '' + description: Secondary address information such as suite, apartment, or building + number for contact us location. - name: city - description: '' + description: City name where the contact us address is located. - name: state - description: '' + description: State or province where the contact location is situated - name: pincode - description: '' + description: Postal or ZIP code for the contact address - name: country - description: '' + description: Country where the contact location is based - name: phone - description: '' + description: Phone number displayed on contact forms or pages for customer inquiries + and support. - name: email_id - description: '' + description: Email address displayed on contact forms or pages for customer inquiries + and support. - name: skype - description: '' + description: Skype username or ID displayed on contact forms or pages for customer + communication. + desc_done: true - table: tabContract description: '' fields: - name: name - description: '' + description: Contract title or identifier used when searching for or referring + to a specific contract - name: party_type - description: '' + description: Type of entity involved in the contract such as customer, vendor, + supplier, or partner options: - Customer - Supplier - Employee - name: is_signed - description: '' + description: Whether the contract has been executed with signatures from all parties - name: party_name - description: '' + description: Name of the external organization or individual that is the counterparty + to the contract. - name: party_user - description: '' + description: Internal user or employee responsible for managing or owning the + relationship with the contract counterparty. join_hint: table: tabUser 'on': party_user = tabUser.name - name: status - description: '' + description: Current state of the contract such as draft, active, expired, or + terminated. options: - Unsigned - Active - Inactive - name: fulfilment_status - description: '' + description: Current state of contract execution indicating whether obligations + are pending, in progress, completed, or breached. options: - N/A - Unfulfilled @@ -5757,39 +6546,53 @@ tables: - Fulfilled - Lapsed - name: party_full_name - description: '' + description: Complete legal name of the counterparty or customer entity involved + in the contract. - name: start_date - description: '' + description: Date when the contract becomes effective and obligations begin. - name: end_date - description: '' + description: Contract expiration or termination date for identifying when agreements + conclude or need renewal - name: signee - description: '' + description: Person or party who signed the contract, used to identify the authorized + individual or entity executing the agreement - name: signed_on - description: '' + description: Date when the contract was executed or signed, distinct from creation + or start dates - name: ip_address - description: '' + description: IP address from which the contract was created or last modified, + relevant for audit trail and security tracking queries. - name: contract_template - description: '' + description: Standardized contract format or template type used to generate this + contract, useful when searching for contracts based on specific template categories + or structures. join_hint: table: tabContract Template 'on': contract_template = tabContract Template.name - name: contract_terms - description: '' + description: Specific negotiated terms, conditions, clauses, and provisions within + the contract, queried when searching for payment terms, delivery conditions, + warranties, or other contractual obligations. - name: requires_fulfilment - description: '' + description: Whether the contract has deliverables or obligations that must be + completed or fulfilled by one or both parties. - name: fulfilment_deadline - description: '' + description: The date by which all contract deliverables or obligations must be + completed. - name: fulfilment_terms - description: '' + description: The specific conditions, requirements, or criteria that define how + contract obligations must be satisfied or delivered. - name: signee_company - description: '' + description: Company that receives and signs the contract as a party to the agreement. - name: signed_by_company - description: '' + description: Company that initiates or issues the contract for the other party + to sign. join_hint: table: tabUser 'on': signed_by_company = tabUser.name - name: document_type - description: '' + description: Category or classification of the contract document such as NDA, + service agreement, or purchase order. options: - Quotation - Project @@ -5798,69 +6601,93 @@ tables: - Sales Invoice - Purchase Invoice - name: document_name - description: '' + description: The title or identifier name assigned to the contract document for + reference and searching. - name: amended_from - description: '' + description: Links to the original contract that this contract amends or replaces, + used when tracking contract revisions and amendments. join_hint: table: tabContract 'on': amended_from = tabContract.name + desc_done: true - table: tabContract Fulfilment Checklist description: '' fields: - name: name - description: '' + description: Name or title of the specific checklist item or fulfillment task + within the contract - name: fulfilled - description: '' + description: Whether this checklist item has been completed or satisfied - name: requirement - description: '' + description: The specific obligation, condition, or deliverable that must be met + for this checklist item - name: notes - description: '' + description: Additional comments or observations about the contract fulfillment + checklist item or overall checklist status. - name: amended_from - description: '' + description: Reference to the previous version of this checklist when it has been + modified or corrected after initial creation. join_hint: table: tabContract Fulfilment Checklist 'on': amended_from = tabContract Fulfilment Checklist.name + desc_done: true - table: tabContract Template description: '' fields: - name: name - description: '' + description: Unique identifier or code for the contract template used to reference + specific template types in queries - name: title - description: '' + description: Display name or heading of the contract template shown to users when + selecting or viewing templates - name: contract_terms - description: '' + description: Legal terms, conditions, clauses, and provisions text that define + the contractual obligations and rights in the template - name: requires_fulfilment - description: '' + description: Indicates whether the contract template mandates physical delivery, + service completion, or other fulfilment obligations before payment or closure. - name: fulfilment_terms - description: '' + description: Specific conditions, timelines, milestones, or deliverables that + define how and when fulfilment obligations must be completed under this contract + template. + desc_done: true - table: tabContract Template Fulfilment Terms description: '' fields: - name: name - description: '' + description: Name or title of the contract template fulfilment term for identification + and reference - name: requirement - description: '' + description: Specific condition or obligation that must be met to fulfill this + contract template term + desc_done: true - table: tabCost Center description: Track separate Income and Expense for product verticals or divisions. fields: - name: name - description: '' + description: Unique identifier or code for the cost center, typically used when + referencing a specific cost center in queries about budgets, expenses, or organizational + structure. - name: cost_center_name - description: '' + description: Full descriptive name of the cost center, used when searching by + department name, business unit name, or organizational division. - name: cost_center_number - description: '' + description: Numeric or alphanumeric code assigned to the cost center, used when + querying by official cost center codes in financial reports or accounting systems. - name: parent_cost_center - description: '' + description: Hierarchical cost center that this cost center rolls up to for consolidated + financial reporting and analysis. join_hint: table: tabCost Center 'on': parent_cost_center = tabCost Center.name - name: company - description: '' + description: Legal entity or business unit that owns and operates this cost center. join_hint: table: tabCompany 'on': company = tabCompany.name - name: custom_zatca__registration_type - description: '' + description: Saudi Arabia ZATCA tax authority registration classification for + VAT and e-invoicing compliance. options: - CRN - MOM @@ -5869,136 +6696,179 @@ tables: - SAG - OTH - name: custom_zatca__registration_number - description: '' + description: ZATCA tax registration number for Saudi Arabian tax compliance and + invoicing requirements. - name: custom_zatca_branch_address - description: '' + description: Physical branch address required for ZATCA tax authority reporting + in Saudi Arabia. join_hint: table: tabAddress 'on': custom_zatca_branch_address = tabAddress.name - name: is_group - description: '' + description: Indicates whether this cost center is a parent grouping container + for other cost centers or an individual operational cost center. - name: disabled - description: '' + description: Whether the cost center is inactive and should be excluded from active + operations or selections. - name: lft - description: '' + description: Left boundary value for nested set hierarchy positioning of cost + centers in organizational tree structure. - name: rgt - description: '' + description: Right boundary value for nested set hierarchy positioning of cost + centers in organizational tree structure. - name: old_parent - description: '' + description: Previous parent cost center before a reorganization or hierarchy + change. join_hint: table: tabCost Center 'on': old_parent = tabCost Center.name + desc_done: true - table: tabCost Center Allocation description: '' fields: - name: name - description: '' + description: Unique identifier or label for this specific cost center allocation + record - name: main_cost_center - description: '' + description: The primary cost center to which expenses or resources are being + allocated join_hint: table: tabCost Center 'on': main_cost_center = tabCost Center.name - name: company - description: '' + description: The company entity that owns or is associated with this cost center + allocation join_hint: table: tabCompany 'on': company = tabCompany.name - name: valid_from - description: '' + description: Date when this cost center allocation becomes effective for distributing + costs across centers. - name: allocation_percentages - description: '' + description: Percentage breakdown defining how costs are split among multiple + cost centers. - name: amended_from - description: '' + description: Reference to the previous allocation record that this entry replaces + or modifies. join_hint: table: tabCost Center Allocation 'on': amended_from = tabCost Center Allocation.name + desc_done: true - table: tabCost Center Allocation Percentage description: '' fields: - name: name - description: '' + description: name - name: cost_center - description: '' + description: The cost center receiving the allocated portion of expenses or revenue join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: percentage - description: '' + description: The proportion of total amount allocated to this cost center, typically + queried when analyzing cost distribution or split ratios + desc_done: true - table: tabCountry description: '' fields: - name: name - description: '' + description: Used to filter, group, or identify countries by their standard name + in sales, operations, and compliance reporting. - name: country_name - description: '' + description: Used to display the full country name in reports, invoices, and customer-facing + documents where formal country identification is required. - name: date_format - description: '' + description: Used to format dates correctly in reports, documents, and user interfaces + according to country-specific conventions for compliance and readability. - name: time_format - description: '' + description: Preferred time display format for the country (12-hour vs 24-hour + clock). - name: time_zones - description: '' + description: List of time zones observed within the country's geographic boundaries. - name: code - description: '' + description: Standard country identifier code (ISO or similar) used for lookups + and integrations. + desc_done: true - table: tabCoupon Code description: '' fields: - name: name - description: '' + description: Unique identifier code for the coupon that customers enter at checkout + or redemption - name: coupon_name - description: '' + description: Marketing or display name of the coupon shown to customers and in + promotional materials - name: coupon_type - description: '' + description: Category or classification of the coupon such as percentage discount, + fixed amount, free shipping, or buy-one-get-one options: - Promotional - Gift Card - name: customer - description: '' + description: Customer who is authorized to use this coupon code for discounts + or promotions join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: coupon_code - description: '' + description: Unique code that customers enter at checkout to apply discounts or + promotional pricing - name: pricing_rule - description: '' + description: Pricing rule that defines the discount type, amount, and conditions + applied when this coupon code is used join_hint: table: tabPricing Rule 'on': pricing_rule = tabPricing Rule.name - name: valid_from - description: '' + description: Start date when the coupon code becomes active and can be applied + to transactions. - name: valid_upto - description: '' + description: End date when the coupon code expires and can no longer be used. - name: maximum_use - description: '' + description: Total number of times the coupon code can be redeemed across all + customers before becoming inactive. - name: used - description: '' + description: Indicates whether the coupon code has been redeemed or applied to + a transaction. - name: description - description: '' + description: Text explaining the purpose, promotion details, or terms associated + with the coupon code. - name: amended_from - description: '' + description: References the original coupon code record if this coupon was created + as a modification or correction of another. join_hint: table: tabCoupon Code 'on': amended_from = tabCoupon Code.name + desc_done: true - table: tabCurrency description: Currency list stores the currency value, its symbol and fraction unit fields: - name: name - description: '' + description: currency_name - name: currency_name - description: '' + description: Used to identify which currency is being referenced in multi-currency + transactions, financial reporting, or when filtering records by specific currencies + like USD, EUR, or GBP. - name: enabled - description: '' + description: Whether the currency is active and available for use in transactions - name: fraction - description: '' + description: Number of decimal places or subdivisions used in this currency for + monetary amounts. - name: fraction_units - description: '' + description: Name of the smallest unit or subunit of the currency (e.g., cents, + pence, centavos). - name: smallest_currency_fraction_value - description: '' + description: Minimum monetary value that can be represented in this currency based + on its smallest denomination. - name: symbol - description: '' + description: Currency symbol or code (e.g., $, USD, €) used when users ask about + currency identification or display representation. - name: symbol_on_right - description: '' + description: Indicates whether the currency symbol appears after the amount (e.g., + 100€ vs $100) for formatting questions. - name: number_format - description: '' + description: Defines how currency amounts are formatted with decimals and separators + (e.g., 1,000.00 vs 1.000,00) for display and localization queries. options: - '#,###.##' - '#.###,##' @@ -6010,145 +6880,199 @@ tables: - '#,###.###' - '#.###' - '#,###' + desc_done: true - table: tabCurrency Exchange description: Specify Exchange Rate to convert one currency into another fields: - name: name - description: '' + description: Unique identifier or label for the currency exchange transaction + record, used when referencing specific exchange rate entries or filtering by + exchange rate name. - name: date - description: '' + description: The effective date of the currency exchange rate, used when analyzing + exchange rates for specific time periods or calculating currency conversions + as of a particular date. - name: from_currency - description: '' + description: The source currency code being converted from, used when filtering + exchange rates by originating currency or calculating conversions from a specific + currency to another. join_hint: table: tabCurrency 'on': from_currency = tabCurrency.name - name: to_currency - description: '' + description: Target currency code when converting from one currency to another join_hint: table: tabCurrency 'on': to_currency = tabCurrency.name - name: exchange_rate - description: '' + description: Conversion rate multiplier applied when exchanging between currencies - name: for_buying - description: '' + description: Indicates whether this rate applies to purchase transactions versus + sales transactions - name: for_selling - description: '' + description: Exchange rate applied when selling goods or services in foreign currency + to customers + desc_done: true - table: tabCurrency Exchange Settings description: '' fields: - name: name - description: '' + description: Unique identifier or label for the currency exchange settings configuration - name: disabled - description: '' + description: Indicates whether this currency exchange settings configuration is + currently inactive or enabled - name: service_provider - description: '' + description: Third-party service or API provider used to retrieve currency exchange + rates options: - frankfurter.app - exchangerate.host - Custom - name: api_endpoint - description: '' + description: URL or service address where currency exchange rates are retrieved + from external providers - name: use_http - description: '' + description: Whether the system connects to the exchange rate service using HTTP + protocol instead of HTTPS - name: access_key - description: '' + description: Authentication credential or token required to access the external + currency exchange rate API - name: url - description: '' + description: API endpoint or web address from which currency exchange rates are + retrieved - name: req_params - description: '' + description: Parameters required to make the currency exchange rate API request - name: result_key - description: '' + description: JSON key or field name in the API response that contains the actual + exchange rate value + desc_done: true - table: tabCurrency Exchange Settings Details description: '' fields: - name: name - description: '' + description: Identifies the specific currency exchange setting or parameter being + configured, used when searching for particular exchange rate rules or conversion + settings. - name: key - description: '' + description: Serves as the unique identifier for the currency exchange configuration + parameter, used when looking up specific system settings or technical references + for exchange rate processing. - name: value - description: '' + description: Contains the actual configuration value or exchange rate data for + the setting, used when retrieving current rates, conversion factors, or parameter + values for currency calculations. + desc_done: true - table: tabCurrency Exchange Settings Result description: '' fields: - name: name - description: '' + description: Name or label of the currency exchange settings configuration for + user identification and selection - name: key - description: '' + description: Unique identifier code for the currency exchange settings used in + lookups and integrations + desc_done: true - table: tabCustom DocPerm description: '' fields: - name: name - description: '' + description: Unique identifier for the custom document permission record - name: parent - description: '' + description: The DocType or document to which this custom permission rule applies - name: role - description: '' + description: The user role that is granted or restricted by this permission rule join_hint: table: tabRole 'on': role = tabRole.name - name: if_owner - description: '' + description: Indicates whether the permission applies only when the user is the + document owner. - name: permlevel - description: '' + description: Defines the permission level tier for controlling access to specific + document fields or sections. - name: select - description: '' + description: Grants permission to view or retrieve documents of this type. - name: read - description: '' + description: Permission flag indicating whether the role can view or access documents + of this custom DocType. - name: write - description: '' + description: Permission flag indicating whether the role can edit or modify existing + documents of this custom DocType. - name: create - description: '' + description: Permission flag indicating whether the role can create new documents + of this custom DocType. - name: delete - description: '' + description: Permission flag indicating whether the user role can delete documents + of this type - name: submit - description: '' + description: Permission flag indicating whether the user role can submit documents + for approval or finalization - name: cancel - description: '' + description: Permission flag indicating whether the user role can cancel submitted + or approved documents - name: amend - description: '' + description: Permission flag indicating whether the user role can amend or modify + submitted documents. - name: report - description: '' + description: Permission flag indicating whether the user role can generate or + view reports for this document type. - name: export - description: '' + description: Permission flag indicating whether the user role can export document + data to external formats like CSV or Excel. - name: import - description: '' + description: Permission flag indicating whether the user role can import records + into this document type - name: share - description: '' + description: Permission flag indicating whether the user role can share this document + with other users - name: print - description: '' + description: Permission flag indicating whether the user role can print or generate + PDF versions of this document - name: email - description: '' + description: Email address of the user or role to whom custom document permissions + are granted. + desc_done: true - table: tabCustom Field description: Adds a custom field to a DocType fields: - name: name - description: '' + description: The label or identifier of the custom field as displayed to users + and referenced in queries - name: is_system_generated - description: '' + description: Indicates whether the custom field was automatically created by the + system versus manually created by a user - name: dt - description: '' + description: The data type of the custom field such as text, number, date, or + dropdown join_hint: table: tabDocType 'on': dt = tabDocType.name - name: module - description: '' + description: The ERP module or functional area where this custom field is used, + such as Sales, Inventory, or HR. join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: label - description: '' + description: The display name or caption shown to users for this custom field + in forms and reports. - name: placeholder - description: '' + description: The hint text displayed inside the custom field input before a user + enters a value. - name: fieldname - description: '' + description: Name or identifier of the custom field being defined - name: insert_after - description: '' + description: Position where this custom field should appear relative to another + field in the form or layout - name: length - description: '' + description: Maximum character or data length allowed for values entered in this + custom field - name: link_filters - description: '' + description: Filters applied to linked document selections in this custom field + to restrict which records users can choose - name: fieldtype - description: '' + description: Type of custom field such as text, number, date, link, select, or + table defining what data it accepts options: - Autocomplete - Attach @@ -6194,7 +7118,7 @@ tables: - Text Editor - Time - name: precision - description: '' + description: Number of decimal places for numeric custom fields options: - '0' - '1' @@ -6207,141 +7131,194 @@ tables: - '8' - '9' - name: hide_seconds - description: '' + description: Controls whether seconds are displayed in time values for this custom + field - name: hide_days - description: '' + description: Controls whether days are displayed in duration or date values for + this custom field - name: options - description: '' + description: Defines the available choices for dropdown, multi-select, or radio + button custom fields - name: sort_options - description: '' + description: Options controlling the sort order or sequence of custom field values + in dropdowns or lists - name: fetch_from - description: '' + description: Source table or field from which this custom field automatically + retrieves its values - name: fetch_if_empty - description: '' + description: Condition or source used to populate this custom field only when + it has no value - name: collapsible - description: '' + description: Whether the custom field can be collapsed or expanded in the user + interface - name: collapsible_depends_on - description: '' + description: Condition that determines when the custom field becomes collapsible + based on other field values - name: default - description: '' + description: The default value automatically assigned to the custom field when + creating new records - name: depends_on - description: '' + description: Condition that controls whether this custom field is visible or hidden + based on values of other fields - name: mandatory_depends_on - description: '' + description: Condition that makes this custom field required based on values of + other fields - name: read_only_depends_on - description: '' + description: Condition that makes this custom field non-editable based on values + of other fields - name: non_negative - description: '' + description: Indicates whether the custom field only accepts values greater than + or equal to zero, preventing negative numbers. - name: reqd - description: '' + description: Indicates whether the custom field must be filled in before saving + a record. - name: unique - description: '' + description: Indicates whether the custom field must contain distinct values across + all records, preventing duplicates. - name: is_virtual - description: '' + description: Indicates whether the custom field is computed dynamically rather + than stored in the database, relevant when users ask about calculated or derived + fields. - name: read_only - description: '' + description: Indicates whether the custom field value can be edited by users or + is display-only, relevant when users ask about field editability or locked values. - name: ignore_user_permissions - description: '' + description: Indicates whether the custom field bypasses role-based access controls, + relevant when users ask about fields visible to all users regardless of permissions. - name: hidden - description: '' + description: Controls whether the custom field is hidden from the user interface + form view. - name: print_hide - description: '' + description: Controls whether the custom field is excluded from printed documents + and PDF outputs. - name: print_hide_if_no_value - description: '' + description: Controls whether the custom field is hidden in printed documents + when it contains no value or is empty. - name: print_width - description: '' + description: Width specification for displaying this custom field in printed documents + and reports. - name: no_copy - description: '' + description: Indicates whether this custom field's value should be excluded when + duplicating or copying records. - name: allow_on_submit - description: '' + description: Controls whether this custom field can be modified after the parent + document has been submitted. - name: in_list_view - description: '' + description: Whether this custom field appears in list/table views of records - name: in_standard_filter - description: '' + description: Whether this custom field is available as a filter option in standard + filter dropdowns - name: in_global_search - description: '' + description: Whether this custom field's values are searchable through global + search functionality - name: in_preview - description: '' + description: Indicates whether the custom field appears in preview or summary + views of records. - name: bold - description: '' + description: Controls whether the custom field label or value displays in bold + formatting. - name: report_hide - description: '' + description: Determines whether the custom field is excluded from reports and + report outputs. - name: search_index - description: '' + description: Indicates whether this custom field is included in search operations + across documents. - name: allow_in_quick_entry - description: '' + description: Controls whether this custom field appears in quick entry forms for + faster data input. - name: ignore_xss_filter - description: '' + description: Determines whether cross-site scripting protection is bypassed for + this custom field's content. - name: translatable - description: '' + description: Whether the custom field supports multi-language translations for + its label or values. - name: hide_border - description: '' + description: Whether the custom field's border is hidden in the user interface + display. - name: show_dashboard - description: '' + description: Whether the custom field is visible or displayed on dashboard views. - name: description - description: '' + description: Text explaining the purpose or meaning of the custom field to users - name: permlevel - description: '' + description: Permission level required to view or edit this custom field - name: width - description: '' + description: Display width of the custom field in the user interface - name: columns - description: '' + description: Number of columns in the custom field layout or grid display configuration + desc_done: true - table: tabCustom HTML Block description: '' fields: - name: name - description: '' + description: Unique identifier or title of the custom HTML block used to reference + or search for specific HTML content blocks - name: private - description: '' + description: Indicates whether the custom HTML block is restricted to specific + users or roles versus publicly accessible - name: html - description: '' + description: The actual HTML markup content that defines what will be rendered + or displayed by this custom block - name: script - description: '' + description: JavaScript or other client-side code to execute custom behavior or + dynamic content in the HTML block - name: style - description: '' + description: CSS styling rules to control the visual appearance and layout of + the HTML block - name: roles - description: '' + description: User roles or permissions that are allowed to view or interact with + this custom HTML block + desc_done: true - table: tabCustom Role description: '' fields: - name: name - description: '' + description: Name or title of the custom role defining user permissions and access + levels - name: page - description: '' + description: Specific page or form that this custom role grants access to join_hint: table: tabPage 'on': page = tabPage.name - name: report - description: '' + description: Specific report that this custom role grants access to view or generate join_hint: table: tabReport 'on': report = tabReport.name - name: roles - description: '' + description: The role name or identifier that has custom permissions or access + rights in the system - name: ref_doctype - description: '' + description: The specific document type or module that this custom role applies + to or has permissions for + desc_done: true - table: tabCustomer description: Buyer of Goods and Services. fields: - name: name - description: '' + description: Customer's full business or individual name used when searching for + or identifying a specific customer - name: naming_series - description: '' + description: Prefix pattern that determines the customer ID format for auto-generated + customer codes options: - CUST-.YYYY.- - name: salutation - description: '' + description: Title or honorific for the customer contact person such as Mr, Mrs, + Dr, or Ms join_hint: table: tabSalutation 'on': salutation = tabSalutation.name - name: customer_name - description: '' + description: Primary customer name used for searching, filtering, and identifying + customers in queries about orders, invoices, or relationships. - name: zatca_customer_name_in_arabic - description: '' + description: Arabic version of customer name required for Saudi ZATCA tax compliance + and Arabic-language invoicing. - name: custom_b2c - description: '' + description: Indicates whether customer is a business-to-consumer account, used + to filter retail versus business customers. - name: custom_buyer_id_type - description: '' + description: Type or category of the custom buyer identifier used for this customer. options: - CRN - TIN @@ -6355,238 +7332,296 @@ tables: - PAS - OTH - name: custom_buyer_id - description: '' + description: Custom identifier assigned to the customer as a buyer in external + or partner systems. - name: customer_type - description: '' + description: Classification of the customer such as individual, business, government, + or reseller. options: - Company - Individual - Partnership - name: customer_group - description: '' + description: Customer classification or segment for pricing, discounts, or business + categorization such as wholesale, retail, or VIP. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: territory - description: '' + description: Geographic sales region or area assigned to the customer for sales + management and regional analysis. join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: gender - description: '' + description: Customer's gender for demographic analysis and personalized marketing. join_hint: table: tabGender 'on': gender = tabGender.name - name: lead_name - description: '' + description: Name of potential customer in initial contact stage before qualification. join_hint: table: tabLead 'on': lead_name = tabLead.name - name: opportunity_name - description: '' + description: Name of qualified sales opportunity with defined deal potential and + timeline. join_hint: table: tabOpportunity 'on': opportunity_name = tabOpportunity.name - name: prospect_name - description: '' + description: Name of researched potential customer being evaluated for outreach + or engagement. join_hint: table: tabProspect 'on': prospect_name = tabProspect.name - name: account_manager - description: '' + description: Employee or user responsible for managing the customer relationship + and handling their account. join_hint: table: tabUser 'on': account_manager = tabUser.name - name: default_currency - description: '' + description: Currency used for transactions and invoicing with this customer. join_hint: table: tabCurrency 'on': default_currency = tabCurrency.name - name: default_bank_account - description: '' + description: Bank account designated for receiving payments from this customer. join_hint: table: tabBank Account 'on': default_bank_account = tabBank Account.name - name: default_price_list - description: '' + description: Price list automatically applied to sales transactions for this customer, + relevant when users ask about customer pricing or discounts. join_hint: table: tabPrice List 'on': default_price_list = tabPrice List.name - name: is_internal_customer - description: '' + description: Indicates whether this customer is an internal entity within the + organization, used to distinguish inter-company or internal transactions from + external sales. - name: represents_company - description: '' + description: The company entity this customer record represents in inter-company + transactions, relevant when querying internal customer relationships or cross-company + dealings. join_hint: table: tabCompany 'on': represents_company = tabCompany.name - name: companies - description: '' + description: Customer's corporate or organizational name used when searching for + specific business entities or company accounts. - name: market_segment - description: '' + description: Customer categorization by business size or type (enterprise, SMB, + mid-market) used when filtering or analyzing customers by strategic segment. join_hint: table: tabMarket Segment 'on': market_segment = tabMarket Segment.name - name: industry - description: '' + description: Customer's business sector or vertical (manufacturing, healthcare, + retail, technology) used when querying customers by their line of business. join_hint: table: tabIndustry Type 'on': industry = tabIndustry Type.name - name: customer_pos_id - description: '' + description: Point of sale system identifier for the customer used in retail or + transaction processing queries. - name: website - description: '' + description: Customer's website URL for identifying online presence or filtering + by web-enabled customers. - name: language - description: '' + description: Preferred language for customer communications, invoices, and correspondence. join_hint: table: tabLanguage 'on': language = tabLanguage.name - name: customer_details - description: '' + description: Full customer information including name, contact details, and account + settings for queries about customer profiles or account information. - name: customer_primary_address - description: '' + description: Main address associated with the customer record for queries about + where the customer is located or their default shipping/billing location. join_hint: table: tabAddress 'on': customer_primary_address = tabAddress.name - name: primary_address - description: '' + description: Primary address identifier or reference for the customer, used when + linking to address records or querying customer location data. - name: customer_primary_contact - description: '' + description: Primary contact person's name for the customer account, used when + users need to know who to reach out to at the customer organization. join_hint: table: tabContact 'on': customer_primary_contact = tabContact.name - name: mobile_no - description: '' + description: Mobile phone number of the customer or primary contact, used for + SMS communications or urgent contact needs. - name: email_id - description: '' + description: Email address for the customer or primary contact, used for electronic + correspondence and invoice delivery. - name: tax_id - description: '' + description: Customer's tax identification number for tax reporting and compliance + purposes. - name: tax_category - description: '' + description: Tax treatment classification determining which taxes apply to sales + transactions with this customer. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: tax_withholding_category - description: '' + description: Classification for withholding tax obligations when paying or transacting + with this customer. join_hint: table: tabTax Withholding Category 'on': tax_withholding_category = tabTax Withholding Category.name - name: payment_terms - description: '' + description: When customer payment is due and what discounts apply for early payment, + such as net 30 or 2/10 net 30. join_hint: table: tabPayment Terms Template 'on': payment_terms = tabPayment Terms Template.name - name: credit_limits - description: '' + description: Maximum amount a customer can owe before orders are blocked or require + approval. - name: accounts - description: '' + description: General ledger account numbers or codes used for posting customer + transactions and revenue recognition. - name: loyalty_program - description: '' + description: Customer's enrolled loyalty or rewards program name for identifying + program membership and benefits eligibility. join_hint: table: tabLoyalty Program 'on': loyalty_program = tabLoyalty Program.name - name: loyalty_program_tier - description: '' + description: Customer's current tier or level within their loyalty program such + as bronze, silver, gold, or platinum for tier-based analysis and benefits. - name: sales_team - description: '' + description: Sales team or group assigned to manage this customer account for + territory and team performance queries. - name: default_sales_partner - description: '' + description: Sales partner automatically assigned to transactions for this customer + for commission tracking and partner performance analysis. join_hint: table: tabSales Partner 'on': default_sales_partner = tabSales Partner.name - name: default_commission_rate - description: '' + description: Commission percentage automatically applied to sales transactions + with this customer. - name: so_required - description: '' + description: Whether a sales order must be created before generating delivery + notes or sales invoices for this customer. - name: dn_required - description: '' + description: Whether delivery notes are mandatory for transactions with this customer. - name: is_frozen - description: '' + description: Whether the customer account is temporarily frozen from making new + transactions. - name: disabled - description: '' + description: Whether the customer record is permanently deactivated and excluded + from active operations. - name: portal_users - description: '' + description: Customer portal user accounts with login credentials and access permissions + for self-service features like order tracking and invoice viewing. + desc_done: true - table: tabCustomer Credit Limit description: '' fields: - name: name - description: '' + description: Unique identifier for the customer credit limit record - name: company - description: '' + description: Company entity to which this customer credit limit applies join_hint: table: tabCompany 'on': company = tabCompany.name - name: credit_limit - description: '' + description: Maximum credit amount approved for the customer to purchase on account - name: bypass_credit_limit_check - description: '' + description: Whether credit limit validation is disabled for this customer, allowing + orders or transactions to proceed regardless of outstanding balance or limit. + desc_done: true - table: tabCustomer Group description: '' fields: - name: name - description: '' + description: Unique identifier code for the customer group used in system references + and technical queries - name: customer_group_name - description: '' + description: Display label for the customer group used when users ask about group + names, categories, or segments by their business-friendly title - name: parent_customer_group - description: '' + description: References the higher-level customer group in a hierarchy when users + ask about group relationships, nested segments, or organizational structure join_hint: table: tabCustomer Group 'on': parent_customer_group = tabCustomer Group.name - name: is_group - description: '' + description: Whether this customer group can contain other customer groups in + a hierarchy - name: default_price_list - description: '' + description: The price list automatically applied to customers belonging to this + group join_hint: table: tabPrice List 'on': default_price_list = tabPrice List.name - name: payment_terms - description: '' + description: The default payment terms template assigned to customers in this + group join_hint: table: tabPayment Terms Template 'on': payment_terms = tabPayment Terms Template.name - name: lft - description: '' + description: Left boundary value in nested set hierarchy for customer group tree + structure positioning. - name: rgt - description: '' + description: Right boundary value in nested set hierarchy for customer group tree + structure positioning. - name: old_parent - description: '' + description: Previous parent customer group before the most recent hierarchy reorganization + or move operation. join_hint: table: tabCustomer Group 'on': old_parent = tabCustomer Group.name - name: accounts - description: '' + description: Customer accounts that belong to this customer group for grouping + and managing related customers together. - name: credit_limits - description: '' + description: Maximum credit amount allowed for customers in this group, used when + checking credit availability or payment terms. + desc_done: true - table: tabCustomer Group Item description: '' fields: - name: name - description: '' + description: Unique identifier for the specific item within this customer group - name: customer_group - description: '' + description: The customer group to which this item pricing or access rule applies join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name + desc_done: true - table: tabCustomer Item description: '' fields: - name: name - description: '' + description: Unique identifier for the customer-item relationship record - name: customer - description: '' + description: The customer for whom this specific item pricing, terms, or preferences + apply join_hint: table: tabCustomer 'on': customer = tabCustomer.name + desc_done: true - table: tabCustomize Form Field description: '' fields: - name: name - description: '' + description: Unique identifier for the customized form field - name: is_system_generated - description: '' + description: Indicates whether the field was automatically created by the system + or manually added by a user - name: label - description: '' + description: Display text shown to users for the form field in the interface - name: fieldtype - description: '' + description: Type of form field such as text, number, date, select, or checkbox + that determines input format and validation. options: - Autocomplete - Attach @@ -6631,37 +7666,46 @@ tables: - Text Editor - Time - name: fieldname - description: '' + description: Unique identifier name of the customized field used in code and queries. - name: non_negative - description: '' + description: Whether numeric field values must be zero or positive, preventing + negative number entry. - name: reqd - description: '' + description: Indicates whether the form field is mandatory and must be filled + in by users before saving. - name: unique - description: '' + description: Indicates whether the field value must be unique across all records + in the table, preventing duplicates. - name: is_virtual - description: '' + description: Indicates whether the field is computed or derived rather than directly + stored in the database. - name: in_list_view - description: '' + description: Whether the field appears as a column in list views and reports - name: in_standard_filter - description: '' + description: Whether the field is available as a quick filter option in the sidebar - name: in_global_search - description: '' + description: Whether the field's content is searchable through the global search + bar - name: in_preview - description: '' + description: Indicates whether this field appears in preview/list views of the + form - name: bold - description: '' + description: Indicates whether this field's label is displayed in bold formatting - name: no_copy - description: '' + description: Indicates whether this field's value is excluded when copying or + duplicating the document - name: allow_in_quick_entry - description: '' + description: Whether the field appears in quick entry forms for faster data input - name: translatable - description: '' + description: Whether the field content can be translated into multiple languages - name: link_filters - description: '' + description: Filter conditions applied when selecting linked documents in this + field - name: default - description: '' + description: Default value automatically populated when creating a new record + in this custom form field - name: precision - description: '' + description: Number of decimal places for numeric custom form fields options: - '0' - '1' @@ -6674,116 +7718,151 @@ tables: - '8' - '9' - name: length - description: '' + description: Maximum character limit for text-based custom form fields - name: options - description: '' + description: Dropdown or selection values available for a customized form field - name: sort_options - description: '' + description: Ordering or sequencing rules applied to field options when displayed - name: fetch_from - description: '' + description: Source field or table from which values are dynamically retrieved + to populate options - name: fetch_if_empty - description: '' + description: Controls whether a field's value should be automatically fetched + from the database when the field is empty - name: show_dashboard - description: '' + description: Determines if this field should be displayed on dashboard views or + summary screens - name: depends_on - description: '' + description: Specifies the conditional logic or field dependencies that control + when this field is visible or enabled - name: permlevel - description: '' + description: Permission level required to access or modify this form field - name: hidden - description: '' + description: Whether the form field is hidden from view in the user interface - name: read_only - description: '' + description: Whether the form field can only be viewed but not edited by users - name: collapsible - description: '' + description: Indicates whether a form field or section can be collapsed or expanded + in the user interface. - name: allow_bulk_edit - description: '' + description: Controls whether this field can be edited when performing bulk update + operations on multiple records. - name: collapsible_depends_on - description: '' + description: Defines the condition or expression that determines when a form section + becomes collapsible based on other field values. - name: ignore_user_permissions - description: '' + description: Controls whether this field bypasses user permission restrictions + when accessed or displayed - name: allow_on_submit - description: '' + description: Indicates whether this field can be modified after the document has + been submitted - name: report_hide - description: '' + description: Determines whether this field is hidden when generating or displaying + reports - name: remember_last_selected_value - description: '' + description: Controls whether the field retains the previously selected value + when the form is reopened or refreshed. - name: hide_border - description: '' + description: Controls whether the field displays with a visible border in the + form layout. - name: ignore_xss_filter - description: '' + description: Controls whether the field bypasses cross-site scripting sanitization + for HTML or script content. - name: mandatory_depends_on - description: '' + description: Conditional expression that determines when this field becomes required + based on values of other fields - name: read_only_depends_on - description: '' + description: Conditional expression that determines when this field becomes non-editable + based on values of other fields - name: in_filter - description: '' + description: Indicates whether this field is available as a filter option in list + views and reports - name: hide_seconds - description: '' + description: Controls whether seconds are displayed in time fields on the customized + form - name: hide_days - description: '' + description: Controls whether days are displayed in duration or date fields on + the customized form - name: description - description: '' + description: Text explaining the purpose or usage of the customized form field - name: placeholder - description: '' + description: Text shown as a hint inside an empty form field to guide user input - name: print_hide - description: '' + description: Controls whether the field appears in printed documents and PDF outputs - name: print_hide_if_no_value - description: '' + description: Hides the field from printed documents only when it contains no data - name: print_width - description: '' + description: Width of the field when rendered in print format or PDF output. - name: columns - description: '' + description: Number of columns the field spans in the form layout grid. - name: width - description: '' + description: Display width of the field in the web form interface. - name: is_custom_field - description: '' + description: Indicates whether the field was added by a user as a custom extension + versus being a standard system field. + desc_done: true - table: tabCustoms Tariff Number description: '' fields: - name: name - description: '' + description: Unique identifier or label for the customs tariff entry - name: tariff_number - description: '' + description: Official harmonized system code used for customs classification and + duty calculation - name: description - description: '' + description: Detailed explanation of goods or product categories covered by this + tariff classification + desc_done: true - table: tabDashboard description: '' fields: - name: name - description: '' + description: Unique identifier or code for the dashboard used when referencing + specific dashboards in queries or filters. - name: dashboard_name - description: '' + description: Display name of the dashboard used when users search for or identify + dashboards by their business title. - name: is_default - description: '' + description: Flag indicating whether this dashboard loads automatically for users, + relevant when determining initial user views or default landing pages. - name: is_standard - description: '' + description: Whether the dashboard is a default system dashboard or a custom user-created + dashboard. - name: module - description: '' + description: The application module or functional area this dashboard belongs + to, such as Accounting, HR, or Sales. join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: charts - description: '' + description: The visualizations and chart components included in this dashboard. - name: chart_options - description: '' + description: Configuration settings for visualizations like chart type, colors, + axes, and display preferences on the dashboard. - name: cards - description: '' + description: Individual dashboard widgets or panels that display specific metrics, + reports, or data visualizations. + desc_done: true - table: tabDashboard Chart description: '' fields: - name: name - description: '' + description: The title or label of the dashboard chart used to identify and search + for specific charts - name: is_standard - description: '' + description: Indicates whether the chart is a built-in system chart or a custom + user-created chart - name: module - description: '' + description: The application module or functional area the chart belongs to, such + as Accounting, CRM, or HR join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: chart_name - description: '' + description: Name or title of the dashboard chart for identifying specific visualizations. - name: chart_type - description: '' + description: Type of visualization such as bar, line, pie, or table used to render + the chart. options: - Count - Sum @@ -6792,53 +7871,66 @@ tables: - Custom - Report - name: report_name - description: '' + description: Name of the underlying report or data source that feeds data into + this chart. join_hint: table: tabReport 'on': report_name = tabReport.name - name: use_report_chart - description: '' + description: Whether the dashboard chart uses a report-based chart configuration + instead of custom query data. - name: x_field - description: '' + description: The field or dimension plotted along the horizontal axis of the chart. - name: y_axis - description: '' + description: The metric, measure, or field plotted along the vertical axis of + the chart. - name: source - description: '' + description: The originating module, report, or data source that feeds data into + this dashboard chart. join_hint: table: tabDashboard Chart Source 'on': source = tabDashboard Chart Source.name - name: document_type - description: '' + description: The type of ERP document or entity being visualized in this chart + (e.g., Sales Order, Purchase Invoice, Stock Entry). join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: parent_document_type - description: '' + description: The parent or related document type when the chart displays data + from linked or hierarchical documents. join_hint: table: tabDocType 'on': parent_document_type = tabDocType.name - name: based_on - description: '' + description: The source DocType or table that provides the data for this dashboard + chart. - name: value_based_on - description: '' + description: The specific field from the source DocType used to calculate or display + the chart's metric values. - name: group_by_type - description: '' + description: The time period or dimension type used to group and aggregate chart + data (e.g., daily, monthly, by status). options: - Count - Sum - Average - name: group_by_based_on - description: '' + description: Field or dimension used to categorize or segment chart data into + groups. - name: aggregate_function_based_on - description: '' + description: Field on which aggregation operations like sum, count, or average + are performed for chart calculations. - name: number_of_groups - description: '' + description: Maximum count of groups or categories displayed in the chart visualization. - name: is_public - description: '' + description: Whether the dashboard chart is visible to all users or restricted + to specific users. - name: heatmap_year - description: '' + description: The specific year for which heatmap data is displayed on the chart. - name: timespan - description: '' + description: The time period or date range covered by the chart data, such as + daily, weekly, monthly, quarterly, or yearly. options: - Last Year - Last Quarter @@ -6846,11 +7938,14 @@ tables: - Last Week - Select Date Range - name: from_date - description: '' + description: Start date for filtering dashboard chart data within a specific date + range. - name: to_date - description: '' + description: End date for filtering dashboard chart data within a specific date + range. - name: time_interval - description: '' + description: Grouping period for aggregating chart data such as daily, weekly, + monthly, or yearly intervals. options: - Yearly - Quarterly @@ -6858,9 +7953,10 @@ tables: - Weekly - Daily - name: timeseries - description: '' + description: Whether the chart displays data over time with date/time on the x-axis. - name: type - description: '' + description: The visualization format of the chart such as bar, line, pie, or + table. options: - Line - Bar @@ -6869,112 +7965,140 @@ tables: - Donut - Heatmap - name: show_values_over_chart - description: '' + description: Whether data point values are displayed directly on top of the chart + visualization. - name: currency - description: '' + description: Currency used for displaying monetary values in the dashboard chart join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: filters_json - description: '' + description: Static filter criteria applied to the chart data - name: dynamic_filters_json - description: '' + description: User-adjustable or runtime filter criteria that can change based + on context or parameters - name: custom_options - description: '' + description: Custom configuration settings or parameters specific to this dashboard + chart's behavior or display - name: color - description: '' + description: Color scheme or palette assigned to the chart for visual styling - name: last_synced_on - description: '' + description: Timestamp when the chart's data was last refreshed or synchronized + from its source - name: roles - description: '' + description: User roles or permission groups that have access to view this dashboard + chart + desc_done: true - table: tabDashboard Chart Field description: '' fields: - name: name - description: '' + description: description or label identifying the specific chart field within + the dashboard - name: y_field - description: '' + description: data field or metric plotted on the vertical axis of the chart - name: color - description: '' + description: color assigned to visually distinguish this chart field in the dashboard + visualization + desc_done: true - table: tabDashboard Chart Link description: '' fields: - name: name - description: '' + description: Name or identifier of the dashboard chart link for referencing specific + chart connections - name: chart - description: '' + description: The chart being linked to the dashboard, used when querying which + charts appear on which dashboards join_hint: table: tabDashboard Chart 'on': chart = tabDashboard Chart.name - name: width - description: '' + description: Display width of the chart on the dashboard, relevant for layout + and sizing queries options: - Half - Full + desc_done: true - table: tabDashboard Chart Source description: '' fields: - name: name - description: '' + description: Unique identifier or label for the dashboard chart, used when searching + for specific visualizations or reporting components. - name: source_name - description: '' + description: The data source or query feeding the chart, used when troubleshooting + data origins or identifying which dataset powers a visualization. - name: module - description: '' + description: The ERP module or functional area the chart belongs to (e.g., Finance, + Sales, Inventory), used when filtering dashboards by business domain. join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: timeseries - description: '' + description: Indicates whether the chart displays data over time periods or as + a static snapshot. + desc_done: true - table: tabDashboard Settings description: '' fields: - name: name - description: '' + description: Dashboard name or title that users reference when asking about specific + dashboards or reports they want to view or modify - name: user - description: '' + description: User who owns or created the dashboard, relevant when filtering dashboards + by person or asking about someone's personal dashboards join_hint: table: tabUser 'on': user = tabUser.name - name: chart_config - description: '' + description: Configuration settings and parameters for charts displayed on the + dashboard, relevant when asking about chart types, data sources, or visualization + settings + desc_done: true - table: tabData Export description: '' fields: - name: name - description: '' + description: Name or identifier of the data export configuration - name: reference_doctype - description: '' + description: The source document type (e.g., Sales Order, Customer) from which + data is being exported join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: export_without_main_header - description: '' + description: Whether to exclude the main header row when exporting data - name: file_type - description: '' + description: Format or extension of the exported file such as CSV, Excel, PDF, + or XML that the user wants to filter or identify. options: - Excel - CSV + desc_done: true - table: tabData Import description: '' fields: - name: name - description: '' + description: Name or identifier of the data import job or batch - name: reference_doctype - description: '' + description: The target document type or table where imported data will be inserted join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: import_type - description: '' + description: Method or format of the import operation such as insert, update, + or upsert options: - Insert New Records - Update Existing Records - name: payload_count - description: '' + description: Number of records or rows included in this data import batch. - name: google_sheets_url - description: '' + description: URL of the Google Sheets document used as the source for this import. - name: status - description: '' + description: Current state of the import process such as pending, in progress, + completed, or failed. options: - Pending - Success @@ -6982,284 +8106,371 @@ tables: - Error - Timed Out - name: submit_after_import - description: '' + description: Whether imported records are automatically submitted after import + completes. - name: mute_emails - description: '' + description: Whether email notifications are suppressed during the import process. - name: template_options - description: '' + description: Configuration settings or parameters available for the import template + being used. - name: template_warnings - description: '' + description: Warnings or validation messages generated during data import template + processing or configuration. - name: show_failed_logs - description: '' + description: Controls whether failed or error records from the import process + are displayed or included in logs. + desc_done: true - table: tabData Import Log description: '' fields: - name: name - description: '' + description: Identifies the specific data import log entry for tracking and referencing + individual import operations. - name: data_import - description: '' + description: Links to the parent data import configuration or batch to trace which + import process generated this log entry. join_hint: table: tabData Import 'on': data_import = tabData Import.name - name: row_indexes - description: '' + description: Captures the specific row numbers processed in this import operation + for troubleshooting failed or successful record imports. - name: success - description: '' + description: Indicates whether the data import operation completed successfully + or failed. - name: docname - description: '' + description: The name or identifier of the document or record that was imported. - name: messages - description: '' + description: Error messages, warnings, or status information generated during + the import process. - name: exception - description: '' + description: Error message or exception details captured when a data import fails + or encounters problems during processing. - name: log_index - description: '' + description: Sequential position or order number of this log entry within the + data import batch or session. + desc_done: true - table: tabDefaultValue description: '' fields: - name: name - description: '' + description: Unique identifier or label for the default value configuration entry. - name: defkey - description: '' + description: Key or parameter name that identifies which system setting or field + this default value applies to. - name: defvalue - description: '' + description: The actual default value assigned to the corresponding key, used + when no user-specified value exists. + desc_done: true - table: tabDeleted Document description: '' fields: - name: name - description: '' + description: Unique identifier of the deleted document record - name: deleted_name - description: '' + description: Original name or ID of the document before it was deleted - name: deleted_doctype - description: '' + description: Type or category of the document that was deleted - name: restored - description: '' + description: Indicates whether a deleted document has been restored or recovered + from deletion. - name: new_name - description: '' + description: The renamed filename or document name assigned when a deleted document + is restored. - name: data - description: '' + description: The actual content or binary data of the deleted document that was + removed from the system. + desc_done: true - table: tabDelivery Note description: '' fields: - name: name - description: '' + description: Unique identifier for the delivery note document, typically auto-generated + based on naming series. - name: title - description: '' + description: Custom display name or label for the delivery note, used when users + want to reference a specific delivery by a memorable name instead of the system + identifier. - name: naming_series - description: '' + description: Prefix pattern that determines how delivery note identifiers are + automatically formatted and numbered. options: - MAT-DN-.YYYY.- - MAT-DN-RET-.YYYY.- - name: customer - description: '' + description: Customer account identifier for the recipient of the delivered goods join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: tax_id - description: '' + description: Tax identification number of the customer receiving the delivery - name: customer_name - description: '' + description: Name of the customer receiving the delivery, used when searching + by company or person name rather than account code - name: posting_date - description: '' + description: Date when the delivery note is officially recorded in the accounting + system, used for financial period tracking and reporting queries. - name: posting_time - description: '' + description: Time when the delivery note is officially recorded, used when precise + timestamp queries are needed beyond just the date. - name: set_posting_time - description: '' + description: Indicates whether the posting date and time were manually specified + rather than automatically set at creation. - name: company - description: '' + description: The company entity that issued or owns this delivery note. join_hint: table: tabCompany 'on': company = tabCompany.name - name: amended_from - description: '' + description: References the original delivery note that this document amends or + corrects. join_hint: table: tabDelivery Note 'on': amended_from = tabDelivery Note.name - name: is_return - description: '' + description: Indicates whether this delivery note represents a return of goods + from customer back to supplier. - name: issue_credit_note - description: '' + description: Whether a credit note should be issued for this delivery note, typically + queried when processing returns or customer refunds. - name: return_against - description: '' + description: Reference to the original delivery note that this return delivery + is against, used to track which shipment is being returned. join_hint: table: tabDelivery Note 'on': return_against = tabDelivery Note.name - name: cost_center - description: '' + description: The cost center assigned to this delivery for accounting allocation + and expense tracking purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Project associated with the delivery for tracking shipments by project + or job join_hint: table: tabProject 'on': project = tabProject.name - name: currency - description: '' + description: Currency in which the delivery note transaction is recorded join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: conversion_rate - description: '' + description: Exchange rate used to convert delivery note amounts from transaction + currency to base currency - name: selling_price_list - description: '' + description: Price list applied to determine item selling prices for this delivery join_hint: table: tabPrice List 'on': selling_price_list = tabPrice List.name - name: price_list_currency - description: '' + description: Currency of the price list used for this delivery's item pricing join_hint: table: tabCurrency 'on': price_list_currency = tabCurrency.name - name: plc_conversion_rate - description: '' + description: Exchange rate used to convert price list currency to delivery transaction + currency - name: ignore_pricing_rule - description: '' + description: Whether pricing rules are bypassed for this delivery note, relevant + when users ask about deliveries with manual pricing or exceptions to standard + pricing. - name: scan_barcode - description: '' + description: Barcode value scanned during delivery processing, used when users + search for deliveries by scanned barcode or track barcode-based fulfillment. - name: last_scanned_warehouse - description: '' + description: Most recent warehouse where a barcode scan occurred for this delivery, + relevant when users ask which warehouse location last processed or scanned items. - name: set_warehouse - description: '' + description: Source warehouse from which items are being delivered or dispatched + in this delivery note. join_hint: table: tabWarehouse 'on': set_warehouse = tabWarehouse.name - name: set_target_warehouse - description: '' + description: Destination warehouse to which items are being transferred when the + delivery note involves inter-warehouse stock movement. join_hint: table: tabWarehouse 'on': set_target_warehouse = tabWarehouse.name - name: items - description: '' + description: Line items included in this delivery note, containing the products, + quantities, and details being delivered. - name: total_qty - description: '' + description: Total quantity of all items in the delivery note, used when asking + about total units delivered or shipped. - name: total_net_weight - description: '' + description: Combined net weight of all items in the delivery note, used when + asking about shipment weight or logistics calculations. - name: base_total - description: '' + description: Total value of the delivery note in base currency before taxes and + charges, used when asking about delivery value or goods amount. - name: base_net_total - description: '' + description: Net total amount in base currency before taxes and after discounts, + used when querying delivery note values in company's default currency. - name: total - description: '' + description: Grand total amount including all taxes, charges, and discounts in + transaction currency, used when querying final delivery note value. - name: net_total - description: '' + description: Net total amount in transaction currency before taxes and after discounts, + used when querying pre-tax delivery note values in the currency of the transaction. - name: tax_category - description: '' + description: Tax classification applied to the delivery note determining which + tax rates and rules apply to the shipment. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: taxes_and_charges - description: '' + description: Template or configuration defining the specific tax types, rates, + and additional charges calculated on this delivery note. join_hint: table: tabSales Taxes and Charges Template 'on': taxes_and_charges = tabSales Taxes and Charges Template.name - name: shipping_rule - description: '' + description: Rule or policy governing shipping costs, carrier selection, or delivery + terms applied to this delivery note. join_hint: table: tabShipping Rule 'on': shipping_rule = tabShipping Rule.name - name: incoterm - description: '' + description: Shipping terms code defining responsibility transfer point between + seller and buyer such as FOB, CIF, or EXW for this delivery. join_hint: table: tabIncoterm 'on': incoterm = tabIncoterm.name - name: named_place - description: '' + description: Specific geographic location associated with the incoterm where responsibility + transfers, such as port name or warehouse address. - name: taxes - description: '' + description: Total tax amount charged on this delivery note including VAT, sales + tax, or other applicable taxes. - name: base_total_taxes_and_charges - description: '' + description: Total amount of all taxes and charges in base currency, used when + analyzing delivery note tax totals in company's default currency. - name: total_taxes_and_charges - description: '' + description: Total amount of all taxes and charges in transaction currency, used + when querying delivery note tax totals in the currency of the specific transaction. - name: base_grand_total - description: '' + description: Final total amount including all items, taxes and charges in base + currency, used when analyzing complete delivery note values in company's default + currency. - name: base_rounding_adjustment - description: '' + description: Amount added or subtracted to round the total to a convenient value + in base currency. - name: base_rounded_total - description: '' + description: Final total amount after applying rounding adjustment in base currency. - name: base_in_words - description: '' + description: Text representation of the base currency total amount written out + in words for formal documentation. - name: grand_total - description: '' + description: Total delivery value before any rounding adjustments are applied - name: rounding_adjustment - description: '' + description: Amount added or subtracted to round the grand total to a convenient + figure - name: rounded_total - description: '' + description: Final delivery total after applying rounding adjustment to the grand + total - name: in_words - description: '' + description: Total amount expressed as text words for printing on delivery documents - name: disable_rounded_total - description: '' + description: Whether rounding is disabled for the delivery note total amount - name: apply_discount_on - description: '' + description: Whether discounts are calculated on grand total or net total before + taxes options: - Grand Total - Net Total - name: base_discount_amount - description: '' + description: Discount amount calculated from line item discounts before applying + any additional document-level discounts. - name: additional_discount_percentage - description: '' + description: Extra percentage discount applied at the delivery note level after + base discounts. - name: discount_amount - description: '' + description: Total final discount amount on the delivery note combining base and + additional discounts. - name: other_charges_calculation - description: '' + description: Additional fees or charges applied to the delivery beyond standard + item costs, such as handling fees, fuel surcharges, or packaging costs. - name: packed_items - description: '' + description: List of individual items that have been physically packed for this + delivery, useful for tracking what was actually shipped versus what was ordered. - name: pricing_rules - description: '' + description: Specific pricing conditions or discount rules applied to this delivery, + such as volume discounts, promotional pricing, or customer-specific rate agreements. - name: customer_address - description: '' + description: Linked customer address record for the delivery destination, used + when filtering or grouping deliveries by specific customer address IDs or address + records. join_hint: table: tabAddress 'on': customer_address = tabAddress.name - name: address_display - description: '' + description: Formatted full delivery address text as it appears on shipping labels + and delivery documents. - name: contact_person - description: '' + description: Specific person to contact at the delivery location for coordination, + receipt confirmation, or delivery issues. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_display - description: '' + description: Name of the person to contact regarding this delivery note for questions + about shipment receipt or delivery issues - name: contact_mobile - description: '' + description: Mobile phone number to reach the delivery contact person for urgent + delivery coordination or real-time shipment updates - name: contact_email - description: '' + description: Email address of the delivery contact person for non-urgent delivery + communications or documentation requests - name: shipping_address_name - description: '' + description: Name of the recipient or location where goods are being delivered + to. join_hint: table: tabAddress 'on': shipping_address_name = tabAddress.name - name: shipping_address - description: '' + description: Full address details where goods are being shipped or delivered to + the customer. - name: dispatch_address_name - description: '' + description: Name of the warehouse, facility, or location from which goods are + being sent out. join_hint: table: tabAddress 'on': dispatch_address_name = tabAddress.name - name: dispatch_address - description: '' + description: Address from which goods are physically shipped or dispatched to + the customer. - name: company_address - description: '' + description: Official registered address of the company issuing the delivery note. join_hint: table: tabAddress 'on': company_address = tabAddress.name - name: company_address_display - description: '' + description: Formatted version of the company address as it appears on printed + delivery note documents. - name: company_contact_person - description: '' + description: Contact person at the company receiving the delivery, used when users + ask who to coordinate with or who accepted the shipment. join_hint: table: tabContact 'on': company_contact_person = tabContact.name - name: tc_name - description: '' + description: Name of the terms and conditions template applied to this delivery + note, used when users ask about contractual terms or legal agreements governing + the delivery. join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Full text or details of the specific terms and conditions for this + delivery, used when users need the actual contractual language or delivery stipulations. - name: per_billed - description: '' + description: Percentage of the delivery note that has been invoiced to the customer - name: status - description: '' + description: Current state of the delivery note such as draft, submitted, completed, + or cancelled options: - Draft - To Bill @@ -7268,441 +8479,561 @@ tables: - Cancelled - Closed - name: per_installed - description: '' + description: Percentage of delivered items that have been installed at the customer + location - name: installation_status - description: '' + description: Status indicating whether delivered items have been installed at + the customer site - name: per_returned - description: '' + description: Percentage of delivered items that have been returned by the customer - name: transporter - description: '' + description: Shipping company or carrier responsible for delivering the goods + to the customer join_hint: table: tabSupplier 'on': transporter = tabSupplier.name - name: driver - description: '' + description: Name or identifier of the person driving the delivery vehicle for + this shipment join_hint: table: tabDriver 'on': driver = tabDriver.name - name: lr_no - description: '' + description: Lorry receipt number or consignment note number issued by the transporter + for tracking the shipment - name: vehicle_no - description: '' + description: Registration or license plate number of the vehicle used for delivery - name: transporter_name - description: '' + description: Name of the logistics company or carrier responsible for shipping + the goods. - name: driver_name - description: '' + description: Name of the person driving the vehicle delivering the goods. - name: lr_date - description: '' + description: Date on the lorry receipt or transport document, indicating when + goods were handed to the transporter. - name: po_no - description: '' + description: Customer's purchase order number referenced when tracking or matching + deliveries to customer orders. - name: po_date - description: '' + description: Date of the customer's purchase order used when filtering or sorting + deliveries by when the customer placed their order. - name: sales_partner - description: '' + description: Third-party partner or agent involved in the sale, referenced when + analyzing partner performance or filtering deliveries by sales channel. join_hint: table: tabSales Partner 'on': sales_partner = tabSales Partner.name - name: amount_eligible_for_commission - description: '' + description: The portion of the delivery note value that qualifies for sales commission + calculation, excluding non-commissionable items or adjustments. - name: commission_rate - description: '' + description: The percentage rate applied to calculate commission for this delivery + note, typically based on salesperson, product category, or customer terms. - name: total_commission - description: '' + description: The final commission amount earned on this delivery note, calculated + from the eligible amount and commission rate. - name: sales_team - description: '' + description: The sales team responsible for or assigned to this delivery, used + when filtering deliveries by team ownership or performance tracking. - name: auto_repeat - description: '' + description: Indicates if this delivery note is part of a recurring delivery schedule + or subscription-based fulfillment pattern. join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: letter_head - description: '' + description: The letterhead template or branding format applied to the printed + or PDF version of this delivery note. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: print_without_amount - description: '' + description: Controls whether delivery note prints with or without monetary amounts + shown - name: group_same_items - description: '' + description: Controls whether identical items are consolidated into single lines + on the delivery note - name: select_print_heading - description: '' + description: Custom heading or title to display when printing the delivery note join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: language - description: '' + description: Language code for delivery note document generation and customer + communication preferences. - name: is_internal_customer - description: '' + description: Indicates whether the delivery is to an internal company entity or + external customer for inter-company transfer tracking. - name: represents_company - description: '' + description: Company entity that this delivery note is issued on behalf of in + multi-company or branch scenarios. join_hint: table: tabCompany 'on': represents_company = tabCompany.name - name: inter_company_reference - description: '' + description: Links to the corresponding purchase receipt or sales invoice when + goods are transferred between related company entities. join_hint: table: tabPurchase Receipt 'on': inter_company_reference = tabPurchase Receipt.name - name: customer_group - description: '' + description: Classification or category of the customer receiving the delivery, + used for filtering deliveries by customer segment or type. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: territory - description: '' + description: Geographic region or sales area assigned to the customer receiving + the delivery, used for location-based delivery analysis. join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: source - description: '' + description: Origin or channel through which the delivery order was created or + received, such as sales order, purchase return, or stock transfer. join_hint: table: tabLead Source 'on': source = tabLead Source.name - name: campaign - description: '' + description: Marketing campaign associated with the delivery to track promotional + or seasonal fulfillment activities. join_hint: table: tabCampaign 'on': campaign = tabCampaign.name - name: excise_page - description: '' + description: Page number or reference in excise documentation for regulatory compliance + tracking of taxable goods delivery. - name: instructions - description: '' + description: Special handling instructions, delivery notes, or specific requirements + provided for the delivery personnel or recipient. + desc_done: true - table: tabDelivery Note Item description: '' fields: - name: name - description: '' + description: Unique identifier or code for the delivery note item line. - name: barcode - description: '' + description: Barcode value scanned or associated with the delivered item for tracking + and verification. - name: has_item_scanned - description: '' + description: Indicates whether the item was physically scanned during the delivery + process. - name: item_code - description: '' + description: Internal product identifier used when asking about specific items + delivered or shipped to customers. join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Product name or description used when asking about delivered items + by their common or display name. - name: customer_item_code - description: '' + description: Customer's own product identifier or SKU used when asking about deliveries + using the customer's naming convention rather than internal codes. - name: description - description: '' + description: Text describing the specific item being delivered, used when searching + for what products or goods were included in a delivery. - name: brand - description: '' + description: Brand or manufacturer name of the delivered item, used when filtering + or searching deliveries by product brand. join_hint: table: tabBrand 'on': brand = tabBrand.name - name: item_group - description: '' + description: Category or classification grouping of the delivered item, used when + analyzing deliveries by product type or category. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: image_view - description: '' + description: Visual representation of the delivered item for verification and + identification purposes. - name: qty - description: '' + description: Quantity of items actually delivered in this delivery note line. - name: stock_uom - description: '' + description: Unit of measurement for the delivered quantity (e.g., pieces, kg, + liters). join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: uom - description: '' + description: Unit of measurement for the delivered item quantity (e.g., boxes, + kg, pieces) as recorded on the delivery note. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert the delivery note item quantity from its UOM + to the base stock UOM. - name: stock_qty - description: '' + description: Quantity of the delivered item expressed in the base stock UOM after + applying the conversion factor. - name: returned_qty - description: '' + description: Quantity of items returned from this delivery, used when tracking + customer returns or partial rejections against delivered goods. - name: price_list_rate - description: '' + description: Item selling price from the price list in transaction currency, used + when verifying pricing or analyzing delivery values before currency conversion. - name: base_price_list_rate - description: '' + description: Item selling price from the price list in company base currency, + used for standardized financial reporting and multi-currency delivery analysis. - name: margin_type - description: '' + description: Indicates whether the margin is calculated as a percentage or fixed + amount on the delivered item. options: - Percentage - Amount - name: margin_rate_or_amount - description: '' + description: The numeric value of the margin applied, interpreted based on margin_type + as either a percentage rate or absolute amount. - name: rate_with_margin - description: '' + description: The final unit price of the delivered item after applying the margin + to the base rate. - name: discount_percentage - description: '' + description: Percentage discount applied directly to this delivery note item line. - name: discount_amount - description: '' + description: Monetary discount applied directly to this delivery note item line. - name: distributed_discount_amount - description: '' + description: Portion of header-level or document-level discount allocated to this + specific item line. - name: base_rate_with_margin - description: '' + description: Unit price including margin adjustments before applying currency + conversion or taxes, used when analyzing pricing with markup. - name: rate - description: '' + description: Final unit price applied to the delivery note item after all adjustments + including currency conversion. - name: amount - description: '' + description: Total line value for the delivered quantity calculated as rate multiplied + by quantity. - name: base_rate - description: '' + description: Unit price in company's base currency before applying pricing rules + or discounts. - name: base_amount - description: '' + description: Total line amount in company's base currency before applying pricing + rules or discounts. - name: pricing_rules - description: '' + description: Applied promotional or contractual pricing rules that modified the + standard rate for this delivery. - name: stock_uom_rate - description: '' + description: Rate per stock unit of measure, used when querying item pricing in + base inventory units rather than transaction units. - name: is_free_item - description: '' + description: Indicates whether the item was given at no charge as a promotional + or complimentary item in the delivery. - name: grant_commission - description: '' + description: Indicates whether this delivered item is eligible for sales commission + calculation. - name: net_rate - description: '' + description: Unit price of the delivered item excluding taxes, used when calculating + pre-tax line totals or comparing prices before tax application. - name: net_amount - description: '' + description: Total line amount for the delivered item excluding taxes, used when + analyzing delivery value before tax or reconciling pre-tax revenue. - name: item_tax_template - description: '' + description: Tax configuration applied to the delivered item, used when identifying + which tax rules or rates govern this specific item on the delivery note. join_hint: table: tabItem Tax Template 'on': item_tax_template = tabItem Tax Template.name - name: base_net_rate - description: '' + description: Unit price in company base currency after discounts but before taxes, + used when analyzing delivery pricing in standard currency. - name: base_net_amount - description: '' + description: Total line amount in company base currency after discounts but before + taxes, used when analyzing delivery values in standard currency. - name: billed_amt - description: '' + description: Amount already invoiced for this delivery note item, used to track + billing progress or identify unbilled deliveries. - name: incoming_rate - description: '' + description: Purchase or acquisition cost per unit of the item at the time of + receipt, used when analyzing cost basis or margins on delivered goods. - name: weight_per_unit - description: '' + description: Weight of a single unit of the item, used when calculating shipping + costs or total weight from quantity. - name: total_weight - description: '' + description: Combined weight of all units of this item in the delivery, used for + freight calculations and logistics planning. - name: weight_uom - description: '' + description: Unit of measurement for the item's weight on this delivery note line. join_hint: table: tabUOM 'on': weight_uom = tabUOM.name - name: warehouse - description: '' + description: Source warehouse from which the item is being delivered or shipped. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: target_warehouse - description: '' + description: Destination warehouse to which the item is being transferred in warehouse-to-warehouse + delivery transactions. join_hint: table: tabWarehouse 'on': target_warehouse = tabWarehouse.name - name: quality_inspection - description: '' + description: Quality inspection record associated with this delivered item for + tracking inspection results and compliance. join_hint: table: tabQuality Inspection 'on': quality_inspection = tabQuality Inspection.name - name: allow_zero_valuation_rate - description: '' + description: Indicates whether this delivery note item can have a zero inventory + valuation rate. - name: against_sales_order - description: '' + description: Sales order that this delivery note item is fulfilling or linked + to. join_hint: table: tabSales Order 'on': against_sales_order = tabSales Order.name - name: so_detail - description: '' + description: Links this delivery note item to the originating sales order line + item. - name: against_sales_invoice - description: '' + description: Links this delivery note item to the sales invoice it was billed + against. join_hint: table: tabSales Invoice 'on': against_sales_invoice = tabSales Invoice.name - name: si_detail - description: '' + description: Links this delivery note item to the specific sales invoice line + item it corresponds to. - name: dn_detail - description: '' + description: Unique identifier for the delivery note item line, referenced when + querying specific items within a delivery note. - name: against_pick_list - description: '' + description: Indicates whether this delivery note item was created from a pick + list, used to filter or identify items originating from warehouse picking operations. join_hint: table: tabPick List 'on': against_pick_list = tabPick List.name - name: pick_list_item - description: '' + description: Links to the specific pick list item that generated this delivery + note item, used to trace back to the original picking instruction. - name: serial_and_batch_bundle - description: '' + description: Reference to bundled serial and batch number tracking when items + use the bundle-based inventory system for lot traceability. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: use_serial_batch_fields - description: '' + description: Indicates whether this delivery note item uses individual serial/batch + fields instead of the bundle system for tracking. - name: serial_no - description: '' + description: Specific serial number assigned to this delivered item for individual + unit traceability and warranty tracking. - name: batch_no - description: '' + description: Batch or lot number assigned to the delivered items for traceability + and inventory tracking purposes. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: actual_qty - description: '' + description: Total quantity of items actually delivered in the base unit of measure. - name: actual_batch_qty - description: '' + description: Quantity actually delivered for the specific batch referenced in + this line item. - name: company_total_stock - description: '' + description: Total stock quantity available across the entire company for the + item being delivered. - name: installed_qty - description: '' + description: Quantity of items that have been installed at the customer location + as part of the delivery. - name: packed_qty - description: '' + description: Quantity of items that have been packed for this delivery note. - name: received_qty - description: '' + description: Quantity of items actually received against this delivery note line, + used when verifying shipment fulfillment or tracking receipt discrepancies. - name: expense_account - description: '' + description: General ledger account charged for this delivered item when it represents + an expense rather than inventory. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: item_tax_rate - description: '' + description: Tax percentage or rate applied to this specific delivery note item + for calculating tax amounts. - name: material_request - description: '' + description: Links delivery note item to the original material request that initiated + the procurement process. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: purchase_order - description: '' + description: Links delivery note item to the purchase order document used to order + the goods from the supplier. join_hint: table: tabPurchase Order 'on': purchase_order = tabPurchase Order.name - name: purchase_order_item - description: '' + description: Links delivery note item to the specific line item on the purchase + order that corresponds to this delivered item. - name: material_request_item - description: '' + description: Links this delivery to the original material request line item that + triggered the procurement or fulfillment. - name: cost_center - description: '' + description: Identifies which department or business unit should be charged for + this delivered item's costs. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Associates this delivered item with a specific project for tracking + project-related shipments and expenses. join_hint: table: tabProject 'on': project = tabProject.name - name: page_break - description: '' + description: Indicates whether a page break should occur before this delivery + note item when printing or generating documents. + desc_done: true - table: tabDelivery Settings description: '' fields: - name: name - description: '' + description: Unique identifier or label for the delivery settings configuration - name: dispatch_template - description: '' + description: Template used for generating dispatch notifications or documents + when deliveries are sent join_hint: table: tabEmail Template 'on': dispatch_template = tabEmail Template.name - name: dispatch_attachment - description: '' + description: File or document automatically attached to dispatch communications + for deliveries join_hint: table: tabPrint Format 'on': dispatch_attachment = tabPrint Format.name - name: send_with_attachment - description: '' + description: Whether delivery notifications or documents are sent with file attachments + included - name: stop_delay - description: '' + description: Time delay or grace period before a delivery stop or suspension takes + effect + desc_done: true - table: tabDelivery Stop description: '' fields: - name: name - description: '' + description: Unique identifier or label for the delivery stop location - name: customer - description: '' + description: Customer associated with this delivery stop join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: address - description: '' + description: Physical location or street address where the delivery will be made join_hint: table: tabAddress 'on': address = tabAddress.name - name: locked - description: '' + description: Indicates whether the delivery stop is locked and cannot be modified + or rescheduled. - name: customer_address - description: '' + description: The physical delivery location address where goods are to be delivered + for this stop. - name: visited - description: '' + description: Indicates whether the delivery driver has arrived at or completed + this delivery stop. - name: delivery_note - description: '' + description: The delivery note document identifier associated with this delivery + stop join_hint: table: tabDelivery Note 'on': delivery_note = tabDelivery Note.name - name: grand_total - description: '' + description: The total monetary value of goods being delivered at this stop - name: contact - description: '' + description: The person to contact or who received the delivery at this stop location join_hint: table: tabContact 'on': contact = tabContact.name - name: email_sent_to - description: '' + description: Email address where delivery notifications or stop-related communications + were sent - name: customer_contact - description: '' + description: Primary contact person at the customer location for this delivery + stop - name: distance - description: '' + description: Distance traveled to reach this delivery stop, typically from the + previous stop or depot - name: estimated_arrival - description: '' + description: Estimated date and time when the delivery vehicle is expected to + arrive at this stop location. - name: lat - description: '' + description: Latitude coordinate of the delivery stop location for mapping and + routing purposes. - name: uom - description: '' + description: Unit of measure for quantities being delivered or picked up at this + stop. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: lng - description: '' + description: Longitude coordinate of the delivery stop location for mapping and + route optimization queries. - name: details - description: '' + description: Additional notes or special instructions about the delivery stop + such as access codes, delivery preferences, or location-specific requirements. + desc_done: true - table: tabDelivery Trip description: '' fields: - name: name - description: '' + description: Unique identifier or code for the delivery trip - name: naming_series - description: '' + description: Prefix pattern used to auto-generate delivery trip names options: - MAT-DT-.YYYY.- - name: company - description: '' + description: Company entity that owns or operates this delivery trip join_hint: table: tabCompany 'on': company = tabCompany.name - name: email_notification_sent - description: '' + description: Whether email notification has been sent for this delivery trip - name: driver - description: '' + description: Driver ID or code assigned to the delivery trip join_hint: table: tabDriver 'on': driver = tabDriver.name - name: driver_name - description: '' + description: Full name of the driver assigned to the delivery trip - name: driver_email - description: '' + description: Email address of the driver assigned to the delivery trip for contact + or notification purposes. - name: driver_address - description: '' + description: Residential or home address of the driver assigned to the delivery + trip. join_hint: table: tabAddress 'on': driver_address = tabAddress.name - name: total_distance - description: '' + description: Total distance covered or planned for the entire delivery trip, typically + measured in kilometers or miles. - name: uom - description: '' + description: Unit of measurement for distance or volume metrics tracked during + the delivery trip. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: vehicle - description: '' + description: The specific vehicle assigned to execute this delivery trip. join_hint: table: tabVehicle 'on': vehicle = tabVehicle.name - name: departure_time - description: '' + description: The scheduled or actual time when the vehicle departed to begin the + delivery trip. - name: employee - description: '' + description: Driver or employee assigned to execute this delivery trip. join_hint: table: tabEmployee 'on': employee = tabEmployee.name - name: delivery_stops - description: '' + description: Number of stops or list of customer locations included in this delivery + trip route. - name: status - description: '' + description: Current state of the delivery trip such as scheduled, in transit, + completed, or cancelled. options: - Draft - Scheduled @@ -7710,104 +9041,136 @@ tables: - Completed - Cancelled - name: amended_from - description: '' + description: Links to the original delivery trip document that was corrected or + modified by this amended version. join_hint: table: tabDelivery Trip 'on': amended_from = tabDelivery Trip.name + desc_done: true - table: tabDepartment description: '' fields: - name: name - description: '' + description: Short code or abbreviation identifying the department, used when + users reference departments by acronym or short identifier. - name: department_name - description: '' + description: Full official name of the department, used when users ask about departments + by their complete formal title. - name: parent_department - description: '' + description: The department to which this department reports, used when users + ask about organizational hierarchy or which department a team belongs under. join_hint: table: tabDepartment 'on': parent_department = tabDepartment.name - name: company - description: '' + description: The company that owns or operates this department. join_hint: table: tabCompany 'on': company = tabCompany.name - name: is_group - description: '' + description: Indicates whether this department is a parent group containing other + departments or a single operational unit. - name: disabled - description: '' + description: Indicates whether this department is currently inactive and excluded + from active operations. - name: lft - description: '' + description: Left boundary value in nested set hierarchy used when querying department + tree structure or organizational depth. - name: rgt - description: '' + description: Right boundary value in nested set hierarchy used when querying department + subtrees or calculating descendants. - name: old_parent - description: '' + description: Previous parent department before reorganization, used when tracking + department moves or historical reporting structure changes. + desc_done: true - table: tabDependent Task description: '' fields: - name: name - description: '' + description: Name or identifier of the dependent task that must be completed in + relation to another task - name: task - description: '' + description: Parent or primary task that has dependent tasks associated with it join_hint: table: tabTask 'on': task = tabTask.name + desc_done: true - table: tabDepreciation Schedule description: '' fields: - name: name - description: '' + description: Unique identifier or label for the depreciation schedule entry - name: schedule_date - description: '' + description: Date when the depreciation expense is scheduled to be recorded or + recognized - name: depreciation_amount - description: '' + description: Monetary value of depreciation expense allocated for the scheduled + period - name: accumulated_depreciation_amount - description: '' + description: Total depreciation accumulated on an asset from acquisition through + the current period. - name: journal_entry - description: '' + description: Accounting journal entry reference created when depreciation is posted + to the general ledger. join_hint: table: tabJournal Entry 'on': journal_entry = tabJournal Entry.name - name: shift - description: '' + description: Work shift or time period during which the asset was used for depreciation + calculation purposes. join_hint: table: tabAsset Shift Factor 'on': shift = tabAsset Shift Factor.name + desc_done: true - table: tabDesignation description: '' fields: - name: name - description: '' + description: Unique identifier for the designation record, used when looking up + specific job titles or roles by their system name. - name: designation_name - description: '' + description: The official job title or position name, used when searching for + employee roles, organizational hierarchy, or filtering by specific designations. - name: description - description: '' + description: Detailed explanation of the designation's responsibilities and scope, + used when understanding role requirements or comparing similar positions. + desc_done: true - table: tabDesktop Icon description: '' fields: - name: name - description: '' + description: Unique identifier for the desktop icon, used when searching for or + referencing specific icon configurations. - name: module_name - description: '' + description: Module or application area this icon belongs to, used when filtering + icons by functional domain or system component. - name: label - description: '' + description: Display text shown to users for the icon, used when searching for + icons by their visible name or user-facing description. - name: standard - description: '' + description: Indicates whether the desktop icon is a built-in system icon rather + than user-created or custom. - name: custom - description: '' + description: Indicates whether the desktop icon was created or customized by a + user rather than being a standard system icon. - name: app - description: '' + description: The application or module that the desktop icon launches or links + to. - name: description - description: '' + description: Name or label of the desktop icon displayed to users - name: category - description: '' + description: Grouping or classification type for organizing desktop icons - name: hidden - description: '' + description: Whether the desktop icon is concealed from user view - name: blocked - description: '' + description: Whether the desktop icon is blocked or disabled from being displayed + or accessed by users. - name: force_show - description: '' + description: Whether the desktop icon is forced to always display regardless of + user preferences or permissions. - name: type - description: '' + description: The category or classification of the desktop icon such as link, + report, module, or page. options: - module - list @@ -7815,84 +9178,108 @@ tables: - page - query-report - name: _doctype - description: '' + description: The document type or module that this desktop icon represents or + links to. join_hint: table: tabDocType 'on': _doctype = tabDocType.name - name: _report - description: '' + description: The specific report that this desktop icon opens or provides access + to. join_hint: table: tabReport 'on': _report = tabReport.name - name: link - description: '' + description: The URL or navigation path that the desktop icon directs to when + clicked. - name: color - description: '' + description: Color of the desktop icon displayed to the user - name: icon - description: '' + description: Icon image or symbol representing the desktop item - name: reverse - description: '' + description: Whether the icon colors are inverted or displayed in reverse mode - name: idx - description: '' + description: Unique identifier for a desktop icon record + desc_done: true - table: tabDiscounted Invoice description: '' fields: - name: name - description: '' + description: Unique identifier for the discounted invoice record, used when referencing + specific discount transactions or tracking discount approvals. - name: sales_invoice - description: '' + description: Links to the original sales invoice that received the discount, used + when analyzing which invoices were discounted or reconciling discount impacts. join_hint: table: tabSales Invoice 'on': sales_invoice = tabSales Invoice.name - name: customer - description: '' + description: Identifies the customer who received the discounted invoice, used + when analyzing discount patterns by customer or evaluating customer-specific + pricing strategies. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: posting_date - description: '' + description: Date when the discounted invoice transaction was recorded in the + accounting ledger. - name: outstanding_amount - description: '' + description: Remaining unpaid balance on the discounted invoice after payments + and adjustments. - name: debit_to - description: '' + description: Account that receives the debit entry for the discounted invoice + transaction. join_hint: table: tabAccount 'on': debit_to = tabAccount.name + desc_done: true - table: tabDiscussion Reply description: '' fields: - name: name - description: '' + description: Unique identifier for the discussion reply record used when tracking + or referencing specific responses in conversation threads. - name: topic - description: '' + description: Links the reply to its parent discussion topic, used when filtering + or grouping responses by subject matter or conversation thread. join_hint: table: tabDiscussion Topic 'on': topic = tabDiscussion Topic.name - name: reply - description: '' + description: Contains the actual response text content, used when searching discussion + content or analyzing user feedback and comments. + desc_done: true - table: tabDiscussion Topic description: '' fields: - name: name - description: '' + description: Unique identifier for the discussion topic used when referencing + or retrieving specific discussion threads. - name: title - description: '' + description: The subject or heading of the discussion topic used when searching + for conversations about specific issues or subjects. - name: reference_doctype - description: '' + description: The document type this discussion is linked to, used when filtering + discussions by related module such as Task, Issue, or Project. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_docname - description: '' + description: Name or identifier of the document being discussed in this topic, + such as a sales order, invoice, or project task. + desc_done: true - table: tabDocField description: '' fields: - name: name - description: '' + description: The technical identifier or code name of the document field, used + when referencing fields programmatically or in custom scripts - name: label - description: '' + description: The user-facing display text shown for the field in forms and reports, + used when asking about what users see on screen - name: fieldtype - description: '' + description: The data type or input control type of the field such as text, number, + date, or select, used when filtering or searching by field behavior options: - Autocomplete - Attach @@ -7938,11 +9325,11 @@ tables: - Text Editor - Time - name: fieldname - description: '' + description: Name or identifier of a custom field defined in a document type - name: length - description: '' + description: Maximum number of characters allowed for the field value - name: precision - description: '' + description: Number of decimal places for numeric field values options: - '0' - '1' @@ -7955,261 +9342,349 @@ tables: - '8' - '9' - name: non_negative - description: '' + description: Whether the field value must be zero or positive, relevant when users + ask about validation rules or constraints on numeric or quantity fields. - name: hide_days - description: '' + description: Whether to hide the days component when displaying duration or date + values, relevant when users ask about date/time formatting or display preferences. - name: hide_seconds - description: '' + description: Whether to hide the seconds component when displaying time values, + relevant when users ask about time formatting or precision requirements. - name: reqd - description: '' + description: Whether the field is mandatory and must be filled in by users when + creating or editing documents. - name: is_virtual - description: '' + description: Whether the field is computed or derived rather than directly stored, + affecting how users can query or filter by it. - name: search_index - description: '' + description: Whether the field is indexed for fast searching and filtering in + queries and reports. - name: options - description: '' + description: Configuration settings or available choices for the document field, + such as validation rules, display options, or field behavior parameters. - name: sort_options - description: '' + description: Defines how values in this document field should be ordered or sorted + when displayed in lists or dropdowns. - name: show_dashboard - description: '' + description: Controls whether this document field appears on dashboard views or + summary screens. - name: link_filters - description: '' + description: Filters applied when linking this field to records in another DocType + to restrict which records can be selected - name: default - description: '' + description: Default value automatically populated in this field when creating + a new document - name: fetch_from - description: '' + description: Source field path from a linked document whose value is automatically + copied into this field - name: fetch_if_empty - description: '' + description: Controls whether the field value is automatically retrieved from + a linked document when left empty - name: hidden - description: '' + description: Indicates whether the field is concealed from the user interface + or form view - name: show_on_timeline - description: '' + description: Determines if changes to this field appear in the document's activity + timeline or history feed - name: bold - description: '' + description: Whether the field label appears in bold formatting in forms and documents - name: allow_in_quick_entry - description: '' + description: Whether the field is included in quick entry forms for faster data + input - name: translatable - description: '' + description: Whether the field content can be translated into multiple languages - name: print_hide - description: '' + description: Controls whether this field appears in printed documents and PDF + outputs. - name: print_hide_if_no_value - description: '' + description: Controls whether this field is hidden in printed documents when it + contains no value. - name: report_hide - description: '' + description: Controls whether this field appears in reports and report builder + views. - name: depends_on - description: '' + description: Condition that controls when this field is visible or enabled based + on values of other fields - name: collapsible - description: '' + description: Whether this field section can be collapsed or expanded in the user + interface - name: collapsible_depends_on - description: '' + description: Condition that controls when this field section can be collapsed + based on values of other fields - name: hide_border - description: '' + description: Whether the field displays without a visible border in forms and + layouts - name: in_list_view - description: '' + description: Whether the field appears as a column in list views and grid displays - name: in_standard_filter - description: '' + description: Whether the field is available as a quick filter option in standard + list filtering - name: in_preview - description: '' + description: Field appears in document preview or quick view displays - name: in_filter - description: '' + description: Field is available as a filter option when searching or narrowing + down documents - name: in_global_search - description: '' + description: Field is searchable through the global search functionality - name: read_only - description: '' + description: Field cannot be edited by users, relevant when asking about non-editable + or view-only fields - name: allow_on_submit - description: '' + description: Field can be modified after document submission, relevant when asking + about post-submission edits or amendments - name: ignore_user_permissions - description: '' + description: Field bypasses user permission restrictions, relevant when asking + about fields accessible regardless of role permissions - name: allow_bulk_edit - description: '' + description: Whether this field can be modified when performing bulk update operations + on multiple documents simultaneously. - name: make_attachment_public - description: '' + description: Whether attachments uploaded to this field are accessible without + authentication or login requirements. - name: permlevel - description: '' + description: Permission level required to view or edit this field, used when restricting + field access to specific user roles. - name: ignore_xss_filter - description: '' + description: Field allows HTML/script content without cross-site scripting sanitization + when enabled - name: unique - description: '' + description: Field enforces uniqueness constraint requiring distinct values across + all records - name: no_copy - description: '' + description: Field is excluded from duplication when copying or cloning documents - name: set_only_once - description: '' + description: Field value can only be set during initial creation and cannot be + changed afterward. - name: remember_last_selected_value - description: '' + description: Field automatically pre-fills with the last value the user selected + in previous entries. - name: mandatory_depends_on - description: '' + description: Conditional expression that determines when this field becomes required + based on other field values. - name: read_only_depends_on - description: '' + description: Condition expression that determines when this field becomes read-only + based on other field values - name: print_width - description: '' + description: Width allocated for this field when rendering printed documents or + PDF outputs - name: width - description: '' + description: Display width of this field in form views and data entry screens - name: max_height - description: '' + description: Maximum vertical space allowed for the field display in document + layouts or forms - name: columns - description: '' + description: Number of horizontal columns the field spans in the document layout - name: description - description: '' + description: Human-readable explanation or label text for the document field - name: documentation_url - description: '' + description: URL link to external documentation or help resources for this field - name: placeholder - description: '' + description: Example text shown in the field input before user enters a value - name: oldfieldname - description: '' + description: Previous name of this field before it was renamed or migrated - name: oldfieldtype - description: '' + description: Previous field type before a field type change or migration occurred. + desc_done: true - table: tabDocPerm description: '' fields: - name: name - description: '' + description: Identifies the specific document type or form to which these permissions + apply, used when filtering access rules by document category. - name: role - description: '' + description: Specifies which user role is granted or restricted access, used when + determining role-based document permissions and access control queries. join_hint: table: tabRole 'on': role = tabRole.name - name: if_owner - description: '' + description: Indicates whether the permission applies only to the document owner, + used when checking if users can access or modify their own documents versus + others' documents. - name: permlevel - description: '' + description: Permission level number that determines the hierarchy or priority + of access rights for a document type - name: select - description: '' + description: Whether users at this permission level can select or view records + in lists and reports - name: read - description: '' + description: Whether users at this permission level can open and read the full + document details - name: write - description: '' + description: Permission flag indicating whether the user or role can modify or + edit existing documents - name: create - description: '' + description: Permission flag indicating whether the user or role can create new + documents - name: delete - description: '' + description: Permission flag indicating whether the user or role can remove or + delete documents - name: submit - description: '' + description: Permission to submit a document from draft to submitted state - name: cancel - description: '' + description: Permission to cancel a submitted document - name: amend - description: '' + description: Permission to amend a cancelled or submitted document - name: report - description: '' + description: Permission to view or print the document type - name: export - description: '' + description: Permission to export the document type to external formats or systems - name: import - description: '' + description: Permission to import or create new documents of this type - name: share - description: '' + description: Permission flag indicating whether the user can share this document + with others - name: print - description: '' + description: Permission flag indicating whether the user can print this document - name: email - description: '' + description: Permission flag indicating whether the user can email this document + desc_done: true - table: tabDocShare description: Internal record of document shares fields: - name: name - description: '' + description: name - name: user - description: '' + description: The user account with whom the document is shared join_hint: table: tabUser 'on': user = tabUser.name - name: share_doctype - description: '' + description: The type of document being shared with the user join_hint: table: tabDocType 'on': share_doctype = tabDocType.name - name: share_name - description: '' + description: Name or identifier of the user, role, or group with whom the document + is shared. - name: read - description: '' + description: Indicates whether the shared party has permission to view or read + the document. - name: write - description: '' + description: Indicates whether the shared party has permission to edit or modify + the document. - name: share - description: '' + description: Document sharing permission level or sharing status indicating whether + and how the document is shared with others. - name: submit - description: '' + description: Indicates whether the document can be submitted or has been submitted + for approval or processing by shared users. - name: everyone - description: '' + description: Flag indicating whether the document is shared publicly with all + users in the system rather than specific individuals or groups. - name: notify_by_email - description: '' + description: Whether email notifications are sent to users when documents are + shared with them + desc_done: true - table: tabDocType Action description: '' fields: - name: name - description: '' + description: Unique identifier for the action that users reference when configuring + or querying specific document type actions - name: label - description: '' + description: Display text shown to end users in the interface when presenting + this action option - name: action_type - description: '' + description: Category of action behavior such as submit, save, cancel, or approve + that determines what the action does options: - Server Action - Route - name: action - description: '' + description: Specific operation or workflow step that can be performed on a document + type, such as submit, approve, cancel, or amend. - name: group - description: '' + description: Category or grouping that organizes related actions together for + a document type. - name: hidden - description: '' + description: Whether the action is concealed from users in the interface or available + action lists. - name: custom - description: '' + description: Indicates whether this action is user-defined rather than a standard + system action + desc_done: true - table: tabDocType Layout description: '' fields: - name: name - description: '' + description: name - name: document_type - description: '' + description: The DocType (form/module) that this layout configuration applies + to, such as Sales Invoice or Purchase Order. join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: route - description: '' + description: URL path or navigation route where this document type layout is accessed + in the application interface. - name: fields - description: '' + description: Field definitions and properties that control form layout, visibility, + and behavior for this document type - name: client_script - description: '' + description: JavaScript code that executes in the browser to add custom validation, + automation, or dynamic behavior to the form + desc_done: true - table: tabDocType Layout Field description: '' fields: - name: name - description: '' + description: Unique identifier for the document type layout field configuration + record. - name: label - description: '' + description: Display text shown to users for this field in the document type layout. - name: fieldname - description: '' + description: Technical field name that maps this layout field to the actual database + column in the document. + desc_done: true - table: tabDocType Link description: '' fields: - name: name - description: '' + description: Unique identifier for the document type link configuration. - name: link_doctype - description: '' + description: Specifies which document type is linked to the parent document for + cross-referencing and relationship tracking. join_hint: table: tabDocType 'on': link_doctype = tabDocType.name - name: link_fieldname - description: '' + description: Defines the specific field name in the linked document that establishes + the relationship connection. - name: parent_doctype - description: '' + description: The main document type that contains or references this linked child + table join_hint: table: tabDocType 'on': parent_doctype = tabDocType.name - name: table_fieldname - description: '' + description: The specific field name in the parent document that holds this child + table's data - name: group - description: '' + description: Category or grouping used to organize related document type links + together - name: hidden - description: '' + description: Whether this DocType link is hidden from the user interface and standard + views. - name: is_child_table - description: '' + description: Whether this link points to a child table that exists as nested records + within a parent document. - name: custom - description: '' + description: Whether this DocType link was created by a user or administrator + rather than being part of the standard system. + desc_done: true - table: tabDocType State description: '' fields: - name: name - description: '' + description: Unique identifier for the document type state, used when filtering + or grouping documents by their workflow status. - name: title - description: '' + description: Display label for the document type state, used when users search + for documents in specific approval or processing stages. - name: color - description: '' + description: Visual indicator color for the state, used when reporting or displaying + document status in dashboards and lists. options: - Blue - Cyan @@ -8222,55 +9697,72 @@ tables: - Red - Yellow - name: custom - description: '' + description: Indicates whether this document type state is user-defined rather + than a standard system state + desc_done: true - table: tabDocument Follow description: '' fields: - name: name - description: '' + description: Unique identifier for the document follow record. - name: ref_doctype - description: '' + description: Specifies which document type (e.g., Sales Order, Invoice) is being + followed or tracked. join_hint: table: tabDocType 'on': ref_doctype = tabDocType.name - name: ref_docname - description: '' + description: Identifies the specific document instance being followed, used to + track updates or changes to particular records. - name: user - description: '' + description: The user who is following or subscribed to a specific document to + receive notifications or updates about changes to that document. join_hint: table: tabUser 'on': user = tabUser.name + desc_done: true - table: tabDocument Naming Rule description: '' fields: - name: name - description: '' + description: name - name: document_type - description: '' + description: The type of document this naming rule applies to, such as Sales Invoice, + Purchase Order, or Payment Entry. join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: disabled - description: '' + description: Whether this naming rule is currently inactive and not being applied + to new documents. - name: priority - description: '' + description: Determines the order in which this naming rule is evaluated when + multiple rules could apply to the same document type. - name: conditions - description: '' + description: Defines the criteria or filters that must be met for this naming + rule to be applied to a document. - name: prefix - description: '' + description: The text string that will be added at the beginning of the generated + document name or number. - name: counter - description: '' + description: Current sequence number used to generate the next document name in + the series. - name: prefix_digits - description: '' + description: Number of digits to pad the counter with leading zeros in generated + document names. + desc_done: true - table: tabDocument Naming Rule Condition description: '' fields: - name: name - description: '' + description: Unique identifier for the document naming rule condition used when + matching specific criteria for automated document naming. - name: field - description: '' + description: The document field or attribute being evaluated in the naming rule + condition, such as document type, customer, or date. - name: condition - description: '' + description: The logical expression or criteria that must be met for this naming + rule to apply to a document. options: - '=' - '!=' @@ -8279,91 +9771,110 @@ tables: - '>=' - <= - name: value - description: '' + description: The specific value or pattern that a document field must match or + satisfy for this naming rule condition to apply. + desc_done: true - table: tabDocument Naming Settings description: Configure various aspects of how document naming works like naming series, current counter. fields: - name: name - description: '' + description: Unique identifier for the document naming configuration, used when + referencing specific naming rules. - name: transaction_type - description: '' + description: The document type (e.g., Sales Invoice, Purchase Order) this naming + rule applies to, used when filtering naming configurations by module or transaction. - name: naming_series_options - description: '' + description: Available prefix patterns for auto-generating document numbers, used + when setting up or validating document numbering schemes. - name: user_must_always_select - description: '' + description: Whether users are required to manually choose a naming series when + creating new documents of this type. - name: try_naming_series - description: '' + description: Naming pattern template that defines the format and sequence for + automatically generating document numbers. - name: series_preview - description: '' + description: Example output showing how document numbers will appear when generated + using the configured naming series. - name: prefix - description: '' + description: Text that appears at the beginning of automatically generated document + numbers or names - name: current_value - description: '' + description: The most recent number used in the document naming sequence - name: default_amend_naming - description: '' + description: Whether amended versions of documents automatically append amendment + indicators to their names options: - Amend Counter - Default Naming - name: amend_naming_override - description: '' + description: Whether the naming convention can be manually overridden when amending + documents. + desc_done: true - table: tabDocument Share Key description: '' fields: - name: name - description: '' + description: name - name: reference_doctype - description: '' + description: The type or category of document being shared (e.g., Sales Order, + Invoice, Purchase Order). join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_docname - description: '' + description: The specific document identifier or name that has been shared with + others. - name: key - description: '' + description: Unique shareable access key or token used to grant external access + to a specific document - name: expires_on - description: '' + description: Date when the document share key becomes invalid and access is revoked + desc_done: true - table: tabDomain description: '' fields: - name: name - description: '' + description: name - name: domain - description: '' + description: domain + desc_done: true - table: tabDomain Settings description: '' fields: - name: name - description: '' + description: Domain name or identifier for the settings configuration - name: active_domains - description: '' + description: Domains currently enabled or in use within the system + desc_done: true - table: tabDowntime Entry description: '' fields: - name: name - description: '' + description: Unique identifier for the downtime entry record - name: naming_series - description: '' + description: Prefix pattern used to generate the downtime entry name options: - DT- - name: workstation - description: '' + description: The specific workstation or machine that experienced the downtime join_hint: table: tabWorkstation 'on': workstation = tabWorkstation.name - name: operator - description: '' + description: Employee or machine operator who logged or is responsible for the + downtime event join_hint: table: tabEmployee 'on': operator = tabEmployee.name - name: from_time - description: '' + description: Start timestamp when the downtime period began - name: to_time - description: '' + description: End timestamp when the downtime period concluded - name: downtime - description: '' + description: Duration or period when equipment or production was not operational. - name: stop_reason - description: '' + description: Categorized cause or reason code explaining why the downtime occurred. options: - Excessive machine set up time - Unplanned machine maintenance @@ -8373,289 +9884,359 @@ tables: - Electricity down - Other - name: remarks - description: '' + description: Additional notes or detailed explanation about the downtime incident. + desc_done: true - table: tabDriver description: '' fields: - name: name - description: '' + description: Driver's primary identifier or short name used to reference the driver + in transactions and queries - name: naming_series - description: '' + description: Prefix pattern used to auto-generate driver IDs or codes options: - HR-DRI-.YYYY.- - name: full_name - description: '' + description: Driver's complete legal name including first, middle, and last names - name: status - description: '' + description: Current availability or employment status of the driver such as active, + inactive, or on leave. options: - Active - Suspended - Left - name: transporter - description: '' + description: The transportation company or carrier organization that the driver + works for or is contracted with. join_hint: table: tabSupplier 'on': transporter = tabSupplier.name - name: employee - description: '' + description: Reference to the driver's employee record if they are a direct employee + rather than a contractor. join_hint: table: tabEmployee 'on': employee = tabEmployee.name - name: cell_number - description: '' + description: Driver's mobile phone number for contact and communication purposes - name: address - description: '' + description: Driver's residential or mailing address for correspondence and records join_hint: table: tabAddress 'on': address = tabAddress.name - name: license_number - description: '' + description: Driver's license identification number required for legal driving + authorization - name: issuing_date - description: '' + description: When the driver's license was originally issued or granted to the + driver. - name: expiry_date - description: '' + description: When the driver's license expires and needs renewal. - name: driving_license_category - description: '' + description: Type or class of vehicles the driver is authorized to operate (e.g., + commercial, passenger, motorcycle). + desc_done: true - table: tabDriving License Category description: '' fields: - name: name - description: '' + description: Unique identifier or label for the driving license category used + when filtering or searching for specific license types. - name: class - description: '' + description: Classification code (e.g., A, B, C, D) used when determining vehicle + type permissions and license requirements. - name: description - description: '' + description: Detailed explanation of what vehicles or operations the license category + covers, used when validating driver qualifications or compliance requirements. - name: issuing_date - description: '' + description: Date when the driving license category was originally issued to the + holder. - name: expiry_date - description: '' + description: Date when the driving license category becomes invalid and requires + renewal. + desc_done: true - table: tabDropbox Settings description: '' fields: - name: name - description: '' + description: Name or identifier of the Dropbox integration configuration - name: enabled - description: '' + description: Whether the Dropbox integration is currently active and operational - name: send_notifications_to - description: '' + description: Email address or recipient who receives alerts about Dropbox sync + events and errors - name: send_email_for_successful_backup - description: '' + description: Whether email notifications are sent when Dropbox backups complete + successfully. - name: backup_frequency - description: '' + description: How often automated Dropbox backups are scheduled to run. options: - Daily - Weekly - name: limit_no_of_backups - description: '' + description: Maximum number of backup copies retained in Dropbox before older + backups are deleted. - name: no_of_backups - description: '' + description: Number of backup copies retained in Dropbox for the organization. - name: file_backup - description: '' + description: Indicates whether automatic file backup to Dropbox is enabled. - name: app_access_key - description: '' + description: Authentication key used to connect and authorize the application + with Dropbox services. - name: app_secret_key - description: '' + description: Secret key for authenticating the Dropbox application integration. - name: dropbox_refresh_token - description: '' + description: Token used to obtain new access tokens when the current Dropbox access + token expires. - name: dropbox_access_token - description: '' + description: Current active token for authorizing API requests to Dropbox services. + desc_done: true - table: tabDunning description: '' fields: - name: name - description: '' + description: Unique identifier for the dunning notice or letter sent to the customer + for overdue payments - name: naming_series - description: '' + description: Prefix pattern used to auto-generate dunning notice numbers options: - DUNN-.MM.-.YY.- - name: customer - description: '' + description: Customer who is being sent the dunning notice for outstanding or + overdue invoices join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: customer_name - description: '' + description: Name of the customer being dunned for overdue payments or outstanding + invoices. - name: company - description: '' + description: Company entity that issued the dunning notice or owns the receivable. join_hint: table: tabCompany 'on': company = tabCompany.name - name: posting_date - description: '' + description: Date when the dunning notice or related transaction was posted to + the accounting ledger. - name: posting_time - description: '' + description: Time of day when the dunning notice was posted or created. - name: status - description: '' + description: Current state of the dunning process such as draft, sent, resolved, + or cancelled. options: - Draft - Resolved - Unresolved - Cancelled - name: currency - description: '' + description: Currency in which the dunning amounts and outstanding balances are + denominated. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: conversion_rate - description: '' + description: Exchange rate used to convert dunning amounts from transaction currency + to company base currency. - name: dunning_type - description: '' + description: Classification of the dunning notice such as first reminder, second + reminder, final notice, or legal action. join_hint: table: tabDunning Type 'on': dunning_type = tabDunning Type.name - name: rate_of_interest - description: '' + description: Interest percentage charged on overdue amounts as specified in the + dunning notice or agreement. - name: overdue_payments - description: '' + description: Amount of payments past their due date that triggered dunning actions + or collection processes. - name: total_interest - description: '' + description: Accumulated interest charges on overdue payments or late balances. - name: dunning_fee - description: '' + description: Fee charged to the customer for dunning collection activities or + late payment reminders. - name: dunning_amount - description: '' + description: Total amount subject to dunning collection in transaction currency, + used when asking about overdue payment amounts or dunning fees charged to customers. - name: base_dunning_amount - description: '' + description: Dunning amount converted to company base currency for consolidated + reporting across multiple currencies. - name: spacer - description: '' + description: Visual separator or placeholder field with no business data value. - name: total_outstanding - description: '' + description: Unpaid balance remaining on the dunning notice after payments and + credits applied - name: grand_total - description: '' + description: Total amount originally due on the dunning notice before any payments + or adjustments - name: language - description: '' + description: Language in which the dunning notice was generated or should be communicated + to the customer join_hint: table: tabLanguage 'on': language = tabLanguage.name - name: body_text - description: '' + description: Main content of the dunning letter sent to customers regarding overdue + payments or outstanding balances. - name: letter_head - description: '' + description: Header section of the dunning letter containing company branding, + logo, or sender information. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: closing_text - description: '' + description: Final paragraph or sign-off text at the end of the dunning letter, + typically containing contact information or payment instructions. - name: income_account - description: '' + description: Account where dunning fees or charges are recorded as revenue join_hint: table: tabAccount 'on': income_account = tabAccount.name - name: cost_center - description: '' + description: Cost center to which dunning-related expenses or activities are allocated join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: amended_from - description: '' + description: Reference to the original dunning document that this dunning replaces + or corrects join_hint: table: tabDunning 'on': amended_from = tabDunning.name - name: customer_address - description: '' + description: Physical or billing address of the customer being dunned for overdue + payments. join_hint: table: tabAddress 'on': customer_address = tabAddress.name - name: address_display - description: '' + description: Formatted address string used when displaying or printing dunning + notices to customers. - name: contact_person - description: '' + description: Specific individual at the customer organization to contact regarding + overdue invoices and payment collection. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_display - description: '' + description: Name of the person to contact for dunning communications or payment + follow-up - name: contact_mobile - description: '' + description: Mobile phone number to reach the dunning contact for urgent payment + matters - name: contact_email - description: '' + description: Email address for sending dunning notices and payment reminders to + the contact - name: company_address - description: '' + description: Company address used for dunning correspondence and legal notices + sent to customers. join_hint: table: tabAddress 'on': company_address = tabAddress.name - name: company_address_display - description: '' + description: Formatted version of company address for display on dunning letters + and customer-facing documents. + desc_done: true - table: tabDunning Letter Text description: '' fields: - name: name - description: '' + description: Unique identifier or title for the dunning letter text template used + to distinguish between different letter versions or types - name: language - description: '' + description: Language code or locale in which the dunning letter text is written, + used when matching letters to customer language preferences join_hint: table: tabLanguage 'on': language = tabLanguage.name - name: is_default_language - description: '' + description: Indicates whether this dunning letter text serves as the fallback + template when no language-specific version matches the customer's language - name: body_text - description: '' + description: Main message content of the dunning letter sent to customers regarding + overdue payments or outstanding balances. - name: closing_text - description: '' + description: Final closing statement or sign-off text that appears at the end + of the dunning letter after the main body content. + desc_done: true - table: tabDunning Type description: '' fields: - name: name - description: '' + description: Unique identifier or label for the dunning type configuration - name: dunning_type - description: '' + description: Classification or category of the dunning process such as letter-based, + email-based, or legal action dunning - name: is_default - description: '' + description: Indicates whether this dunning type is automatically applied to new + customers or accounts without explicit assignment - name: company - description: '' + description: Company entity to which this dunning type configuration applies. join_hint: table: tabCompany 'on': company = tabCompany.name - name: dunning_fee - description: '' + description: Fixed fee amount charged to customers when this dunning type is applied + for overdue payments. - name: rate_of_interest - description: '' + description: Percentage interest rate applied to overdue amounts when using this + dunning type. - name: dunning_letter_text - description: '' + description: Text content of the dunning notice sent to customers with overdue + payments. - name: income_account - description: '' + description: Account where dunning fees or charges are recorded as revenue. join_hint: table: tabAccount 'on': income_account = tabAccount.name - name: cost_center - description: '' + description: Cost center to which dunning-related expenses or activities are allocated. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name + desc_done: true - table: tabDynamic Link description: '' fields: - name: name - description: '' + description: Unique identifier for this dynamic link record - name: link_doctype - description: '' + description: The type of document being linked (e.g., Customer, Supplier, Employee) + that determines what kind of entity this link points to join_hint: table: tabDocType 'on': link_doctype = tabDocType.name - name: link_name - description: '' + description: The specific document ID or name of the linked entity within the + link_doctype - name: link_title - description: '' + description: Title or name of the linked document or record being referenced in + the dynamic relationship + desc_done: true - table: tabEmail Account description: '' fields: - name: name - description: '' + description: email_account_name - name: email_id - description: '' + description: email_address_or_username_for_the_account - name: company - description: '' + description: company_or_organization_associated_with_this_email_account join_hint: table: tabCompany 'on': company = tabCompany.name - name: email_account_name - description: '' + description: The unique identifier or label for the email account, used when searching + for specific email configurations or account details. - name: domain - description: '' + description: The domain portion of the email address (e.g., company.com), used + when filtering accounts by organization or email provider domain. join_hint: table: tabEmail Domain 'on': domain = tabEmail Domain.name - name: service - description: '' + description: The email service provider or protocol type (e.g., Gmail, Outlook, + IMAP, SMTP), used when identifying which platform or technology handles the + email account. options: - GMail - Sendgrid @@ -8664,337 +10245,440 @@ tables: - Outlook.com - Yandex.Mail - name: auth_method - description: '' + description: Authentication method used for the email account such as password, + OAuth, or API token. options: - Basic - OAuth - name: backend_app_flow - description: '' + description: Whether the email account uses backend application authentication + flow for automated or service-based access. - name: password - description: '' + description: Password credential for email account authentication when using password-based + auth method. - name: awaiting_password - description: '' + description: Indicates whether the email account is pending password entry or + authentication credentials to become active. - name: ascii_encode_password - description: '' + description: Controls whether the password should be ASCII-encoded for compatibility + with certain email servers or authentication protocols. - name: connected_app - description: '' + description: References the third-party application or OAuth app used to authenticate + and connect this email account. join_hint: table: tabConnected App 'on': connected_app = tabConnected App.name - name: connected_user - description: '' + description: User account linked to this email account for sending and receiving + emails join_hint: table: tabUser 'on': connected_user = tabUser.name - name: login_id_is_different - description: '' + description: Indicates whether the login credentials differ from the email address + itself - name: login_id - description: '' + description: Username or identifier used to authenticate into the email server + when different from the email address - name: enable_incoming - description: '' + description: Whether this email account can receive incoming emails from external + sources. - name: default_incoming - description: '' + description: Whether this email account is the default account for receiving all + incoming emails. - name: use_imap - description: '' + description: Whether this email account uses IMAP protocol instead of POP3 for + retrieving emails. - name: use_ssl - description: '' + description: Whether the email account uses SSL encryption for secure connection + to the email server. - name: use_starttls - description: '' + description: Whether the email account uses STARTTLS encryption to upgrade a plain + connection to secure. - name: email_server - description: '' + description: The hostname or IP address of the incoming mail server for receiving + emails. - name: incoming_port - description: '' + description: Port number for receiving incoming emails via IMAP or POP3 protocols - name: attachment_limit - description: '' + description: Maximum file size allowed for email attachments in this account - name: email_sync_option - description: '' + description: Configuration for how emails are synchronized between server and + system, such as sync frequency or which folders to sync options: - ALL - UNSEEN - name: initial_sync_count - description: '' + description: Number of emails synchronized during the first sync when the email + account was set up options: - '100' - '250' - '500' - name: imap_folder - description: '' + description: IMAP folder path or name where emails are stored or retrieved from + on the mail server - name: append_emails_to_sent_folder - description: '' + description: Whether sent emails are automatically added to the sent folder after + being dispatched - name: sent_folder_name - description: '' + description: Name of the folder where sent emails are stored for this email account. - name: append_to - description: '' + description: Specifies which DocType or entity type incoming emails should be + linked or appended to. join_hint: table: tabDocType 'on': append_to = tabDocType.name - name: create_contact - description: '' + description: Whether to automatically create a new contact record when receiving + emails from unknown senders. - name: enable_automatic_linking - description: '' + description: Whether incoming emails are automatically linked to related documents + like customers, leads, or issues. - name: notify_if_unreplied - description: '' + description: Whether to send notifications when emails remain unanswered for a + specified duration. - name: unreplied_for_mins - description: '' + description: Time threshold in minutes after which an unreplied email triggers + a notification. - name: send_notification_to - description: '' + description: Email address that receives system notifications and alerts from + this email account. - name: enable_outgoing - description: '' + description: Whether this email account can send outbound emails. - name: use_tls - description: '' + description: Whether TLS encryption is enabled for secure email transmission on + this account. - name: use_ssl_for_outgoing - description: '' + description: Whether SSL/TLS encryption is enabled for sending outbound emails + through this account. - name: smtp_server - description: '' + description: Hostname or IP address of the mail server used to send outgoing emails. - name: smtp_port - description: '' + description: Network port number used to connect to the SMTP server for sending + emails. - name: default_outgoing - description: '' + description: Whether this email account is the default choice for sending outbound + emails from the system. - name: always_use_account_email_id_as_sender - description: '' + description: Whether outgoing emails always use this account's email address as + the sender, overriding individual user email addresses. - name: always_use_account_name_as_sender_name - description: '' + description: Whether outgoing emails always use this account's display name as + the sender name, overriding individual user names. - name: send_unsubscribe_message - description: '' + description: Whether unsubscribe confirmation messages are sent when recipients + opt out of emails from this account. - name: track_email_status - description: '' + description: Whether delivery, open, and bounce tracking is enabled for emails + sent through this account. - name: no_smtp_authentication - description: '' + description: Whether SMTP authentication is disabled when connecting to the outgoing + mail server for this account. - name: always_bcc - description: '' + description: Email addresses that are automatically copied on every outgoing email + from this account - name: add_signature - description: '' + description: Whether the signature is automatically appended to outgoing emails + from this account - name: signature - description: '' + description: The text or HTML content that appears at the bottom of outgoing emails + when enabled - name: enable_auto_reply - description: '' + description: Whether automatic email replies are turned on for this email account + when receiving messages - name: auto_reply_message - description: '' + description: The text content sent automatically when someone emails this account + and auto-reply is enabled - name: footer - description: '' + description: Signature or standard text automatically appended to the bottom of + outgoing emails from this account - name: uidvalidity - description: '' + description: IMAP uidvalidity value indicating whether email UIDs have been reset + or changed for this account. - name: uidnext - description: '' + description: IMAP uidnext value predicting the next unique identifier to be assigned + to incoming emails. - name: no_failed - description: '' + description: Count of failed email operations or connection attempts for this + email account. + desc_done: true - table: tabEmail Campaign description: '' fields: - name: name - description: '' + description: Unique identifier or code for the email campaign record - name: campaign_name - description: '' + description: Display name or title of the email campaign used in marketing communications join_hint: table: tabCampaign 'on': campaign_name = tabCampaign.name - name: email_campaign_for - description: '' + description: Target entity, audience segment, or purpose that this email campaign + is designed to reach options: - Lead - Contact - Email Group - name: recipient - description: '' + description: Email address or contact who receives the campaign message - name: sender - description: '' + description: Email address or contact who sends the campaign message join_hint: table: tabUser 'on': sender = tabUser.name - name: start_date - description: '' + description: Date when the email campaign begins or is scheduled to launch - name: end_date - description: '' + description: Date when the email campaign concludes or is scheduled to stop sending + messages. - name: status - description: '' + description: Current state of the email campaign such as draft, active, paused, + completed, or cancelled. options: - Scheduled - In Progress - Completed - Unsubscribed + desc_done: true - table: tabEmail Digest description: Send regular summary reports via Email. fields: - name: name - description: '' + description: Unique identifier or title of the email digest configuration - name: enabled - description: '' + description: Whether this email digest is currently active and will be sent to + recipients - name: company - description: '' + description: Company or organization that this email digest belongs to or is configured + for join_hint: table: tabCompany 'on': company = tabCompany.name - name: frequency - description: '' + description: How often the email digest is sent (daily, weekly, monthly) to determine + the schedule interval. options: - Daily - Weekly - Monthly - name: next_send - description: '' + description: The upcoming date and time when this email digest will be automatically + sent to recipients. - name: recipients - description: '' + description: The list of email addresses or users who will receive this digest + when it is sent. - name: income - description: '' + description: Revenue or earnings received during the email digest period. - name: expenses_booked - description: '' + description: Expenses recorded or recognized during the email digest period. - name: income_year_to_date - description: '' + description: Cumulative revenue or earnings from the start of the fiscal year + to the email digest date. - name: expense_year_to_date - description: '' + description: Total expenses accumulated from the beginning of the current year, + used when asking about annual spending or year-to-date expense totals. - name: bank_balance - description: '' + description: Current amount of funds available in bank accounts, used when asking + about available cash or bank account balances. - name: credit_balance - description: '' + description: Outstanding credit amount owed or available credit limit, used when + asking about credit obligations or available credit. - name: invoiced_amount - description: '' + description: Total amount that has been invoiced to customers for completed billing + transactions. - name: payables - description: '' + description: Outstanding amounts owed to suppliers or vendors that need to be + paid. - name: sales_orders_to_bill - description: '' + description: Sales orders that have been fulfilled or shipped but not yet invoiced + to customers. - name: purchase_orders_to_bill - description: '' + description: Filters digest to include purchase orders that have been received + but not yet invoiced by suppliers. - name: sales_order - description: '' + description: Filters digest to include sales order transactions and customer order + activity. - name: purchase_order - description: '' + description: Filters digest to include purchase order transactions and supplier + ordering activity. - name: sales_orders_to_deliver - description: '' + description: Sales orders that have been confirmed but not yet fully delivered + to customers. - name: purchase_orders_to_receive - description: '' + description: Purchase orders awaiting receipt of goods or services from suppliers. - name: sales_invoice - description: '' + description: Invoices issued to customers for sales transactions. - name: purchase_invoice - description: '' + description: Referenced when users ask about supplier bills, vendor invoices, + or accounts payable documents in email digests. - name: new_quotations - description: '' + description: Referenced when users ask about recently created or just-submitted + sales quotes in email digests. - name: pending_quotations - description: '' + description: Referenced when users ask about outstanding or awaiting-response + sales quotes in email digests. - name: issue - description: '' + description: References a specific issue or problem tracked in the system that + is included in the email digest. - name: project - description: '' + description: References the project associated with items or updates included + in the email digest. - name: purchase_orders_items_overdue - description: '' + description: Indicates whether the email digest includes information about overdue + purchase order items. - name: calendar_events - description: '' + description: Whether the digest includes upcoming calendar events and meetings + scheduled for the recipient - name: todo_list - description: '' + description: Whether the digest includes pending tasks and to-do items assigned + to or created by the recipient - name: notifications - description: '' + description: Whether the digest includes system notifications, alerts, and activity + updates for the recipient - name: add_quote - description: '' + description: Whether to include quoted text from previous messages in the email + digest + desc_done: true - table: tabEmail Digest Recipient description: '' fields: - name: name - description: '' + description: Unique identifier for the email digest recipient record - name: recipient - description: '' + description: Email address or user who receives the digest notifications join_hint: table: tabUser 'on': recipient = tabUser.name + desc_done: true - table: tabEmail Domain description: '' fields: - name: name - description: '' + description: Descriptive label or identifier for the email domain configuration - name: domain_name - description: '' + description: The actual domain name (e.g., company.com) used in email addresses - name: email_server - description: '' + description: The mail server hostname or address that handles email for this domain - name: use_imap - description: '' + description: Whether incoming email is retrieved using IMAP protocol instead of + POP3. - name: use_ssl - description: '' + description: Whether the email connection uses SSL/TLS encryption from the start + of the connection. - name: use_starttls - description: '' + description: Whether the email connection upgrades to TLS encryption after initial + plain connection using STARTTLS command. - name: incoming_port - description: '' + description: Port number for receiving incoming emails through IMAP or POP3 protocols. - name: attachment_limit - description: '' + description: Maximum file size allowed for email attachments in this domain. - name: smtp_server - description: '' + description: Server address used for sending outgoing emails from this domain. - name: use_tls - description: '' + description: Whether TLS encryption is enabled for email communication on this + domain. - name: use_ssl_for_outgoing - description: '' + description: Whether SSL encryption is enabled specifically for outgoing emails + from this domain. - name: smtp_port - description: '' + description: The port number used for SMTP server connections when sending emails + from this domain. - name: append_emails_to_sent_folder - description: '' + description: Whether outgoing emails are automatically saved to the sent folder + for this email domain. - name: sent_folder_name - description: '' + description: The name of the folder where sent emails are stored for this email + domain. + desc_done: true - table: tabEmail Flag Queue description: '' fields: - name: name - description: '' + description: Identifier or label for the email flag queue entry - name: is_completed - description: '' + description: Whether the email flagging task has been finished or resolved - name: communication - description: '' + description: Reference to the specific email or message associated with this flag + queue item - name: action - description: '' + description: The type of email operation to perform, such as send, receive, or + process. options: - Read - Unread - name: email_account - description: '' + description: The email account associated with this queued email action. - name: uid - description: '' + description: Unique identifier for tracking a specific email in the processing + queue. + desc_done: true - table: tabEmail Group description: '' fields: - name: name - description: '' + description: Unique identifier or code for the email group used in technical queries + and system references - name: title - description: '' + description: Display label or human-readable name of the email group shown to + users - name: total_subscribers - description: '' + description: Count of recipients or members currently subscribed to this email + group - name: confirmation_email_template - description: '' + description: Template used when users need to confirm their subscription or membership + to the email group. join_hint: table: tabEmail Template 'on': confirmation_email_template = tabEmail Template.name - name: welcome_email_template - description: '' + description: Template sent to new members when they join or are added to the email + group. join_hint: table: tabEmail Template 'on': welcome_email_template = tabEmail Template.name - name: welcome_url - description: '' + description: URL included in welcome communications where new members are directed + after joining the email group. - name: add_query_parameters - description: '' + description: Query string parameters automatically appended to links in emails + sent to this group. + desc_done: true - table: tabEmail Group Member description: '' fields: - name: name - description: '' + description: Unique identifier for the email group member record. - name: email_group - description: '' + description: Links to the parent email group to which this member belongs, used + when querying group membership or distribution lists. join_hint: table: tabEmail Group 'on': email_group = tabEmail Group.name - name: email - description: '' + description: The email address of the member, used when searching for who receives + communications from a specific group or when validating recipient lists. - name: unsubscribed - description: '' + description: Whether the member has opted out of receiving emails from this email + group. + desc_done: true - table: tabEmail Queue description: Email Queue records. fields: - name: name - description: '' + description: Unique identifier or reference name for the queued email message - name: sender - description: '' + description: Email address or account from which the email will be sent - name: recipients - description: '' + description: Email addresses of people who will receive the email - name: show_as_cc - description: '' + description: Whether the recipient appears in the CC field rather than the TO + field of the email - name: message - description: '' + description: The actual email content or body text being sent - name: status - description: '' + description: Current state of the email in the queue such as pending, sent, failed, + or error options: - Not Sent - Sending @@ -9002,251 +10686,317 @@ tables: - Partially Sent - Error - name: error - description: '' + description: Error message or exception details when email sending or processing + fails. - name: message_id - description: '' + description: Unique identifier assigned to the email message for tracking and + referencing in email systems. - name: reference_doctype - description: '' + description: Type of document that triggered or is associated with this queued + email. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_name - description: '' + description: Unique identifier or name for the queued email used to track or reference + specific email entries. - name: communication - description: '' + description: The communication template or document type associated with this + queued email. join_hint: table: tabCommunication 'on': communication = tabCommunication.name - name: send_after - description: '' + description: Scheduled date and time when the email should be sent or become eligible + for sending. - name: priority - description: '' + description: Urgency level of the email determining send order when multiple emails + are queued. - name: add_unsubscribe_link - description: '' + description: Whether an unsubscribe link is automatically included in the email + footer. - name: unsubscribe_param - description: '' + description: URL parameter or token used to identify the recipient when they click + the unsubscribe link. - name: unsubscribe_method - description: '' + description: Method or mechanism used by recipients to opt out of email communications. - name: expose_recipients - description: '' + description: Whether recipient email addresses are visible to all recipients in + the email. - name: attachments - description: '' + description: Files or documents included with the queued email. - name: retry - description: '' + description: Number of times the system has attempted to send this email after + initial failure - name: email_account - description: '' + description: The email account or sender configuration used to send this email join_hint: table: tabEmail Account 'on': email_account = tabEmail Account.name + desc_done: true - table: tabEmail Queue Recipient description: '' fields: - name: name - description: '' + description: Unique identifier for the email queue recipient record - name: recipient - description: '' + description: Email address or contact receiving the queued email message - name: status - description: '' + description: Current delivery state of the email such as pending, sent, failed, + or bounced options: - Not Sent - Sent - name: error - description: '' + description: Error message or failure reason when email delivery to this recipient + failed + desc_done: true - table: tabEmail Rule description: '' fields: - name: name - description: '' + description: Unique identifier or label for the email rule used to organize and + reference specific filtering or routing configurations - name: email_id - description: '' + description: Identifier of the specific email message that this rule applies to + or was triggered by - name: is_spam - description: '' + description: Indicates whether the email rule classifies or marks messages as + spam or junk mail + desc_done: true - table: tabEmail Template description: '' fields: - name: name - description: '' + description: Unique identifier or title of the email template used to reference + or select a specific template - name: subject - description: '' + description: Subject line text that will appear in emails sent using this template - name: use_html - description: '' + description: Indicates whether the email template uses HTML formatting versus + plain text - name: response_html - description: '' + description: HTML-formatted version of the email template content for rendering + rich text with styling, images, and links. - name: response - description: '' + description: Plain text version of the email template content without formatting + or markup. + desc_done: true - table: tabEmail Unsubscribe description: '' fields: - name: name - description: '' + description: name - name: email - description: '' + description: Email address of the contact who has unsubscribed from communications - name: reference_doctype - description: '' + description: Document type that triggered or is associated with the unsubscribe + action join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_name - description: '' + description: Unique identifier or name for the email unsubscribe record, used + when searching for specific unsubscribe entries or referencing them in queries. - name: global_unsubscribe - description: '' + description: Indicates whether the contact has opted out of all email communications + across the entire system, not just specific email types or campaigns. + desc_done: true - table: tabEmployee description: '' fields: - name: name - description: '' + description: Full name of the employee as displayed throughout the system - name: employee - description: '' + description: Unique employee identifier or code used to reference a specific employee + record - name: naming_series - description: '' + description: Prefix pattern used to generate the employee identifier options: - HR-EMP- - name: first_name - description: '' + description: Employee's given name used when searching or filtering by first name + only. - name: middle_name - description: '' + description: Employee's middle name used when full legal name or complete name + matching is required. - name: last_name - description: '' + description: Employee's family name or surname used when searching by last name + or sorting alphabetically. - name: employee_name - description: '' + description: Full name of the employee for identification, searching, and filtering + by person. - name: gender - description: '' + description: Employee's gender for demographic analysis, diversity reporting, + and HR compliance queries. join_hint: table: tabGender 'on': gender = tabGender.name - name: date_of_birth - description: '' + description: Employee's birth date for calculating age, retirement eligibility, + and age-related benefits or compliance. - name: salutation - description: '' + description: Title or honorific used to address the employee such as Mr., Ms., + Dr., or Prof. join_hint: table: tabSalutation 'on': salutation = tabSalutation.name - name: date_of_joining - description: '' + description: The date when the employee officially started working at the organization. - name: status - description: '' + description: Current employment status indicating whether the employee is active, + on leave, terminated, or resigned. options: - Active - Inactive - Suspended - Left - name: user_id - description: '' + description: Employee's unique system login identifier for authentication and + user account linkage. join_hint: table: tabUser 'on': user_id = tabUser.name - name: create_user_permission - description: '' + description: Whether the employee is authorized to create new user accounts in + the system. - name: company - description: '' + description: The company or legal entity to which the employee belongs. join_hint: table: tabCompany 'on': company = tabCompany.name - name: department - description: '' + description: Organizational unit or division where the employee works, used to + filter or group employees by business function or team. join_hint: table: tabDepartment 'on': department = tabDepartment.name - name: employee_number - description: '' + description: Unique identifier assigned to each employee, used to look up or reference + a specific individual. - name: designation - description: '' + description: Job title or role of the employee, used to identify position level, + responsibilities, or filter by job function. join_hint: table: tabDesignation 'on': designation = tabDesignation.name - name: reports_to - description: '' + description: Manager or supervisor that the employee directly reports to in the + organizational hierarchy. join_hint: table: tabEmployee 'on': reports_to = tabEmployee.name - name: branch - description: '' + description: Physical office location or branch where the employee is assigned + to work. join_hint: table: tabBranch 'on': branch = tabBranch.name - name: scheduled_confirmation_date - description: '' + description: Date when the employee's probationary period is expected to end and + employment status becomes permanent. - name: final_confirmation_date - description: '' + description: Date when employee's permanent employment status was confirmed after + probation or trial period. - name: contract_end_date - description: '' + description: Date when employee's employment contract expires or terminates, relevant + for fixed-term or temporary employees. - name: notice_number_of_days - description: '' + description: Required advance notice period in days before employment termination + by either employee or employer. - name: date_of_retirement - description: '' + description: When an employee retired or is scheduled to retire from the organization. - name: cell_number - description: '' + description: Employee's mobile phone number for direct contact. - name: personal_email - description: '' + description: Employee's non-work email address for personal communication outside + company systems. - name: company_email - description: '' + description: Official work email address assigned by the organization to the employee. - name: prefered_contact_email - description: '' + description: Email address the employee prefers for receiving work-related communications + and notifications. options: - Company Email - Personal Email - User ID - name: prefered_email - description: '' + description: Employee's preferred personal email address for general correspondence. - name: unsubscribed - description: '' + description: Whether employee has opted out of company communications or mailing + lists. - name: current_address - description: '' + description: Employee's present residential address for contact, shipping, or + location-based queries. - name: current_accommodation_type - description: '' + description: Type of housing arrangement where employee currently resides, such + as owned, rented, or company-provided. options: - Rented - Owned - name: permanent_address - description: '' + description: Employee's permanent residential address for official records and + correspondence when temporary or current address differs. - name: permanent_accommodation_type - description: '' + description: Type of housing at permanent address such as owned, rented, or company-provided + accommodation. options: - Rented - Owned - name: person_to_be_contacted - description: '' + description: Emergency contact person's name to reach in case of employee emergencies + or urgent situations. - name: emergency_phone_number - description: '' + description: Contact number for employee's emergency contact person in case of + workplace incidents or urgent situations. - name: relation - description: '' + description: Relationship of the emergency contact person to the employee, such + as spouse, parent, or sibling. - name: attendance_device_id - description: '' + description: Identifier linking employee to biometric or card-based time clock + systems for tracking clock-ins and clock-outs. - name: holiday_list - description: '' + description: Which holiday calendar or schedule applies to this employee for determining + their days off and public holidays. join_hint: table: tabHoliday List 'on': holiday_list = tabHoliday List.name - name: ctc - description: '' + description: Total cost to company compensation package for the employee including + salary, benefits, bonuses, and all employer costs. - name: salary_currency - description: '' + description: Currency in which the employee's salary and compensation are paid. join_hint: table: tabCurrency 'on': salary_currency = tabCurrency.name - name: salary_mode - description: '' + description: Payment method for employee salary such as bank transfer, cash, or + check options: - Bank - Cash - Cheque - name: bank_name - description: '' + description: Name of the financial institution where employee receives salary + payments - name: bank_ac_no - description: '' + description: Employee's bank account number for salary deposits - name: iban - description: '' + description: International bank account number for employee salary payments and + direct deposits - name: marital_status - description: '' + description: Employee's current marital status such as single, married, divorced, + or widowed options: - Single - Married - Divorced - Widowed - name: family_background - description: '' + description: Information about employee's family members, dependents, emergency + contacts, or household composition - name: blood_group - description: '' + description: Employee's blood type for medical emergencies and health records options: - A+ - A- @@ -9257,145 +11007,198 @@ tables: - O+ - O- - name: health_details - description: '' + description: Medical conditions, allergies, disabilities, or other health information + relevant to workplace safety and accommodations - name: passport_number - description: '' + description: Employee's passport identification number for international travel, + work permits, and visa processing - name: valid_upto - description: '' + description: Expiration date of employee document or credential such as passport, + visa, work permit, or license. - name: date_of_issue - description: '' + description: Issue date of employee document or credential such as passport, visa, + work permit, or license. - name: place_of_issue - description: '' + description: Location or authority where employee document or credential was issued + such as passport office, embassy, or licensing agency. - name: bio - description: '' + description: Employee biographical summary or personal profile information including + background and professional overview. - name: education - description: '' + description: Employee academic qualifications, degrees, certifications, and educational + institutions attended. - name: external_work_history - description: '' + description: Employment history and work experience at previous companies before + joining the current organization. - name: internal_work_history - description: '' + description: Job changes, promotions, transfers, or role movements within the + same organization for an employee. - name: resignation_letter_date - description: '' + description: Date when the employee formally submitted their resignation notice. - name: relieving_date - description: '' + description: Date when the employee's employment officially ended and they were + released from duties. - name: held_on - description: '' + description: Date when an employee event, meeting, review, or disciplinary action + was conducted. - name: new_workplace - description: '' + description: Updated work location or office assignment for an employee after + a transfer or relocation. - name: leave_encashed - description: '' + description: Amount of unused leave days converted to monetary payment upon separation + or as per policy. options: - 'Yes' - 'No' - name: encashment_date - description: '' + description: Date when an employee cashes out unused leave or benefits, typically + queried during exit settlements or leave balance conversions. - name: reason_for_leaving - description: '' + description: Employee's stated reason for resignation or termination, used when + analyzing attrition patterns or exit circumstances. - name: feedback - description: '' + description: Comments or evaluations about the employee, typically from performance + reviews, exit interviews, or manager assessments. - name: lft - description: '' + description: Left boundary value in nested set model for employee organizational + hierarchy traversal and reporting structure queries. - name: rgt - description: '' + description: Right boundary value in nested set model for employee organizational + hierarchy traversal and reporting structure queries. - name: old_parent - description: '' + description: Previous manager or parent employee before a reporting structure + change or organizational transfer. + desc_done: true - table: tabEmployee Education description: '' fields: - name: name - description: '' + description: Employee name used to identify which individual's educational background + is being queried or analyzed - name: school_univ - description: '' + description: Educational institution name used when searching for employees by + alma mater or analyzing workforce education sources - name: qualification - description: '' + description: Degree or certification level used to filter employees by educational + attainment or verify credential requirements - name: level - description: '' + description: Education qualification level such as high school, bachelor's degree, + master's degree, or doctorate options: - Graduate - Post Graduate - Under Graduate - name: year_of_passing - description: '' + description: Year when the employee completed or graduated from this education + level - name: class_per - description: '' + description: Percentage, grade, or GPA achieved by the employee in this education + qualification - name: maj_opt_subj - description: '' + description: Major, optional subject, or area of specialization studied by the + employee during their education + desc_done: true - table: tabEmployee External Work History description: '' fields: - name: name - description: '' + description: Employee name used to identify which employee's external work history + is being queried or analyzed. - name: company_name - description: '' + description: Previous employer name used when searching for employees with experience + at specific companies or analyzing competitor talent sources. - name: designation - description: '' + description: Job title at previous employer used to find employees with specific + prior role experience or track career progression patterns. - name: salary - description: '' + description: Compensation amount earned at a previous employer outside the current + organization. - name: address - description: '' + description: Location or workplace address of the former employer where the employee + previously worked. - name: contact - description: '' + description: Contact person or reference information from the employee's previous + employer. - name: total_experience - description: '' + description: Total years or duration of work experience accumulated at this external + employer, used when calculating overall career experience or tenure requirements. + desc_done: true - table: tabEmployee Group description: '' fields: - name: name - description: '' + description: Unique identifier for the employee group used when filtering or grouping + employees by organizational unit or team. - name: employee_group_name - description: '' + description: Display name of the employee group used when searching for specific + departments, divisions, or organizational segments. - name: employee_list - description: '' + description: Collection of employees belonging to this group used when analyzing + headcount, team composition, or reporting structures. + desc_done: true - table: tabEmployee Group Table description: '' fields: - name: name - description: '' + description: Unique identifier or label for the employee group such as 'Sales + Team' or 'Engineering Department' - name: employee - description: '' + description: Employee ID or reference linked to this group for membership queries join_hint: table: tabEmployee 'on': employee = tabEmployee.name - name: employee_name - description: '' + description: Full name of the employee who belongs to this group for human-readable + identification - name: user_id - description: '' + description: Identifier of the user who created or owns this employee group + desc_done: true - table: tabEmployee Internal Work History description: '' fields: - name: name - description: '' + description: Employee full name used to identify individuals when tracking job + changes, promotions, transfers, or analyzing career progression within the organization. - name: branch - description: '' + description: Physical office or location identifier used when analyzing employee + transfers, regional workforce distribution, or location-based organizational + changes. join_hint: table: tabBranch 'on': branch = tabBranch.name - name: department - description: '' + description: Functional business unit or team assignment used to track interdepartmental + moves, organizational restructuring, or career path transitions across different + areas of the company. join_hint: table: tabDepartment 'on': department = tabDepartment.name - name: designation - description: '' + description: Job title or role name held by the employee during this period of + internal work history. join_hint: table: tabDesignation 'on': designation = tabDesignation.name - name: from_date - description: '' + description: Start date when the employee began working in this designation or + role. - name: to_date - description: '' + description: End date when the employee stopped working in this designation or + role, empty if currently active. + desc_done: true - table: tabEnergy Point Log description: '' fields: - name: name - description: '' + description: Unique identifier for the energy point log entry - name: user - description: '' + description: Employee or system user who earned or was assigned the energy points join_hint: table: tabUser 'on': user = tabUser.name - name: type - description: '' + description: Category or reason for the energy point transaction such as appreciation, + review, or task completion options: - Auto - Appreciation @@ -9403,46 +11206,55 @@ tables: - Review - Revert - name: points - description: '' + description: Energy points awarded or deducted in this transaction - name: rule - description: '' + description: The specific energy point rule that triggered this point allocation join_hint: table: tabEnergy Point Rule 'on': rule = tabEnergy Point Rule.name - name: reference_doctype - description: '' + description: The document type (like Sales Order, Task, Issue) that triggered + the energy point award join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_name - description: '' + description: Unique identifier or name used to reference this specific energy + point transaction or activity. - name: reverted - description: '' + description: Indicates whether this energy point entry has been reversed or cancelled. - name: revert_of - description: '' + description: Links to the original energy point log entry that this record reverses + or cancels. join_hint: table: tabEnergy Point Log 'on': revert_of = tabEnergy Point Log.name - name: reason - description: '' + description: Explanation or justification for why energy points were awarded or + deducted in this transaction. - name: seen - description: '' + description: Indicates whether the user has viewed or acknowledged this energy + point log entry. + desc_done: true - table: tabEnergy Point Rule description: '' fields: - name: name - description: '' + description: Unique identifier for the energy point rule record - name: enabled - description: '' + description: Whether the energy point rule is currently active and awarding points - name: rule_name - description: '' + description: Display name or title of the energy point rule describing what action + earns points - name: reference_doctype - description: '' + description: The document type (e.g., Sales Order, Task) that triggers energy + point allocation when events occur on it. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: for_doc_event - description: '' + description: The specific event action (e.g., submit, cancel, update) on the reference + document that triggers energy points. options: - New - Submit @@ -9450,47 +11262,61 @@ tables: - Value Change - Custom - name: field_to_check - description: '' + description: The specific field name on the reference document whose value or + change is evaluated to determine if energy points should be awarded. - name: points - description: '' + description: Number of energy points awarded or deducted when this rule is triggered - name: for_assigned_users - description: '' + description: Whether energy points are given to users assigned to a document rather + than the document creator - name: user_field - description: '' + description: Specific field name in the document that identifies which user receives + the energy points - name: multiplier_field - description: '' + description: Field name from the reference document whose value multiplies the + base points earned. - name: max_points - description: '' + description: Maximum points that can be awarded per occurrence of this energy + point rule. - name: apply_only_once - description: '' + description: Whether this rule awards points only on the first occurrence or can + trigger multiple times. - name: condition - description: '' + description: Criteria or rule logic that must be met for energy points to be awarded + or applied + desc_done: true - table: tabEnergy Point Settings description: '' fields: - name: name - description: '' + description: Unique identifier for the energy point settings configuration - name: enabled - description: '' + description: Whether the energy points system is currently active and awarding + points - name: review_levels - description: '' + description: Approval thresholds or review stages required for energy point redemption + or allocation - name: point_allocation_periodicity - description: '' + description: Frequency at which energy points are automatically allocated to users + (daily, weekly, monthly). options: - Daily - Weekly - Monthly - name: last_point_allocation_date - description: '' + description: Most recent date when energy points were allocated to users in the + system. + desc_done: true - table: tabEvent description: '' fields: - name: name - description: '' + description: Short identifier or title of the event - name: subject - description: '' + description: Detailed topic or matter that the event addresses - name: event_category - description: '' + description: Classification grouping events by type such as meeting, training, + conference, or appointment options: - Event - Meeting @@ -9498,254 +11324,336 @@ tables: - Sent/Received Email - Other - name: event_type - description: '' + description: Category or classification of the event such as meeting, appointment, + task, deadline, or training session. options: - Private - Public - name: color - description: '' + description: Visual color code assigned to the event for calendar display and + categorization purposes. - name: send_reminder - description: '' + description: Whether a notification or alert should be sent to participants before + the event occurs. - name: repeat_this_event - description: '' + description: Whether the event recurs on a regular schedule or is a one-time occurrence - name: starts_on - description: '' + description: The date and time when the event begins - name: ends_on - description: '' + description: The date and time when the event concludes - name: status - description: '' + description: Event confirmation status such as confirmed, tentative, or cancelled options: - Open - Completed - Closed - Cancelled - name: sender - description: '' + description: Person or entity who created or sent the event invitation - name: all_day - description: '' + description: Whether the event spans an entire day without specific start and + end times - name: sync_with_google_calendar - description: '' + description: Whether the event is synchronized with Google Calendar for bi-directional + updates. - name: add_video_conferencing - description: '' + description: Whether a video conferencing link should be automatically added to + the event. - name: google_calendar - description: '' + description: The specific Google Calendar account or calendar name where the event + is synced. join_hint: table: tabGoogle Calendar 'on': google_calendar = tabGoogle Calendar.name - name: google_calendar_id - description: '' + description: Identifier linking this event to a specific Google Calendar where + it was created or synced. - name: google_calendar_event_id - description: '' + description: Unique identifier for this event within Google Calendar's system, + used to track the specific calendar entry. - name: google_meet_link - description: '' + description: URL for the Google Meet video conference associated with this event. - name: pulled_from_google_calendar - description: '' + description: Indicates whether the event was imported or synced from Google Calendar. - name: repeat_on - description: '' + description: Specifies which days of the week or dates the event recurs on for + repeating events. options: - Daily - Weekly - Monthly - Yearly - name: repeat_till - description: '' + description: The end date when a recurring event stops repeating. - name: monday - description: '' + description: Indicates whether the event occurs on Mondays or Monday-specific + scheduling flag - name: tuesday - description: '' + description: Indicates whether the event occurs on Tuesdays or Tuesday-specific + scheduling flag - name: wednesday - description: '' + description: Indicates whether the event occurs on Wednesdays or Wednesday-specific + scheduling flag - name: thursday - description: '' + description: Event occurs or is scheduled on Thursdays - name: friday - description: '' + description: Event occurs or is scheduled on Fridays - name: saturday - description: '' + description: Event occurs or is scheduled on Saturdays - name: sunday - description: '' + description: Whether the event occurs on Sundays or is scheduled for Sunday availability - name: description - description: '' + description: Text explaining the event's purpose, details, or notes that users + search when looking for specific event information - name: event_participants - description: '' + description: People or entities attending or involved in the event - name: reference_doctype - description: '' + description: Type of document this event is linked to, such as Lead, Opportunity, + Customer, or Project join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_docname - description: '' + description: Specific document name or ID that this event is associated with - name: links - description: '' + description: Additional related documents or records connected to this event beyond + the primary reference + desc_done: true - table: tabEvent Participants description: '' fields: - name: name - description: '' + description: name - name: reference_doctype - description: '' + description: Type of document the participant is linked to, such as Event, Meeting, + or Task. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_docname - description: '' + description: Specific document record the participant is associated with, identifying + which event or meeting instance they are attending. - name: email - description: '' + description: Email address of the person participating in the event, used to identify + or contact participants. + desc_done: true - table: tabExchange Rate Revaluation description: '' fields: - name: name - description: '' + description: Unique identifier or reference code for the exchange rate revaluation + transaction - name: posting_date - description: '' + description: Date when the exchange rate revaluation was posted to the general + ledger - name: rounding_loss_allowance - description: '' + description: Maximum acceptable rounding difference amount allowed when calculating + revaluation gains or losses - name: company - description: '' + description: Identifies which company entity the exchange rate revaluation applies + to for multi-entity organizations. join_hint: table: tabCompany 'on': company = tabCompany.name - name: accounts - description: '' + description: Specifies which general ledger accounts are included in or affected + by this exchange rate revaluation. - name: gain_loss_unbooked - description: '' + description: Indicates the calculated unrealized foreign exchange gain or loss + amount that has not yet been posted to the general ledger. - name: gain_loss_booked - description: '' + description: Realized foreign exchange gains or losses that have been posted to + accounting ledgers from this revaluation. - name: total_gain_loss - description: '' + description: Total calculated foreign exchange gain or loss amount from this revaluation, + including both booked and unbooked amounts. - name: amended_from - description: '' + description: Reference to the previous exchange rate revaluation document that + this record amends or corrects. join_hint: table: tabExchange Rate Revaluation 'on': amended_from = tabExchange Rate Revaluation.name + desc_done: true - table: tabExchange Rate Revaluation Account description: '' fields: - name: name - description: '' + description: Unique identifier for the exchange rate revaluation account record, + used when tracking or referencing specific revaluation configurations. - name: account - description: '' + description: The general ledger account that will be revalued for foreign currency + gains or losses, used when identifying which accounts require currency revaluation. join_hint: table: tabAccount 'on': account = tabAccount.name - name: party_type - description: '' + description: The type of party (Customer, Supplier, Employee) associated with + the revaluation account, used when filtering revaluations by business relationship + category. join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: party - description: '' + description: The customer or supplier whose foreign currency balance is being + revalued for exchange rate gains or losses. - name: account_currency - description: '' + description: The foreign currency in which the party's account balance is denominated. join_hint: table: tabCurrency 'on': account_currency = tabCurrency.name - name: balance_in_account_currency - description: '' + description: The outstanding amount owed by or to the party in their account's + foreign currency before revaluation. - name: new_balance_in_account_currency - description: '' + description: The recalculated account balance in the original account currency + after applying the new exchange rate for revaluation. - name: current_exchange_rate - description: '' + description: The exchange rate currently in effect before revaluation adjustments + are applied. - name: new_exchange_rate - description: '' + description: The updated exchange rate being applied during the revaluation process + to recalculate foreign currency balances. - name: balance_in_base_currency - description: '' + description: Original account balance converted to base currency before revaluation + adjustments are applied. - name: new_balance_in_base_currency - description: '' + description: Updated account balance in base currency after applying current exchange + rates during revaluation. - name: gain_loss - description: '' + description: Calculated foreign exchange gain or loss amount resulting from the + difference between original and revalued balances. - name: zero_balance - description: '' + description: Indicates whether the revaluation account should have its balance + zeroed out or reset during exchange rate revaluation processing. + desc_done: true - table: tabFile description: '' fields: - name: name - description: '' + description: User-defined label or title for the file record, typically used when + searching for files by their descriptive name rather than the actual filename. - name: file_name - description: '' + description: Actual filename including extension as stored in the system, used + when searching for specific file formats or exact file references. - name: is_private - description: '' + description: Access restriction flag indicating whether the file has limited visibility, + used when filtering for confidential or publicly accessible files. - name: file_type - description: '' + description: Type or category of the file such as document, image, spreadsheet, + or folder. - name: is_home_folder - description: '' + description: Indicates whether this is a user's personal home folder for storing + private files. - name: is_attachments_folder - description: '' + description: Indicates whether this folder contains files attached to records + like orders, invoices, or tickets. - name: file_size - description: '' + description: Size of the uploaded file in bytes, used when filtering or sorting + files by storage space or identifying large files. - name: file_url - description: '' + description: Direct URL or path to access the actual file content, used when retrieving + or downloading the file. - name: thumbnail_url - description: '' + description: URL to a preview or thumbnail image of the file, used when displaying + visual previews without loading the full file. - name: folder - description: '' + description: The directory path or parent folder location where this file is stored + in the file system hierarchy. join_hint: table: tabFile 'on': folder = tabFile.name - name: is_folder - description: '' + description: Indicates whether this record represents a folder/directory rather + than an individual file. - name: attached_to_doctype - description: '' + description: The document type (like Sales Order, Customer, Invoice) that this + file is linked or attached to. join_hint: table: tabDocType 'on': attached_to_doctype = tabDocType.name - name: attached_to_name - description: '' + description: Name or identifier of the specific record (document, transaction, + customer, etc.) that this file is attached to. - name: attached_to_field - description: '' + description: Database field or column name indicating which type of entity (doctype) + this file is linked to. - name: old_parent - description: '' + description: Previous parent record identifier before the file attachment was + moved or reassigned to a different entity. - name: content_hash - description: '' + description: Unique fingerprint of file contents used to detect duplicate files + or verify file integrity hasn't changed - name: uploaded_to_dropbox - description: '' + description: Whether this file has been synced or backed up to Dropbox cloud storage - name: uploaded_to_google_drive - description: '' + description: Whether this file has been synced or backed up to Google Drive cloud + storage + desc_done: true - table: tabFinance Book description: '' fields: - name: name - description: '' + description: Unique identifier for the finance book used in system references + and lookups - name: finance_book_name - description: '' + description: Display name of the finance book used when users specify which accounting + book or ledger to query + desc_done: true - table: tabFiscal Year description: Represents a Financial Year. All accounting entries and other major transactions are tracked against the Fiscal Year. fields: - name: name - description: '' + description: Fiscal year name or label, typically used when users refer to a specific + fiscal period by its display name rather than numeric year. - name: year - description: '' + description: Numeric calendar year value of the fiscal year, used when users query + by specific year numbers or date ranges. - name: disabled - description: '' + description: Indicates whether the fiscal year is inactive or no longer available + for transaction posting or selection. - name: is_short_year - description: '' + description: Indicates whether the fiscal year has fewer than 12 months, relevant + when users ask about partial or abbreviated fiscal periods. - name: year_start_date - description: '' + description: The date when the fiscal year begins, used when users need to identify + the starting point of a fiscal period or filter transactions from the start + of the year. - name: year_end_date - description: '' + description: The date when the fiscal year ends, used when users need to identify + the closing point of a fiscal period or filter transactions through year-end. - name: companies - description: '' + description: Companies to which this fiscal year applies or is assigned - name: auto_created - description: '' + description: Whether the fiscal year was automatically created by the system rather + than manually defined by a user + desc_done: true - table: tabFiscal Year Company description: '' fields: - name: name - description: '' + description: Fiscal year identifier or label used when querying financial periods + or year-end reporting timeframes - name: company - description: '' + description: Company entity associated with this fiscal year configuration for + multi-company financial period tracking join_hint: table: tabCompany 'on': company = tabCompany.name + desc_done: true - table: tabForm Tour description: '' fields: - name: name - description: '' + description: Unique identifier or code for the form tour, used when referencing + specific guided tour configurations or filtering tour records. - name: title - description: '' + description: Display label for the form tour shown to users, used when searching + for tours by their human-readable name or presenting tour options. - name: view_name - description: '' + description: Technical identifier of the view or form where this tour is displayed, + used when filtering tours by specific screens or determining which tours apply + to a particular interface. options: - Workspaces - List @@ -9753,12 +11661,13 @@ tables: - Tree - Page - name: workspace_name - description: '' + description: Name of the workspace where form tours are organized or grouped. join_hint: table: tabWorkspace 'on': workspace_name = tabWorkspace.name - name: list_name - description: '' + description: Name of the list view or collection that the form tour is associated + with. options: - List - Report @@ -9771,69 +11680,89 @@ tables: - Inbox - Map - name: report_name - description: '' + description: Name of the report that the form tour provides guidance or walkthrough + for. join_hint: table: tabReport 'on': report_name = tabReport.name - name: dashboard_name - description: '' + description: Name of the dashboard where users view aggregated data and analytics + for this form tour. join_hint: table: tabDashboard 'on': dashboard_name = tabDashboard.name - name: new_document_form - description: '' + description: Indicates whether this tour is for creating a new document or record + entry form. - name: page_name - description: '' + description: Name of the specific page or screen where this form tour is displayed + or activated. join_hint: table: tabPage 'on': page_name = tabPage.name - name: reference_doctype - description: '' + description: The specific document type or form that this tour provides guidance + for, used when users ask about tours for a particular form or screen. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: module - description: '' + description: The functional module or application area this tour belongs to, used + when users search for tours within a specific business domain or module. join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: ui_tour - description: '' + description: The actual tour configuration or content that guides users through + the interface, referenced when users want to view or access the tour itself. - name: track_steps - description: '' + description: Whether the form tour tracks user progress through individual steps + or stages. - name: is_standard - description: '' + description: Whether this is a default or built-in form tour versus a custom or + user-created one. - name: save_on_complete - description: '' + description: Whether the form automatically saves data when the user completes + the tour. - name: first_document - description: '' + description: The initial or starting document in a form tour sequence that users + see first. - name: include_name_field - description: '' + description: Whether the name field is displayed or required in the form tour. - name: page_route - description: '' + description: The URL path or navigation route where the form tour is displayed + or triggered. - name: steps - description: '' + description: Number of steps or stages in the tour workflow or process sequence + desc_done: true - table: tabForm Tour Step description: '' fields: - name: name - description: '' + description: Identifier or label for the specific step within a guided tour - name: ui_tour - description: '' + description: The parent tour that this step belongs to - name: is_table_field - description: '' + description: Whether this tour step highlights or interacts with a table field + element - name: title - description: '' + description: Display name or heading shown to users for this step in the form + tour - name: parent_fieldname - description: '' + description: Field name of the parent form or section that contains this tour + step - name: fieldname - description: '' + description: Unique identifier field name for this specific tour step within the + form - name: element_selector - description: '' + description: CSS selector identifying the UI element this tour step highlights + or interacts with - name: parent_element_selector - description: '' + description: CSS selector of the containing element when the target element needs + contextual positioning - name: position - description: '' + description: Display position or sequence order of the tour step relative to other + steps options: - Left - Left Center @@ -9849,380 +11778,492 @@ tables: - Bottom Right - Mid Center - name: hide_buttons - description: '' + description: Whether navigation buttons are hidden during this tour step, relevant + when users ask about tour step button visibility or custom navigation behavior. - name: popover_element - description: '' + description: The UI element or selector that the tour popover is attached to or + points at during this step, used when identifying which screen element a tour + step highlights. - name: modal_trigger - description: '' + description: The action or element that triggers a modal dialog during this tour + step, relevant when users ask about tour interactions that open modal windows. - name: offset_x - description: '' + description: Horizontal pixel offset for positioning the tour step popup or highlight + element on screen. - name: offset_y - description: '' + description: Vertical pixel offset for positioning the tour step popup or highlight + element on screen. - name: next_on_click - description: '' + description: Whether the tour automatically advances to the next step when the + user clicks the highlighted element. - name: label - description: '' + description: Display text or title shown to the user for this tour step - name: fieldtype - description: '' + description: Type of form field being highlighted or referenced in this tour step - name: has_next_condition - description: '' + description: Whether progression to the next tour step depends on a specific condition + being met - name: next_step_condition - description: '' + description: Conditional logic expression that determines whether to proceed to + the next tour step based on user actions or form state. - name: next_form_tour - description: '' + description: The subsequent form tour that should be triggered or launched after + completing the current tour step. join_hint: table: tabForm Tour 'on': next_form_tour = tabForm Tour.name - name: child_doctype - description: '' + description: The specific child table or nested document type that this tour step + focuses on or interacts with. + desc_done: true - table: tabGL Entry description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the general ledger entry - name: posting_date - description: '' + description: Date when the entry was officially recorded in the general ledger + for accounting period purposes - name: transaction_date - description: '' + description: Date when the underlying business transaction actually occurred, + which may differ from when it was posted - name: fiscal_year - description: '' + description: The fiscal year period to which this general ledger entry is assigned + for financial reporting and year-end closing purposes. join_hint: table: tabFiscal Year 'on': fiscal_year = tabFiscal Year.name - name: due_date - description: '' + description: The date by which payment or settlement related to this GL entry + is expected or required. - name: account - description: '' + description: The general ledger account number or code that categorizes this entry + for financial statement classification and reporting. join_hint: table: tabAccount 'on': account = tabAccount.name - name: account_currency - description: '' + description: Currency in which the general ledger account transaction is recorded, + relevant when users ask about foreign currency transactions or multi-currency + accounting entries. join_hint: table: tabCurrency 'on': account_currency = tabCurrency.name - name: against - description: '' + description: Reference to the offsetting account or party in a double-entry transaction, + used when users need to trace what account was debited or credited against the + current entry. - name: party_type - description: '' + description: Classification of the external entity involved in the transaction + such as Customer, Supplier, or Employee, relevant when users filter GL entries + by business relationship type. join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: party - description: '' + description: The customer, supplier, or other external entity involved in the + transaction when the GL entry relates to a receivable, payable, or party-specific + transaction. - name: voucher_type - description: '' + description: The category or classification of the accounting document such as + Payment Entry, Sales Invoice, Purchase Invoice, or Journal Entry. join_hint: table: tabDocType 'on': voucher_type = tabDocType.name - name: voucher_no - description: '' + description: The unique identifier or document number of the source transaction + that created this GL entry. - name: voucher_subtype - description: '' + description: Classification of journal entry by operational purpose such as opening, + closing, or contra entries. - name: transaction_currency - description: '' + description: Currency in which the original transaction amount was recorded, relevant + for multi-currency queries. join_hint: table: tabCurrency 'on': transaction_currency = tabCurrency.name - name: against_voucher_type - description: '' + description: Document type being referenced or settled by this entry, such as + invoice or payment voucher. join_hint: table: tabDocType 'on': against_voucher_type = tabDocType.name - name: against_voucher - description: '' + description: Reference to the original voucher being adjusted, settled, or reversed + by this entry. - name: voucher_detail_no - description: '' + description: Specific line item number within a multi-line voucher for tracking + individual transaction details. - name: transaction_exchange_rate - description: '' + description: Exchange rate applied at the time of this specific transaction for + foreign currency conversion. - name: debit_in_account_currency - description: '' + description: Debit amount converted to the currency of the GL account being debited. - name: debit - description: '' + description: Debit amount in the company's base or reporting currency for consolidated + financial statements. - name: debit_in_transaction_currency - description: '' + description: Debit amount in the original currency of the transaction as recorded + at entry time. - name: credit_in_account_currency - description: '' + description: Credit amount converted to the currency of the GL account being credited. - name: credit - description: '' + description: Credit amount in the company's base or reporting currency for consolidated + financial statements. - name: credit_in_transaction_currency - description: '' + description: Credit amount in the original currency of the business transaction + as entered. - name: cost_center - description: '' + description: Department or organizational unit to which the transaction costs + are allocated for expense tracking and budgeting. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Specific project to which the transaction is assigned for project-based + accounting and profitability analysis. join_hint: table: tabProject 'on': project = tabProject.name - name: finance_book - description: '' + description: Accounting book or ledger set used when maintaining multiple parallel + accounting standards or reporting requirements. join_hint: table: tabFinance Book 'on': finance_book = tabFinance Book.name - name: company - description: '' + description: Company entity associated with the general ledger transaction for + multi-entity accounting. join_hint: table: tabCompany 'on': company = tabCompany.name - name: is_opening - description: '' + description: Indicates whether this entry represents opening balances brought + forward from a prior period. options: - 'No' - 'Yes' - name: is_advance - description: '' + description: Indicates whether this entry represents an advance payment or prepayment + transaction. options: - 'No' - 'Yes' - name: to_rename - description: '' + description: Indicates the entry is marked for renaming or correction in a future + period. - name: is_cancelled - description: '' + description: Indicates the entry has been voided or reversed, excluding it from + active financial reporting. - name: remarks - description: '' + description: Free-text notes or comments explaining the purpose, context, or special + circumstances of the journal entry. + desc_done: true - table: tabGender description: '' fields: - name: name - description: '' + description: Full name or label for the gender category - name: gender - description: '' + description: Short code or abbreviation representing the gender (e.g., M, F, Other) + desc_done: true - table: tabGlobal Defaults description: '' fields: - name: name - description: '' + description: name - name: default_company - description: '' + description: The company entity automatically selected or applied when creating + new transactions or records join_hint: table: tabCompany 'on': default_company = tabCompany.name - name: country - description: '' + description: The default country used for localization settings, tax rules, and + regional formatting across the system join_hint: table: tabCountry 'on': country = tabCountry.name - name: default_distance_unit - description: '' + description: Unit of measurement for distance calculations and display across + the system (miles, kilometers, etc). join_hint: table: tabUOM 'on': default_distance_unit = tabUOM.name - name: default_currency - description: '' + description: Primary currency used for financial transactions, pricing, and monetary + amounts throughout the system. join_hint: table: tabCurrency 'on': default_currency = tabCurrency.name - name: hide_currency_symbol - description: '' + description: Controls whether currency symbols are displayed or hidden in monetary + values and financial reports. options: - 'No' - 'Yes' - name: disable_rounded_total - description: '' + description: Controls whether invoice and document totals are rounded to the nearest + whole number. - name: disable_in_words - description: '' + description: Controls whether monetary amounts are displayed in written word format + on documents and invoices. - name: demo_company - description: '' + description: Indicates whether the company instance is a demonstration or test + environment rather than production data. join_hint: table: tabCompany 'on': demo_company = tabCompany.name + desc_done: true - table: tabGlobal Search DocType description: '' fields: - name: name - description: '' + description: Unique identifier or name of the global search DocType record - name: document_type - description: '' + description: The type of document or module being indexed for global search functionality join_hint: table: tabDocType 'on': document_type = tabDocType.name + desc_done: true - table: tabGlobal Search Settings description: '' fields: - name: name - description: '' + description: Name of the DocType or module that can be searched globally - name: allowed_in_global_search - description: '' + description: Whether this DocType or module is enabled for global search functionality + desc_done: true - table: tabGoogle Calendar description: '' fields: - name: name - description: '' + description: Unique identifier or label for the Google Calendar integration configuration - name: enable - description: '' + description: Whether the Google Calendar integration is active and operational - name: calendar_name - description: '' + description: The actual name of the specific Google Calendar being synchronized + or referenced - name: user - description: '' + description: The person whose Google Calendar is being synced or referenced in + calendar integration queries. join_hint: table: tabUser 'on': user = tabUser.name - name: pull_from_google_calendar - description: '' + description: Whether events are being imported from Google Calendar into the ERP + system. - name: sync_as_public - description: '' + description: Whether calendar events are synced with public visibility rather + than private. - name: push_to_google_calendar - description: '' + description: Whether events are automatically synced or pushed to Google Calendar. - name: google_calendar_id - description: '' + description: The unique identifier of the specific Google Calendar being integrated + or synced with. - name: refresh_token - description: '' + description: Authentication token used to maintain ongoing access to Google Calendar + without re-authorization. - name: authorization_code - description: '' + description: OAuth code used to authenticate and connect a user's Google Calendar + account to the system. - name: next_sync_token - description: '' + description: Token indicating the starting point for retrieving incremental changes + since the last Google Calendar synchronization. + desc_done: true - table: tabGoogle Contacts description: '' fields: - name: name - description: '' + description: Full name or display name of the contact person in Google Contacts - name: enable - description: '' + description: Whether the contact is active or disabled for use in communications + and syncing - name: email_id - description: '' + description: Primary email address associated with the contact for correspondence - name: last_sync_on - description: '' + description: Timestamp when contacts were last synchronized with Google, relevant + for checking sync freshness or troubleshooting outdated contact data. - name: authorization_code - description: '' + description: OAuth code used to initially authenticate Google Contacts integration, + relevant when diagnosing connection setup issues. - name: refresh_token - description: '' + description: Token used to maintain ongoing access to Google Contacts without + re-authentication, relevant when investigating persistent sync failures or expired + connections. - name: next_sync_token - description: '' + description: Token tracking the last successful synchronization point with Google + Contacts for incremental updates. - name: pull_from_google_contacts - description: '' + description: Controls whether contact data should be imported from Google Contacts + into the system. - name: push_to_google_contacts - description: '' + description: Controls whether contact data should be exported from the system + to Google Contacts. + desc_done: true - table: tabGoogle Drive description: '' fields: - name: name - description: '' + description: Name or identifier of the Google Drive integration or connection - name: enable - description: '' + description: Whether the Google Drive integration is active or turned on - name: backup_folder_name - description: '' + description: Name of the folder in Google Drive where backups are stored - name: frequency - description: '' + description: How often automated Google Drive backups or syncs are scheduled to + run (e.g., daily, weekly, hourly). options: - Daily - Weekly - name: email - description: '' + description: Email address associated with the Google Drive account or recipient + for backup notifications. - name: send_email_for_successful_backup - description: '' + description: Whether to send email notifications when Google Drive backups complete + successfully, not just on failures. - name: file_backup - description: '' + description: Whether automatic backup is enabled for files in Google Drive. - name: backup_folder_id - description: '' + description: The specific Google Drive folder where backups are stored. - name: last_backup_on - description: '' + description: The most recent date and time when a backup was completed. - name: refresh_token - description: '' + description: Token used to maintain ongoing access to Google Drive without requiring + repeated user authorization. - name: authorization_code - description: '' + description: Temporary code obtained during initial Google Drive connection setup + before exchanging for access tokens. + desc_done: true - table: tabGoogle Settings description: '' fields: - name: name - description: '' + description: name - name: enable - description: '' + description: Whether Google integration is currently active or turned on for this + configuration - name: client_id - description: '' + description: OAuth application identifier from Google Cloud Console used to authenticate + API requests - name: client_secret - description: '' + description: OAuth credential for authenticating Google service integrations and + API access - name: api_key - description: '' + description: Google API authentication key for accessing Google services and features - name: google_drive_picker_enabled - description: '' + description: Whether users can select and attach files directly from Google Drive - name: app_id - description: '' + description: Identifier for the specific Google application or service being configured + in the integration settings. + desc_done: true - table: tabHas Domain description: '' fields: - name: name - description: '' + description: Name or identifier of the entity that possesses or is associated + with the domain - name: domain - description: '' + description: The specific domain, category, or area that the entity has authority + over or belongs to join_hint: table: tabDomain 'on': domain = tabDomain.name + desc_done: true - table: tabHelp Article description: '' fields: - name: name - description: '' + description: Unique identifier or code for the help article used when referencing + specific documentation or support content. - name: title - description: '' + description: Display title of the help article used when searching for or presenting + support documentation to users. - name: category - description: '' + description: Classification grouping of the help article used when filtering or + organizing support content by topic area. join_hint: table: tabHelp Category 'on': category = tabHelp Category.name - name: published - description: '' + description: Whether the help article is publicly available to users or still + in draft status. - name: author - description: '' + description: The person who created or wrote the help article. - name: level - description: '' + description: The difficulty or expertise level required to understand the help + article, such as beginner, intermediate, or advanced. options: - Beginner - Intermediate - Expert - name: content - description: '' + description: Full text body of the help article containing instructions, explanations, + and documentation that users search through when looking for support information. - name: likes - description: '' + description: Number of positive reactions or endorsements the help article has + received, used when finding popular or highly-rated support content. - name: route - description: '' + description: URL path or navigation location where the help article is accessed, + used when referencing specific article links or web addresses. - name: helpful - description: '' + description: Number of users who marked this help article as helpful or useful - name: not_helpful - description: '' + description: Number of users who marked this help article as not helpful or unhelpful + desc_done: true - table: tabHelp Category description: '' fields: - name: name - description: '' + description: Unique identifier or label for the help category record used when + referencing specific help topics. - name: category_name - description: '' + description: Display name of the help category used when searching or filtering + help documentation by topic area. - name: category_description - description: '' + description: Detailed explanation of the help category's scope used when users + need to understand what topics or issues are covered within this category. - name: published - description: '' + description: Whether the help category is visible and accessible to users. - name: help_articles - description: '' + description: Number of help articles or list of articles contained within this + category. - name: route - description: '' + description: URL path or navigation route to access this help category in the + application. + desc_done: true - table: tabHoliday description: '' fields: - name: name - description: '' + description: Name or description of the holiday such as Christmas, New Year, or + Independence Day - name: holiday_date - description: '' + description: Specific calendar date when the holiday occurs or is observed - name: weekly_off - description: '' + description: Indicates if this is a recurring weekly day off like Saturday or + Sunday rather than a one-time holiday - name: description - description: '' + description: Name or description of the holiday, such as 'Christmas', 'New Year's + Day', or 'Independence Day'. + desc_done: true - table: tabHoliday List description: '' fields: - name: name - description: '' + description: Unique identifier for the holiday list record - name: holiday_list_name - description: '' + description: Display name of the holiday list used when users ask about specific + holiday calendars or schedules by name - name: from_date - description: '' + description: Start date of the holiday list period, used when filtering or querying + holidays effective from a specific date - name: to_date - description: '' + description: End date of the holiday list period or validity range. - name: total_holidays - description: '' + description: Total count of holidays defined in this holiday list. - name: weekly_off - description: '' + description: Designated day of the week for regular weekly offs or rest days. options: - Sunday - Monday @@ -10232,59 +12273,70 @@ tables: - Friday - Saturday - name: country - description: '' + description: Country for which the holiday list applies, used when filtering holidays + by national location. - name: subdivision - description: '' + description: State, province, or regional subdivision within a country for location-specific + holidays. - name: holidays - description: '' + description: Collection of holiday dates and names included in this holiday list. - name: color - description: '' + description: Visual color code assigned to the holiday list for calendar display + and UI differentiation + desc_done: true - table: tabHomepage description: '' fields: - name: name - description: '' + description: Unique identifier or title of the homepage configuration - name: company - description: '' + description: Company to which this homepage configuration belongs or applies join_hint: table: tabCompany 'on': company = tabCompany.name - name: hero_section_based_on - description: '' + description: Determines what content or data source drives the hero section display + on the homepage options: - Default - Slideshow - Homepage Section - name: title - description: '' + description: Main heading or name displayed on the homepage - name: tag_line - description: '' + description: Short promotional phrase or slogan shown beneath the homepage title - name: description - description: '' + description: Detailed explanatory text or content block for the homepage - name: slideshow - description: '' + description: Main rotating banner or carousel images displayed prominently on + the homepage join_hint: table: tabWebsite Slideshow 'on': slideshow = tabWebsite Slideshow.name - name: hero_section - description: '' + description: Primary featured content area at the top of the homepage, typically + static or with a single focal message join_hint: table: tabHomepage Section 'on': hero_section = tabHomepage Section.name + desc_done: true - table: tabHomepage Section description: '' fields: - name: name - description: '' + description: Name or title of the homepage section displayed to users - name: section_based_on - description: '' + description: Criteria or entity type that determines which content or cards appear + in this homepage section options: - Cards - Custom HTML - name: section_cards - description: '' + description: Collection of individual cards or items displayed within this homepage + section - name: no_of_columns - description: '' + description: Number of columns in the homepage section layout for controlling + content display width. options: - '1' - '2' @@ -10292,81 +12344,101 @@ tables: - '4' - '6' - name: section_html - description: '' + description: HTML content or markup defining what appears in the homepage section. - name: section_order - description: '' + description: Sequence position determining where this section appears relative + to other homepage sections. + desc_done: true - table: tabHomepage Section Card description: '' fields: - name: name - description: '' + description: Unique identifier or internal reference name for the homepage section + card - name: title - description: '' + description: Main heading or primary display text shown to users on the homepage + section card - name: subtitle - description: '' + description: Secondary descriptive text or supporting information displayed below + the title on the homepage section card - name: content - description: '' + description: Text or HTML content displayed within the homepage section card. - name: route - description: '' + description: URL path or navigation route that the card links to when clicked. + desc_done: true - table: tabIMAP Folder description: '' fields: - name: name - description: '' + description: Unique identifier or label for the IMAP folder configuration used + when referencing specific email folder setups. - name: folder_name - description: '' + description: The actual IMAP mailbox folder path being monitored, used when filtering + or routing emails from specific folders like Inbox or Sent. - name: append_to - description: '' + description: Target destination or entity where emails from this IMAP folder are + appended or linked, used when tracking email integration points. join_hint: table: tabDocType 'on': append_to = tabDocType.name - name: uidvalidity - description: '' + description: IMAP folder validity identifier used to detect when folder contents + have been reset or recreated, causing all message UIDs to become invalid. - name: uidnext - description: '' + description: Next unique identifier that will be assigned to the next new message + arriving in this IMAP folder. + desc_done: true - table: tabImport Supplier Invoice description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the supplier invoice - name: invoice_series - description: '' + description: Series or sequence group that categorizes or organizes invoices by + type, location, or numbering scheme options: - ACC-PINV-.YYYY.- - name: company - description: '' + description: The company entity or legal entity that is receiving and recording + this supplier invoice join_hint: table: tabCompany 'on': company = tabCompany.name - name: item_code - description: '' + description: Identifies the specific product or material being purchased on the + supplier invoice line. join_hint: table: tabItem 'on': item_code = tabItem.name - name: supplier_group - description: '' + description: Categorizes the supplier into a classification group for analyzing + spending patterns and vendor segmentation. join_hint: table: tabSupplier Group 'on': supplier_group = tabSupplier Group.name - name: tax_account - description: '' + description: Specifies the general ledger account where tax amounts from this + supplier invoice are posted. join_hint: table: tabAccount 'on': tax_account = tabAccount.name - name: default_buying_price_list - description: '' + description: Price list applied to purchases from this supplier for determining + item costs and currency join_hint: table: tabPrice List 'on': default_buying_price_list = tabPrice List.name - name: status - description: '' + description: Current state of the supplier invoice such as draft, submitted, paid, + or cancelled + desc_done: true - table: tabIncoming Call Handling Schedule description: '' fields: - name: name - description: '' + description: description or identifier for the incoming call handling schedule - name: day_of_week - description: '' + description: specific day when this call handling schedule is active options: - Monday - Tuesday @@ -10376,175 +12448,218 @@ tables: - Saturday - Sunday - name: from_time - description: '' + description: start time when this call handling schedule begins on the specified + day - name: to_time - description: '' + description: End time of the scheduled period when incoming calls are handled + by the assigned agent group - name: agent_group - description: '' + description: Team or group of agents assigned to handle incoming calls during + this scheduled time period join_hint: table: tabEmployee Group 'on': agent_group = tabEmployee Group.name + desc_done: true - table: tabIncoming Call Settings description: '' fields: - name: name - description: '' + description: Identifier or label for the incoming call configuration - name: call_routing - description: '' + description: Destination or routing rule that determines where incoming calls + are directed (e.g., user, queue, IVR) options: - Sequential - Simultaneous - name: greeting_message - description: '' + description: Audio message or text played to callers when they first connect - name: agent_busy_message - description: '' + description: Message played to callers when agents are busy on other calls. - name: agent_unavailable_message - description: '' + description: Message played to callers when no agents are available to take calls. - name: call_handling_schedule - description: '' + description: Schedule defining when incoming calls are accepted or routed to agents. + desc_done: true - table: tabIncoterm description: '' fields: - name: name - description: '' + description: Full descriptive name of the Incoterm used when identifying delivery + terms in sales orders, purchase orders, and shipment documentation. - name: code - description: '' + description: Short standardized Incoterm code (e.g., FOB, CIF, EXW) used for quick + lookup when analyzing shipping responsibilities and cost allocation. - name: title - description: '' + description: Display label for the Incoterm used in reports and user interfaces + when reviewing trade terms and delivery conditions. - name: description - description: '' + description: Full name or explanation of the Incoterm delivery rule (e.g., 'Free + On Board', 'Cost Insurance and Freight') used when searching by meaning rather + than code + desc_done: true - table: tabIndustry Type description: '' fields: - name: name - description: '' + description: Name of the industry type or classification category - name: industry - description: '' + description: Specific industry sector or business vertical classification + desc_done: true - table: tabInstallation Note description: '' fields: - name: name - description: '' + description: Unique identifier or title for the installation note record - name: naming_series - description: '' + description: Prefix pattern used to auto-generate the installation note name options: - MAT-INS-.YYYY.- - name: customer - description: '' + description: Customer for whom the installation is being performed or documented join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: customer_address - description: '' + description: Physical location where installation service was performed or equipment + was installed join_hint: table: tabAddress 'on': customer_address = tabAddress.name - name: contact_person - description: '' + description: Individual at customer site who coordinated or received the installation join_hint: table: tabContact 'on': contact_person = tabContact.name - name: customer_name - description: '' + description: Company or individual who requested or owns the installation - name: address_display - description: '' + description: Formatted address of the installation location for display purposes. - name: contact_display - description: '' + description: Primary contact person's name at the installation site. - name: contact_mobile - description: '' + description: Mobile phone number of the installation site contact person. - name: contact_email - description: '' + description: Email address for the contact person associated with the installation + note. - name: territory - description: '' + description: Geographic or sales territory where the installation is located. join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: customer_group - description: '' + description: Classification or category of the customer receiving the installation. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: inst_date - description: '' + description: Date when installation work was performed or scheduled, used to find + installations by time period or verify completion timing. - name: inst_time - description: '' + description: Time of day when installation work was performed or scheduled, used + to track specific appointment times or work duration. - name: status - description: '' + description: Current state of the installation note such as pending, completed, + or cancelled, used to filter active work or track progress. options: - Draft - Submitted - Cancelled - name: company - description: '' + description: The company entity associated with this installation note, used when + filtering or reporting installation activities by organizational unit. join_hint: table: tabCompany 'on': company = tabCompany.name - name: amended_from - description: '' + description: References the original installation note that this document amends + or replaces, used to track document revision history. join_hint: table: tabInstallation Note 'on': amended_from = tabInstallation Note.name - name: remarks - description: '' + description: Free-text comments or additional observations about the installation, + used when searching for specific notes or contextual details about the installation + work. - name: items - description: '' + description: Installation note line items or detailed entries describing specific + work performed, parts used, or observations recorded during the installation + desc_done: true - table: tabInstallation Note Item description: '' fields: - name: name - description: '' + description: Unique identifier for the installation note item record used when + referencing specific line items in installation documentation. - name: item_code - description: '' + description: Product or service code being installed, used when querying what + items were installed at customer locations. join_hint: table: tabItem 'on': item_code = tabItem.name - name: serial_and_batch_bundle - description: '' + description: Links to serial numbers or batch tracking for installed items, used + when tracing specific units deployed in the field. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: serial_no - description: '' + description: Unique identifier of the specific item or equipment installed at + the customer site. - name: qty - description: '' + description: Quantity of the item installed during this installation activity. - name: description - description: '' + description: Details about the installed item including specifications, condition, + or installation notes. - name: prevdoc_detail_docname - description: '' + description: Identifies the specific line item or detail row from the previous + document that this installation note item references. - name: prevdoc_docname - description: '' + description: Identifies the parent document (such as a delivery note or sales + order) that this installation note item originated from. - name: prevdoc_doctype - description: '' + description: Specifies the type of the previous document (e.g., Delivery Note, + Sales Order) that this installation note item is linked to. + desc_done: true - table: tabInstalled Application description: '' fields: - name: name - description: '' + description: User-friendly display name or title of the installed application - name: app_name - description: '' + description: Technical identifier or package name of the installed application, + used for system-level references - name: app_version - description: '' + description: Version number or release identifier of the installed application - name: git_branch - description: '' + description: Git branch name of the installed application version, relevant when + users ask about deployment branches or version control information. - name: has_setup_wizard - description: '' + description: Indicates whether the application includes an initial setup wizard, + relevant when users ask which apps require or offer guided setup. - name: is_setup_complete - description: '' + description: Indicates whether the application's setup wizard has been completed, + relevant when users ask about setup status or incomplete configurations. + desc_done: true - table: tabIntegration Request description: '' fields: - name: name - description: '' + description: Descriptive label or title identifying the integration request - name: request_id - description: '' + description: Unique identifier for looking up or referencing a specific integration + request - name: integration_request_service - description: '' + description: The external service or system that this integration request connects + to or interacts with - name: is_remote_request - description: '' + description: Whether the integration request originates from or targets a remote + system or external source. - name: request_description - description: '' + description: Detailed explanation of what the integration request is intended + to accomplish or the specific integration requirements. - name: status - description: '' + description: Current state of the integration request such as pending, approved, + in progress, completed, or rejected. options: - Queued - Authorized @@ -10552,80 +12667,112 @@ tables: - Cancelled - Failed - name: url - description: '' + description: The endpoint address where the integration request is sent to communicate + with external systems or APIs. - name: request_headers - description: '' + description: HTTP headers included in the integration request such as authentication + tokens, content type, or custom metadata. - name: data - description: '' + description: The payload or body content sent in the integration request, typically + containing the actual information being transmitted to the external system. - name: output - description: '' + description: Response data or result returned from the external system after the + integration request is processed. - name: error - description: '' + description: Error message or failure details when the integration request encounters + problems or fails to execute. - name: reference_doctype - description: '' + description: The source document type (like Sales Order, Purchase Invoice) that + triggered or is linked to this integration request. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_docname - description: '' + description: Name or identifier of the source document that triggered or is linked + to this integration request, such as a sales order, invoice, or purchase order + being synchronized with an external system. + desc_done: true - table: tabInventory Dimension description: '' fields: - name: name - description: '' + description: Unique identifier for the inventory dimension record used when filtering + or grouping inventory analysis by specific dimension configurations. - name: dimension_name - description: '' + description: Business label of the inventory dimension used when users need to + identify which tracking attribute (e.g., size, color, location) applies to inventory + items. - name: reference_document - description: '' + description: Source document or transaction reference linked to this dimension + entry used when tracing inventory dimension origins or auditing dimension setup + history. join_hint: table: tabDocType 'on': reference_document = tabDocType.name - name: disabled - description: '' + description: Whether this inventory dimension is currently inactive or excluded + from use in transactions and reporting. - name: source_fieldname - description: '' + description: The originating field name from the source system or table that maps + to this inventory dimension. - name: target_fieldname - description: '' + description: The destination field name in the target system or table where this + inventory dimension data is mapped or stored. - name: apply_to_all_doctypes - description: '' + description: Whether inventory dimension rules apply across all transaction types + or only specific document types. - name: validate_negative_stock - description: '' + description: Whether the system prevents or allows inventory balances to go below + zero for this dimension. - name: document_type - description: '' + description: Specific transaction or document type (e.g., Sales Order, Purchase + Receipt) to which this inventory dimension applies when not applied to all types. join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: type_of_transaction - description: '' + description: Indicates whether the inventory transaction is a receipt, issue, + transfer, adjustment, or other movement type. options: - Inward - Outward - Both - name: fetch_from_parent - description: '' + description: Controls whether dimension values are inherited from a parent document + or transaction. - name: istable - description: '' + description: Indicates whether this dimension represents a tabular or multi-row + structure rather than a single value. - name: condition - description: '' + description: Expression that determines when this inventory dimension field becomes + visible or applicable in transactions. - name: reqd - description: '' + description: Indicates whether this inventory dimension field must be filled in + when creating or updating inventory records. - name: mandatory_depends_on - description: '' + description: Expression that conditionally makes this inventory dimension field + required based on values in other fields. + desc_done: true - table: tabInvoice Discounting description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the invoice discounting + transaction - name: posting_date - description: '' + description: Date when the invoice discounting transaction was recorded in the + accounting system - name: loan_start_date - description: '' + description: Date when the invoice discounting loan or financing period begins - name: loan_period - description: '' + description: Duration of the invoice discounting loan expressed as a time period, + used when asking about loan length or term. - name: loan_end_date - description: '' + description: Specific date when the invoice discounting loan matures or must be + repaid, used when asking about loan expiration or repayment deadlines. - name: status - description: '' + description: Current state of the invoice discounting transaction such as pending, + approved, disbursed, or closed, used when filtering or asking about loan progress. options: - Draft - Sanctioned @@ -10633,71 +12780,84 @@ tables: - Settled - Cancelled - name: company - description: '' + description: The business entity that owns or is associated with the invoice discounting + transaction. join_hint: table: tabCompany 'on': company = tabCompany.name - name: invoices - description: '' + description: The specific invoice documents or invoice numbers included in this + discounting arrangement. - name: total_amount - description: '' + description: The aggregate monetary value of all invoices being discounted in + this transaction. - name: bank_charges - description: '' + description: Fees charged by the bank for processing the invoice discounting transaction. - name: short_term_loan - description: '' + description: Linked short-term loan record created when invoices are discounted + for immediate cash. join_hint: table: tabAccount 'on': short_term_loan = tabAccount.name - name: bank_account - description: '' + description: Bank account where discounted invoice funds are deposited or from + which repayment is made. join_hint: table: tabAccount 'on': bank_account = tabAccount.name - name: bank_charges_account - description: '' + description: Account where fees charged by the bank for invoice discounting services + are recorded. join_hint: table: tabAccount 'on': bank_charges_account = tabAccount.name - name: accounts_receivable_credit - description: '' + description: Account credited when invoice discounting proceeds are received, + representing the reduction in receivables. join_hint: table: tabAccount 'on': accounts_receivable_credit = tabAccount.name - name: accounts_receivable_discounted - description: '' + description: Account tracking invoices that have been discounted with a financial + institution but not yet collected from customers. join_hint: table: tabAccount 'on': accounts_receivable_discounted = tabAccount.name - name: accounts_receivable_unpaid - description: '' + description: Outstanding receivable amount not yet collected from customers, relevant + when checking unpaid balances or available discounting capacity. join_hint: table: tabAccount 'on': accounts_receivable_unpaid = tabAccount.name - name: amended_from - description: '' + description: Reference to the original invoice discounting document that this + record corrects or replaces. join_hint: table: tabInvoice Discounting 'on': amended_from = tabInvoice Discounting.name + desc_done: true - table: tabIssue description: '' fields: - name: name - description: '' + description: Unique identifier or issue number assigned to the issue - name: naming_series - description: '' + description: Prefix pattern used to auto-generate issue names or numbers options: - ISS-.YYYY.- - name: subject - description: '' + description: Brief title or summary describing what the issue is about - name: customer - description: '' + description: The customer account or organization that is experiencing or reporting + the issue. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: raised_by - description: '' + description: The specific person or user who created or submitted the issue. - name: status - description: '' + description: The current state of the issue such as open, in progress, resolved, + or closed. options: - Open - Replied @@ -10705,176 +12865,231 @@ tables: - Resolved - Closed - name: priority - description: '' + description: Urgency or importance level of the issue, used when filtering or + sorting by criticality such as high, medium, or low priority. join_hint: table: tabIssue Priority 'on': priority = tabIssue Priority.name - name: issue_type - description: '' + description: Category or classification of the issue such as bug, feature request, + task, or incident. join_hint: table: tabIssue Type 'on': issue_type = tabIssue Type.name - name: issue_split_from - description: '' + description: Reference to the original parent issue when this issue was created + by splitting from another issue. join_hint: table: tabIssue 'on': issue_split_from = tabIssue.name - name: description - description: '' + description: Detailed explanation of the problem, request, or incident reported + in the issue - name: service_level_agreement - description: '' + description: SLA policy or tier governing response and resolution timeframes for + this issue join_hint: table: tabService Level Agreement 'on': service_level_agreement = tabService Level Agreement.name - name: response_by - description: '' + description: Deadline by which the first response to the issue must be provided - name: agreement_status - description: '' + description: Current status of the service level agreement associated with the + issue, used when filtering issues by whether SLA terms are being met or breached. options: - First Response Due - Resolution Due - Fulfilled - Failed - name: sla_resolution_by - description: '' + description: Target deadline by which the issue must be resolved according to + SLA terms, used when checking overdue issues or time remaining. - name: service_level_agreement_creation - description: '' + description: The specific SLA contract or template applied when the issue was + created, used to identify which service tier or agreement governs the issue. - name: on_hold_since - description: '' + description: Timestamp when the issue was most recently placed on hold, used to + find currently held issues or calculate current hold duration. - name: total_hold_time - description: '' + description: Cumulative duration the issue has been on hold across all hold periods, + used to measure total time spent waiting or paused. - name: first_response_time - description: '' + description: Duration or timestamp from issue creation until the first response + was provided, used to measure initial support responsiveness. - name: first_responded_on - description: '' + description: Timestamp when the issue received its first response from support + or assigned personnel. - name: avg_response_time - description: '' + description: Average time taken to respond to updates or communications on this + issue. - name: resolution_details - description: '' + description: Explanation or notes describing how the issue was resolved or closed. - name: opening_date - description: '' + description: Date when the issue was first created or reported, used to track + issue age and response times. - name: opening_time - description: '' + description: Time of day when the issue was first created or reported, used for + time-specific analysis and shift-based metrics. - name: sla_resolution_date - description: '' + description: Target deadline by which the issue must be resolved according to + service level agreement commitments. - name: resolution_time - description: '' + description: Total time taken to resolve the issue including system processing + and wait times. - name: user_resolution_time - description: '' + description: Actual time spent by users actively working on resolving the issue, + excluding wait times. - name: lead - description: '' + description: Person or team member assigned primary responsibility for managing + and resolving the issue. join_hint: table: tabLead 'on': lead = tabLead.name - name: contact - description: '' + description: The specific person or contact record associated with this issue + for follow-up or communication purposes. join_hint: table: tabContact 'on': contact = tabContact.name - name: email_account - description: '' + description: The email account through which this issue was received or is being + managed. join_hint: table: tabEmail Account 'on': email_account = tabEmail Account.name - name: customer_name - description: '' + description: The name of the customer or company who reported or is affected by + this issue. - name: project - description: '' + description: The project this issue is associated with or belongs to. join_hint: table: tabProject 'on': project = tabProject.name - name: company - description: '' + description: The company or customer organization that reported or is affected + by this issue. join_hint: table: tabCompany 'on': company = tabCompany.name - name: via_customer_portal - description: '' + description: Indicates whether this issue was submitted through the customer-facing + portal rather than internally. - name: content_type - description: '' + description: Type or category of the issue such as bug, feature request, task, + or incident for filtering and classification purposes. + desc_done: true - table: tabIssue Priority description: '' fields: - name: name - description: '' + description: Priority level identifier or label for categorizing issue urgency - name: description - description: '' + description: Detailed explanation of what the priority level means and when it + should be applied to issues + desc_done: true - table: tabIssue Type description: '' fields: - name: name - description: '' + description: Issue type name or label identifying the category of issue - name: description - description: '' + description: Detailed explanation or definition of what the issue type represents + and when it should be used + desc_done: true - table: tabItem description: A Product or a Service that is bought, sold or kept in stock. fields: - name: name - description: '' + description: Full descriptive name of the item as displayed to users and on documents + like invoices and purchase orders - name: naming_series - description: '' + description: Prefix pattern used to auto-generate item codes for this item options: - STO-ITEM-.YYYY.- - name: item_code - description: '' + description: Unique identifier code for the item used in transactions, inventory + tracking, and as the primary reference across the system - name: item_name - description: '' + description: Primary identifier for products, materials, or services when searching, + filtering, or referencing specific items in inventory, sales, or purchasing + queries. - name: item_group - description: '' + description: Category or classification of items used to filter, group, or analyze + items by product type, family, or business segment. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: stock_uom - description: '' + description: Unit of measurement for inventory quantities such as pieces, kilograms, + or liters used when querying stock levels, consumption, or movement. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: disabled - description: '' + description: Item is inactive and cannot be used in new transactions or purchases - name: allow_alternative_item - description: '' + description: Item can be substituted with alternative items when out of stock + or unavailable - name: is_stock_item - description: '' + description: Item inventory levels are tracked in warehouses versus non-stock + items like services or expenses - name: has_variants - description: '' + description: Indicates whether this item has multiple variants like different + sizes, colors, or configurations that customers can choose from. - name: opening_stock - description: '' + description: The initial quantity of this item recorded when starting inventory + tracking or at the beginning of an accounting period. - name: valuation_rate - description: '' + description: The per-unit cost used to calculate the total value of this item's + inventory for accounting and financial reporting purposes. - name: standard_rate - description: '' + description: Default selling price per unit for this item when creating sales + transactions or quotations. - name: is_fixed_asset - description: '' + description: Indicates whether this item represents a fixed asset like equipment, + machinery, or property rather than inventory or consumables. - name: auto_create_assets - description: '' + description: Controls whether purchasing this item automatically generates individual + asset records for tracking depreciation and maintenance. - name: is_grouped_asset - description: '' + description: Indicates whether this item represents a grouped or bundled asset + rather than an individual asset. - name: asset_category - description: '' + description: The classification category for this item when it is treated as a + fixed asset, used to determine depreciation and accounting treatment. join_hint: table: tabAsset Category 'on': asset_category = tabAsset Category.name - name: asset_naming_series - description: '' + description: The naming convention or prefix pattern used to automatically generate + identifiers for assets created from this item. - name: over_delivery_receipt_allowance - description: '' + description: Maximum percentage by which received quantity can exceed ordered + quantity for this item without requiring approval. - name: over_billing_allowance - description: '' + description: Maximum percentage by which billed amount can exceed ordered amount + for this item without requiring approval. - name: description - description: '' + description: Primary text description or name of the item used for display, search, + and identification. - name: brand - description: '' + description: Brand name or manufacturer of the item, used when filtering or searching + items by brand. join_hint: table: tabBrand 'on': brand = tabBrand.name - name: uoms - description: '' + description: Units of measure available for the item (e.g., pieces, boxes, kilograms), + used when querying how an item can be measured or sold. - name: shelf_life_in_days - description: '' + description: Number of days the item remains usable before expiration, used when + checking perishability or expiration timeframes. - name: end_of_life - description: '' + description: Date when the item is discontinued or no longer available for sale + or production. - name: default_material_request_type - description: '' + description: Whether material requests for this item default to purchase, transfer, + manufacture, or customer provided. options: - Purchase - Material Transfer @@ -10882,202 +13097,271 @@ tables: - Manufacture - Customer Provided - name: valuation_method - description: '' + description: Method used to calculate inventory value for this item such as FIFO, + LIFO, or moving average. options: - FIFO - Moving Average - LIFO - name: warranty_period - description: '' + description: Duration of warranty coverage for the item, used when users ask about + warranty length or coverage period. - name: weight_per_unit - description: '' + description: Physical weight of a single unit of the item, used when users ask + about item weight, shipping calculations, or weight-based pricing. - name: weight_uom - description: '' + description: Unit of measurement for the item's weight (e.g., kg, lbs, grams), + used when users need to know the weight measurement standard. join_hint: table: tabUOM 'on': weight_uom = tabUOM.name - name: allow_negative_stock - description: '' + description: Whether this item can be issued or sold even when inventory quantity + is zero or below. - name: barcodes - description: '' + description: Barcode identifiers associated with this item for scanning and lookup + operations. - name: reorder_levels - description: '' + description: Minimum stock quantity thresholds that trigger purchase or manufacturing + requests for this item across warehouses. - name: has_batch_no - description: '' + description: Item requires batch number tracking for inventory management and + traceability - name: create_new_batch - description: '' + description: Automatically generate a new batch number when this item is received + or manufactured - name: batch_number_series - description: '' + description: Naming pattern or series used to auto-generate batch numbers for + this item - name: has_expiry_date - description: '' + description: Indicates whether this item expires and requires expiration date + tracking for inventory and sales. - name: retain_sample - description: '' + description: Indicates whether a sample of this item must be retained for quality + control or compliance purposes. - name: sample_quantity - description: '' + description: The quantity of this item to retain as a sample when retain_sample + is enabled. - name: has_serial_no - description: '' + description: Indicates whether this item requires unique serial number tracking + for individual units. - name: serial_no_series - description: '' + description: Naming pattern or prefix used to generate serial numbers for this + item when serial tracking is enabled. - name: variant_of - description: '' + description: Parent item template from which this item inherits properties as + a size, color, or specification variant. join_hint: table: tabItem 'on': variant_of = tabItem.name - name: variant_based_on - description: '' + description: Template item from which this variant inherits properties and configuration + when creating product variations. options: - Item Attribute - Manufacturer - name: attributes - description: '' + description: Item variant attributes like size, color, or material that differentiate + this product from other variants. - name: enable_deferred_expense - description: '' + description: Whether expense recognition is spread over time rather than recorded + immediately at purchase. - name: no_of_months_exp - description: '' + description: Duration in months over which item expenses are amortized or recognized + when the item represents a prepaid or deferred expense. - name: enable_deferred_revenue - description: '' + description: Indicates whether revenue from this item should be deferred and recognized + over time rather than immediately upon sale. - name: no_of_months - description: '' + description: Duration in months for general time-based item calculations such + as warranty periods, subscriptions, or service contracts. - name: item_defaults - description: '' + description: Default settings for warehouses, suppliers, expense accounts, selling + cost centers, and buying cost centers applied when this item is used in transactions. - name: purchase_uom - description: '' + description: Unit of measurement used when purchasing this item from suppliers, + which may differ from the stock or sales unit. join_hint: table: tabUOM 'on': purchase_uom = tabUOM.name - name: min_order_qty - description: '' + description: Minimum quantity that must be ordered when purchasing this item from + suppliers. - name: safety_stock - description: '' + description: Minimum inventory quantity to maintain as buffer against stockouts + or demand variability. - name: is_purchase_item - description: '' + description: Indicates whether this item is procured from external suppliers rather + than manufactured internally. - name: lead_time_days - description: '' + description: Number of days required from order placement to receipt of the item + from supplier or production. - name: last_purchase_rate - description: '' + description: Most recent purchase price paid for this item, used when analyzing + cost trends or comparing current purchase quotes against historical pricing. - name: is_customer_provided_item - description: '' + description: Indicates whether the customer supplies this item directly rather + than the company purchasing or manufacturing it, relevant for job work or consignment + scenarios. - name: customer - description: '' + description: Specific customer who owns or is associated with this item, used + for customer-specific items, custom products, or serialized goods tied to a + particular customer account. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: delivered_by_supplier - description: '' + description: Indicates whether the item is drop-shipped or delivered directly + from the supplier to the customer rather than through company inventory. - name: supplier_items - description: '' + description: Links to supplier-specific item codes, pricing, and lead times for + this item across different vendors. - name: country_of_origin - description: '' + description: The country where the item was manufactured or produced, relevant + for customs, tariffs, trade compliance, and country-specific sourcing queries. join_hint: table: tabCountry 'on': country_of_origin = tabCountry.name - name: customs_tariff_number - description: '' + description: Harmonized System code for international trade classification and + customs duty calculation. join_hint: table: tabCustoms Tariff Number 'on': customs_tariff_number = tabCustoms Tariff Number.name - name: sales_uom - description: '' + description: Unit of measure used when selling this item to customers, such as + pieces, boxes, or kilograms. join_hint: table: tabUOM 'on': sales_uom = tabUOM.name - name: grant_commission - description: '' + description: Whether sales of this item are eligible for commission payments to + sales representatives. - name: is_sales_item - description: '' + description: Whether this item can be sold to customers in sales transactions. - name: max_discount - description: '' + description: Maximum discount percentage allowed when selling this item. - name: customer_items - description: '' + description: Customer-specific item codes or names that map this item to individual + customer catalogs. - name: taxes - description: '' + description: Tax rules or tax template applied to this item for calculating sales + tax, purchase tax, or VAT on transactions. - name: inspection_required_before_purchase - description: '' + description: Whether incoming purchased items must pass quality inspection before + being accepted into inventory. - name: quality_inspection_template - description: '' + description: Predefined checklist or template used to perform quality inspections + on this item during purchase or manufacturing. join_hint: table: tabQuality Inspection Template 'on': quality_inspection_template = tabQuality Inspection Template.name - name: inspection_required_before_delivery - description: '' + description: Item must pass quality inspection before being delivered to customer + or released from warehouse - name: include_item_in_manufacturing - description: '' + description: Item is available for use in production planning, bill of materials, + and manufacturing operations - name: is_sub_contracted_item - description: '' + description: Item production or processing is outsourced to external subcontractors + rather than manufactured in-house - name: default_bom - description: '' + description: Bill of materials automatically selected when manufacturing or assembling + this item join_hint: table: tabBOM 'on': default_bom = tabBOM.name - name: customer_code - description: '' + description: Customer's own part number or SKU for this item in their system - name: default_item_manufacturer - description: '' + description: Primary manufacturer associated with this item for procurement and + sourcing join_hint: table: tabManufacturer 'on': default_item_manufacturer = tabManufacturer.name - name: default_manufacturer_part_no - description: '' + description: Manufacturer's part number for the item, used when searching by vendor + or supplier part codes. - name: total_projected_qty - description: '' + description: Forecasted quantity including current stock plus planned receipts + minus planned issues, used for future inventory availability queries. + desc_done: true - table: tabItem Alternative description: '' fields: - name: name - description: '' + description: name - name: item_code - description: '' + description: The primary item code for which alternative substitutes are defined join_hint: table: tabItem 'on': item_code = tabItem.name - name: alternative_item_code - description: '' + description: The substitute item code that can replace the primary item in transactions + or production join_hint: table: tabItem 'on': alternative_item_code = tabItem.name - name: two_way - description: '' + description: Indicates whether the alternative item relationship works in both + directions, allowing either item to substitute for the other. - name: item_name - description: '' + description: The primary item code for which alternative substitutes are defined. - name: alternative_item_name - description: '' + description: The substitute item code that can replace the primary item in transactions + or production. + desc_done: true - table: tabItem Attribute description: '' fields: - name: name - description: '' + description: Unique identifier for the item attribute record, used when filtering + or joining attribute data to specific items. - name: attribute_name - description: '' + description: The name or type of the attribute being tracked, used when searching + for items by specific characteristics like color, size, or material. - name: numeric_values - description: '' + description: Indicates whether the attribute stores numeric data, used when filtering + for quantitative attributes or performing numerical comparisons on item properties. - name: disabled - description: '' + description: Whether this item attribute is currently inactive and should not + be used for new transactions or selections. - name: from_range - description: '' + description: Starting value of the valid range for this attribute, used when filtering + or validating attribute values against minimum thresholds. - name: increment - description: '' + description: Step value by which this attribute can change, used when determining + valid incremental values between the range limits. - name: to_range - description: '' + description: Upper bound of a numeric or date range for filtering or validating + item attribute values. - name: item_attribute_values - description: '' + description: Specific values assigned to this item attribute, such as color options, + size choices, or material types available for selection. + desc_done: true - table: tabItem Attribute Value description: '' fields: - name: name - description: '' + description: name - name: attribute_value - description: '' + description: The specific value assigned to an item attribute, such as color 'Red' + or size 'Large', used when filtering or searching items by their characteristics. - name: abbr - description: '' + description: Shortened code or abbreviation for the attribute value, used when + users reference compact identifiers like 'RD' for Red or 'LG' for Large. + desc_done: true - table: tabItem Barcode description: '' fields: - name: name - description: '' + description: name - name: barcode - description: '' + description: Scannable barcode value used to identify and look up items during + inventory, sales, or receiving operations - name: barcode_type - description: '' + description: Format or standard of the barcode such as UPC, EAN, Code128, or QR + code options: - EAN - UPC-A @@ -11094,314 +13378,393 @@ tables: - PZN - UPC - name: uom - description: '' + description: Unit of measure for the barcode, relevant when users ask about item + quantities in specific units like boxes, pieces, or pallets associated with + a barcode. join_hint: table: tabUOM 'on': uom = tabUOM.name + desc_done: true - table: tabItem Customer Detail description: For the convenience of customers, these codes can be used in print formats like Invoices and Delivery Notes fields: - name: name - description: '' + description: Unique identifier code or ID for the item-customer relationship record - name: customer_name - description: '' + description: Name of the specific customer associated with this item detail join_hint: table: tabCustomer 'on': customer_name = tabCustomer.name - name: customer_group - description: '' + description: Category or segment classification that groups customers with similar + characteristics for this item join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: ref_code - description: '' + description: Reference code identifying the customer-item relationship, used when + searching for specific customer-product associations or custom pricing arrangements. + desc_done: true - table: tabItem Default description: '' fields: - name: name - description: '' + description: Item name or code that users reference when asking about products, + materials, or inventory items - name: company - description: '' + description: Company entity that owns or manages this item, relevant when filtering + items by organizational unit or legal entity join_hint: table: tabCompany 'on': company = tabCompany.name - name: default_warehouse - description: '' + description: Primary storage location automatically assigned for this item's stock + transactions and inventory operations join_hint: table: tabWarehouse 'on': default_warehouse = tabWarehouse.name - name: default_price_list - description: '' + description: Price list automatically applied when this item is sold or purchased + in transactions join_hint: table: tabPrice List 'on': default_price_list = tabPrice List.name - name: default_discount_account - description: '' + description: General ledger account where discounts given on this item are recorded join_hint: table: tabAccount 'on': default_discount_account = tabAccount.name - name: buying_cost_center - description: '' + description: Cost center assigned to track expenses when purchasing this item join_hint: table: tabCost Center 'on': buying_cost_center = tabCost Center.name - name: default_supplier - description: '' + description: Primary vendor from whom this item is typically purchased or sourced join_hint: table: tabSupplier 'on': default_supplier = tabSupplier.name - name: expense_account - description: '' + description: General ledger account charged when this item is expensed rather + than capitalized or inventoried join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: default_provisional_account - description: '' + description: Temporary holding account used for goods received but not yet invoiced + from suppliers join_hint: table: tabAccount 'on': default_provisional_account = tabAccount.name - name: selling_cost_center - description: '' + description: Cost center assigned to track profitability or expenses when this + item is sold in sales transactions. join_hint: table: tabCost Center 'on': selling_cost_center = tabCost Center.name - name: income_account - description: '' + description: Revenue account credited when this item is sold, determining where + sales income is recorded in the general ledger. join_hint: table: tabAccount 'on': income_account = tabAccount.name - name: deferred_expense_account - description: '' + description: Account used to defer expense recognition for this item until a later + period, typically for prepaid or amortized costs. join_hint: table: tabAccount 'on': deferred_expense_account = tabAccount.name - name: deferred_revenue_account - description: '' + description: Account used to track revenue that has been invoiced but not yet + earned or recognized, typically for prepaid services or subscriptions. join_hint: table: tabAccount 'on': deferred_revenue_account = tabAccount.name + desc_done: true - table: tabItem Group description: An Item Group is a way to classify items based on types. fields: - name: name - description: '' + description: Unique identifier code for the item group, used when referencing + item groups by their system ID or short code - name: item_group_name - description: '' + description: Display name or label of the item group, used when searching or filtering + by the human-readable group name - name: parent_item_group - description: '' + description: Hierarchical parent of this item group, used when navigating category + trees or finding top-level vs sub-level groupings join_hint: table: tabItem Group 'on': parent_item_group = tabItem Group.name - name: is_group - description: '' + description: Whether this item group contains nested subgroups rather than individual + items. - name: item_group_defaults - description: '' + description: Default settings applied to items in this group such as default warehouse, + expense account, or income account. - name: taxes - description: '' + description: Tax templates or tax rates automatically applied to items belonging + to this item group. - name: lft - description: '' + description: Left boundary value in nested set hierarchy for determining item + group position and ancestry relationships. - name: old_parent - description: '' + description: Previous parent item group before the most recent reparenting operation + in the hierarchy. join_hint: table: tabItem Group 'on': old_parent = tabItem Group.name - name: rgt - description: '' + description: Right boundary value in nested set hierarchy for determining item + group descendants and subtree scope. + desc_done: true - table: tabItem Manufacturer description: '' fields: - name: name - description: '' + description: name - name: item_code - description: '' + description: The specific item or product that this manufacturer produces or supplies join_hint: table: tabItem 'on': item_code = tabItem.name - name: manufacturer - description: '' + description: The company or entity that manufactures the item join_hint: table: tabManufacturer 'on': manufacturer = tabManufacturer.name - name: manufacturer_part_no - description: '' + description: Manufacturer's unique part number for the item, used when searching + by vendor-specific part identifiers or cross-referencing supplier catalogs. - name: item_name - description: '' + description: Internal item name or code in the ERP system, used when querying + by company's own item identification rather than manufacturer's designation. - name: description - description: '' + description: Detailed text description of the item from the manufacturer, used + when searching by product characteristics, specifications, or features rather + than part numbers. - name: is_default - description: '' + description: Indicates whether this manufacturer is the primary or preferred manufacturer + for the item. + desc_done: true - table: tabItem Price description: Log the selling and buying rate of an Item fields: - name: name - description: '' + description: Item name used to identify products when searching for pricing information + or analyzing price variations across different items. - name: item_code - description: '' + description: Unique item identifier used to retrieve specific product pricing + or filter price lists by particular SKUs. join_hint: table: tabItem 'on': item_code = tabItem.name - name: uom - description: '' + description: Unit of measure that determines the pricing basis (e.g., per piece, + per kg) when comparing prices or calculating total costs. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: packing_unit - description: '' + description: Unit of measure for packaging or selling the item (e.g., box, carton, + pallet) used when users ask about packaging quantities or bulk pricing units. - name: item_name - description: '' + description: Name or title of the product or item being priced, used when users + search for specific products or reference items by their common name. - name: brand - description: '' + description: Manufacturer or brand name of the item, used when users filter or + search for products by specific brands or compare pricing across brands. join_hint: table: tabBrand 'on': brand = tabBrand.name - name: item_description - description: '' + description: Description of the item for which the price is defined, used when + searching prices by product name or characteristics. - name: price_list - description: '' + description: Name of the price list this price belongs to, used when querying + prices for specific customer segments, regions, or pricing strategies. join_hint: table: tabPrice List 'on': price_list = tabPrice List.name - name: customer - description: '' + description: Specific customer for whom this price applies, used when looking + up customer-specific negotiated or contracted pricing. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: supplier - description: '' + description: Vendor or supplier from whom the item is purchased at this price + point. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: batch_no - description: '' + description: Specific batch or lot number associated with this item price, used + when pricing varies by production batch. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: buying - description: '' + description: Purchase price or cost at which the item is bought from the supplier. - name: selling - description: '' + description: Indicates whether this price applies to sales transactions versus + purchasing transactions. - name: currency - description: '' + description: The currency in which the price_list_rate is denominated for this + item price. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: price_list_rate - description: '' + description: The actual price amount for the item in the specified currency and + price list. - name: valid_from - description: '' + description: Start date when this item price becomes effective for purchases or + sales transactions. - name: lead_time_days - description: '' + description: Number of days required between order placement and delivery availability + for this item at this price. - name: valid_upto - description: '' + description: End date when this item price expires and is no longer applicable + for transactions. - name: note - description: '' + description: Internal notes or comments about this specific item price, such as + reasons for price changes or special conditions. - name: reference - description: '' + description: External reference number or code linking this price to a customer + agreement, contract, or vendor quote. + desc_done: true - table: tabItem Quality Inspection Parameter description: '' fields: - name: name - description: '' + description: Unique identifier or title of the specific quality inspection parameter + being measured or evaluated - name: specification - description: '' + description: Detailed criteria, acceptable range, or standard that defines how + the quality parameter should be measured or what values are acceptable join_hint: table: tabQuality Inspection Parameter 'on': specification = tabQuality Inspection Parameter.name - name: parameter_group - description: '' + description: Category or grouping that organizes related quality inspection parameters + together for classification purposes join_hint: table: tabQuality Inspection Parameter Group 'on': parameter_group = tabQuality Inspection Parameter Group.name - name: value - description: '' + description: Actual measured or observed result for a quality inspection parameter, + stored as text to accommodate both numeric and non-numeric values. - name: numeric - description: '' + description: Flag indicating whether the inspection parameter accepts numeric + measurements versus categorical or text-based observations. - name: min_value - description: '' + description: Minimum acceptable threshold for numeric quality inspection parameters + to determine pass/fail criteria. - name: max_value - description: '' + description: Maximum acceptable value threshold for numeric quality inspection + parameters - name: formula_based_criteria - description: '' + description: Indicates whether the quality acceptance criteria is determined by + a formula rather than fixed min/max values - name: acceptance_formula - description: '' + description: Custom formula expression used to calculate or evaluate whether an + inspection result passes quality standards + desc_done: true - table: tabItem Reorder description: '' fields: - name: name - description: '' + description: Unique identifier for the item reorder record, used when searching + for specific reorder configurations or policies by item code. - name: warehouse_group - description: '' + description: Groups warehouses for consolidated reorder planning, used when analyzing + or setting reorder rules across multiple warehouse locations. join_hint: table: tabWarehouse 'on': warehouse_group = tabWarehouse.name - name: warehouse - description: '' + description: Specific warehouse location for the reorder rule, used when querying + inventory replenishment needs or reorder points at individual storage facilities. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: warehouse_reorder_level - description: '' + description: Minimum stock quantity threshold that triggers automatic reorder + for this item in a specific warehouse - name: warehouse_reorder_qty - description: '' + description: Quantity to order when stock falls below the reorder level for this + item in a specific warehouse - name: material_request_type - description: '' + description: Type of material request generated when reordering (Purchase, Transfer, + Manufacture) options: - Purchase - Transfer - Material Issue - Manufacture + desc_done: true - table: tabItem Supplier description: '' fields: - name: name - description: '' + description: name - name: supplier - description: '' + description: The vendor or supplier company that provides this item for purchase. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: supplier_part_no - description: '' + description: The part number or SKU assigned by the supplier to identify this + item in their catalog. + desc_done: true - table: tabItem Tax description: '' fields: - name: name - description: '' + description: name - name: item_tax_template - description: '' + description: Links to the specific tax template applied to this item, used when + querying which tax rules or rates govern an item's taxation. join_hint: table: tabItem Tax Template 'on': item_tax_template = tabItem Tax Template.name - name: tax_category - description: '' + description: Classification of the item for tax purposes (e.g., taxable goods, + exempt services), used when filtering or grouping items by their tax treatment + type. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: valid_from - description: '' + description: Date when this tax rate becomes effective for the item - name: minimum_net_rate - description: '' + description: Lowest net tax rate applicable to this item within the valid period - name: maximum_net_rate - description: '' + description: Highest net tax rate applicable to this item within the valid period + desc_done: true - table: tabItem Tax Template description: '' fields: - name: name - description: '' + description: Unique identifier or code for the item tax template - name: title - description: '' + description: Display label or descriptive name shown to users for the tax template - name: company - description: '' + description: Company or organization to which this tax template belongs join_hint: table: tabCompany 'on': company = tabCompany.name - name: disabled - description: '' + description: Whether this item tax template is inactive and cannot be used in + transactions. - name: taxes - description: '' + description: The list of tax types and rates that apply when this template is + used on an item. - name: custom_exemption_reason_code - description: '' + description: User-defined code explaining why an item qualifies for tax exemption + under this template. options: - Standard 15% - VATEX-SA-29 @@ -11421,201 +13784,252 @@ tables: - VATEX-SA-MLTRY - VATEX-SA-OOS - name: custom_zatca_tax_category - description: '' + description: ZATCA tax category classification for Saudi Arabian e-invoicing compliance + requirements options: - Standard - Zero Rated - Exempted - Services outside scope of tax / Not subject to VAT + desc_done: true - table: tabItem Tax Template Detail description: '' fields: - name: name - description: '' + description: Unique identifier or title of the specific tax template detail entry - name: tax_type - description: '' + description: Category or classification of the tax being applied such as VAT, + sales tax, or excise tax join_hint: table: tabAccount 'on': tax_type = tabAccount.name - name: tax_rate - description: '' + description: Percentage or decimal value representing the rate at which this tax + is calculated + desc_done: true - table: tabItem Variant description: '' fields: - name: name - description: '' + description: The specific variant name or identifier that distinguishes this item + variation from others of the same base item. - name: item_attribute - description: '' + description: The attribute type or characteristic that defines how this variant + differs (e.g., color, size, material). join_hint: table: tabItem Attribute 'on': item_attribute = tabItem Attribute.name - name: item_attribute_value - description: '' + description: The specific value assigned to the variant's attribute (e.g., 'Red' + for color, 'Large' for size). + desc_done: true - table: tabItem Variant Attribute description: '' fields: - name: name - description: '' + description: description - name: variant_of - description: '' + description: description join_hint: table: tabItem 'on': variant_of = tabItem.name - name: attribute - description: '' + description: description join_hint: table: tabItem Attribute 'on': attribute = tabItem Attribute.name - name: attribute_value - description: '' + description: The specific value assigned to an item variant attribute, such as + color 'Red' or size 'Large'. - name: numeric_values - description: '' + description: Numeric representation of the attribute value when the attribute + is quantitative, such as weight in kilograms or length in centimeters. - name: disabled - description: '' + description: Indicates whether this attribute value is currently inactive and + unavailable for selection on item variants. - name: from_range - description: '' + description: Starting value of the numeric range for this item variant attribute + specification - name: increment - description: '' + description: Step value by which the attribute increases between the from_range + and to_range - name: to_range - description: '' + description: Ending value of the numeric range for this item variant attribute + specification + desc_done: true - table: tabItem Variant Settings description: '' fields: - name: name - description: '' + description: name - name: do_not_update_variants - description: '' + description: Controls whether item variants should be automatically updated when + variant attributes or templates change. - name: allow_rename_attribute_value - description: '' + description: Determines if attribute values can be renamed after variants have + been created using them. - name: fields - description: '' + description: Specifies which item attributes or properties are configurable when + creating variants, such as size, color, or material options. + desc_done: true - table: tabItem Website Specification description: Table for Item that will be shown in Web Site fields: - name: name - description: '' + description: Unique identifier for the item website specification record - name: label - description: '' + description: Display text shown to users for this website specification on the + item - name: description - description: '' + description: Detailed explanation of what this website specification means or + includes for the item + desc_done: true - table: tabJob Card description: '' fields: - name: name - description: '' + description: Unique identifier for the job card - name: naming_series - description: '' + description: Prefix pattern used to generate job card numbers options: - PO-JOB.##### - name: work_order - description: '' + description: Reference to the parent work order that this job card belongs to join_hint: table: tabWork Order 'on': work_order = tabWork Order.name - name: bom_no - description: '' + description: Bill of materials number defining the component list and structure + for manufacturing the production item on this job card. join_hint: table: tabBOM 'on': bom_no = tabBOM.name - name: production_item - description: '' + description: The finished good or assembly being manufactured or produced by this + job card. join_hint: table: tabItem 'on': production_item = tabItem.name - name: employee - description: '' + description: Worker or operator assigned to execute or responsible for the manufacturing + tasks on this job card. - name: posting_date - description: '' + description: Date when the job card transaction was posted to the accounting ledger. - name: company - description: '' + description: Company entity to which this job card belongs. join_hint: table: tabCompany 'on': company = tabCompany.name - name: for_quantity - description: '' + description: Target quantity of items to be produced or processed in this job + card. - name: total_completed_qty - description: '' + description: Quantity of items finished or produced through this job card operation. - name: process_loss_qty - description: '' + description: Quantity of materials lost or wasted during the manufacturing process. - name: expected_start_date - description: '' + description: Planned or scheduled date when the job card operation should begin. - name: time_required - description: '' + description: Total time needed to complete the job card operation or task. - name: expected_end_date - description: '' + description: Target date when the job card work is planned to be finished. - name: scheduled_time_logs - description: '' + description: Planned or allocated time entries for tracking work hours against + the job card. - name: time_logs - description: '' + description: Individual time entries recorded by employees working on this job + card, used when querying who worked when and for how long on specific tasks. - name: actual_start_date - description: '' + description: Date and time when work actually began on this job card, used to + track delays or compare planned versus actual start times. - name: total_time_in_mins - description: '' + description: Cumulative minutes spent on this job card across all time logs, used + when calculating labor costs or comparing estimated versus actual duration. - name: actual_end_date - description: '' + description: Date when the job card operation was actually completed, used to + track production delays or completion timing. - name: operation - description: '' + description: Specific manufacturing operation or task being performed in this + job card, such as cutting, welding, or assembly. join_hint: table: tabOperation 'on': operation = tabOperation.name - name: wip_warehouse - description: '' + description: Warehouse location where work-in-progress inventory for this job + card is stored during production. join_hint: table: tabWarehouse 'on': wip_warehouse = tabWarehouse.name - name: workstation_type - description: '' + description: Category or classification of the workstation where job card operations + are performed, used when filtering or grouping by workstation category rather + than specific workstation location. join_hint: table: tabWorkstation Type 'on': workstation_type = tabWorkstation Type.name - name: workstation - description: '' + description: Specific workstation or machine where the job card work is executed, + used when identifying exact production location or equipment. join_hint: table: tabWorkstation 'on': workstation = tabWorkstation.name - name: quality_inspection_template - description: '' + description: Template defining quality checks and inspection criteria to be performed + for this job card, used when querying quality control requirements or inspection + procedures. join_hint: table: tabQuality Inspection Template 'on': quality_inspection_template = tabQuality Inspection Template.name - name: quality_inspection - description: '' + description: Quality inspection details or results recorded for this job card + to track product compliance and defects. join_hint: table: tabQuality Inspection 'on': quality_inspection = tabQuality Inspection.name - name: sub_operations - description: '' + description: Breakdown of individual sub-tasks or operations within the main job + card operation for detailed production tracking. - name: items - description: '' + description: Materials, components, or finished goods associated with this job + card for production or work order execution. - name: scrap_items - description: '' + description: Items or materials that were scrapped or wasted during the job card + execution - name: for_job_card - description: '' + description: Reference to the parent or related job card when this is a linked + or dependent job card join_hint: table: tabJob Card 'on': for_job_card = tabJob Card.name - name: is_corrective_job_card - description: '' + description: Indicates whether this job card was created to correct defects or + rework issues from a previous job - name: hour_rate - description: '' + description: Hourly labor or machine rate charged for work performed on this job + card. - name: for_operation - description: '' + description: Specific manufacturing or production operation this job card tracks + or executes. join_hint: table: tabOperation 'on': for_operation = tabOperation.name - name: project - description: '' + description: Project associated with this job card for tracking work against project + budgets and timelines. join_hint: table: tabProject 'on': project = tabProject.name - name: item_name - description: '' + description: Item being manufactured or produced in this job card operation - name: transferred_qty - description: '' + description: Quantity of items actually transferred or moved from this job card + operation to the next stage - name: requested_qty - description: '' + description: Quantity of items originally requested or planned for this job card + operation - name: status - description: '' + description: Current state of the job card such as open, in progress, completed, + or cancelled. options: - Open - Work In Progress @@ -11625,163 +14039,199 @@ tables: - Cancelled - Completed - name: operation_row_number - description: '' + description: Sequential position or order number of this operation within the + job card's operation list. - name: operation_id - description: '' + description: Identifier linking to the specific manufacturing operation or routing + step being performed in this job card. - name: sequence_id - description: '' + description: Order of operations or steps within the job card workflow. - name: remarks - description: '' + description: Free-text notes or comments about the job card for additional context + or instructions. - name: serial_and_batch_bundle - description: '' + description: Grouped serial numbers and batch identifiers tracked together for + this job card's materials or products. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: batch_no - description: '' + description: Batch number associated with the manufacturing job for tracking groups + of items produced together. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: serial_no - description: '' + description: Unique serial number identifying this specific job card record. - name: job_started - description: '' + description: Indicates whether the manufacturing job has been started or is still + pending. - name: started_time - description: '' + description: Timestamp when the job card work actually began, used to track when + production or operations commenced. - name: current_time - description: '' + description: Real-time or last updated timestamp for the job card, used to calculate + elapsed time or current status duration. - name: amended_from - description: '' + description: Reference to the original job card that this one was amended or corrected + from, used to trace revisions and corrections. join_hint: table: tabJob Card 'on': amended_from = tabJob Card.name + desc_done: true - table: tabJob Card Item description: '' fields: - name: name - description: '' + description: Unique identifier for the job card item record - name: item_code - description: '' + description: Product or material code being manufactured or processed in this + job card operation join_hint: table: tabItem 'on': item_code = tabItem.name - name: source_warehouse - description: '' + description: Warehouse location from which raw materials or components are issued + for this job card item join_hint: table: tabWarehouse 'on': source_warehouse = tabWarehouse.name - name: uom - description: '' + description: Unit of measurement for the item quantity used in this specific job + card operation or transaction. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: item_group - description: '' + description: Category or classification of the item being produced or consumed + in the job card. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: stock_uom - description: '' + description: Base unit of measurement for the item as defined in inventory, which + may differ from the transaction uom. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: item_name - description: '' + description: The specific item or material being consumed or produced in this + job card operation. - name: description - description: '' + description: Additional details or specifications about the item beyond its name. - name: required_qty - description: '' + description: The quantity of the item needed or planned for this job card operation. - name: transferred_qty - description: '' + description: Quantity of this item that has been transferred from the job card + to stock or another location. - name: allow_alternative_item - description: '' + description: Whether a substitute item can be used in place of this item during + job card execution. + desc_done: true - table: tabJob Card Operation description: '' fields: - name: name - description: '' + description: Unique identifier or code for the specific operation within the job + card - name: sub_operation - description: '' + description: Indicates whether this is a secondary or subsidiary operation under + a main operation join_hint: table: tabOperation 'on': sub_operation = tabOperation.name - name: completed_time - description: '' + description: Timestamp when the operation was finished or marked complete - name: status - description: '' + description: Current state of the job card operation such as pending, in progress, + completed, or on hold. options: - Complete - Pause - Pending - Work In Progress - name: completed_qty - description: '' + description: Quantity of items finished for this specific operation in the job + card. + desc_done: true - table: tabJob Card Scheduled Time description: '' fields: - name: name - description: '' + description: Unique identifier for the scheduled time slot on a job card - name: from_time - description: '' + description: Start time of the scheduled work period for a job card operation - name: to_time - description: '' + description: End time of the scheduled work period for a job card operation - name: time_in_mins - description: '' + description: Duration of scheduled time allocated for a job card operation or + task, used when querying how long work is planned to take. + desc_done: true - table: tabJob Card Scrap Item description: '' fields: - name: name - description: '' + description: Unique identifier for the scrap item record in the job card - name: item_code - description: '' + description: Code of the scrapped item material or product join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Name of the scrapped item material or product - name: description - description: '' + description: Details or notes about the scrapped item from the job card operation. - name: stock_qty - description: '' + description: Quantity of the scrapped item recorded in stock units. - name: stock_uom - description: '' + description: Unit of measurement for the scrapped item quantity in stock. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name + desc_done: true - table: tabJob Card Time Log description: '' fields: - name: name - description: '' + description: Unique identifier or code for the specific time log entry on a job + card - name: employee - description: '' + description: Employee who performed or logged the work time on the job card join_hint: table: tabEmployee 'on': employee = tabEmployee.name - name: from_time - description: '' + description: Start timestamp when the employee began working on the job card task - name: to_time - description: '' + description: End timestamp when work on the job card stopped or was completed - name: time_in_mins - description: '' + description: Total duration of work performed in minutes for this time log entry - name: completed_qty - description: '' + description: Quantity of items finished or produced during this specific time + log period - name: operation - description: '' + description: The specific manufacturing operation or work step being performed + during this time log entry. join_hint: table: tabOperation 'on': operation = tabOperation.name + desc_done: true - table: tabJournal Entry description: '' fields: - name: name - description: '' + description: Unique identifier for the journal entry used when referencing specific + transactions or filtering by entry number. - name: is_system_generated - description: '' + description: Indicates whether the journal entry was automatically created by + the system versus manually entered by a user, useful for auditing and filtering + automated transactions. - name: title - description: '' + description: Brief description or purpose of the journal entry used when searching + for specific transaction types or understanding the nature of accounting entries. - name: voucher_type - description: '' + description: Type of accounting transaction such as sales invoice, purchase invoice, + payment entry, or journal entry used to categorize the source document. options: - Journal Entry - Inter Company Journal Entry @@ -11800,187 +14250,235 @@ tables: - Deferred Revenue - Deferred Expense - name: naming_series - description: '' + description: Prefix pattern that determines the numbering sequence for journal + entry identifiers. options: - ACC-JV-.YYYY.- - name: finance_book - description: '' + description: Separate accounting book for maintaining parallel financial records + under different accounting standards or for different legal entities. join_hint: table: tabFinance Book 'on': finance_book = tabFinance Book.name - name: process_deferred_accounting - description: '' + description: Indicates whether this journal entry triggers deferred revenue or + expense recognition workflows. join_hint: table: tabProcess Deferred Accounting 'on': process_deferred_accounting = tabProcess Deferred Accounting.name - name: reversal_of - description: '' + description: References the original journal entry that this entry reverses or + cancels. join_hint: table: tabJournal Entry 'on': reversal_of = tabJournal Entry.name - name: tax_withholding_category - description: '' + description: Specifies the tax withholding classification applied to this journal + entry for compliance and reporting. join_hint: table: tabTax Withholding Category 'on': tax_withholding_category = tabTax Withholding Category.name - name: from_template - description: '' + description: Indicates whether the journal entry was created from a predefined + template rather than manually entered from scratch. join_hint: table: tabJournal Entry Template 'on': from_template = tabJournal Entry Template.name - name: company - description: '' + description: The specific company or legal entity to which this journal entry + belongs in a multi-company environment. join_hint: table: tabCompany 'on': company = tabCompany.name - name: posting_date - description: '' + description: The accounting period date when the journal entry is officially recorded + in the general ledger, affecting financial statements for that period. - name: apply_tds - description: '' + description: Whether tax deducted at source is applied to this journal entry transaction. - name: accounts - description: '' + description: The list of account lines with debits and credits that make up this + journal entry. - name: cheque_no - description: '' + description: The check or cheque number associated with this journal entry payment. - name: cheque_date - description: '' + description: Date on the cheque used for payment in this journal entry transaction. - name: user_remark - description: '' + description: Custom notes or comments added by the user to explain or annotate + this journal entry. - name: total_debit - description: '' + description: Sum of all debit amounts across all line items in this journal entry. - name: total_credit - description: '' + description: Sum of all credit amounts in the journal entry, used when analyzing + or validating credit-side transactions. - name: difference - description: '' + description: Imbalance between total debits and total credits, used to identify + unbalanced or incomplete journal entries. - name: multi_currency - description: '' + description: Indicates whether the journal entry involves transactions in multiple + currencies. - name: total_amount_currency - description: '' + description: Currency code for the journal entry total amount, used when filtering + or grouping entries by currency type. join_hint: table: tabCurrency 'on': total_amount_currency = tabCurrency.name - name: total_amount - description: '' + description: Net total monetary value of the journal entry, used for financial + calculations, balance verification, and amount-based queries. - name: total_amount_in_words - description: '' + description: Written text representation of the total amount, used for check printing, + formal documents, and compliance requirements. - name: clearance_date - description: '' + description: Date when a journal entry transaction was cleared or reconciled with + bank or other accounts. - name: remark - description: '' + description: Additional notes or comments explaining the purpose or context of + the journal entry. - name: paid_loan - description: '' + description: Indicates whether this journal entry represents a loan payment transaction. - name: inter_company_journal_entry_reference - description: '' + description: Links to the corresponding journal entry in another company entity + when recording transactions between related companies or subsidiaries. join_hint: table: tabJournal Entry 'on': inter_company_journal_entry_reference = tabJournal Entry.name - name: bill_no - description: '' + description: Vendor bill or invoice number associated with this journal entry + when recording payables or expense transactions. - name: bill_date - description: '' + description: Date on the vendor bill or invoice, used to track when the bill was + issued rather than when it was recorded or paid. - name: due_date - description: '' + description: Date when payment or settlement of the journal entry is expected + or required. - name: write_off_based_on - description: '' + description: Method or criteria used to determine the write-off calculation, such + as accounts receivable or accounts payable. options: - Accounts Receivable - Accounts Payable - name: write_off_amount - description: '' + description: Monetary value being written off as uncollectible, expired, or otherwise + removed from active accounts. - name: pay_to_recd_from - description: '' + description: Party name from whom payment was received or to whom payment was + made in this journal entry transaction. - name: letter_head - description: '' + description: Letterhead template applied when printing this journal entry document. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: select_print_heading - description: '' + description: Custom heading text that appears on the printed version of this journal + entry. join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: mode_of_payment - description: '' + description: Payment method used for the transaction such as cash, check, credit + card, or bank transfer. join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: payment_order - description: '' + description: Reference to the payment order document that initiated or is associated + with this journal entry. join_hint: table: tabPayment Order 'on': payment_order = tabPayment Order.name - name: party_not_required - description: '' + description: Indicates whether this journal entry can be created without specifying + a customer or supplier party. - name: is_opening - description: '' + description: Indicates whether this journal entry records opening balances when + initializing accounts at the start of a fiscal period or company setup. options: - 'No' - 'Yes' - name: stock_entry - description: '' + description: Links this journal entry to a stock/inventory movement transaction + that triggered automatic accounting entries. join_hint: table: tabStock Entry 'on': stock_entry = tabStock Entry.name - name: auto_repeat - description: '' + description: References the recurring schedule that automatically generates this + journal entry at defined intervals. join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: amended_from - description: '' + description: Links to the original journal entry that this entry amends or corrects, + used when users ask about corrections, amendments, or the history of modified + journal entries. join_hint: table: tabJournal Entry 'on': amended_from = tabJournal Entry.name + desc_done: true - table: tabJournal Entry Account description: '' fields: - name: name - description: '' + description: name - name: account - description: '' + description: The specific general ledger account code or identifier being debited + or credited in this journal entry line. join_hint: table: tabAccount 'on': account = tabAccount.name - name: account_type - description: '' + description: The classification of the account such as Asset, Liability, Equity, + Income, or Expense to categorize the nature of the transaction. - name: bank_account - description: '' + description: Bank account involved in the journal entry transaction for cash or + banking operations. join_hint: table: tabBank Account 'on': bank_account = tabBank Account.name - name: party_type - description: '' + description: Type of entity associated with the journal entry such as Customer, + Supplier, Employee, or Shareholder. join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: party - description: '' + description: Specific entity name or identifier linked to the journal entry when + the transaction involves a customer, supplier, or other party. - name: cost_center - description: '' + description: Department or business unit to which this journal entry line is allocated + for expense tracking and budgeting. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Specific project to which this journal entry line is assigned for + project-based accounting and profitability analysis. join_hint: table: tabProject 'on': project = tabProject.name - name: account_currency - description: '' + description: Currency in which this journal entry line's account maintains its + balance, which may differ from the transaction or company currency. join_hint: table: tabCurrency 'on': account_currency = tabCurrency.name - name: exchange_rate - description: '' + description: Rate used to convert foreign currency amounts to base currency for + this journal entry line. - name: debit_in_account_currency - description: '' + description: Debit amount in the original foreign currency of the account before + conversion. - name: debit - description: '' + description: Debit amount in the company's base currency after exchange rate conversion. - name: credit_in_account_currency - description: '' + description: Credit amount in the specific currency of the account, used when + analyzing transactions in their original currency rather than company base currency. - name: credit - description: '' + description: Credit amount converted to company base currency, used for consolidated + financial reporting and cross-account analysis. - name: reference_type - description: '' + description: Type of document or transaction this journal entry relates to, such + as Sales Invoice, Purchase Order, or Payment Entry. options: - Sales Invoice - Purchase Invoice @@ -11998,36 +14496,49 @@ tables: - Full and Final Statement - Payment Entry - name: reference_name - description: '' + description: Name or identifier of the external document or transaction that this + journal entry relates to, such as an invoice number, purchase order, or payment + reference. - name: reference_due_date - description: '' + description: Due date associated with the referenced external document, used when + tracking payment deadlines or obligation dates tied to the journal entry. - name: reference_detail_no - description: '' + description: Line item or detail number from the referenced external document, + used to link journal entries to specific lines in source transactions like invoice + line items or order details. - name: advance_voucher_type - description: '' + description: Type of advance payment voucher linked to this journal entry account + line, used when tracking prepayments or advance settlements. join_hint: table: tabDocType 'on': advance_voucher_type = tabDocType.name - name: advance_voucher_no - description: '' + description: Reference number of the advance payment voucher being settled or + applied in this journal entry account line. - name: is_advance - description: '' + description: Indicates whether this journal entry account line represents an advance + payment or prepayment transaction. options: - 'No' - 'Yes' - name: user_remark - description: '' + description: Custom notes or comments added by users to explain the purpose or + context of this journal entry line item. - name: against_account - description: '' + description: The offsetting account that this journal entry line is posted against, + showing the other side of the accounting transaction. + desc_done: true - table: tabJournal Entry Template description: '' fields: - name: name - description: '' + description: Unique identifier code for the journal entry template - name: template_title - description: '' + description: Descriptive title or label for the journal entry template used when + selecting or displaying templates - name: voucher_type - description: '' + description: Category or classification of the voucher associated with this template + such as payment, receipt, journal, or contra entry options: - Journal Entry - Inter Company Journal Entry @@ -12043,69 +14554,89 @@ tables: - Depreciation Entry - Exchange Rate Revaluation - name: naming_series - description: '' + description: Prefix pattern for automatically generating journal entry template + identifiers - name: company - description: '' + description: Company entity to which this journal entry template belongs and will + be applied join_hint: table: tabCompany 'on': company = tabCompany.name - name: is_opening - description: '' + description: Indicates whether this template is used for creating opening balance + journal entries options: - 'No' - 'Yes' - name: multi_currency - description: '' + description: Indicates whether the journal entry template supports transactions + in multiple currencies or foreign exchange entries. - name: accounts - description: '' + description: List of general ledger accounts included in this journal entry template + for posting debits and credits. + desc_done: true - table: tabJournal Entry Template Account description: '' fields: - name: name - description: '' + description: Name or identifier of the journal entry template account line item - name: account - description: '' + description: General ledger account code or number assigned to this template line + for posting transactions join_hint: table: tabAccount 'on': account = tabAccount.name + desc_done: true - table: tabKanban Board description: '' fields: - name: name - description: '' + description: Unique identifier for the kanban board record - name: kanban_board_name - description: '' + description: Display name of the kanban board shown to users - name: reference_doctype - description: '' + description: The document type (e.g., Task, Issue, Lead) that this kanban board + organizes and displays join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: field_name - description: '' + description: Name or title of the kanban board used to identify and distinguish + it from other boards - name: private - description: '' + description: Whether the kanban board is restricted to specific users or visible + to all users in the system - name: show_labels - description: '' + description: Whether labels or tags are displayed on cards within this kanban + board - name: columns - description: '' + description: Kanban board column definitions representing workflow stages like + To Do, In Progress, or Done that cards move through. - name: filters - description: '' + description: Criteria applied to determine which records or cards are displayed + on the kanban board based on status, assignment, priority, or other conditions. - name: fields - description: '' + description: Data attributes or properties shown on each kanban card such as title, + assignee, due date, or custom fields. + desc_done: true - table: tabKanban Board Column description: '' fields: - name: name - description: '' + description: Unique identifier for the kanban board column used when filtering + or grouping tasks by workflow stage. - name: column_name - description: '' + description: Display label of the kanban column used when users search for tasks + in specific workflow stages like 'In Progress' or 'Done'. - name: status - description: '' + description: Indicates whether the kanban column is active or inactive, used when + analyzing current workflow configurations or filtering visible stages. options: - Active - Archived - name: indicator - description: '' + description: Visual indicator or color code representing the kanban column status + or priority level. options: - Blue - Cyan @@ -12119,272 +14650,353 @@ tables: - Red - Yellow - name: order - description: '' + description: Sequence position determining the left-to-right display order of + this column on the kanban board. + desc_done: true - table: tabLDAP Group Mapping description: '' fields: - name: name - description: '' + description: Unique identifier for the LDAP group mapping configuration - name: ldap_group - description: '' + description: LDAP group name from the directory service that will be mapped to + an ERPNext role - name: erpnext_role - description: '' + description: ERPNext role assigned to users who belong to the corresponding LDAP + group join_hint: table: tabRole 'on': erpnext_role = tabRole.name + desc_done: true - table: tabLDAP Settings description: '' fields: - name: name - description: '' + description: Unique identifier or label for the LDAP configuration - name: enabled - description: '' + description: Whether this LDAP configuration is currently active for authentication - name: ldap_directory_server - description: '' + description: Hostname or IP address of the LDAP/Active Directory server to connect + to options: - Active Directory - OpenLDAP - Custom - name: ldap_server_url - description: '' + description: URL or hostname of the LDAP server used for authentication and directory + services. - name: base_dn - description: '' + description: Distinguished name defining the starting point for LDAP directory + searches and user lookups. - name: password - description: '' + description: Credential used to bind and authenticate to the LDAP server. - name: ldap_search_path_user - description: '' + description: LDAP directory path where user accounts are searched, such as organizational + unit or domain component for user authentication. - name: ldap_search_string - description: '' + description: LDAP query filter string used to match and retrieve directory entries + based on specific attributes or conditions. - name: ldap_search_path_group - description: '' + description: LDAP directory path where group objects are searched, such as organizational + unit or domain component for group membership lookups. - name: ldap_email_field - description: '' + description: LDAP attribute name that maps to user email addresses for authentication + and communication. - name: ldap_username_field - description: '' + description: LDAP attribute name that maps to user login usernames for system + authentication. - name: ldap_first_name_field - description: '' + description: LDAP attribute name that maps to user first names for profile display + and personalization. - name: do_not_create_new_user - description: '' + description: Controls whether new users are automatically created from LDAP authentication + or only existing users can authenticate. - name: ldap_middle_name_field - description: '' + description: LDAP attribute mapped to user middle name during authentication and + synchronization. - name: ldap_last_name_field - description: '' + description: LDAP attribute mapped to user last name during authentication and + synchronization. - name: ldap_phone_field - description: '' + description: LDAP attribute name mapped to user phone numbers for directory synchronization + and contact information. - name: ldap_mobile_field - description: '' + description: LDAP attribute name mapped to user mobile numbers for directory synchronization + and mobile contact information. - name: ssl_tls_mode - description: '' + description: Security protocol configuration for LDAP server connections determining + encryption method. options: - 'Off' - StartTLS - name: require_trusted_certificate - description: '' + description: Whether LDAP connections must use certificates signed by a trusted + certificate authority for secure authentication. options: - 'No' - 'Yes' - name: local_private_key_file - description: '' + description: File path to the private key used for LDAP SSL/TLS encryption and + server authentication. - name: local_server_certificate_file - description: '' + description: File path to the server certificate used for LDAP SSL/TLS connections + and identity verification. - name: local_ca_certs_file - description: '' + description: File path to local certificate authority certificates for validating + LDAP server SSL/TLS connections. - name: ldap_group_objectclass - description: '' + description: LDAP object class type used to identify and filter group entries + in the directory. - name: ldap_custom_group_search - description: '' + description: Custom LDAP search filter or query expression for locating groups + beyond default objectclass matching. - name: ldap_group_member_attribute - description: '' + description: LDAP attribute name that identifies group membership for users authenticating + via directory services. - name: default_user_type - description: '' + description: User type automatically assigned to new users created through LDAP + authentication. join_hint: table: tabUser Type 'on': default_user_type = tabUser Type.name - name: default_role - description: '' + description: Role automatically assigned to new users created through LDAP authentication. join_hint: table: tabRole 'on': default_role = tabRole.name - name: ldap_groups - description: '' + description: LDAP group names or identifiers that users belong to for authentication + and authorization purposes - name: ldap_group_field - description: '' + description: The specific LDAP attribute name used to retrieve group membership + information from the directory server + desc_done: true - table: tabLanded Cost Item description: '' fields: - name: name - description: '' + description: Unique identifier for the landed cost item record used when referencing + specific cost entries in queries and reports. - name: item_code - description: '' + description: Code linking to the inventory item receiving the landed cost allocation, + used when analyzing cost impacts on specific products. join_hint: table: tabItem 'on': item_code = tabItem.name - name: description - description: '' + description: Text explanation of the landed cost component (freight, duties, insurance) + used when filtering or grouping costs by type or category. - name: receipt_document_type - description: '' + description: Type of document associated with the goods receipt, such as purchase + order, transfer order, or return authorization. options: - Purchase Invoice - Purchase Receipt - name: receipt_document - description: '' + description: Identifier or number of the specific receipt document that triggered + the landed cost allocation. - name: qty - description: '' + description: Quantity of items received in this landed cost allocation, used to + calculate per-unit landed cost distribution. - name: rate - description: '' + description: Rate per unit used to calculate the landed cost charge applied to + items in the shipment. - name: amount - description: '' + description: Total monetary value of the landed cost charge for this item. - name: is_fixed_asset - description: '' + description: Indicates whether the landed cost item should be capitalized as a + fixed asset rather than expensed. - name: applicable_charges - description: '' + description: Total landed cost charges allocated to this item from freight, customs, + insurance and other import-related expenses. - name: purchase_receipt_item - description: '' + description: Reference to the specific line item on the purchase receipt that + this landed cost is being applied to. - name: cost_center - description: '' + description: Cost center to which this landed cost item's expenses should be allocated + for accounting and budgeting purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name + desc_done: true - table: tabLanded Cost Purchase Receipt description: '' fields: - name: name - description: '' + description: Unique identifier for the landed cost purchase receipt record - name: receipt_document_type - description: '' + description: Type of document associated with the receipt such as Purchase Receipt + or Purchase Invoice options: - Purchase Invoice - Purchase Receipt - name: receipt_document - description: '' + description: Specific document number or reference of the purchase receipt or + invoice linked to this landed cost - name: supplier - description: '' + description: The vendor or supplier from whom the goods were purchased and received. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: posting_date - description: '' + description: The accounting date when the purchase receipt transaction was recorded + in the financial ledger. - name: grand_total - description: '' + description: The total amount of the purchase receipt including all items, taxes, + and charges. + desc_done: true - table: tabLanded Cost Taxes and Charges description: '' fields: - name: name - description: '' + description: Unique identifier for the specific landed cost tax or charge line + item - name: expense_account - description: '' + description: General ledger account where this landed cost tax or charge expense + is recorded join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: account_currency - description: '' + description: Currency of the expense account used for this landed cost tax or + charge join_hint: table: tabCurrency 'on': account_currency = tabCurrency.name - name: exchange_rate - description: '' + description: Rate used to convert foreign currency charges to the base currency + for this landed cost tax or charge line item. - name: description - description: '' + description: Text explanation or label identifying the specific tax or charge + being applied to the landed cost. - name: amount - description: '' + description: Monetary value of the tax or charge applied to the landed cost in + the specified currency. - name: base_amount - description: '' + description: Tax or charge amount in company's base currency for landed cost calculations. - name: has_corrective_cost - description: '' + description: Indicates whether this tax or charge includes a corrective adjustment + to the landed cost. + desc_done: true - table: tabLanded Cost Voucher description: '' fields: - name: name - description: '' + description: Unique identifier for the landed cost voucher used to reference or + search for a specific landed cost allocation transaction. - name: naming_series - description: '' + description: Prefix pattern that determines the automatic numbering format for + landed cost voucher identifiers. options: - MAT-LCV-.YYYY.- - name: company - description: '' + description: The company entity to which this landed cost voucher belongs, used + when filtering or reporting landed costs by organizational unit. join_hint: table: tabCompany 'on': company = tabCompany.name - name: posting_date - description: '' + description: Date when the landed cost voucher is posted to the general ledger + for accounting purposes. - name: purchase_receipts - description: '' + description: References to the purchase receipt documents against which landed + costs are being allocated. - name: items - description: '' + description: Line items detailing the landed cost components such as freight, + customs, insurance, and other charges being distributed. - name: taxes - description: '' + description: Line items detailing individual tax components and charges applied + to the landed cost voucher. - name: total_taxes_and_charges - description: '' + description: Aggregate sum of all taxes and additional charges on the landed cost + voucher. - name: distribute_charges_based_on - description: '' + description: Method used to allocate landed costs across items, such as by quantity, + amount, or weight. options: - Qty - Amount - Distribute Manually - name: amended_from - description: '' + description: References the original landed cost voucher that this document amends + or corrects. join_hint: table: tabLanded Cost Voucher 'on': amended_from = tabLanded Cost Voucher.name + desc_done: true - table: tabLanguage description: '' fields: - name: name - description: '' + description: Language display name or label in human-readable form - name: enabled - description: '' + description: Whether the language is currently active and available for use in + the system - name: language_code - description: '' + description: ISO standard language identifier code used for programmatic language + selection and localization - name: language_name - description: '' + description: Name of the language used for translations, localization, and multi-language + content in the system. - name: flag - description: '' + description: Country or regional flag icon associated with the language for visual + identification in user interfaces. - name: based_on - description: '' + description: Parent or source language from which this language variant or dialect + is derived. join_hint: table: tabLanguage 'on': based_on = tabLanguage.name + desc_done: true - table: tabLead description: '' fields: - name: name - description: '' + description: Full name of the lead or prospect contact person - name: naming_series - description: '' + description: Prefix pattern used to generate the lead identifier code options: - CRM-LEAD-.YYYY.- - name: salutation - description: '' + description: Title or honorific for the lead contact such as Mr, Ms, Dr, or Prof join_hint: table: tabSalutation 'on': salutation = tabSalutation.name - name: first_name - description: '' + description: Lead's given name used when searching or filtering by first name + only - name: middle_name - description: '' + description: Lead's middle name used when full legal name matching or detailed + contact information is needed - name: last_name - description: '' + description: Lead's family name or surname used when searching by last name or + sorting alphabetically - name: lead_name - description: '' + description: Name of the potential customer or prospect being tracked for sales + opportunities. - name: job_title - description: '' + description: Professional role or position title of the lead contact person. - name: gender - description: '' + description: Gender identity of the lead contact for demographic segmentation + and personalization. join_hint: table: tabGender 'on': gender = tabGender.name - name: source - description: '' + description: Where the lead originated from, such as website, referral, trade + show, or advertising campaign. join_hint: table: tabLead Source 'on': source = tabLead Source.name - name: lead_owner - description: '' + description: The salesperson or team member responsible for managing and following + up with this lead. join_hint: table: tabUser 'on': lead_owner = tabUser.name - name: status - description: '' + description: Current stage of the lead in the sales pipeline, such as new, contacted, + qualified, or converted. options: - Lead - Open @@ -12396,39 +15008,46 @@ tables: - Converted - Do Not Contact - name: customer - description: '' + description: The potential customer or prospect company/person associated with + this sales lead join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: type - description: '' + description: The classification or category of the lead such as prospect, opportunity, + or qualified lead stage options: - Client - Channel Partner - Consultant - name: request_type - description: '' + description: The nature or purpose of the initial inquiry such as product demo, + pricing request, or support inquiry options: - Product Enquiry - Request for Information - Suggestions - Other - name: email_id - description: '' + description: Email address of the lead for contact and communication purposes - name: website - description: '' + description: Company or personal website URL associated with the lead - name: mobile_no - description: '' + description: Mobile phone number of the lead for direct contact - name: whatsapp_no - description: '' + description: WhatsApp contact number for the lead, used when users need to reach + leads via WhatsApp messaging. - name: phone - description: '' + description: Primary telephone number for the lead, used for voice calls and general + phone contact. - name: phone_ext - description: '' + description: Telephone extension number appended to the primary phone number for + direct dialing to the lead. - name: company_name - description: '' + description: Name of the organization or business associated with the lead - name: no_of_employees - description: '' + description: Total employee count at the lead's organization, used to assess company + size and qualification criteria options: - 1-10 - 11-50 @@ -12437,127 +15056,160 @@ tables: - 501-1000 - 1000+ - name: annual_revenue - description: '' + description: Yearly revenue of the lead's organization, used to evaluate financial + capacity and lead prioritization - name: industry - description: '' + description: The business sector or industry vertical of the lead such as manufacturing, + healthcare, or technology. join_hint: table: tabIndustry Type 'on': industry = tabIndustry Type.name - name: market_segment - description: '' + description: The specific market category or customer segment the lead belongs + to, such as enterprise, SMB, or mid-market. join_hint: table: tabMarket Segment 'on': market_segment = tabMarket Segment.name - name: territory - description: '' + description: The geographic sales region or area assigned to the lead for sales + coverage and ownership. join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: fax - description: '' + description: Fax number of the lead for contact purposes - name: city - description: '' + description: City location of the lead's address - name: state - description: '' + description: State or province of the lead's address - name: country - description: '' + description: Geographic location of the lead used for territory assignment, regional + analysis, and market segmentation queries. join_hint: table: tabCountry 'on': country = tabCountry.name - name: qualification_status - description: '' + description: Current stage in the lead qualification process indicating whether + the lead is unqualified, qualified, or disqualified. options: - Unqualified - In Process - Qualified - name: qualified_by - description: '' + description: Person or user who performed the qualification action on the lead. join_hint: table: tabUser 'on': qualified_by = tabUser.name - name: qualified_on - description: '' + description: Date when the lead was marked as qualified or met qualification criteria - name: campaign_name - description: '' + description: Marketing campaign that generated or is associated with this lead join_hint: table: tabCampaign 'on': campaign_name = tabCampaign.name - name: company - description: '' + description: Company or organization name of the lead join_hint: table: tabCompany 'on': company = tabCompany.name - name: language - description: '' + description: Preferred language for communicating with the lead join_hint: table: tabLanguage 'on': language = tabLanguage.name - name: title - description: '' + description: Job title or role of the lead contact person - name: disabled - description: '' + description: Whether the lead record is inactive or excluded from active sales + processes - name: unsubscribed - description: '' + description: Whether the lead has opted out of marketing communications or email + campaigns - name: blog_subscriber - description: '' + description: Whether the lead has subscribed to receive blog updates or content + notifications - name: notes - description: '' + description: Free-form comments or additional information recorded about the lead's + interactions, preferences, or context + desc_done: true - table: tabLead Source description: '' fields: - name: name - description: '' + description: Unique identifier or label for the lead source record used when filtering + or grouping leads by their origin. - name: source_name - description: '' + description: The marketing channel or campaign name where the lead originated, + used to analyze lead generation effectiveness and ROI. - name: details - description: '' + description: Additional context about the lead source such as campaign specifics + or referral information, used when investigating lead quality or attribution + details. + desc_done: true - table: tabLedger Health description: '' fields: - name: name - description: '' + description: Descriptive label or title identifying the specific ledger health + record or transaction - name: voucher_type - description: '' + description: Category or classification of the accounting voucher such as payment, + receipt, journal, or sales - name: voucher_no - description: '' + description: Unique identifier number assigned to the specific voucher document + for tracking and reference - name: checked_on - description: '' + description: Date when ledger health validation was performed, used to find when + accounts were last audited or reconciled. - name: debit_credit_mismatch - description: '' + description: Indicates whether debits and credits are out of balance, used to + identify accounting errors or unbalanced journal entries. - name: general_and_payment_ledger_mismatch - description: '' + description: Indicates discrepancies between general ledger and payment ledger + totals, used to detect reconciliation issues between payment records and accounting + books. + desc_done: true - table: tabLedger Health Monitor description: '' fields: - name: name - description: '' + description: Name or identifier of the ledger being monitored for health status + and anomalies. - name: enable_health_monitor - description: '' + description: Indicates whether health monitoring is active for this ledger to + track transaction patterns and detect issues. - name: monitor_for_last_x_days - description: '' + description: Number of days of historical ledger activity to analyze when checking + for health issues or anomalies. - name: debit_credit_mismatch - description: '' + description: Indicates when total debits and credits are unbalanced in ledger + entries, used to identify accounting equation violations. - name: general_and_payment_ledger_mismatch - description: '' + description: Flags discrepancies between general ledger and payment ledger records + for the same transactions, used to detect reconciliation issues. - name: companies - description: '' + description: The company or legal entity being monitored for ledger health issues. + desc_done: true - table: tabLedger Health Monitor Company description: '' fields: - name: name - description: '' + description: Name or identifier of the ledger health monitoring entity being tracked - name: company - description: '' + description: Company associated with the ledger health monitoring record for multi-entity + financial tracking join_hint: table: tabCompany 'on': company = tabCompany.name + desc_done: true - table: tabLedger Merge description: '' fields: - name: name - description: '' + description: Name or title of the ledger merge configuration or grouping - name: root_type - description: '' + description: Classification indicating whether this ledger merge represents an + asset, liability, equity, income, or expense category options: - Asset - Liability @@ -12565,135 +15217,166 @@ tables: - Expense - Equity - name: account - description: '' + description: Specific general ledger account number or code associated with this + ledger merge entry join_hint: table: tabAccount 'on': account = tabAccount.name - name: account_name - description: '' + description: Name of the general ledger account involved in the transaction, used + when searching for transactions by account type or category. - name: company - description: '' + description: Company entity associated with the ledger entry, used when filtering + transactions by legal entity or business unit. join_hint: table: tabCompany 'on': company = tabCompany.name - name: status - description: '' + description: Current state of the ledger entry such as draft, posted, or cancelled, + used when filtering for finalized versus pending transactions. options: - Pending - Success - Partial Success - Error - name: is_group - description: '' + description: Indicates whether this ledger entry represents a grouped or consolidated + set of accounts rather than an individual account. - name: merge_accounts - description: '' + description: Specifies which accounts are combined or consolidated together in + this ledger merge operation. + desc_done: true - table: tabLedger Merge Accounts description: '' fields: - name: name - description: '' + description: Descriptive label for the merged ledger account grouping or consolidation + rule - name: account - description: '' + description: Account code or identifier being merged or consolidated into a parent + account join_hint: table: tabAccount 'on': account = tabAccount.name - name: account_name - description: '' + description: Full name of the account being merged, providing readable context + for the account code - name: merged - description: '' + description: Indicates whether this ledger account has been merged into another + account and is no longer active for new transactions. + desc_done: true - table: tabLetter Head description: '' fields: - name: name - description: '' + description: Unique identifier for the letterhead record - name: letter_head_name - description: '' + description: Display name of the letterhead shown to users when selecting letterhead + templates for documents - name: source - description: '' + description: Defines whether the letterhead uses an image file or HTML code for + rendering the header/footer design options: - Image - HTML - name: footer_source - description: '' + description: Source content or template for the footer section displayed at the + bottom of documents using this letterhead options: - Image - HTML - name: disabled - description: '' + description: Whether this letterhead is inactive and unavailable for selection + when creating new documents - name: is_default - description: '' + description: Whether this letterhead is automatically selected as the default + option for new documents - name: image_height - description: '' + description: Height dimension of the letterhead image in pixels or units - name: image_width - description: '' + description: Width dimension of the letterhead image in pixels or units - name: align - description: '' + description: Horizontal alignment position of letterhead content such as left, + center, or right options: - Left - Right - Center - name: footer_image_height - description: '' + description: Height dimension of the footer image on letterhead documents - name: footer_image_width - description: '' + description: Width dimension of the footer image on letterhead documents - name: footer_align - description: '' + description: Horizontal alignment position of the footer content on letterhead + documents options: - Left - Right - Center - name: header_script - description: '' + description: Custom script or HTML code that appears at the top of letterhead + documents. - name: footer_script - description: '' + description: Custom script or HTML code that appears at the bottom of letterhead + documents. + desc_done: true - table: tabLinked Location description: '' fields: - name: name - description: '' + description: Name or identifier of the linked location relationship - name: location - description: '' + description: The actual location being linked or referenced in this relationship join_hint: table: tabLocation 'on': location = tabLocation.name + desc_done: true - table: tabList Filter description: '' fields: - name: name - description: '' + description: Unique identifier for the list filter record, used when referencing + or retrieving a specific saved filter configuration. - name: filter_name - description: '' + description: Display name of the saved filter, used when users search for or select + predefined filter criteria to apply to list views. - name: reference_doctype - description: '' + description: The document type this filter applies to, used when determining which + filters are available for a specific module or report. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: for_user - description: '' + description: User who owns or created this saved filter configuration join_hint: table: tabUser 'on': for_user = tabUser.name - name: filters - description: '' + description: Saved filter criteria and conditions applied to list views + desc_done: true - table: tabList View Settings description: '' fields: - name: name - description: '' + description: Name or identifier of the list view configuration - name: disable_count - description: '' + description: Controls whether the total record count is hidden in the list view - name: disable_comment_count - description: '' + description: Controls whether the comment count is hidden in the list view - name: disable_sidebar_stats - description: '' + description: Controls whether statistics are hidden in the sidebar for this list + view - name: disable_auto_refresh - description: '' + description: Controls whether the list view automatically refreshes when data + changes - name: allow_edit - description: '' + description: Controls whether users can edit records directly within this list + view - name: disable_automatic_recency_filters - description: '' + description: Whether automatic date-based filtering is turned off for this list + view, relevant when users want to see all historical records without time restrictions. - name: total_fields - description: '' + description: Count of fields configured or displayed in this list view. options: - '4' - '5' @@ -12703,356 +15386,449 @@ tables: - '9' - '10' - name: fields - description: '' + description: Collection or specification of which data fields are included in + this list view configuration. + desc_done: true - table: tabLocation description: '' fields: - name: name - description: '' + description: Unique identifier code or short name for the location, used when + referencing locations by their system code or abbreviation - name: location_name - description: '' + description: Full descriptive name of the location, used when searching or filtering + by the complete location title - name: parent_location - description: '' + description: The higher-level location that contains this location, used for hierarchical + queries about location relationships or organizational structure join_hint: table: tabLocation 'on': parent_location = tabLocation.name - name: is_container - description: '' + description: Indicates whether the location can hold or store other items or materials + within it. - name: is_group - description: '' + description: Indicates whether the location represents a logical grouping of multiple + physical locations rather than a single physical space. - name: latitude - description: '' + description: Geographic coordinate for the location's north-south position, used + when querying location coordinates or mapping warehouse/facility positions. - name: longitude - description: '' + description: Geographic longitude coordinate of the location, used when filtering + or analyzing locations by geographic position or mapping requirements. - name: area - description: '' + description: Physical size or space measurement of the location, used when filtering + by location capacity or space availability. - name: area_uom - description: '' + description: Unit of measurement for the area field (e.g., square feet, square + meters), used when interpreting or converting location size values. join_hint: table: tabUOM 'on': area_uom = tabUOM.name - name: location - description: '' + description: Location identifier or name used when querying where inventory, assets, + or operations are physically situated - name: lft - description: '' + description: Left boundary value in nested set model for hierarchical location + queries involving parent-child or ancestor-descendant relationships - name: rgt - description: '' + description: Right boundary value in nested set model for hierarchical location + queries involving parent-child or ancestor-descendant relationships - name: old_parent - description: '' + description: Previous parent location before a location was moved or reparented + in the location hierarchy. + desc_done: true - table: tabLog Setting User description: '' fields: - name: name - description: '' + description: name - name: user - description: '' + description: user join_hint: table: tabUser 'on': user = tabUser.name + desc_done: true - table: tabLog Settings description: '' fields: - name: name - description: '' + description: Name or identifier of the log settings configuration - name: logs_to_clear - description: '' + description: Specifies which log types or categories are designated for clearing + or deletion + desc_done: true - table: tabLogs To Clear description: '' fields: - name: name - description: '' + description: name - name: ref_doctype - description: '' + description: The document type whose logs are scheduled for automatic clearing + or deletion join_hint: table: tabDocType 'on': ref_doctype = tabDocType.name - name: days - description: '' + description: Number of days after which logs for the specified document type will + be automatically cleared + desc_done: true - table: tabLost Reason Detail description: '' fields: - name: name - description: '' + description: Specific detail or sub-category explaining why an opportunity or + sale was lost - name: lost_reason - description: '' + description: Primary category or high-level classification of why an opportunity + or sale was lost join_hint: table: tabOpportunity Lost Reason 'on': lost_reason = tabOpportunity Lost Reason.name + desc_done: true - table: tabLower Deduction Certificate description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the lower deduction certificate + issued by tax authorities - name: tax_withholding_category - description: '' + description: Category of tax for which lower withholding rate applies under this + certificate join_hint: table: tabTax Withholding Category 'on': tax_withholding_category = tabTax Withholding Category.name - name: fiscal_year - description: '' + description: Financial year during which the lower deduction certificate is valid + or applicable join_hint: table: tabFiscal Year 'on': fiscal_year = tabFiscal Year.name - name: company - description: '' + description: Company entity for which the lower tax deduction certificate is issued + or applicable join_hint: table: tabCompany 'on': company = tabCompany.name - name: certificate_no - description: '' + description: Unique certificate number assigned to the lower deduction certificate + by tax authorities - name: supplier - description: '' + description: Vendor or supplier who provided the lower deduction certificate for + reduced TDS withholding join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: pan_no - description: '' + description: Permanent Account Number of the entity for which the lower tax deduction + certificate is issued. - name: valid_from - description: '' + description: Start date from which the lower deduction certificate becomes effective. - name: valid_upto - description: '' + description: End date until which the lower deduction certificate remains valid. - name: rate - description: '' + description: Tax deduction rate percentage specified in the lower deduction certificate + for reduced TDS withholding - name: certificate_limit - description: '' + description: Maximum transaction amount or threshold up to which the lower deduction + rate applies under this certificate + desc_done: true - table: tabLoyalty Point Entry description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the loyalty point transaction + entry - name: loyalty_program - description: '' + description: The loyalty program under which these points were earned or redeemed join_hint: table: tabLoyalty Program 'on': loyalty_program = tabLoyalty Program.name - name: loyalty_program_tier - description: '' + description: The membership tier level of the customer at the time of this point + transaction - name: customer - description: '' + description: Customer who earned or redeemed loyalty points in this transaction. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: invoice_type - description: '' + description: Type of document that triggered the loyalty point transaction, such + as Sales Invoice or Sales Order. join_hint: table: tabDocType 'on': invoice_type = tabDocType.name - name: invoice - description: '' + description: Specific document number or reference that generated this loyalty + point entry. - name: redeem_against - description: '' + description: The transaction or invoice document against which loyalty points + are being redeemed or applied. join_hint: table: tabLoyalty Point Entry 'on': redeem_against = tabLoyalty Point Entry.name - name: loyalty_points - description: '' + description: The number of loyalty points earned or redeemed in this transaction + entry. - name: purchase_amount - description: '' + description: The monetary value of the purchase that triggered the loyalty point + calculation or redemption. - name: expiry_date - description: '' + description: Date when loyalty points become invalid and can no longer be redeemed + by the customer. - name: posting_date - description: '' + description: Date when the loyalty point transaction was recorded in the system. - name: company - description: '' + description: Company entity that issued or manages the loyalty points. join_hint: table: tabCompany 'on': company = tabCompany.name + desc_done: true - table: tabLoyalty Point Entry Redemption description: '' fields: - name: name - description: '' + description: Unique identifier for the loyalty point redemption transaction - name: sales_invoice - description: '' + description: Sales invoice where loyalty points were redeemed for payment or discount - name: redemption_date - description: '' + description: Date when loyalty points were redeemed by the customer - name: redeemed_points - description: '' + description: Number of loyalty points deducted from customer balance when redeeming + rewards or benefits. + desc_done: true - table: tabLoyalty Program description: '' fields: - name: name - description: '' + description: Unique identifier or code for the loyalty program record - name: loyalty_program_name - description: '' + description: Full display name of the loyalty program as shown to customers and + in reports - name: loyalty_program_type - description: '' + description: Classification of the loyalty program such as points-based, tier-based, + cashback, or referral options: - Single Tier Program - Multiple Tier Program - name: from_date - description: '' + description: Start date when the loyalty program becomes active for customers + to earn or redeem points. - name: to_date - description: '' + description: End date when the loyalty program expires and is no longer valid + for transactions. - name: customer_group - description: '' + description: Specific customer segment or tier eligible to participate in this + loyalty program. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: customer_territory - description: '' + description: Geographic region or sales territory where the loyalty program customer + is located or assigned. join_hint: table: tabTerritory 'on': customer_territory = tabTerritory.name - name: auto_opt_in - description: '' + description: Whether customers are automatically enrolled in the loyalty program + without explicit consent action. - name: collection_rules - description: '' + description: Conditions and criteria defining how loyalty points or rewards are + earned from customer transactions. - name: conversion_factor - description: '' + description: Ratio used to calculate how many loyalty points are earned or redeemed + per currency unit spent or received. - name: expiry_duration - description: '' + description: Time period after which earned loyalty points become invalid and + can no longer be redeemed. - name: expense_account - description: '' + description: General ledger account where loyalty program costs such as point + redemptions or rewards are recorded. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: company - description: '' + description: The company entity that owns or operates this loyalty program. join_hint: table: tabCompany 'on': company = tabCompany.name - name: cost_center - description: '' + description: The cost center responsible for expenses related to this loyalty + program. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: The project associated with this loyalty program for tracking purposes. join_hint: table: tabProject 'on': project = tabProject.name + desc_done: true - table: tabLoyalty Program Collection description: '' fields: - name: name - description: '' + description: Name of the loyalty program collection that groups related loyalty + tiers and benefits together - name: tier_name - description: '' + description: Name of the specific loyalty tier level within a program such as + Bronze, Silver, Gold, or Platinum - name: min_spent - description: '' + description: Minimum spending amount required for a customer to qualify for or + maintain this loyalty tier - name: collection_factor - description: '' + description: Multiplier or percentage rate applied to transactions or purchases + to determine loyalty points earned in this program collection. + desc_done: true - table: tabMaintenance Schedule description: '' fields: - name: name - description: '' + description: Unique identifier or title for the maintenance schedule - name: naming_series - description: '' + description: Prefix pattern used to generate the maintenance schedule name options: - MAT-MSH-.YYYY.- - name: customer - description: '' + description: Customer for whom the maintenance schedule is created join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: status - description: '' + description: Current state of the maintenance schedule such as planned, in progress, + completed, or cancelled. options: - Draft - Submitted - Cancelled - name: transaction_date - description: '' + description: Date when the maintenance schedule record was created or last modified + in the system. - name: items - description: '' + description: Equipment, assets, or components included in this maintenance schedule + for servicing or inspection. - name: schedules - description: '' + description: Planned maintenance appointments or recurring service visit timings + for equipment or facilities - name: customer_name - description: '' + description: Name of the customer or company receiving the scheduled maintenance + service - name: contact_person - description: '' + description: Individual at the customer location who coordinates or approves maintenance + visits join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_mobile - description: '' + description: Mobile phone number of the person responsible for or associated with + this maintenance schedule. - name: contact_email - description: '' + description: Email address of the person responsible for or associated with this + maintenance schedule. - name: contact_display - description: '' + description: Full name or display label of the person responsible for or associated + with this maintenance schedule. - name: customer_address - description: '' + description: Specific address record linked to the customer where maintenance + is performed or equipment is located. join_hint: table: tabAddress 'on': customer_address = tabAddress.name - name: address_display - description: '' + description: Formatted full address text for displaying the maintenance location + to users. - name: territory - description: '' + description: Sales or service territory assigned to the maintenance schedule for + routing and assignment purposes. join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: customer_group - description: '' + description: Customer segment or category this maintenance schedule applies to, + used when filtering schedules by customer type or classification. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: company - description: '' + description: Legal entity or business unit that owns or manages this maintenance + schedule. join_hint: table: tabCompany 'on': company = tabCompany.name - name: amended_from - description: '' + description: Reference to the previous version of this maintenance schedule if + it was modified or corrected after creation. join_hint: table: tabMaintenance Schedule 'on': amended_from = tabMaintenance Schedule.name + desc_done: true - table: tabMaintenance Schedule Detail description: '' fields: - name: name - description: '' + description: Unique identifier or label for this specific maintenance schedule + detail entry - name: item_code - description: '' + description: Code of the item or asset requiring maintenance in this schedule join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Descriptive name of the item or asset requiring maintenance in this + schedule - name: scheduled_date - description: '' + description: When maintenance was originally planned to occur, used to track planned + timing versus actual execution. - name: actual_date - description: '' + description: When maintenance was actually performed, used to measure delays or + early completion against the schedule. - name: sales_person - description: '' + description: The salesperson associated with this maintenance activity, used to + track service ownership or commission eligibility. join_hint: table: tabSales Person 'on': sales_person = tabSales Person.name - name: completion_status - description: '' + description: Current state of the maintenance task indicating whether it is pending, + in progress, completed, or cancelled. options: - Pending - Partially Completed - Fully Completed - name: serial_no - description: '' + description: Sequence number identifying the order or position of this maintenance + task within the schedule. - name: item_reference - description: '' + description: Identifier linking to the specific equipment, asset, or item being + maintained in this scheduled task. join_hint: table: tabMaintenance Schedule Item 'on': item_reference = tabMaintenance Schedule Item.name + desc_done: true - table: tabMaintenance Schedule Item description: '' fields: - name: name - description: '' + description: Unique identifier or title for this specific maintenance schedule + item entry - name: item_code - description: '' + description: SKU or product code of the physical item being maintained join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Human-readable product name of the physical item being maintained - name: description - description: '' + description: Details what maintenance task or activity is scheduled to be performed + on equipment or assets. - name: start_date - description: '' + description: When the scheduled maintenance activity is planned to begin. - name: end_date - description: '' + description: When the scheduled maintenance activity is planned to be completed + or conclude. - name: periodicity - description: '' + description: Frequency or interval at which maintenance visits are scheduled, + such as weekly, monthly, quarterly, or annually. options: - Weekly - Monthly @@ -13061,267 +15837,340 @@ tables: - Yearly - Random - name: no_of_visits - description: '' + description: Total number of maintenance visits planned or required for this schedule + item. - name: sales_person - description: '' + description: Sales representative responsible for the maintenance contract or + schedule. join_hint: table: tabSales Person 'on': sales_person = tabSales Person.name - name: serial_no - description: '' + description: Unique identifier of the specific equipment or asset being maintained + under this schedule. - name: sales_order - description: '' + description: Original sales order that delivered the equipment or asset requiring + scheduled maintenance. join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: serial_and_batch_bundle - description: '' + description: Groups multiple serial numbers or batch numbers together for bulk + maintenance scheduling. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name + desc_done: true - table: tabMaintenance Team Member description: '' fields: - name: name - description: '' + description: Unique identifier or code for the maintenance team member record - name: team_member - description: '' + description: Reference to the user or employee assigned as a maintenance team + member join_hint: table: tabUser 'on': team_member = tabUser.name - name: full_name - description: '' + description: Complete name of the maintenance team member for display and search + purposes - name: maintenance_role - description: '' + description: Role or job function of the team member in maintenance operations, + such as technician, supervisor, or engineer. join_hint: table: tabRole 'on': maintenance_role = tabRole.name + desc_done: true - table: tabMaintenance Visit description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the maintenance visit - name: naming_series - description: '' + description: Prefix pattern used to auto-generate the maintenance visit name options: - MAT-MVS-.YYYY.- - name: customer - description: '' + description: Customer who requested or is receiving the maintenance service join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: customer_name - description: '' + description: Customer who requested or is receiving the maintenance visit service. - name: address_display - description: '' + description: Physical location where the maintenance visit is performed or scheduled. - name: contact_display - description: '' + description: Person to reach regarding this maintenance visit for coordination + or communication. - name: contact_mobile - description: '' + description: Mobile phone number of the person to contact regarding this maintenance + visit for scheduling or urgent communication. - name: contact_email - description: '' + description: Email address of the person to contact regarding this maintenance + visit for confirmations and documentation. - name: maintenance_schedule - description: '' + description: Planned date and time or recurrence pattern for when the maintenance + visit is scheduled to occur. join_hint: table: tabMaintenance Schedule 'on': maintenance_schedule = tabMaintenance Schedule.name - name: maintenance_schedule_detail - description: '' + description: Links to the planned maintenance schedule entry that this visit fulfills + or executes. join_hint: table: tabMaintenance Schedule Detail 'on': maintenance_schedule_detail = tabMaintenance Schedule Detail.name - name: mntc_date - description: '' + description: The calendar date when the maintenance visit occurred or is scheduled + to occur. - name: mntc_time - description: '' + description: The time of day when the maintenance visit occurred or is scheduled + to occur. - name: completion_status - description: '' + description: Current state of the maintenance visit indicating whether it is scheduled, + in progress, completed, or cancelled. options: - Partially Completed - Fully Completed - name: maintenance_type - description: '' + description: Category of maintenance work performed such as preventive, corrective, + emergency, or routine inspection. options: - Scheduled - Unscheduled - Breakdown - name: purposes - description: '' + description: Specific reasons or objectives for the maintenance visit such as + repair, inspection, calibration, or compliance check. - name: customer_feedback - description: '' + description: Customer comments or satisfaction ratings provided after the maintenance + visit was completed. - name: status - description: '' + description: Current stage of the maintenance visit such as scheduled, in progress, + completed, or cancelled. options: - Draft - Cancelled - Submitted - name: amended_from - description: '' + description: Reference to the original maintenance visit record that this visit + was created from as a correction or modification. join_hint: table: tabMaintenance Visit 'on': amended_from = tabMaintenance Visit.name - name: company - description: '' + description: Company that owns or is responsible for the maintenance visit record. join_hint: table: tabCompany 'on': company = tabCompany.name - name: customer_address - description: '' + description: Physical location where the maintenance visit is scheduled or was + performed. join_hint: table: tabAddress 'on': customer_address = tabAddress.name - name: contact_person - description: '' + description: Individual at the customer site who can be reached regarding the + maintenance visit. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: territory - description: '' + description: Geographic sales region or area assigned to the maintenance visit + for routing and regional analysis. join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: customer_group - description: '' + description: Customer classification or segment for the maintenance visit used + to filter by customer type or category. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name + desc_done: true - table: tabMaintenance Visit Purpose description: '' fields: - name: name - description: '' + description: Unique identifier or label for the specific purpose of a maintenance + visit, such as 'Annual Inspection' or 'Emergency Repair' - name: item_code - description: '' + description: Code linking this maintenance visit purpose to a specific inventory + item or service item being maintained join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Name of the inventory item or service item associated with this maintenance + visit purpose - name: service_person - description: '' + description: Technician or employee assigned to perform the maintenance visit join_hint: table: tabSales Person 'on': service_person = tabSales Person.name - name: serial_no - description: '' + description: Unique identifier for the specific maintenance visit purpose record join_hint: table: tabSerial No 'on': serial_no = tabSerial No.name - name: description - description: '' + description: Reason or objective for the maintenance visit such as repair, inspection, + or preventive maintenance - name: work_done - description: '' + description: Description of maintenance tasks or repairs performed during the + visit. - name: prevdoc_doctype - description: '' + description: Type of the originating document that triggered or is linked to this + maintenance visit. join_hint: table: tabDocType 'on': prevdoc_doctype = tabDocType.name - name: prevdoc_docname - description: '' + description: Identifier of the specific originating document that triggered or + is linked to this maintenance visit. - name: maintenance_schedule_detail - description: '' + description: Specific details or notes about what maintenance activities are planned + or performed during this visit. + desc_done: true - table: tabManufacturer description: Manufacturers used in Items fields: - name: name - description: '' + description: Manufacturer's primary business name used in standard references + and searches. - name: short_name - description: '' + description: Abbreviated manufacturer name for compact displays and quick identification. - name: full_name - description: '' + description: Complete legal or official manufacturer name including corporate + designations and full entity details. - name: website - description: '' + description: Manufacturer's official website URL for contact or product information + lookup - name: country - description: '' + description: Country where the manufacturer is headquartered or primarily operates join_hint: table: tabCountry 'on': country = tabCountry.name - name: notes - description: '' + description: Additional free-text information about the manufacturer such as certifications, + partnerships, or special terms + desc_done: true - table: tabManufacturing Settings description: '' fields: - name: name - description: '' + description: Unique identifier for the manufacturing settings configuration - name: material_consumption - description: '' + description: Determines whether materials are consumed based on BOM quantity or + actual material transfer entries during production - name: get_rm_cost_from_consumption_entry - description: '' + description: Controls whether raw material costs are calculated from actual consumption + entries instead of BOM standard costs - name: backflush_raw_materials_based_on - description: '' + description: Determines the trigger or basis for automatically consuming raw materials + in production (e.g., BOM quantity vs actual finished goods). options: - BOM - Material Transferred for Manufacture - name: validate_components_quantities_per_bom - description: '' + description: Controls whether component quantities must match BOM specifications + during production transactions. - name: update_bom_costs_automatically - description: '' + description: Controls whether bill of materials costs recalculate automatically + when component prices change. - name: default_wip_warehouse - description: '' + description: Warehouse where work-in-progress inventory is stored during manufacturing + before completion. join_hint: table: tabWarehouse 'on': default_wip_warehouse = tabWarehouse.name - name: default_fg_warehouse - description: '' + description: Warehouse where finished goods are stored after manufacturing is + complete. join_hint: table: tabWarehouse 'on': default_fg_warehouse = tabWarehouse.name - name: default_scrap_warehouse - description: '' + description: Warehouse where defective materials or waste from manufacturing processes + are stored. join_hint: table: tabWarehouse 'on': default_scrap_warehouse = tabWarehouse.name - name: overproduction_percentage_for_sales_order - description: '' + description: Allowed excess production quantity beyond sales order demand to account + for waste or buffer inventory. - name: overproduction_percentage_for_work_order - description: '' + description: Allowed excess production quantity beyond work order target to account + for scrap or quality rejections. - name: add_corrective_operation_cost_in_finished_good_valuation - description: '' + description: Whether rework or corrective operation costs are included in the + final cost of manufactured finished goods. - name: enforce_time_logs - description: '' + description: Controls whether time tracking is mandatory for manufacturing operations + and job cards. - name: job_card_excess_transfer - description: '' + description: Determines whether excess material from job cards can be transferred + to other jobs or stock. - name: disable_capacity_planning - description: '' + description: Controls whether production capacity and resource availability calculations + are active for work orders and scheduling. - name: allow_overtime - description: '' + description: Whether manufacturing operations can schedule or record work hours + beyond standard shift times. - name: allow_production_on_holidays - description: '' + description: Whether manufacturing production activities are permitted on designated + holiday dates. - name: capacity_planning_for_days - description: '' + description: Number of days forward to calculate and plan manufacturing capacity + and resource availability. - name: mins_between_operations - description: '' + description: Time buffer in minutes allocated between consecutive manufacturing + operations for scheduling and transition purposes. - name: set_op_cost_and_scrap_from_sub_assemblies - description: '' + description: Whether operation costs and scrap quantities are automatically calculated + by rolling up values from sub-assembly work orders. - name: make_serial_no_batch_from_work_order - description: '' + description: Whether serial numbers or batch numbers are automatically generated + during work order completion rather than requiring manual entry. + desc_done: true - table: tabMarket Segment description: '' fields: - name: name - description: '' + description: Market segment name or label used when filtering or grouping customers, + sales, or products by their target market category - name: market_segment - description: '' + description: Unique identifier code for the market segment used when joining to + other tables or searching by segment ID rather than name + desc_done: true - table: tabMarketing Campaign description: '' fields: - name: name - description: '' + description: Marketing campaign name or title used to identify and reference specific + campaigns - name: campaign_description - description: '' + description: Detailed explanation of marketing campaign objectives, strategy, + target audience, and execution plan + desc_done: true - table: tabMaterial Request description: '' fields: - name: name - description: '' + description: Unique identifier for the material request used in queries asking + for a specific material request by its ID or document number - name: naming_series - description: '' + description: Prefix pattern that determines how material request IDs are auto-generated, + relevant when users ask about numbering schemes or request naming conventions options: - MAT-MR-.YYYY.- - name: title - description: '' + description: Descriptive label or summary of the material request purpose, used + when searching by subject or brief description rather than ID - name: material_request_type - description: '' + description: Type of material request such as Purchase, Material Transfer, Material + Issue, or Manufacture indicating the intended fulfillment method. options: - Purchase - Material Transfer @@ -13329,54 +16178,66 @@ tables: - Manufacture - Customer Provided - name: customer - description: '' + description: Customer for whom materials are being requested when the request + is customer-specific or linked to a sales order. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: company - description: '' + description: Company entity that owns and is requesting the materials for its + operations or projects. join_hint: table: tabCompany 'on': company = tabCompany.name - name: transaction_date - description: '' + description: Date when the material request was created or submitted for processing. - name: schedule_date - description: '' + description: Target date by which the requested materials are needed or expected + to be delivered. - name: buying_price_list - description: '' + description: Price list used to estimate or evaluate costs when purchasing the + requested materials from suppliers. join_hint: table: tabPrice List 'on': buying_price_list = tabPrice List.name - name: amended_from - description: '' + description: Links to the original material request that was amended or corrected + by this document. join_hint: table: tabMaterial Request 'on': amended_from = tabMaterial Request.name - name: scan_barcode - description: '' + description: Barcode value scanned to quickly add items to the material request. - name: last_scanned_warehouse - description: '' + description: Warehouse automatically populated when a barcode is scanned for item + selection. - name: set_from_warehouse - description: '' + description: Source warehouse from which materials will be transferred when fulfilling + this material request. join_hint: table: tabWarehouse 'on': set_from_warehouse = tabWarehouse.name - name: set_warehouse - description: '' + description: Default target warehouse where requested materials should be delivered + or stored. join_hint: table: tabWarehouse 'on': set_warehouse = tabWarehouse.name - name: items - description: '' + description: Line items listing individual materials, quantities, and specifications + being requested in this material request. - name: tc_name - description: '' + description: Terms and conditions template applied to this material request for + supplier agreements or procurement policies join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Specific terms and conditions text or clauses governing this material + request's fulfillment - name: status - description: '' + description: Current approval or fulfillment status of the material request such + as draft, pending, approved, or completed options: - Draft - Submitted @@ -13390,179 +16251,227 @@ tables: - Transferred - Received - name: per_ordered - description: '' + description: Percentage of requested material quantity that has been converted + to purchase orders or manufacturing orders. - name: transfer_status - description: '' + description: Status of inter-warehouse or inter-branch material transfer fulfillment + for this request. options: - Not Started - In Transit - Completed - name: per_received - description: '' + description: Percentage of requested material quantity that has been physically + received into inventory. - name: letter_head - description: '' + description: Letterhead template used when printing or emailing the material request + document. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: select_print_heading - description: '' + description: Custom heading that appears on the printed material request instead + of the default title. join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: job_card - description: '' + description: Links this material request to a specific job card for production + or work order tracking. join_hint: table: tabJob Card 'on': job_card = tabJob Card.name - name: work_order - description: '' + description: Links the material request to a specific manufacturing work order + that requires these materials for production. join_hint: table: tabWork Order 'on': work_order = tabWork Order.name + desc_done: true - table: tabMaterial Request Item description: '' fields: - name: name - description: '' + description: Unique identifier for the material request item line - name: item_code - description: '' + description: SKU or product code of the requested material join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Human-readable product name or description of the requested material - name: schedule_date - description: '' + description: Date when the requested material is needed or expected to be delivered + to fulfill the requirement. - name: description - description: '' + description: Detailed text explaining the specific material item being requested, + including specifications or additional context. - name: item_group - description: '' + description: Category or classification grouping that the requested material belongs + to for organizational or reporting purposes. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: brand - description: '' + description: Brand or manufacturer of the requested material item, used when filtering + or searching material requests by specific brands. join_hint: table: tabBrand 'on': brand = tabBrand.name - name: qty - description: '' + description: Quantity of material being requested in this line item, used to analyze + request volumes or check amounts needed. - name: stock_uom - description: '' + description: Unit of measurement for the requested quantity (e.g., pieces, kg, + liters), used to understand or filter by measurement units in material requests. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: from_warehouse - description: '' + description: Source warehouse from which material should be transferred to fulfill + this material request item. join_hint: table: tabWarehouse 'on': from_warehouse = tabWarehouse.name - name: warehouse - description: '' + description: Target warehouse where the requested material is needed or should + be delivered. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: uom - description: '' + description: Unit of measurement for the requested material quantity in this item. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Factor used to convert between the requested UOM and stock UOM for + quantity calculations. - name: stock_qty - description: '' + description: Quantity of the item expressed in the stock/inventory UOM after applying + conversion factor. - name: min_order_qty - description: '' + description: Minimum quantity that must be ordered or requested for this item. - name: projected_qty - description: '' + description: Forecasted future quantity of the item accounting for planned receipts + and issues, used when asking about expected availability or future stock levels. - name: actual_qty - description: '' + description: Current physical quantity of the item available in stock right now, + used when asking about present inventory levels or what's on hand. - name: ordered_qty - description: '' + description: Quantity of the item that has been ordered through purchase orders + but not yet received, used when asking about pending incoming stock or outstanding + orders. - name: received_qty - description: '' + description: Quantity of the material request item that has been physically received + into inventory against this request. - name: rate - description: '' + description: Actual transaction price per unit for this material request item + after applying discounts or adjustments. - name: price_list_rate - description: '' + description: Standard catalog or list price per unit before any discounts or negotiations + are applied. - name: amount - description: '' + description: Total monetary value of the material request item, used when analyzing + costs or budgets for requested materials. - name: expense_account - description: '' + description: General ledger account to which the cost of this material request + item will be charged, used when tracking departmental or project expenses. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: wip_composite_asset - description: '' + description: Work-in-progress composite asset that this material request item + is associated with, used when tracking materials for multi-component asset construction + or assembly projects. join_hint: table: tabAsset 'on': wip_composite_asset = tabAsset.name - name: manufacturer - description: '' + description: The company that manufactures the requested material item, used when + specifying or filtering by brand or supplier origin. join_hint: table: tabManufacturer 'on': manufacturer = tabManufacturer.name - name: manufacturer_part_no - description: '' + description: The manufacturer's specific part number for the requested item, used + to identify exact components by vendor catalog reference. - name: bom_no - description: '' + description: The bill of materials number associated with this material request + item, used to link requests to specific production or assembly structures. join_hint: table: tabBOM 'on': bom_no = tabBOM.name - name: project - description: '' + description: Project associated with the material request item for tracking project-specific + material needs and costs. join_hint: table: tabProject 'on': project = tabProject.name - name: cost_center - description: '' + description: Cost center to which the material request item expense will be allocated + for budgeting and financial tracking. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: lead_time_date - description: '' + description: Expected date when the requested material will be available or delivered + based on supplier lead time. - name: sales_order - description: '' + description: Links this material request item to the originating sales order when + materials are being procured or manufactured to fulfill a specific customer + order. join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: sales_order_item - description: '' + description: Links to the specific line item in the sales order that triggered + this material request, enabling traceability from customer order line to material + procurement. - name: production_plan - description: '' + description: Links this material request to a production plan when materials are + being requested as part of planned manufacturing operations rather than direct + sales orders. join_hint: table: tabProduction Plan 'on': production_plan = tabProduction Plan.name - name: material_request_plan_item - description: '' + description: Links this material request item to a specific material request plan + item when the request originates from production planning. - name: job_card_item - description: '' + description: Links this material request item to a specific job card item when + materials are requested for a manufacturing job. - name: page_break - description: '' + description: Controls whether a page break appears before this item when printing + the material request document. + desc_done: true - table: tabMaterial Request Plan Item description: '' fields: - name: name - description: '' + description: Unique identifier for the material request plan item record - name: item_code - description: '' + description: Product or material being requested in this plan item join_hint: table: tabItem 'on': item_code = tabItem.name - name: from_warehouse - description: '' + description: Source warehouse from which the material will be transferred or issued join_hint: table: tabWarehouse 'on': from_warehouse = tabWarehouse.name - name: warehouse - description: '' + description: Target warehouse where the requested material will be stored or delivered + to. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: item_name - description: '' + description: Full descriptive name of the product or material being requested, + used when searching by item description rather than code. - name: material_request_type - description: '' + description: Type of material request such as Purchase, Material Transfer, or + Material Issue, indicating how the material will be procured or moved. options: - Purchase - Material Transfer @@ -13570,367 +16479,487 @@ tables: - Manufacture - Customer Provided - name: quantity - description: '' + description: Material quantity planned to be requested for production or procurement + in this plan item. - name: required_bom_qty - description: '' + description: Quantity of this material required according to the bill of materials + calculation for the planned production. - name: schedule_date - description: '' + description: Target date when the material is needed or should be available for + production or fulfillment. - name: uom - description: '' + description: Unit of measurement for the material request plan item quantity. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Factor to convert between the material request plan item UOM and + the base stock UOM. - name: description - description: '' + description: Detailed text describing the material request plan item specifications + or requirements. - name: min_order_qty - description: '' + description: Minimum quantity that must be ordered for this material item in the + request plan. - name: sales_order - description: '' + description: Sales order linked to this material request plan item, used when + planning materials for specific customer orders. join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: actual_qty - description: '' + description: Current available quantity of the material in inventory at the time + of planning. - name: requested_qty - description: '' + description: Quantity of material requested in the plan, used when asking about + total material requirements or demand. - name: reserved_qty_for_production - description: '' + description: Quantity already reserved or allocated for production orders, used + when checking material availability or committed stock. - name: ordered_qty - description: '' + description: Quantity already ordered from suppliers or in purchase orders, used + when verifying procurement status or pending receipts. - name: projected_qty - description: '' + description: Forecasted inventory quantity available after accounting for planned + receipts and demands for this material. - name: safety_stock - description: '' + description: Minimum buffer inventory level maintained to prevent stockouts and + ensure continuous availability. + desc_done: true - table: tabMilestone description: '' fields: - name: name - description: '' + description: Milestone name or title identifying the specific deliverable or checkpoint + in a project timeline - name: reference_type - description: '' + description: Type of entity the milestone is linked to, such as Project, Task, + or Sales Order join_hint: table: tabDocType 'on': reference_type = tabDocType.name - name: reference_name - description: '' + description: Name or identifier of the specific entity instance this milestone + belongs to - name: track_field - description: '' + description: The specific metric or data point being tracked by this milestone, + such as revenue, quantity, or completion percentage. - name: value - description: '' + description: The target or actual numeric value associated with the milestone + being tracked. - name: milestone_tracker - description: '' + description: The parent tracker or category that groups related milestones together + for monitoring progress. join_hint: table: tabMilestone Tracker 'on': milestone_tracker = tabMilestone Tracker.name + desc_done: true - table: tabMilestone Tracker description: Track milestones for any document fields: - name: name - description: '' + description: Milestone name or title identifying the specific achievement or checkpoint + being tracked - name: document_type - description: '' + description: Type of document or entity this milestone is associated with such + as project, task, or transaction join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: track_field - description: '' + description: Specific field or attribute being monitored to determine milestone + completion or progress - name: disabled - description: '' + description: Indicates whether the milestone is inactive or excluded from active + tracking and reporting. + desc_done: true - table: tabMode of Payment description: '' fields: - name: name - description: '' + description: description - name: mode_of_payment - description: '' + description: Identifies the payment method (cash, credit card, bank transfer, + etc.) used for filtering transactions and analyzing payment preferences. - name: enabled - description: '' + description: Indicates whether this payment mode is currently active and available + for selection in transactions. - name: type - description: '' + description: Cash, bank, credit card, or other payment method category options: - Cash - Bank - General - Phone - name: accounts - description: '' + description: Linked general ledger accounts for posting payment transactions + desc_done: true - table: tabMode of Payment Account description: '' fields: - name: name - description: '' + description: Identifier or label for the specific mode of payment account configuration - name: company - description: '' + description: Company entity to which this mode of payment account configuration + belongs join_hint: table: tabCompany 'on': company = tabCompany.name - name: default_account - description: '' + description: General ledger account used by default when processing transactions + with this payment mode join_hint: table: tabAccount 'on': default_account = tabAccount.name + desc_done: true - table: tabModule Onboarding description: '' fields: - name: name - description: '' + description: Unique identifier or code for the onboarding module, used when searching + for specific onboarding programs or workflows by their system name. - name: title - description: '' + description: Display name of the onboarding module, used when users search for + onboarding content by its business-friendly label or heading. - name: subtitle - description: '' + description: Secondary descriptive text for the onboarding module, used when searching + for additional context or detailed information about the onboarding program's + purpose or scope. - name: module - description: '' + description: The specific module or feature being onboarded, used when asking + which modules have onboarding flows or what is being introduced to users. join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: allow_roles - description: '' + description: Roles permitted to access or view this onboarding flow, used when + asking which user types can see specific onboarding content. - name: success_message - description: '' + description: Message displayed when onboarding completes successfully, used when + asking what confirmation users receive after finishing module onboarding. - name: documentation_url - description: '' + description: Link to external onboarding documentation or help resources for the + module. - name: is_complete - description: '' + description: Whether the module onboarding process has been finished by the user. - name: steps - description: '' + description: Onboarding tasks or stages required to complete module setup. + desc_done: true - table: tabModule Profile description: '' fields: - name: name - description: '' + description: Unique identifier for the module profile record used when referencing + specific profile configurations. - name: module_profile_name - description: '' + description: Display name of the module profile used when searching or filtering + profiles by business function or user role. - name: block_modules - description: '' + description: List of modules that are blocked or disabled in this profile, used + when determining access restrictions or feature availability. + desc_done: true - table: tabMonthly Distribution description: Helps you distribute the Budget/Target across months if you have seasonality in your business. fields: - name: name - description: '' + description: Used to identify or filter monthly distribution records by their + descriptive label or title. - name: distribution_id - description: '' + description: Used to uniquely identify and join specific monthly distribution + transactions across related tables. - name: fiscal_year - description: '' + description: Used to filter or group monthly distributions by the accounting year + for period-over-period analysis and fiscal reporting. join_hint: table: tabFiscal Year 'on': fiscal_year = tabFiscal Year.name - name: percentages - description: '' + description: Percentage allocation values used when distributing amounts across + multiple months or periods in a schedule. + desc_done: true - table: tabMonthly Distribution Percentage description: '' fields: - name: name - description: '' + description: name - name: month - description: '' + description: specific month for which the distribution percentage applies - name: percentage_allocation - description: '' + description: percentage value allocated or distributed for the corresponding month + desc_done: true - table: tabNavbar Item description: '' fields: - name: name - description: '' + description: Unique identifier for the navbar item used to reference specific + navigation elements in queries and configurations. - name: item_label - description: '' + description: Display text shown to users in the navigation bar, used when searching + for menu items by their visible name. - name: item_type - description: '' + description: Classification of the navbar element (e.g., link, dropdown, button) + used to filter navigation items by their functional behavior. options: - Route - Action - Separator - name: route - description: '' + description: URL path or routing destination that the navbar item navigates to + when clicked - name: action - description: '' + description: Specific operation or function triggered when the navbar item is + selected, such as opening a form or executing a command - name: hidden - description: '' + description: Indicates whether the navbar item is visible to users or concealed + from the navigation menu - name: is_standard - description: '' + description: Indicates whether this navbar item is a default system item versus + a custom user-created item. - name: condition - description: '' + description: Expression or rule that determines when this navbar item is visible + or accessible to users. + desc_done: true - table: tabNavbar Settings description: '' fields: - name: name - description: '' + description: name - name: settings_dropdown - description: '' + description: Controls whether the settings menu appears in the navigation bar + for user access to configuration options - name: help_dropdown - description: '' + description: Controls whether the help menu appears in the navigation bar for + user access to documentation and support resources - name: announcement_widget - description: '' + description: Whether the announcement widget is enabled or displayed in the navigation + bar. + desc_done: true - table: tabNetwork Printer Settings description: '' fields: - name: name - description: '' + description: Network printer identifier or label used to reference a specific + printer in the system - name: server_ip - description: '' + description: IP address of the print server or network printer for connection + and routing - name: port - description: '' + description: Network port number used to communicate with the printer or print + server - name: printer_name - description: '' + description: Name or identifier of the network printer used for routing print + jobs and printer configuration queries. + desc_done: true - table: tabNewsletter description: Create and send emails to a specific group of subscribers periodically. fields: - name: name - description: '' + description: Newsletter name or title used to identify specific email campaigns + or editions - name: email_sent_at - description: '' + description: Timestamp when the newsletter was sent to recipients, used to find + newsletters by send date or time - name: total_recipients - description: '' + description: Count of recipients who received the newsletter, used to measure + distribution size or audience reach - name: total_views - description: '' + description: Number of times the newsletter was opened or viewed by recipients - name: email_sent - description: '' + description: Number of newsletter emails successfully delivered to recipients - name: sender_name - description: '' + description: Name displayed as the sender or from address on the newsletter - name: sender_email - description: '' + description: Email address that appears as the sender in the From header of newsletter + messages. - name: send_from - description: '' + description: Display name or label shown alongside the sender email address in + newsletter communications. - name: email_group - description: '' + description: Target recipient group or mailing list segment that receives this + newsletter. - name: subject - description: '' + description: Newsletter subject line or title used when searching for newsletters + by topic or theme - name: content_type - description: '' + description: Format or media type of the newsletter such as HTML, plain text, + or rich media options: - Rich Text - Markdown - HTML - name: message - description: '' + description: Main body content of the newsletter used when searching for specific + information or announcements within newsletters - name: message_md - description: '' + description: Markdown-formatted content of the newsletter message body for searching + or analyzing newsletter text - name: campaign - description: '' + description: Marketing campaign or initiative that the newsletter is associated + with for filtering newsletters by promotional effort join_hint: table: tabMarketing Campaign 'on': campaign = tabMarketing Campaign.name - name: attachments - description: '' + description: Files or documents attached to the newsletter such as PDFs, images, + or other downloadable content - name: send_unsubscribe_link - description: '' + description: Whether the newsletter includes an unsubscribe link for recipients + to opt out of future emails. - name: send_webview_link - description: '' + description: Whether the newsletter includes a link to view the email content + in a web browser. - name: scheduled_to_send - description: '' + description: The date and time when the newsletter is scheduled to be sent to + recipients. - name: schedule_sending - description: '' + description: Indicates whether the newsletter is currently in the process of being + sent on its scheduled date and time. - name: schedule_send - description: '' + description: The specific date and time when the newsletter is scheduled to be + sent to recipients. - name: published - description: '' + description: Indicates whether the newsletter content has been finalized and made + ready for distribution. - name: route - description: '' + description: Delivery or distribution route assigned to the newsletter for physical + or regional distribution purposes + desc_done: true - table: tabNewsletter Attachment description: '' fields: - name: name - description: '' + description: File name or title of the document attached to the newsletter + desc_done: true - table: tabNewsletter Email Group description: '' fields: - name: name - description: '' + description: name - name: email_group - description: '' + description: The newsletter group or list that subscribers are organized into + for targeted email campaigns. join_hint: table: tabEmail Group 'on': email_group = tabEmail Group.name - name: total_subscribers - description: '' + description: The count of subscribers currently enrolled in this newsletter email + group. + desc_done: true - table: tabNon Conformance description: '' fields: - name: name - description: '' + description: Unique identifier or reference number used to track and locate specific + non-conformance records in queries and reports. - name: subject - description: '' + description: Brief title or category describing what the non-conformance is about, + used when searching for issues by topic or type. - name: procedure - description: '' + description: The documented process or standard operating procedure that was violated + or not followed, referenced when analyzing compliance gaps or process breakdowns. join_hint: table: tabQuality Procedure 'on': procedure = tabQuality Procedure.name - name: process_owner - description: '' + description: Person or department responsible for managing and resolving the non-conformance + issue - name: full_name - description: '' + description: Complete identifying name or title of the non-conformance record - name: status - description: '' + description: Current state of the non-conformance in its lifecycle such as open, + under investigation, closed, or resolved options: - Open - Resolved - Cancelled - name: details - description: '' + description: Description of what went wrong or failed to meet specifications in + the non-conformance incident. - name: corrective_action - description: '' + description: Actions taken to fix or remedy the specific non-conformance issue + that occurred. - name: preventive_action - description: '' + description: Actions implemented to prevent the non-conformance from happening + again in the future. + desc_done: true - table: tabNote description: '' fields: - name: name - description: '' + description: Unique identifier or reference code for the note record, used when + searching for or linking to specific notes. - name: title - description: '' + description: Subject or heading of the note, used when searching note content + or filtering by topic. - name: public - description: '' + description: Visibility flag indicating whether the note is shared with all users + or restricted, used when filtering notes by access level. - name: notify_on_login - description: '' + description: Whether to show this note to the user when they log in to the system. - name: notify_on_every_login - description: '' + description: Whether to display this note on every single login session, not just + once. - name: expire_notification_on - description: '' + description: Date when the login notification for this note should stop appearing. - name: content - description: '' + description: The text body or message of the note, searched when users ask about + note details, comments, or what was written in notes. - name: seen_by - description: '' + description: Users who have viewed or been notified about the note, queried when + asking who has seen, read, or been informed about specific notes. + desc_done: true - table: tabNote Seen By description: '' fields: - name: name - description: '' + description: Unique identifier for the note that was seen, used when tracking + which specific notes have been viewed by users - name: user - description: '' + description: Identifier of the user who viewed the note, used when analyzing note + readership or filtering notes by who has already seen them join_hint: table: tabUser 'on': user = tabUser.name + desc_done: true - table: tabNotification description: '' fields: - name: name - description: '' + description: notification name or identifier used to reference specific notification + types or templates - name: enabled - description: '' + description: whether the notification is currently active and will be sent when + triggered - name: is_standard - description: '' + description: whether the notification is a built-in system notification versus + a custom user-created one - name: module - description: '' + description: The ERP module or functional area that this notification relates + to, such as Sales, Inventory, or Purchasing. join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: channel - description: '' + description: The delivery method or platform for sending the notification, such + as email, SMS, Slack, or in-app. options: - Email - Slack - System Notification - SMS - name: slack_webhook_url - description: '' + description: The specific Slack webhook endpoint URL where notifications are posted + when Slack is the selected channel. join_hint: table: tabSlack Webhook URL 'on': slack_webhook_url = tabSlack Webhook URL.name - name: subject - description: '' + description: The notification message or title shown to the user describing what + the notification is about. - name: event - description: '' + description: The triggering action or business event that caused this notification + to be created, such as order approval, payment received, or task assignment. options: - New - Save @@ -13942,66 +16971,79 @@ tables: - Method - Custom - name: document_type - description: '' + description: The type of business document or record that this notification relates + to, such as Sales Order, Purchase Invoice, or Delivery Note. join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: method - description: '' + description: Notification delivery method such as email, SMS, or in-app alert - name: date_changed - description: '' + description: When the notification settings or status were last modified - name: days_in_advance - description: '' + description: How many days before an event or deadline the notification should + be sent - name: value_changed - description: '' + description: The specific field or value that triggered the notification to be + sent. - name: sender - description: '' + description: The user or system entity that initiated or sent the notification. join_hint: table: tabEmail Account 'on': sender = tabEmail Account.name - name: send_system_notification - description: '' + description: Flag indicating whether a system-level notification should be dispatched + for this event. - name: sender_email - description: '' + description: Email address from which the notification is sent to recipients. - name: condition - description: '' + description: Criteria or trigger logic that determines when this notification + should be sent. - name: set_property_after_alert - description: '' + description: Property or field value that gets updated automatically after the + notification is triggered. - name: property_value - description: '' + description: Value or content associated with a notification property or parameter + that determines notification behavior or content. - name: send_to_all_assignees - description: '' + description: Indicates whether the notification should be sent to all users assigned + to the related task, document, or record rather than just the primary assignee. - name: recipients - description: '' + description: List of specific users, email addresses, or contacts who will receive + the notification. - name: message_type - description: '' + description: Type or category of notification such as alert, reminder, warning, + or informational message options: - Markdown - HTML - Plain Text - name: message - description: '' + description: Actual notification text content sent to users - name: attach_print - description: '' + description: Whether a printed document or report is attached to the notification - name: print_format - description: '' + description: Template or layout format used when printing or generating PDF output + of the notification join_hint: table: tabPrint Format 'on': print_format = tabPrint Format.name + desc_done: true - table: tabNotification Log description: '' fields: - name: name - description: '' + description: Unique identifier or title of the notification log entry - name: subject - description: '' + description: Message content or topic of the notification sent to the user - name: for_user - description: '' + description: Recipient user who received or is intended to receive this notification join_hint: table: tabUser 'on': for_user = tabUser.name - name: type - description: '' + description: Identifies the notification method or channel used when analyzing + communication patterns or filtering by delivery mechanism. options: - Mention - Energy Point @@ -14009,114 +17051,143 @@ tables: - Share - Alert - name: email_content - description: '' + description: Contains the actual message text when searching for specific notification + content or analyzing communication details sent to users. - name: document_type - description: '' + description: Specifies the business document that triggered the notification when + tracing alerts related to specific transaction types like invoices or orders. join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: read - description: '' + description: Whether the notification has been opened or viewed by the recipient. - name: document_name - description: '' + description: The name or title of the document or record that triggered the notification. - name: attached_file - description: '' + description: File attached to the notification for download or reference. - name: from_user - description: '' + description: User who triggered or sent the notification join_hint: table: tabUser 'on': from_user = tabUser.name - name: link - description: '' + description: URL or document reference that the notification points to + desc_done: true - table: tabNotification Recipient description: '' fields: - name: name - description: '' + description: Unique identifier or label for this notification recipient configuration - name: receiver_by_document_field - description: '' + description: Specifies that the recipient is determined dynamically from a field + value in the document being notified about - name: receiver_by_role - description: '' + description: Specifies that recipients are determined by their assigned role rather + than individual user selection join_hint: table: tabRole 'on': receiver_by_role = tabRole.name - name: cc - description: '' + description: Email addresses that receive a carbon copy of the notification - name: bcc - description: '' + description: Email addresses that receive a blind carbon copy of the notification + without other recipients knowing - name: condition - description: '' + description: Rule or criteria that determines when this recipient should receive + the notification + desc_done: true - table: tabNotification Settings description: '' fields: - name: name - description: '' + description: Notification name or identifier for the notification setting configuration - name: enabled - description: '' + description: Whether the notification is active and will be sent to recipients - name: subscribed_documents - description: '' + description: Document types or specific documents that trigger this notification + when changed - name: enable_email_notifications - description: '' + description: Controls whether user receives any email notifications for system + events and updates. - name: enable_email_mention - description: '' + description: Controls whether user receives email when mentioned or tagged in + comments, posts, or documents. - name: enable_email_assignment - description: '' + description: Controls whether user receives email when tasks, tickets, or work + items are assigned to them. - name: enable_email_threads_on_assigned_document - description: '' + description: Controls whether email notifications are sent for threaded conversations + when a document is assigned to a user. - name: enable_email_energy_point - description: '' + description: Controls whether email notifications are sent when users earn or + receive energy points for gamification activities. - name: enable_email_share - description: '' + description: Controls whether email notifications are sent when documents or items + are shared with users. - name: enable_email_event_reminders - description: '' + description: Whether the user receives email notifications for upcoming calendar + events or scheduled reminders. - name: user - description: '' + description: The specific user account whose notification preferences are configured + in this record. join_hint: table: tabUser 'on': user = tabUser.name - name: seen - description: '' + description: Whether the user has viewed or acknowledged a particular notification + message. - name: energy_points_system_notifications - description: '' + description: Whether the user receives notifications related to energy points + earned, awarded, or redeemed in the gamification system. + desc_done: true - table: tabNotification Subscribed Document description: '' fields: - name: name - description: '' + description: Unique identifier or label for the notification subscription record - name: document - description: '' + description: The document type or document name that triggers notifications when + subscribed join_hint: table: tabDocType 'on': document = tabDocType.name + desc_done: true - table: tabNumber Card description: '' fields: - name: name - description: '' + description: The title or label of the number card widget displayed to users - name: is_standard - description: '' + description: Whether the number card is a built-in system card versus a custom + user-created card - name: module - description: '' + description: The application module or functional area where this number card + appears or belongs join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: label - description: '' + description: Display name or title of the number card shown to users in dashboards + and reports. - name: type - description: '' + description: Category or classification of the number card indicating its purpose + or metric type. options: - Document Type - Report - Custom - name: report_name - description: '' + description: Name of the underlying report or data source that powers the number + card's value. join_hint: table: tabReport 'on': report_name = tabReport.name - name: method - description: '' + description: Numbering approach for generating card numbers such as sequential, + random, or custom pattern-based methods - name: function - description: '' + description: Business rule or calculation logic applied when creating or assigning + card numbers options: - Count - Sum @@ -14124,219 +17195,279 @@ tables: - Minimum - Maximum - name: aggregate_function_based_on - description: '' + description: Field or data element used as the basis for aggregate calculations + when generating card number sequences - name: document_type - description: '' + description: The type of document this number card configuration applies to, such + as Sales Invoice, Purchase Order, or Payment Entry. join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: parent_document_type - description: '' + description: The parent or source document type from which this document is derived + or linked, used when numbering depends on a related document. join_hint: table: tabDocType 'on': parent_document_type = tabDocType.name - name: report_field - description: '' + description: The field name from the document that should be displayed or used + in reports when referencing this number card. - name: report_function - description: '' + description: Function or purpose category of the number card for filtering or + grouping cards by their analytical role options: - Sum - Average - Minimum - Maximum - name: is_public - description: '' + description: Whether the number card is visible to all users or restricted to + specific users - name: currency - description: '' + description: Currency code for monetary values displayed in the number card join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: filters_config - description: '' + description: Configuration defining which filters are applied to the number card + to narrow down the data displayed. - name: show_percentage_stats - description: '' + description: Whether the number card displays statistics as percentages rather + than absolute values. - name: stats_time_interval - description: '' + description: Time period or interval used for calculating and displaying statistics + in the number card. options: - Daily - Weekly - Monthly - Yearly - name: filters_json - description: '' + description: Static filter criteria applied to the number card to define which + data records are included in the calculation - name: dynamic_filters_json - description: '' + description: User-adjustable or parameter-driven filters that can be changed at + runtime without modifying the card definition - name: color - description: '' + description: Display color or theme assigned to the number card for visual identification + in dashboards - name: background_color - description: '' + description: Color used for the card's background display, relevant when users + filter or customize card appearance by color scheme. + desc_done: true - table: tabNumber Card Link description: '' fields: - name: name - description: '' + description: Name or label identifying the number card link - name: card - description: '' + description: Reference to the specific number card being linked join_hint: table: tabNumber Card 'on': card = tabNumber Card.name + desc_done: true - table: tabOAuth Authorization Code description: '' fields: - name: name - description: '' + description: OAuth authorization code value issued to the client for token exchange - name: client - description: '' + description: Application or service requesting OAuth authorization join_hint: table: tabOAuth Client 'on': client = tabOAuth Client.name - name: user - description: '' + description: End user who granted authorization to the client application join_hint: table: tabUser 'on': user = tabUser.name - name: scopes - description: '' + description: Permissions or access levels granted by the authorization code for + API or resource access - name: authorization_code - description: '' + description: Temporary code issued during OAuth flow to exchange for access tokens - name: expiration_time - description: '' + description: When the authorization code becomes invalid and can no longer be + exchanged - name: redirect_uri_bound_to_authorization_code - description: '' + description: The callback URL where the user is redirected after OAuth authorization, + used to verify redirect URI consistency during token exchange. - name: validity - description: '' + description: The expiration timeframe or active status of the authorization code, + used to check if the code is still usable for token exchange. options: - Valid - Invalid - name: nonce - description: '' + description: The unique random value used to prevent replay attacks in OAuth flows, + typically validated during OpenID Connect authentication. - name: code_challenge - description: '' + description: PKCE code challenge value used when validating authorization requests + with proof key for code exchange - name: code_challenge_method - description: '' + description: Hashing algorithm (plain or S256) applied to the code verifier for + PKCE validation options: - s256 - plain + desc_done: true - table: tabOAuth Bearer Token description: '' fields: - name: name - description: '' + description: Unique identifier or label for the OAuth bearer token - name: client - description: '' + description: OAuth client application that the bearer token was issued to join_hint: table: tabOAuth Client 'on': client = tabOAuth Client.name - name: user - description: '' + description: User account associated with or authenticated by this bearer token join_hint: table: tabUser 'on': user = tabUser.name - name: scopes - description: '' + description: Permissions or access levels granted to the OAuth token, relevant + when filtering by authorization scope or checking what resources the token can + access. - name: access_token - description: '' + description: The token used to authenticate API requests, relevant when validating + active sessions or troubleshooting authentication issues. - name: refresh_token - description: '' + description: The token used to obtain a new access token when it expires, relevant + when investigating token renewal or long-term session management. - name: expiration_time - description: '' + description: Absolute timestamp when the OAuth bearer token becomes invalid and + can no longer authenticate requests - name: expires_in - description: '' + description: Remaining seconds until token expiration, calculated from current + time or issuance time - name: status - description: '' + description: Current validity state of the OAuth token such as active, expired, + revoked, or suspended options: - Active - Revoked + desc_done: true - table: tabOAuth Client description: '' fields: - name: name - description: '' + description: Internal identifier or label for the OAuth client configuration used + when managing or referencing client registrations. - name: client_id - description: '' + description: Unique public identifier for the OAuth application used when querying + which app is making authentication requests or API calls. - name: app_name - description: '' + description: Display name of the application using OAuth used when identifying + which business application or service is accessing resources. - name: user - description: '' + description: The user account that owns or is associated with this OAuth client + application. join_hint: table: tabUser 'on': user = tabUser.name - name: allowed_roles - description: '' + description: The roles permitted to authenticate or access resources through this + OAuth client. - name: client_secret - description: '' + description: The confidential secret key used to authenticate the OAuth client + application during token requests. - name: skip_authorization - description: '' + description: Whether the OAuth client bypasses user consent prompts during authorization + flows - name: scopes - description: '' + description: Permissions and access levels granted to the OAuth client for API + resources - name: redirect_uris - description: '' + description: Allowed callback URLs where users are redirected after OAuth authentication - name: default_redirect_uri - description: '' + description: URL where users are redirected after OAuth authorization, used when + querying which applications redirect to specific domains or endpoints. - name: grant_type - description: '' + description: OAuth authorization flow type (authorization_code, client_credentials, + implicit, etc.) used when filtering clients by how they obtain access tokens. options: - Authorization Code - Implicit - name: response_type - description: '' + description: OAuth response format requested during authorization (code, token, + id_token) used when identifying clients by what they receive from the authorization + endpoint. options: - Code - Token + desc_done: true - table: tabOAuth Client Role description: '' fields: - name: name - description: '' + description: Name or identifier of the OAuth client application that has been + granted specific permissions - name: role - description: '' + description: The permission level or access role assigned to the OAuth client + for authorization purposes join_hint: table: tabRole 'on': role = tabRole.name + desc_done: true - table: tabOAuth Provider Settings description: '' fields: - name: name - description: '' + description: Name or identifier of the OAuth provider (e.g., Google, Microsoft, + GitHub) used for authentication. - name: skip_authorization - description: '' + description: Whether the OAuth flow bypasses the user consent screen for already-authorized + applications. options: - Force - Auto + desc_done: true - table: tabOAuth Scope description: '' fields: - name: name - description: '' + description: Human-readable label or title for the OAuth scope - name: scope - description: '' + description: Technical OAuth scope string used in authorization requests and API + access control + desc_done: true - table: tabOnboarding Permission description: '' fields: - name: name - description: '' + description: Name or identifier of the onboarding permission being granted to + users during the onboarding process - name: role - description: '' + description: Role to which this onboarding permission is assigned or applies join_hint: table: tabRole 'on': role = tabRole.name + desc_done: true - table: tabOnboarding Step description: '' fields: - name: name - description: '' + description: Unique identifier or code for the onboarding step used to reference + it programmatically or in workflows. - name: title - description: '' + description: Display label or heading shown to users describing what the onboarding + step involves. - name: is_complete - description: '' + description: Whether this onboarding step has been finished or marked as done + by the user or system. - name: is_skipped - description: '' + description: Whether the onboarding step was bypassed or skipped by the user - name: description - description: '' + description: Text explaining what the onboarding step covers or instructs the + user to do - name: intro_video_url - description: '' + description: Link to the video that introduces or demonstrates this onboarding + step - name: action - description: '' + description: The specific onboarding task or activity to be completed, such as + filling a form, watching a video, or completing training. options: - Create Entry - Update Settings @@ -14345,168 +17476,214 @@ tables: - Go to Page - Watch Video - name: action_label - description: '' + description: The display name or user-facing text shown for the onboarding action, + used when referencing how tasks appear to employees. - name: reference_document - description: '' + description: The linked document, guide, or resource that provides instructions + or information needed to complete the onboarding step. join_hint: table: tabDocType 'on': reference_document = tabDocType.name - name: show_full_form - description: '' + description: Controls whether the complete onboarding form is displayed to the + user during this step. - name: show_form_tour - description: '' + description: Controls whether an interactive guided tour of the form is presented + during this onboarding step. - name: form_tour - description: '' + description: The specific tour content or tour identifier that will be shown when + the form tour is enabled. join_hint: table: tabForm Tour 'on': form_tour = tabForm Tour.name - name: is_single - description: '' + description: Indicates whether this onboarding step applies to a single-instance + configuration or a list-based workflow. - name: reference_report - description: '' + description: The specific report that this onboarding step links to or demonstrates. join_hint: table: tabReport 'on': reference_report = tabReport.name - name: report_reference_doctype - description: '' + description: The document type associated with the reference report for this onboarding + step. - name: report_type - description: '' + description: Type or category of onboarding report being generated for this step. - name: report_description - description: '' + description: Detailed explanation of what the onboarding report contains or measures. - name: path - description: '' + description: File system location or URL where the onboarding step report or resource + is stored. - name: callback_title - description: '' + description: Title displayed when user completes or interacts with this onboarding + step - name: callback_message - description: '' + description: Message shown to user after completing this onboarding step - name: validate_action - description: '' + description: Action or validation rule that must be satisfied before user can + proceed past this onboarding step - name: field - description: '' + description: The specific data field or attribute being validated or configured + during this onboarding step. - name: value_to_validate - description: '' + description: The expected or required value that must be entered or verified for + the field during onboarding. - name: video_url - description: '' + description: Link to instructional video content that guides users through completing + this onboarding step. + desc_done: true - table: tabOnboarding Step Map description: '' fields: - name: name - description: '' + description: Identifier or label for the onboarding step map configuration - name: step - description: '' + description: Reference to the specific onboarding step included in this map sequence join_hint: table: tabOnboarding Step 'on': step = tabOnboarding Step.name + desc_done: true - table: tabOpening Invoice Creation Tool description: '' fields: - name: name - description: '' + description: Unique identifier or reference name for this opening invoice creation + tool record - name: company - description: '' + description: Company entity for which opening invoices are being created or imported join_hint: table: tabCompany 'on': company = tabCompany.name - name: create_missing_party - description: '' + description: Whether to automatically create customer or supplier records if they + don't exist during opening invoice import - name: invoice_type - description: '' + description: Specifies whether the opening invoice is a sales invoice, purchase + invoice, credit note, or debit note. options: - Sales - Purchase - name: cost_center - description: '' + description: The cost center to which the opening invoice balance is allocated + for accounting and budgeting purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: The project associated with the opening invoice for tracking project-specific + receivables or payables. join_hint: table: tabProject 'on': project = tabProject.name - name: invoices - description: '' + description: Invoice documents or records being created or processed through the + opening invoice creation workflow + desc_done: true - table: tabOpening Invoice Creation Tool Item description: '' fields: - name: name - description: '' + description: Unique identifier for the opening invoice creation tool item record. - name: invoice_number - description: '' + description: The invoice number being created or imported as an opening balance + entry. - name: party_type - description: '' + description: The type of party associated with the invoice, such as Customer or + Supplier, determining whether it's a receivable or payable. join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: party - description: '' + description: The customer or supplier for whom opening invoice balances are being + created during initial system setup or migration. - name: temporary_opening_account - description: '' + description: The intermediate ledger account used to offset opening invoice entries + before final reconciliation or adjustment. join_hint: table: tabAccount 'on': temporary_opening_account = tabAccount.name - name: posting_date - description: '' + description: The accounting date when the opening invoice balance is recorded + in the system, typically the go-live or migration date. - name: due_date - description: '' + description: Date when payment for this invoice item is expected or becomes overdue. - name: item_name - description: '' + description: Name or description of the specific product or service line item + on the opening invoice. - name: outstanding_amount - description: '' + description: Unpaid balance remaining for this invoice item that still needs to + be collected. - name: qty - description: '' + description: Quantity of items being invoiced in the opening invoice creation + tool. - name: cost_center - description: '' + description: Cost center assigned to allocate expenses or revenue for the invoice + item. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name + desc_done: true - table: tabOperation description: '' fields: - name: name - description: '' + description: Operation name or identifier used when referencing specific manufacturing + steps or processes in production routing - name: workstation - description: '' + description: Physical location or machine where the operation is performed, used + when querying where work happens join_hint: table: tabWorkstation 'on': workstation = tabWorkstation.name - name: is_corrective_operation - description: '' + description: Indicates whether this operation fixes defects or rework issues rather + than standard production work - name: create_job_card_based_on_batch_size - description: '' + description: Whether production job cards are automatically split or created according + to the defined batch size for this operation. - name: quality_inspection_template - description: '' + description: The quality inspection checklist or template applied when this operation + is completed or inspected. join_hint: table: tabQuality Inspection Template 'on': quality_inspection_template = tabQuality Inspection Template.name - name: batch_size - description: '' + description: The quantity of items processed together in a single batch for this + operation, used to determine production grouping and job card splitting. - name: sub_operations - description: '' + description: Individual steps or tasks that make up this operation, used when + asking about operation breakdown or detailed workflow stages. - name: total_operation_time - description: '' + description: Complete duration to finish this operation including all sub-operations, + used when asking about cycle time, throughput, or scheduling. - name: description - description: '' + description: Textual explanation of what this operation does or produces, used + when searching operations by activity, purpose, or work content. + desc_done: true - table: tabOpportunity description: Potential Sales Deal fields: - name: name - description: '' + description: The title or descriptive name of the sales opportunity - name: naming_series - description: '' + description: The prefix pattern used to generate the opportunity ID number options: - CRM-OPP-.YYYY.- - name: opportunity_from - description: '' + description: The source type of the opportunity indicating whether it originated + from a Lead or an existing Customer join_hint: table: tabDocType 'on': opportunity_from = tabDocType.name - name: party_name - description: '' + description: The legal entity or organization name associated with the opportunity, + used when searching by official business name or parent company. - name: customer_name - description: '' + description: The customer-facing or doing-business-as name for the opportunity, + used when searching by brand name or common customer identifier. - name: status - description: '' + description: Current stage of the opportunity in the sales pipeline such as prospecting, + qualified, proposal, negotiation, won, or lost. options: - Open - Quotation @@ -14515,31 +17692,39 @@ tables: - Replied - Closed - name: opportunity_type - description: '' + description: Category or classification of the sales opportunity such as new business, + upsell, renewal, or cross-sell. join_hint: table: tabOpportunity Type 'on': opportunity_type = tabOpportunity Type.name - name: source - description: '' + description: Origin or channel where the opportunity was generated such as referral, + website, trade show, or cold call. join_hint: table: tabLead Source 'on': source = tabLead Source.name - name: opportunity_owner - description: '' + description: Sales representative or team member responsible for managing and + closing the opportunity. join_hint: table: tabUser 'on': opportunity_owner = tabUser.name - name: sales_stage - description: '' + description: Current phase of the sales opportunity such as prospecting, qualification, + proposal, negotiation, or closed won/lost. join_hint: table: tabSales Stage 'on': sales_stage = tabSales Stage.name - name: expected_closing - description: '' + description: Anticipated date when the opportunity is forecasted to close or be + won. - name: probability - description: '' + description: Percentage likelihood that the opportunity will be successfully won + and closed. - name: no_of_employees - description: '' + description: Number of employees at the prospect or customer organization associated + with this opportunity, used when qualifying opportunity size or segmenting by + company headcount. options: - 1-10 - 11-50 @@ -14548,242 +17733,317 @@ tables: - 501-1000 - 1000+ - name: annual_revenue - description: '' + description: Yearly revenue of the prospect or customer organization associated + with this opportunity, used when assessing deal potential or filtering by company + financial size. - name: customer_group - description: '' + description: Classification or segment category assigned to the customer associated + with this opportunity, used when analyzing opportunities by customer type, tier, + or strategic grouping. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: industry - description: '' + description: The industry vertical or sector of the customer or prospect associated + with the opportunity, such as manufacturing, healthcare, or retail. join_hint: table: tabIndustry Type 'on': industry = tabIndustry Type.name - name: market_segment - description: '' + description: The specific market segment or customer category within an industry, + such as enterprise, mid-market, or SMB. join_hint: table: tabMarket Segment 'on': market_segment = tabMarket Segment.name - name: website - description: '' + description: The web address or URL of the customer or prospect organization related + to the opportunity. - name: city - description: '' + description: City where the opportunity or customer is located, used when filtering + or analyzing opportunities by geographic city. - name: state - description: '' + description: State or province where the opportunity or customer is located, used + when filtering or analyzing opportunities by geographic region. - name: country - description: '' + description: Country where the opportunity or customer is located, used when filtering + or analyzing opportunities by geographic market or international presence. join_hint: table: tabCountry 'on': country = tabCountry.name - name: territory - description: '' + description: Geographic or organizational sales region assigned to the opportunity + for territory management and sales assignment purposes join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: currency - description: '' + description: Currency denomination in which the opportunity amount and related + financial values are expressed join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: conversion_rate - description: '' + description: Exchange rate used to convert the opportunity's currency amounts + to the base or home currency - name: opportunity_amount - description: '' + description: Total potential revenue value of the sales opportunity in the transaction + currency. - name: base_opportunity_amount - description: '' + description: Total potential revenue value of the sales opportunity converted + to the company's base currency for consolidated reporting. - name: company - description: '' + description: The legal entity or business unit that owns or is pursuing this sales + opportunity. join_hint: table: tabCompany 'on': company = tabCompany.name - name: campaign - description: '' + description: Marketing campaign that generated or is associated with this sales + opportunity join_hint: table: tabCampaign 'on': campaign = tabCampaign.name - name: transaction_date - description: '' + description: Date when the opportunity transaction occurred or was recorded - name: language - description: '' + description: Preferred language for communication with the opportunity contact + or account join_hint: table: tabLanguage 'on': language = tabLanguage.name - name: amended_from - description: '' + description: References the original opportunity that this opportunity was created + from when amendments or revisions are made to an existing deal. join_hint: table: tabOpportunity 'on': amended_from = tabOpportunity.name - name: title - description: '' + description: The name or headline of the sales opportunity used to identify and + search for specific deals. - name: first_response_time - description: '' + description: Tracks when the sales team first responded or engaged with the opportunity + after it was created or received. - name: lost_reasons - description: '' + description: Reasons why an opportunity was lost or closed unsuccessfully, typically + selected from predefined categories. - name: order_lost_reason - description: '' + description: Specific reason why an order associated with this opportunity was + lost, distinct from general opportunity loss reasons. - name: competitors - description: '' + description: Competitor companies or products that were involved in this sales + opportunity. - name: contact_person - description: '' + description: Name of the individual at the customer organization who is the primary + contact for this sales opportunity. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: job_title - description: '' + description: Professional role or position title of the contact person associated + with this opportunity. - name: contact_email - description: '' + description: Email address of the contact person for communication regarding this + sales opportunity. - name: contact_mobile - description: '' + description: Mobile phone number of the primary contact person associated with + the opportunity. - name: whatsapp - description: '' + description: WhatsApp contact number for the opportunity, may differ from mobile + or phone. - name: phone - description: '' + description: Primary landline or office phone number for the opportunity, distinct + from mobile contact. - name: phone_ext - description: '' + description: Extension number for the opportunity contact's phone line - name: customer_address - description: '' + description: Billing or primary address of the customer associated with the opportunity join_hint: table: tabAddress 'on': customer_address = tabAddress.name - name: address_display - description: '' + description: Formatted full address string for displaying the opportunity location + or customer site - name: contact_display - description: '' + description: The name or identifier of the primary contact person associated with + this sales opportunity. - name: items - description: '' + description: The individual products or services included in this opportunity's + proposal or quote. - name: base_total - description: '' + description: The total value of the opportunity before any adjustments like taxes, + discounts, or currency conversions. - name: total - description: '' + description: Total monetary value of the sales opportunity including all products + and services being proposed to the customer - name: notes - description: '' + description: Free-form text comments and additional context about the opportunity + such as customer requirements, competitive situation, or special considerations + desc_done: true - table: tabOpportunity Item description: '' fields: - name: name - description: '' + description: Unique identifier or title for this specific opportunity line item - name: item_code - description: '' + description: SKU or product code identifying the product or service being offered + in this opportunity join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Descriptive name of the product or service being offered in this + opportunity - name: uom - description: '' + description: Unit of measurement for the opportunity item quantity (e.g., pieces, + boxes, kilograms). join_hint: table: tabUOM 'on': uom = tabUOM.name - name: qty - description: '' + description: Quantity of the item included in the opportunity. - name: brand - description: '' + description: Brand or manufacturer name of the product being offered in the opportunity. join_hint: table: tabBrand 'on': brand = tabBrand.name - name: item_group - description: '' + description: Product category or classification of the opportunity line item for + grouping similar products together join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: description - description: '' + description: Detailed text explaining what the opportunity line item is or includes - name: image_view - description: '' + description: Visual representation or picture of the opportunity line item - name: base_rate - description: '' + description: Unit price or rate in the company's base currency before any currency + conversion adjustments. - name: base_amount - description: '' + description: Total line item amount in the company's base currency before any + currency conversion adjustments. - name: rate - description: '' + description: Unit price or rate in the transaction currency as quoted to the customer. - name: amount - description: '' + description: Total monetary value of this specific product or service line item + within the sales opportunity. + desc_done: true - table: tabOpportunity Lost Reason description: '' fields: - name: name - description: '' + description: Unique identifier or label for this specific opportunity lost reason + record - name: lost_reason - description: '' + description: The actual reason or explanation for why an opportunity was lost, + such as pricing, competition, or timing issues + desc_done: true - table: tabOpportunity Lost Reason Detail description: '' fields: - name: name - description: '' + description: Unique identifier or label for this specific opportunity lost reason + detail record - name: lost_reason - description: '' + description: The reason why an opportunity was lost, such as pricing, competitor, + timing, or other business factors join_hint: table: tabOpportunity Lost Reason 'on': lost_reason = tabOpportunity Lost Reason.name + desc_done: true - table: tabOpportunity Type description: '' fields: - name: name - description: '' + description: Opportunity type name or category label that classifies the kind + of sales opportunity - name: description - description: '' + description: Detailed explanation or notes about what this opportunity type represents + and when to use it + desc_done: true - table: tabOverdue Payment description: '' fields: - name: name - description: '' + description: Unique identifier for the overdue payment record, used when tracking + or referencing specific outstanding payment instances. - name: sales_invoice - description: '' + description: Links to the originating sales invoice document, used when investigating + which invoice has overdue amounts or analyzing payment delays by invoice. join_hint: table: tabSales Invoice 'on': sales_invoice = tabSales Invoice.name - name: payment_schedule - description: '' + description: References the specific payment schedule entry that is overdue, used + when tracking installment-based payments or analyzing which scheduled payments + are past due. - name: dunning_level - description: '' + description: Escalation stage or severity level of collection efforts for the + overdue payment - name: payment_term - description: '' + description: Original agreed payment conditions or due date terms that were not + met join_hint: table: tabPayment Term 'on': payment_term = tabPayment Term.name - name: description - description: '' + description: Explanatory notes or details about why the payment is overdue or + collection actions taken - name: due_date - description: '' + description: Original deadline when payment was expected before becoming overdue - name: overdue_days - description: '' + description: Number of days elapsed since the payment due date passed - name: mode_of_payment - description: '' + description: Payment method or channel used or expected for the overdue transaction join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: invoice_portion - description: '' + description: The specific portion or line item of an invoice that is overdue for + payment. - name: payment_amount - description: '' + description: The amount of money that was paid or is expected to be paid against + the overdue invoice. - name: outstanding - description: '' + description: The remaining unpaid balance that is still overdue after any payments + have been applied. - name: paid_amount - description: '' + description: Amount actually paid by customer toward the overdue payment, used + when asking how much was received or settled. - name: discounted_amount - description: '' + description: Amount reduced or waived from the original overdue balance, used + when asking about payment reductions or forgiveness. - name: interest - description: '' + description: Additional charges accrued on the overdue payment, used when asking + about late fees or penalty amounts. + desc_done: true - table: tabPOS Closing Entry description: '' fields: - name: name - description: '' + description: Unique identifier for the POS closing entry, typically referenced + when looking up a specific closing shift or session. - name: period_start_date - description: '' + description: Start date and time of the POS shift or period being closed, used + to find closings within a specific timeframe or that began on a certain date. - name: period_end_date - description: '' + description: End date and time of the POS shift or period being closed, used to + identify when a closing was completed or to filter closings that ended on a + specific date. - name: posting_date - description: '' + description: Date when the POS shift was closed and transactions were finalized + for accounting purposes. - name: posting_time - description: '' + description: Time when the POS shift was closed and transactions were finalized. - name: pos_opening_entry - description: '' + description: Links to the corresponding POS shift opening record to match closing + with opening entries. join_hint: table: tabPOS Opening Entry 'on': pos_opening_entry = tabPOS Opening Entry.name - name: status - description: '' + description: Current state of the POS closing entry such as draft, submitted, + or cancelled. options: - Draft - Submitted @@ -14791,116 +18051,148 @@ tables: - Failed - Cancelled - name: company - description: '' + description: Company for which this POS closing entry was created. join_hint: table: tabCompany 'on': company = tabCompany.name - name: pos_profile - description: '' + description: POS profile or configuration used during the sales period being closed. join_hint: table: tabPOS Profile 'on': pos_profile = tabPOS Profile.name - name: user - description: '' + description: Employee or cashier who performed the POS closing and is responsible + for the shift reconciliation. join_hint: table: tabUser 'on': user = tabUser.name - name: pos_transactions - description: '' + description: Count of sales transactions processed during the shift being closed. - name: payment_reconciliation - description: '' + description: Linked reconciliation document that matches expected versus actual + cash and payment amounts at shift end. - name: grand_total - description: '' + description: Final total amount including all taxes, discounts, and charges for + the POS closing entry. - name: net_total - description: '' + description: Total amount before taxes are applied but after item-level discounts + in the POS closing entry. - name: total_quantity - description: '' + description: Total number of items or units sold across all transactions in the + POS closing entry. - name: taxes - description: '' + description: Tax amounts collected during the POS shift or closing period, used + when querying total tax revenue or tax breakdown by type. - name: error_message - description: '' + description: Error or validation message captured when the POS closing entry failed + or encountered issues during processing. - name: amended_from - description: '' + description: Reference to the original POS closing entry that this entry corrects + or replaces, used when tracking corrections or amendments. join_hint: table: tabPOS Closing Entry 'on': amended_from = tabPOS Closing Entry.name + desc_done: true - table: tabPOS Closing Entry Detail description: '' fields: - name: name - description: '' + description: Unique identifier for the POS closing entry detail record - name: mode_of_payment - description: '' + description: Payment method used for transactions in this closing entry line (cash, + card, check, etc.) join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: opening_amount - description: '' + description: Starting cash or payment method balance at the beginning of the POS + shift - name: expected_amount - description: '' + description: Expected cash or payment amount that should be present based on transactions + recorded during the shift or period. - name: closing_amount - description: '' + description: Actual cash or payment amount counted and declared at the end of + the shift or period. - name: difference - description: '' + description: Variance between expected and actual closing amounts, indicating + overages or shortages in the register. + desc_done: true - table: tabPOS Closing Entry Taxes description: '' fields: - name: name - description: '' + description: Unique identifier or label for the specific tax entry recorded during + POS closing - name: account_head - description: '' + description: General ledger account where this tax amount is posted for accounting + purposes join_hint: table: tabAccount 'on': account_head = tabAccount.name - name: rate - description: '' + description: Tax percentage applied to calculate the tax amount for this entry - name: amount - description: '' + description: Tax amount collected or paid for a specific tax type during the POS + closing period. + desc_done: true - table: tabPOS Customer Group description: '' fields: - name: name - description: '' + description: name - name: customer_group - description: '' + description: Unique identifier and label for the customer group used when filtering, + segmenting, or analyzing customers by their assigned group category join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name + desc_done: true - table: tabPOS Field description: '' fields: - name: name - description: '' + description: Unique identifier for the POS field configuration record. - name: fieldname - description: '' + description: Technical database column name used to map POS data fields to system + tables. - name: label - description: '' + description: User-facing display name shown in POS interface and reports for this + field. - name: fieldtype - description: '' + description: Data type of the POS field such as Currency, Data, Link, or Select + that determines how values are stored and displayed - name: options - description: '' + description: Configuration values or linked doctype name that defines valid choices + or relationships for the POS field - name: default_value - description: '' + description: Pre-populated value automatically assigned to the POS field when + creating new transactions - name: reqd - description: '' + description: Indicates whether this POS field is mandatory and must be filled + in during transactions or data entry. - name: read_only - description: '' + description: Indicates whether this POS field can be edited by users or is locked + from modification. + desc_done: true - table: tabPOS Invoice description: '' fields: - name: name - description: '' + description: Unique identifier for the POS invoice transaction - name: custom_ksa_einvoicing_xml - description: '' + description: XML format data for Saudi Arabia ZATCA e-invoicing compliance and + submission - name: custom_zatca_tax_category - description: '' + description: Tax category classification code required for Saudi Arabian ZATCA + e-invoicing regulations options: - Standard - Zero Rated - Exempted - Services outside scope of tax / Not subject to VAT - name: custom_exemption_reason_code - description: '' + description: Tax exemption reason code for invoices claiming exemption from VAT + or other taxes. options: - VATEX-SA-29 - VATEX-SA-29-7 @@ -14919,347 +18211,446 @@ tables: - VATEX-SA-MLTRY - VATEX-SA-OOS - name: custom_uuid - description: '' + description: Unique universal identifier for the POS invoice used for external + system integration and tracking. - name: custom_zatca_status - description: '' + description: ZATCA (Saudi tax authority) compliance status indicating whether + the invoice has been successfully submitted, approved, or rejected for e-invoicing. - name: title - description: '' + description: Display name or identifier for the POS invoice transaction - name: naming_series - description: '' + description: Prefix pattern used to generate the POS invoice number options: - ACC-PSINV-.YYYY.- - name: customer - description: '' + description: The customer who made the purchase in this POS transaction join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: customer_name - description: '' + description: Name of the customer who made the purchase at the point of sale. - name: tax_id - description: '' + description: Tax identification number of the customer for tax reporting and compliance + purposes. - name: pos_profile - description: '' + description: Configuration profile that determines POS settings like payment methods, + pricing rules, and warehouse for this transaction. join_hint: table: tabPOS Profile 'on': pos_profile = tabPOS Profile.name - name: consolidated_invoice - description: '' + description: Reference to the master invoice when multiple POS transactions are + combined into a single consolidated billing document. join_hint: table: tabSales Invoice 'on': consolidated_invoice = tabSales Invoice.name - name: is_pos - description: '' + description: Indicates whether this invoice originated from a point-of-sale transaction + rather than a standard sales invoice. - name: is_return - description: '' + description: Indicates whether this invoice represents a product return or refund + transaction rather than a sale. - name: update_billed_amount_in_sales_order - description: '' + description: Whether this POS invoice updates the billed amount back to the originating + sales order for tracking fulfillment progress. - name: update_billed_amount_in_delivery_note - description: '' + description: Whether this POS invoice updates the billed amount back to the associated + delivery note for reconciling shipped versus invoiced quantities. - name: company - description: '' + description: The legal entity or business unit that issued this POS invoice for + financial reporting and multi-company operations. join_hint: table: tabCompany 'on': company = tabCompany.name - name: posting_date - description: '' + description: Date when the POS invoice transaction is officially recorded in accounting + books - name: posting_time - description: '' + description: Time when the POS invoice transaction is officially recorded in accounting + books - name: set_posting_time - description: '' + description: Indicates whether the posting date and time were manually specified + instead of using current timestamp - name: due_date - description: '' + description: Date when payment for the POS invoice is expected or required from + the customer. - name: amended_from - description: '' + description: Reference to the original POS invoice that this document amends or + corrects. join_hint: table: tabPOS Invoice 'on': amended_from = tabPOS Invoice.name - name: return_against - description: '' + description: Reference to the original POS invoice for which this document represents + a return or credit. join_hint: table: tabPOS Invoice 'on': return_against = tabPOS Invoice.name - name: custom_zatca_pos_name - description: '' + description: Point of sale terminal or device name for Saudi ZATCA tax compliance + and invoice tracking. join_hint: table: tabZATCA Multiple Setting 'on': custom_zatca_pos_name = tabZATCA Multiple Setting.name - name: project - description: '' + description: Project associated with this POS invoice for project-based revenue + tracking and cost allocation. join_hint: table: tabProject 'on': project = tabProject.name - name: cost_center - description: '' + description: Cost center assigned to this POS invoice for departmental or location-based + financial reporting. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: po_no - description: '' + description: Purchase order number from the customer used to match invoices to + customer PO references or track order fulfillment. - name: po_date - description: '' + description: Date of the customer's purchase order used to identify when the order + was placed or filter invoices by PO timing. - name: customer_address - description: '' + description: Billing or shipping address of the customer used to identify invoice + location, filter by region, or verify delivery details. join_hint: table: tabAddress 'on': customer_address = tabAddress.name - name: address_display - description: '' + description: Formatted billing or shipping address shown on the POS invoice for + customer delivery or correspondence. - name: contact_person - description: '' + description: Individual person associated with the customer account for this POS + transaction. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_display - description: '' + description: Formatted customer or contact name displayed on the POS invoice header. - name: contact_mobile - description: '' + description: Mobile phone number of the customer for this POS transaction, used + when searching invoices by customer contact information. - name: contact_email - description: '' + description: Email address of the customer for this POS transaction, used when + searching invoices by customer contact details or for receipt delivery. - name: territory - description: '' + description: Sales territory or geographic region assigned to this POS invoice, + used for location-based sales analysis and regional performance tracking. join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: shipping_address_name - description: '' + description: Name of the person or business receiving the shipment at the delivery + location. join_hint: table: tabAddress 'on': shipping_address_name = tabAddress.name - name: shipping_address - description: '' + description: Full delivery address where the invoice items are shipped to the + customer. - name: company_address - description: '' + description: Address of the company issuing the POS invoice, typically the seller's + business location. join_hint: table: tabAddress 'on': company_address = tabAddress.name - name: company_address_display - description: '' + description: Formatted company address appearing on POS invoices for customer-facing + documents and receipts. - name: company_contact_person - description: '' + description: Designated contact person from the company for customer inquiries + related to this POS invoice. join_hint: table: tabContact 'on': company_contact_person = tabContact.name - name: currency - description: '' + description: Currency in which the POS invoice transaction amounts are denominated + and processed. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: conversion_rate - description: '' + description: Exchange rate applied to convert transaction amounts from price list + currency to company base currency at time of invoice. - name: selling_price_list - description: '' + description: Name of the price list used to determine item prices for this POS + invoice. join_hint: table: tabPrice List 'on': selling_price_list = tabPrice List.name - name: price_list_currency - description: '' + description: Currency in which the selling price list prices are denominated, + may differ from company base currency. join_hint: table: tabCurrency 'on': price_list_currency = tabCurrency.name - name: plc_conversion_rate - description: '' + description: Exchange rate used to convert price list currency amounts to company + base currency for this invoice. - name: ignore_pricing_rule - description: '' + description: Whether promotional discounts, volume pricing, and other automatic + pricing rules were bypassed for this invoice. - name: set_warehouse - description: '' + description: Default warehouse location from which all items on this invoice are + fulfilled or shipped. join_hint: table: tabWarehouse 'on': set_warehouse = tabWarehouse.name - name: update_stock - description: '' + description: Whether this POS invoice automatically updates inventory stock levels + upon submission. - name: scan_barcode - description: '' + description: Barcode value scanned at POS to quickly add items to the invoice. - name: last_scanned_warehouse - description: '' + description: Warehouse from which the most recently scanned item's stock will + be deducted. - name: items - description: '' + description: Products or services sold in the point-of-sale transaction with quantities + and prices - name: pricing_rules - description: '' + description: Discounts, promotions, or special pricing conditions applied to this + invoice - name: packed_items - description: '' + description: Items that have been physically packed or prepared for delivery from + this sale - name: timesheets - description: '' + description: References timesheet entries linked to this POS invoice for billing + labor or service hours. - name: total_billing_amount - description: '' + description: Final amount charged to the customer including all items, taxes, + and adjustments on this POS invoice. - name: total_qty - description: '' + description: Sum of quantities across all line items sold in this POS invoice + transaction. - name: base_total - description: '' + description: Grand total of the POS invoice in company's base currency including + taxes and charges. - name: base_net_total - description: '' + description: Net total of the POS invoice in company's base currency excluding + taxes but after discounts. - name: total - description: '' + description: Grand total of the POS invoice in transaction currency including + taxes and charges. - name: net_total - description: '' + description: Total invoice amount before applying taxes, discounts, or additional + charges. - name: total_net_weight - description: '' + description: Combined weight of all items in the invoice excluding packaging or + container weight. - name: taxes_and_charges - description: '' + description: Total amount of taxes and additional charges applied to the invoice. join_hint: table: tabSales Taxes and Charges Template 'on': taxes_and_charges = tabSales Taxes and Charges Template.name - name: shipping_rule - description: '' + description: Shipping method or carrier rule applied to calculate delivery charges + for this POS invoice join_hint: table: tabShipping Rule 'on': shipping_rule = tabShipping Rule.name - name: tax_category - description: '' + description: Tax classification or category that determines which tax rates apply + to items on this invoice join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: taxes - description: '' + description: Actual tax amounts or tax line items calculated and charged on this + POS invoice - name: other_charges_calculation - description: '' + description: Additional fees or charges beyond standard taxes applied to the POS + invoice, such as shipping, handling, or service fees. - name: base_total_taxes_and_charges - description: '' + description: Total of all taxes and charges in the base currency before any currency + conversion. - name: total_taxes_and_charges - description: '' + description: Total of all taxes and charges in the transaction currency after + applying exchange rates. - name: loyalty_points - description: '' + description: Points earned by the customer from this transaction for future redemption. - name: loyalty_amount - description: '' + description: Monetary value equivalent of loyalty points earned on this invoice. - name: redeem_loyalty_points - description: '' + description: Points redeemed by the customer to reduce payment on this transaction. - name: loyalty_program - description: '' + description: Loyalty program applied to this POS invoice for earning or redeeming + customer rewards points. join_hint: table: tabLoyalty Program 'on': loyalty_program = tabLoyalty Program.name - name: loyalty_redemption_account - description: '' + description: General ledger account used to record the financial impact when loyalty + points are redeemed on this invoice. join_hint: table: tabAccount 'on': loyalty_redemption_account = tabAccount.name - name: loyalty_redemption_cost_center - description: '' + description: Cost center assigned to track departmental expenses when loyalty + points are redeemed on this invoice. join_hint: table: tabCost Center 'on': loyalty_redemption_cost_center = tabCost Center.name - name: coupon_code - description: '' + description: Promotional or discount code applied to the invoice for tracking + which coupon was used. join_hint: table: tabCoupon Code 'on': coupon_code = tabCoupon Code.name - name: apply_discount_on - description: '' + description: Specifies whether the discount applies to grand total or net total, + determining discount calculation basis. options: - Grand Total - Net Total - name: base_discount_amount - description: '' + description: Discount amount in base currency before any currency conversion or + tax adjustments. - name: additional_discount_percentage - description: '' + description: Percentage discount applied to the entire invoice after line-item + discounts, used when users ask about overall invoice-level discount rates. - name: discount_amount - description: '' + description: Total monetary value of all discounts applied to the invoice, used + when users ask about absolute discount amounts rather than percentages. - name: base_grand_total - description: '' + description: Final invoice total in base currency before applying additional discounts + or taxes, used when users need the subtotal after line items but before invoice-level + adjustments. - name: base_rounding_adjustment - description: '' + description: Amount added or subtracted to round the invoice total to the nearest + acceptable value in base currency. - name: base_rounded_total - description: '' + description: Final invoice total after applying rounding adjustment in base currency. - name: base_in_words - description: '' + description: Text representation of the base currency invoice amount spelled out + in words for printing on receipts or invoices. - name: grand_total - description: '' + description: Total invoice amount before any rounding adjustments are applied. - name: rounding_adjustment - description: '' + description: Amount added or subtracted to round the grand total to a convenient + figure. - name: rounded_total - description: '' + description: Final invoice amount after applying rounding adjustment to the grand + total. - name: in_words - description: '' + description: Total invoice amount expressed as text words for printing on receipts + and invoices. - name: total_advance - description: '' + description: Sum of all advance payments received from the customer before or + at the time of this POS invoice. - name: outstanding_amount - description: '' + description: Remaining unpaid balance on this POS invoice after applying payments + and advances. - name: allocate_advances_automatically - description: '' + description: Whether customer advance payments are automatically applied to this + invoice upon creation or submission. - name: advances - description: '' + description: List of advance payment entries that have been allocated or linked + to offset this invoice amount. - name: payment_terms_template - description: '' + description: The predefined payment terms schedule applied to this invoice defining + due dates and installment amounts. join_hint: table: tabPayment Terms Template 'on': payment_terms_template = tabPayment Terms Template.name - name: payment_schedule - description: '' + description: Payment plan or installment terms defining when and how much the + customer will pay for this POS invoice. - name: cash_bank_account - description: '' + description: Bank or cash account where payment for this POS invoice will be deposited + or has been received. join_hint: table: tabAccount 'on': cash_bank_account = tabAccount.name - name: payments - description: '' + description: Actual payment transactions recorded against this POS invoice, tracking + amounts received and payment methods used. - name: base_paid_amount - description: '' + description: Total amount paid by customer in company's base currency before currency + conversion. - name: paid_amount - description: '' + description: Total amount paid by customer in transaction currency. - name: base_change_amount - description: '' + description: Change returned to customer in company's base currency when payment + exceeds invoice total. - name: change_amount - description: '' + description: Cash returned to customer when payment exceeds invoice total in point + of sale transactions. - name: account_for_change_amount - description: '' + description: General ledger account where cash change given to customers is recorded. join_hint: table: tabAccount 'on': account_for_change_amount = tabAccount.name - name: write_off_amount - description: '' + description: Amount forgiven or removed from invoice total due to discrepancies, + damages, or business decisions. - name: base_write_off_amount - description: '' + description: Amount written off in base currency when closing an invoice with + small payment discrepancies or rounding differences. - name: write_off_outstanding_amount_automatically - description: '' + description: Whether the system automatically writes off small remaining balances + when the invoice is marked as paid. - name: write_off_account - description: '' + description: General ledger account where write-off amounts are posted when invoice + balances are written off. join_hint: table: tabAccount 'on': write_off_account = tabAccount.name - name: write_off_cost_center - description: '' + description: Cost center assigned when writing off amounts from this POS invoice + for accounting allocation purposes join_hint: table: tabCost Center 'on': write_off_cost_center = tabCost Center.name - name: tc_name - description: '' + description: Name of the tax category applied to this POS invoice for tax calculation + and compliance join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Payment terms defining when payment is due for this POS invoice - name: letter_head - description: '' + description: Letterhead template used for printing or displaying the POS invoice + header with company branding and contact information. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: group_same_items - description: '' + description: Indicates whether identical items in the invoice are consolidated + into a single line with combined quantity. - name: language - description: '' + description: Language in which the POS invoice content and labels are displayed + or printed. - name: select_print_heading - description: '' + description: Custom heading text that appears on printed POS invoice documents + instead of the default heading. join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: inter_company_invoice_reference - description: '' + description: Links this POS invoice to a corresponding invoice in another company + entity for inter-company transactions. join_hint: table: tabPurchase Invoice 'on': inter_company_invoice_reference = tabPurchase Invoice.name - name: customer_group - description: '' + description: Classification or category of the customer making the purchase, used + for segmentation and group-based analysis. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: campaign - description: '' + description: Marketing or promotional campaign associated with the POS transaction + for tracking sales by promotion or offer. join_hint: table: tabCampaign 'on': campaign = tabCampaign.name - name: is_discounted - description: '' + description: Whether any discount was applied to the invoice, used to identify + discounted versus full-price transactions. - name: status - description: '' + description: Current state of the POS invoice such as draft, paid, cancelled, + or returned. options: - Draft - Return @@ -15273,1528 +18664,1940 @@ tables: - Overdue - Cancelled - name: source - description: '' + description: Identifies the originating system or module that created this POS + invoice, such as mobile app, web portal, or third-party integration. join_hint: table: tabLead Source 'on': source = tabLead Source.name - name: debit_to - description: '' + description: The receivable account that will be debited for the total invoice + amount owed by the customer. join_hint: table: tabAccount 'on': debit_to = tabAccount.name - name: party_account_currency - description: '' + description: The currency in which the customer's account balance and transactions + are maintained, which may differ from the invoice transaction currency. join_hint: table: tabCurrency 'on': party_account_currency = tabCurrency.name - name: is_opening - description: '' + description: Indicates whether this POS invoice is an opening balance entry for + migration or initial setup purposes. options: - 'No' - 'Yes' - name: remarks - description: '' + description: Free-text comments or notes about the POS transaction, often used + when searching for specific transaction details or special instructions. - name: sales_partner - description: '' + description: The partner, agent, or third-party entity credited with or associated + with this sale for commission or referral tracking. join_hint: table: tabSales Partner 'on': sales_partner = tabSales Partner.name - name: amount_eligible_for_commission - description: '' + description: Sales amount that qualifies for commission calculation, excluding + non-commissionable items or discounts. - name: commission_rate - description: '' + description: Percentage rate applied to eligible sales amount to calculate commission + earned. - name: total_commission - description: '' + description: Final commission amount earned on this invoice, calculated from eligible + amount and rate. - name: sales_team - description: '' + description: Sales team responsible for this POS invoice transaction - name: from_date - description: '' + description: Start date of the period covered by this POS invoice - name: to_date - description: '' + description: End date of the period covered by this POS invoice - name: auto_repeat - description: '' + description: Indicates if this invoice is part of a recurring billing schedule + or subscription. join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: against_income_account - description: '' + description: The revenue or income account credited when this invoice is posted. - name: custom_zatca_full_response - description: '' + description: Complete response data from Saudi Arabia's ZATCA e-invoicing system + for compliance verification. + desc_done: true - table: tabPOS Invoice Item description: '' fields: - name: name - description: '' + description: Item name or description on the POS invoice line - name: barcode - description: '' + description: Barcode scanned or entered for the item at point of sale - name: has_item_scanned - description: '' + description: Whether the item was added by scanning a barcode versus manual entry - name: item_code - description: '' + description: Internal product identifier used when searching for items sold through + point of sale by SKU or internal code. join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Product name or description used when searching for items sold at + POS by their display name or label. - name: customer_item_code - description: '' + description: Customer's own product identifier or reference number used when customers + have custom SKUs or part numbers for items they purchase. - name: description - description: '' + description: Text description of the product or service sold in the POS transaction, + used when searching for items by name or details. - name: item_group - description: '' + description: Category or classification grouping of the item, used for filtering + sales by product type or analyzing category performance. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: brand - description: '' + description: Manufacturer or brand name of the item sold, used for brand-specific + sales analysis or filtering transactions by brand. - name: image_view - description: '' + description: Item image displayed on POS screen during transaction selection and + checkout. - name: qty - description: '' + description: Quantity of the item sold in this POS invoice line. - name: stock_uom - description: '' + description: Unit of measurement for the item quantity in this POS transaction. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: uom - description: '' + description: Unit of measurement for the item as sold in this POS transaction + (e.g., Box, Kg, Piece). join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert the sold UOM quantity into the base stock UOM + quantity. - name: stock_qty - description: '' + description: Quantity of the item in base stock units after applying the conversion + factor from the sold UOM. - name: price_list_rate - description: '' + description: Item selling price from the price list in transaction currency before + any discounts or margin adjustments. - name: base_price_list_rate - description: '' + description: Item selling price from the price list converted to company base + currency. - name: margin_type - description: '' + description: Whether profit margin is calculated as a percentage or fixed amount + on this item. options: - Percentage - Amount - name: margin_rate_or_amount - description: '' + description: Markup added to item cost to determine selling price, either as percentage + or absolute amount. - name: rate_with_margin - description: '' + description: Final item price after applying margin but before discounts. - name: discount_percentage - description: '' + description: Percentage reduction applied to item price at point of sale. - name: discount_amount - description: '' + description: Direct discount applied to this line item, used when calculating + item-level price reductions or promotional discounts. - name: distributed_discount_amount - description: '' + description: Portion of invoice-level or header discount allocated to this line + item, used when analyzing how total discounts are spread across items. - name: base_rate_with_margin - description: '' + description: Item rate including margin markup before discounts, used when analyzing + profit margins or comparing selling price to base cost. - name: rate - description: '' + description: Unit price of the item before applying quantity or discounts. - name: amount - description: '' + description: Total line item value after applying quantity and discounts but before + taxes. - name: item_tax_template - description: '' + description: Tax configuration template applied to this specific item to determine + applicable tax rates and rules. join_hint: table: tabItem Tax Template 'on': item_tax_template = tabItem Tax Template.name - name: base_rate - description: '' + description: Unit price of the item before applying pricing rules, discounts, + or currency conversion. - name: base_amount - description: '' + description: Total line amount before applying pricing rules, discounts, or currency + conversion. - name: pricing_rules - description: '' + description: Specific promotional or conditional pricing rules applied to this + invoice line item. - name: is_free_item - description: '' + description: Indicates whether the item was given at no charge as a promotional + or complimentary item. - name: grant_commission - description: '' + description: Indicates whether this item qualifies for sales commission calculation. - name: net_rate - description: '' + description: Final price per unit after applying all discounts and adjustments + but before taxes. - name: net_amount - description: '' + description: Line item amount after item-level discounts but before taxes, in + transaction currency. - name: base_net_rate - description: '' + description: Per-unit price after item-level discounts in company base currency, + used for multi-currency reporting. - name: base_net_amount - description: '' + description: Line item amount after item-level discounts but before taxes, converted + to company base currency for consolidated reporting. - name: delivered_by_supplier - description: '' + description: Indicates whether the item was directly shipped/delivered by the + supplier rather than from own inventory. - name: income_account - description: '' + description: The general ledger account where revenue from selling this item is + recorded. join_hint: table: tabAccount 'on': income_account = tabAccount.name - name: is_fixed_asset - description: '' + description: Indicates whether the item sold is a fixed asset (equipment, machinery, + property) rather than regular inventory or service. - name: asset - description: '' + description: Fixed asset item being sold or transferred in this POS transaction + line. join_hint: table: tabAsset 'on': asset = tabAsset.name - name: finance_book - description: '' + description: Accounting book or entity for recording this POS item's financial + impact when multiple books are maintained. join_hint: table: tabFinance Book 'on': finance_book = tabFinance Book.name - name: expense_account - description: '' + description: General ledger account to record the cost or expense associated with + this POS item. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: deferred_revenue_account - description: '' + description: Accounting ledger account where revenue from this item is deferred + until earned over time. join_hint: table: tabAccount 'on': deferred_revenue_account = tabAccount.name - name: service_stop_date - description: '' + description: End date of the service period for this item, used to calculate revenue + recognition and service duration. - name: enable_deferred_revenue - description: '' + description: Indicates whether this item's revenue should be recognized over time + rather than immediately at sale. - name: service_start_date - description: '' + description: Start date of service period for subscription or time-based items + sold through POS. - name: service_end_date - description: '' + description: End date of service period for subscription or time-based items sold + through POS. - name: weight_per_unit - description: '' + description: Physical weight of a single unit of the item, used for shipping calculations + and logistics queries. - name: total_weight - description: '' + description: Combined weight of all quantities of this item on the POS invoice + line, used when calculating shipping costs or logistics requirements. - name: weight_uom - description: '' + description: Unit of measurement for the item's weight (kg, lbs, grams), used + to interpret total_weight values. join_hint: table: tabUOM 'on': weight_uom = tabUOM.name - name: warehouse - description: '' + description: Storage location or facility from which this item was fulfilled or + inventory was deducted for the POS sale. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: target_warehouse - description: '' + description: Warehouse where inventory from this POS invoice item will be delivered + or allocated. join_hint: table: tabWarehouse 'on': target_warehouse = tabWarehouse.name - name: quality_inspection - description: '' + description: Reference to quality inspection record required or performed for + this item before delivery. join_hint: table: tabQuality Inspection 'on': quality_inspection = tabQuality Inspection.name - name: serial_and_batch_bundle - description: '' + description: Bundle containing serial numbers or batch numbers assigned to this + specific item in the transaction. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: use_serial_batch_fields - description: '' + description: Indicates whether this invoice item tracks serial numbers or batch + numbers for inventory control and traceability. - name: allow_zero_valuation_rate - description: '' + description: Indicates whether this item can be invoiced with zero valuation cost, + typically for free samples, promotional items, or non-stock items. - name: item_tax_rate - description: '' + description: Tax rates and percentages applied specifically to this invoice line + item, overriding default tax templates when item-specific taxation is needed. - name: actual_batch_qty - description: '' + description: Quantity of items from a specific batch used in this POS invoice + line item. - name: actual_qty - description: '' + description: Total quantity of items sold in this POS invoice line item, regardless + of batch or serial number. - name: serial_no - description: '' + description: Specific serial number identifier for individually tracked items + sold in this POS invoice line item. - name: batch_no - description: '' + description: Batch number for inventory tracking of serialized or lot-controlled + items sold in this invoice line. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: sales_order - description: '' + description: Reference to the originating sales order that this invoice item fulfills + or bills against. join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: so_detail - description: '' + description: Specific line item from the sales order that corresponds to this + invoice item. - name: pos_invoice_item - description: '' + description: Individual line item on a point-of-sale invoice representing a product + or service sold in a retail transaction. - name: delivery_note - description: '' + description: Reference to the delivery note document associated with this invoice + item when goods are shipped or delivered. join_hint: table: tabDelivery Note 'on': delivery_note = tabDelivery Note.name - name: dn_detail - description: '' + description: Specific line item from the delivery note that corresponds to this + invoice item, linking shipped goods to billed items. - name: delivered_qty - description: '' + description: Quantity of items actually delivered to the customer in this POS + invoice line, relevant for tracking fulfillment and delivery completion. - name: cost_center - description: '' + description: Cost center assigned to this POS invoice item for internal expense + allocation and departmental accounting. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Project linked to this POS invoice item for tracking revenue and + costs against specific projects or jobs. join_hint: table: tabProject 'on': project = tabProject.name - name: page_break - description: '' + description: Indicates whether a page break should occur before this item when + printing the POS invoice. + desc_done: true - table: tabPOS Invoice Merge Log description: '' fields: - name: name - description: '' + description: Unique identifier for the POS invoice merge transaction or batch + operation - name: company - description: '' + description: Company entity where the POS invoice merge was executed join_hint: table: tabCompany 'on': company = tabCompany.name - name: posting_date - description: '' + description: Accounting date when the merged POS invoices were posted to the general + ledger - name: posting_time - description: '' + description: Time when the merged POS invoice was posted, used to filter or identify + when invoice consolidation occurred. - name: merge_invoices_based_on - description: '' + description: Criteria used to group and consolidate POS invoices such as customer + or payment method. options: - Customer - Customer Group - name: pos_closing_entry - description: '' + description: Reference to the POS closing entry that triggered this invoice merge + operation. join_hint: table: tabPOS Closing Entry 'on': pos_closing_entry = tabPOS Closing Entry.name - name: customer - description: '' + description: The customer account associated with the merged POS invoices. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: customer_group - description: '' + description: The customer group classification for the customer whose POS invoices + were merged. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: pos_invoices - description: '' + description: The list or count of individual POS invoice documents that were combined + in this merge operation. - name: consolidated_invoice - description: '' + description: The final merged invoice created when combining multiple POS invoices + into a single consolidated document. join_hint: table: tabSales Invoice 'on': consolidated_invoice = tabSales Invoice.name - name: consolidated_credit_note - description: '' + description: The final merged credit note created when combining multiple POS + credit notes into a single consolidated document. join_hint: table: tabSales Invoice 'on': consolidated_credit_note = tabSales Invoice.name - name: amended_from - description: '' + description: The previous version of this merge log entry if it was corrected + or modified after initial creation. join_hint: table: tabPOS Invoice Merge Log 'on': amended_from = tabPOS Invoice Merge Log.name + desc_done: true - table: tabPOS Invoice Reference description: '' fields: - name: name - description: '' + description: Unique identifier for the POS invoice reference record - name: pos_invoice - description: '' + description: Links to the actual POS invoice document being referenced join_hint: table: tabPOS Invoice 'on': pos_invoice = tabPOS Invoice.name - name: posting_date - description: '' + description: Date when the POS invoice transaction was posted to accounts - name: customer - description: '' + description: Customer name or ID associated with the POS invoice for filtering + sales by customer or analyzing customer purchase history. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: grand_total - description: '' + description: Final total amount of the POS invoice including all items, taxes, + and discounts for revenue analysis and sales reporting. - name: is_return - description: '' + description: Indicates whether the POS invoice represents a product return or + refund transaction rather than a sale. - name: return_against - description: '' + description: Original POS invoice number that this return or credit note is issued + against join_hint: table: tabPOS Invoice 'on': return_against = tabPOS Invoice.name + desc_done: true - table: tabPOS Item Group description: '' fields: - name: name - description: '' + description: Unique identifier for the POS item group record. - name: item_group - description: '' + description: The inventory item group or category that this POS item group is + linked to for product classification and pricing. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name + desc_done: true - table: tabPOS Opening Entry description: '' fields: - name: name - description: '' + description: Unique identifier for the POS opening entry record. - name: period_start_date - description: '' + description: Date when the POS shift or opening period begins, used to filter + transactions or reconciliations by shift start time. - name: period_end_date - description: '' + description: Date when the POS shift or opening period ends, used to calculate + shift duration or filter closing activities. - name: status - description: '' + description: Current state of the POS opening entry such as draft, submitted, + or cancelled. options: - Draft - Open - Closed - Cancelled - name: posting_date - description: '' + description: The accounting date when the POS opening transaction is recorded + in the financial ledger. - name: set_posting_date - description: '' + description: Whether the posting date is manually specified or automatically determined + by the system. - name: company - description: '' + description: The company entity for which this POS opening entry is recorded. join_hint: table: tabCompany 'on': company = tabCompany.name - name: pos_profile - description: '' + description: The POS profile configuration that defines settings and defaults + for this POS opening session. join_hint: table: tabPOS Profile 'on': pos_profile = tabPOS Profile.name - name: pos_closing_entry - description: '' + description: Links to the corresponding POS closing entry that finalizes this + opening session. - name: user - description: '' + description: The cashier or employee assigned to operate this POS register during + the shift. join_hint: table: tabUser 'on': user = tabUser.name - name: balance_details - description: '' + description: Breakdown of opening cash denominations and payment methods available + at shift start. - name: amended_from - description: '' + description: Reference to the previous POS opening entry that this document corrects + or replaces. join_hint: table: tabPOS Opening Entry 'on': amended_from = tabPOS Opening Entry.name + desc_done: true - table: tabPOS Opening Entry Detail description: '' fields: - name: name - description: '' + description: Unique identifier for the POS opening entry detail record - name: mode_of_payment - description: '' + description: Payment method (cash, card, etc.) being tracked in this opening entry + line item join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: opening_amount - description: '' + description: Starting balance amount for the specific payment mode when the POS + shift or register was opened + desc_done: true - table: tabPOS Payment Method description: '' fields: - name: name - description: '' + description: Payment method name or label such as Cash, Credit Card, Mobile Payment, + or Bank Transfer - name: default - description: '' + description: Whether this payment method is automatically selected when creating + a new POS transaction - name: allow_in_returns - description: '' + description: Whether this payment method can be used when processing customer + returns or refunds - name: mode_of_payment - description: '' + description: The payment method name or type used for POS transactions such as + cash, credit card, debit card, mobile payment, or gift card. join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name + desc_done: true - table: tabPOS Profile description: '' fields: - name: name - description: '' + description: Unique identifier for the POS profile configuration used to distinguish + between different point-of-sale setups or terminals - name: company - description: '' + description: Company entity that owns or operates this POS profile join_hint: table: tabCompany 'on': company = tabCompany.name - name: customer - description: '' + description: Default customer account assigned to transactions when no specific + customer is selected at this POS terminal join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: country - description: '' + description: Country where this POS profile operates, used to filter or identify + point-of-sale locations by geographic region. - name: disabled - description: '' + description: Indicates whether this POS profile is currently inactive or unavailable + for transactions. - name: warehouse - description: '' + description: Default warehouse from which inventory is drawn for sales made through + this POS profile. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: campaign - description: '' + description: Marketing or promotional campaign associated with this POS profile + for tracking sales by promotion or offer period. join_hint: table: tabCampaign 'on': campaign = tabCampaign.name - name: company_address - description: '' + description: Physical address of the company location where this POS profile operates, + used to identify store or outlet location. join_hint: table: tabAddress 'on': company_address = tabAddress.name - name: applicable_for_users - description: '' + description: Specific users or user roles who are authorized to use this POS profile + for transactions. - name: payments - description: '' + description: Payment methods and modes accepted or configured for point of sale + transactions. - name: hide_images - description: '' + description: Controls whether product images are displayed in the POS interface. - name: hide_unavailable_items - description: '' + description: Controls whether out-of-stock or unavailable products are shown in + the POS interface. - name: auto_add_item_to_cart - description: '' + description: Whether items are automatically added to cart when scanned or selected + at point of sale - name: validate_stock_on_save - description: '' + description: Whether inventory availability is checked before completing a POS + transaction - name: print_receipt_on_order_complete - description: '' + description: Whether receipt automatically prints when a POS order is finalized - name: update_stock - description: '' + description: Whether inventory levels are automatically adjusted when transactions + are processed through this POS profile - name: ignore_pricing_rule - description: '' + description: Whether promotional discounts and pricing rules are bypassed for + sales made using this POS profile - name: allow_rate_change - description: '' + description: Whether cashiers can manually modify item prices during checkout + at this POS terminal - name: allow_discount_change - description: '' + description: Whether cashiers can modify discount amounts during checkout transactions. - name: disable_grand_total_to_default_mop - description: '' + description: Whether the system prevents automatically applying the invoice total + to the default payment method. - name: allow_partial_payment - description: '' + description: Whether customers can pay invoices in multiple installments or split + payments across methods. - name: item_groups - description: '' + description: Specifies which product categories or item groups are allowed or + configured for this POS profile. - name: customer_groups - description: '' + description: Defines which customer segments or groups can transact using this + POS profile. - name: print_format - description: '' + description: Determines the receipt or invoice template layout used when printing + from this POS profile. join_hint: table: tabPrint Format 'on': print_format = tabPrint Format.name - name: letter_head - description: '' + description: Letterhead template used for printed POS receipts and invoices from + this profile join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: tc_name - description: '' + description: Terms and conditions template applied to POS transactions using this + profile join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: select_print_heading - description: '' + description: Custom heading text displayed on printed POS documents instead of + default title join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: selling_price_list - description: '' + description: Price list applied to sales transactions at this POS location to + determine item selling prices join_hint: table: tabPrice List 'on': selling_price_list = tabPrice List.name - name: currency - description: '' + description: Currency in which transactions are processed and recorded at this + POS profile join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: write_off_account - description: '' + description: Account used to record small discrepancies or rounding differences + when closing POS transactions join_hint: table: tabAccount 'on': write_off_account = tabAccount.name - name: write_off_cost_center - description: '' + description: Cost center assigned to write-off transactions when discrepancies + or losses occur at point of sale. join_hint: table: tabCost Center 'on': write_off_cost_center = tabCost Center.name - name: write_off_limit - description: '' + description: Maximum amount that can be written off in a single POS transaction + without requiring additional approval. - name: account_for_change_amount - description: '' + description: General ledger account where cash change given to customers is recorded + during POS transactions. join_hint: table: tabAccount 'on': account_for_change_amount = tabAccount.name - name: disable_rounded_total - description: '' + description: Whether invoice totals should not be rounded to nearest currency + unit at point of sale. - name: income_account - description: '' + description: Default general ledger account where sales revenue from POS transactions + is recorded. join_hint: table: tabAccount 'on': income_account = tabAccount.name - name: expense_account - description: '' + description: Default general ledger account where costs or expenses related to + POS operations are recorded. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: taxes_and_charges - description: '' + description: Tax template or rule set applied to transactions at this point of + sale location join_hint: table: tabSales Taxes and Charges Template 'on': taxes_and_charges = tabSales Taxes and Charges Template.name - name: tax_category - description: '' + description: Classification determining which tax rates apply based on customer + type, product category, or jurisdiction join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: apply_discount_on - description: '' + description: Whether discounts calculate from grand total or net total before + taxes options: - Grand Total - Net Total - name: cost_center - description: '' + description: Cost center to which POS transactions are allocated for accounting + and expense tracking purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Project to which POS transactions are linked for project-based revenue + or cost allocation. join_hint: table: tabProject 'on': project = tabProject.name + desc_done: true - table: tabPOS Profile User description: '' fields: - name: name - description: '' + description: name - name: default - description: '' + description: Indicates whether this is the default POS profile assigned to the + user - name: user - description: '' + description: The specific user account linked to this POS profile assignment join_hint: table: tabUser 'on': user = tabUser.name + desc_done: true - table: tabPOS Search Fields description: '' fields: - name: name - description: '' + description: Descriptive label for the POS search field used when identifying + or filtering available search criteria in point-of-sale transactions. - name: field - description: '' + description: Technical field identifier used when mapping or referencing the actual + database column for POS search operations. - name: fieldname - description: '' + description: System field name used when programmatically accessing or querying + specific POS search attributes in reports or integrations. + desc_done: true - table: tabPOS Settings description: '' fields: - name: name - description: '' + description: Unique identifier for the POS settings configuration or profile name - name: invoice_fields - description: '' + description: Fields displayed or printed on POS invoices and receipts - name: pos_search_fields - description: '' + description: Fields enabled for searching items or customers at the point of sale + terminal + desc_done: true - table: tabPSOA Cost Center description: '' fields: - name: name - description: '' + description: Short identifier or code for the cost center used in queries about + cost center codes or abbreviations - name: cost_center_name - description: '' + description: Full descriptive name of the cost center used when searching by department + name or organizational unit description join_hint: table: tabCost Center 'on': cost_center_name = tabCost Center.name + desc_done: true - table: tabPSOA Project description: '' fields: - name: name - description: '' + description: Unique identifier or code for the project used in system references + and lookups - name: project_name - description: '' + description: Full descriptive title of the project used when searching or filtering + by project description join_hint: table: tabProject 'on': project_name = tabProject.name + desc_done: true - table: tabPackage description: '' fields: - name: name - description: '' + description: Unique identifier or display name for the package used in general + references and listings - name: package_name - description: '' + description: Technical package name used for installation, deployment, or system-level + package identification - name: readme - description: '' + description: Documentation content describing package purpose, usage instructions, + and implementation details - name: license_type - description: '' + description: Category or classification of the software license governing the + package (e.g., MIT, GPL, proprietary). options: - MIT License - GNU General Public License - GNU Affero General Public License - name: license - description: '' + description: Full license text, terms, or detailed licensing information for the + package. + desc_done: true - table: tabPackage Import description: '' fields: - name: name - description: '' + description: Identifier or label of the package being imported - name: activate - description: '' + description: Whether the package should be activated immediately after import - name: force - description: '' + description: Whether to force the import even if conflicts or validation errors + exist - name: log - description: '' + description: Import execution details, errors, warnings, and processing messages + generated during the package import operation. + desc_done: true - table: tabPackage Release description: '' fields: - name: name - description: '' + description: Unique identifier or version label for the package release, used + when tracking specific release versions or querying release history. - name: package - description: '' + description: Reference to the parent package being released, used when filtering + releases by package or analyzing package deployment patterns. join_hint: table: tabPackage 'on': package = tabPackage.name - name: publish - description: '' + description: Indicates whether the release is published or available for deployment, + used when identifying active releases or controlling release visibility. - name: path - description: '' + description: File system location or directory path where the package release + is stored or deployed. - name: major - description: '' + description: Major version number of the package release, indicating significant + changes or breaking updates. - name: minor - description: '' + description: Minor version number of the package release, indicating incremental + improvements or backward-compatible updates. - name: patch - description: '' + description: Patch number or version identifier for incremental updates within + a package release - name: release_notes - description: '' + description: Detailed documentation describing changes, fixes, and new features + included in the package release + desc_done: true - table: tabPacked Item description: '' fields: - name: name - description: '' + description: Unique identifier for the packed item configuration - name: parent_item - description: '' + description: The main item or bundle that contains this packed item as a component join_hint: table: tabItem 'on': parent_item = tabItem.name - name: item_code - description: '' + description: The specific item being packed or included within the parent item join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Name of the packed item product or SKU being stored or shipped. - name: description - description: '' + description: Detailed text description or specifications of the packed item. - name: warehouse - description: '' + description: Warehouse location where the packed item is stored or managed. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: target_warehouse - description: '' + description: Warehouse where the packed item will be stored or delivered after + packing. join_hint: table: tabWarehouse 'on': target_warehouse = tabWarehouse.name - name: conversion_factor - description: '' + description: Multiplier used to convert between the packed item's unit of measure + and the base unit. - name: qty - description: '' + description: Quantity of the item in the packed configuration or bundle. - name: rate - description: '' + description: Price or cost per unit for this packed item in the bundle or package. - name: uom - description: '' + description: Unit of measurement for the packed item quantity (e.g., box, kg, + pieces). join_hint: table: tabUOM 'on': uom = tabUOM.name - name: use_serial_batch_fields - description: '' + description: Whether this packed item requires serial number or batch tracking + for inventory control. - name: serial_and_batch_bundle - description: '' + description: Bundle identifier linking multiple serial numbers or batch numbers + together for a packed item shipment or transaction. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: delivered_by_supplier - description: '' + description: Supplier or vendor name that physically delivered this packed item + to the warehouse or customer. - name: serial_no - description: '' + description: Unique serial number assigned to an individual packed item unit for + tracking and identification purposes. - name: batch_no - description: '' + description: Batch number assigned to the packed items for tracking and traceability + purposes. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: actual_batch_qty - description: '' + description: Actual quantity of items packed at the batch level, representing + the total count for the entire batch. - name: actual_qty - description: '' + description: Actual quantity of individual items packed, representing the item-level + count within the packing operation. - name: projected_qty - description: '' + description: Estimated or planned quantity expected to be packed for this item. - name: ordered_qty - description: '' + description: Quantity of this item that was originally ordered by the customer. - name: packed_qty - description: '' + description: Actual quantity of this item that has been physically packed and + ready for shipment. - name: incoming_rate - description: '' + description: Rate or price per unit of the item when it was received or purchased + into inventory. - name: picked_qty - description: '' + description: Quantity of the item that has been physically picked from warehouse + or inventory for packing. - name: page_break - description: '' + description: Indicates whether a page break should occur before this item when + printing packing documents or lists. - name: prevdoc_doctype - description: '' + description: Document type of the source document that was packed, such as Sales + Order or Delivery Note. - name: parent_detail_docname - description: '' + description: Reference to the specific line item from the parent document that + this packed item corresponds to. + desc_done: true - table: tabPacking Slip description: Generate packing slips for packages to be delivered. Used to notify package number, package contents and its weight. fields: - name: name - description: '' + description: Unique identifier for the packing slip document - name: delivery_note - description: '' + description: Reference to the associated delivery note document that this packing + slip was created from join_hint: table: tabDelivery Note 'on': delivery_note = tabDelivery Note.name - name: naming_series - description: '' + description: Prefix pattern used to generate the packing slip number options: - MAT-PAC-.YYYY.- - name: from_case_no - description: '' + description: Starting case number in a range of cases included in this packing + slip shipment. - name: to_case_no - description: '' + description: Ending case number in a range of cases included in this packing slip + shipment. - name: items - description: '' + description: Line items or products included in the packing slip for this shipment. - name: net_weight_pkg - description: '' + description: Weight of packaged goods excluding packaging materials, used when + calculating shipping costs or verifying product weight without container. - name: net_weight_uom - description: '' + description: Unit of measurement for net weight (kg, lbs, etc), used when interpreting + or converting net weight values. join_hint: table: tabUOM 'on': net_weight_uom = tabUOM.name - name: gross_weight_pkg - description: '' + description: Total weight of packaged goods including all packaging materials, + used when determining actual shipping weight or handling requirements. - name: gross_weight_uom - description: '' + description: Unit of measurement for the total weight of the packed shipment including + packaging materials. join_hint: table: tabUOM 'on': gross_weight_uom = tabUOM.name - name: letter_head - description: '' + description: Letterhead template applied to the printed packing slip document + for branding. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: amended_from - description: '' + description: Reference to the original packing slip document that this version + corrects or replaces. join_hint: table: tabPacking Slip 'on': amended_from = tabPacking Slip.name + desc_done: true - table: tabPacking Slip Item description: '' fields: - name: name - description: '' + description: Unique identifier for the packing slip item record - name: item_code - description: '' + description: SKU or product code for the item being packed and shipped join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Human-readable product name or description of the item being packed - name: batch_no - description: '' + description: Batch or lot number assigned to the items being packed for traceability + and inventory tracking purposes. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: description - description: '' + description: Text description of the specific item included in the packing slip. - name: qty - description: '' + description: Quantity of the item being shipped or packed in this packing slip + line. - name: net_weight - description: '' + description: Weight of the item excluding packaging, used when calculating shipping + costs or verifying actual product weight. - name: stock_uom - description: '' + description: Unit of measure for inventory tracking and stock quantities, such + as pieces, boxes, or kilograms. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: weight_uom - description: '' + description: Unit of measure specifically for the net_weight field, such as kg, + lbs, or grams. join_hint: table: tabUOM 'on': weight_uom = tabUOM.name - name: page_break - description: '' + description: Indicates whether a page break should occur before this item when + printing the packing slip. - name: dn_detail - description: '' + description: Links this packing slip item to the corresponding delivery note item + detail. - name: pi_detail - description: '' + description: Links this packing slip item to the corresponding purchase invoice + item detail. + desc_done: true - table: tabPage description: '' fields: - name: name - description: '' + description: Unique identifier or title of the page used to reference specific + pages in navigation and access control queries. - name: system_page - description: '' + description: Flag indicating whether the page is a core system page versus custom + page, used to filter standard functionality from customizations. - name: page_name - description: '' + description: Display label or human-readable name of the page used when searching + for pages by their visible title in the user interface. - name: title - description: '' + description: The display name or heading of the page shown to users in navigation + and interfaces. - name: icon - description: '' + description: The visual symbol or graphic identifier representing the page in + menus and navigation. - name: module - description: '' + description: The functional area or application section that the page belongs + to, used to group related pages together. join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: restrict_to_domain - description: '' + description: Domain restriction setting that limits page access to specific domains + or subdomains. join_hint: table: tabDomain 'on': restrict_to_domain = tabDomain.name - name: standard - description: '' + description: Indicates whether the page is a standard system page or a custom + user-created page. options: - 'Yes' - 'No' - name: roles - description: '' + description: User roles that have permission to access or view this page. + desc_done: true - table: tabParty Account description: '' fields: - name: name - description: '' + description: Unique identifier for the party-account relationship record used + when querying specific party-account linkages or filtering relationship data. - name: company - description: '' + description: Company entity that owns this party-account relationship, used when + filtering multi-company data or analyzing party relationships within specific + organizational units. join_hint: table: tabCompany 'on': company = tabCompany.name - name: account - description: '' + description: The accounting ledger account linked to this party, used when querying + receivables/payables balances, generating financial reports, or analyzing party-specific + transactions. join_hint: table: tabAccount 'on': account = tabAccount.name - name: advance_account - description: '' + description: Account used to record advance payments made to or received from + this party before goods or services are delivered. join_hint: table: tabAccount 'on': advance_account = tabAccount.name + desc_done: true - table: tabParty Link description: '' fields: - name: name - description: '' + description: Unique identifier or label for the party link relationship between + two entities - name: primary_role - description: '' + description: Defines the main business function or relationship type of the first + party in the link join_hint: table: tabDocType 'on': primary_role = tabDocType.name - name: secondary_role - description: '' + description: Defines the complementary business function or relationship type + of the second party in the link join_hint: table: tabDocType 'on': secondary_role = tabDocType.name - name: primary_party - description: '' + description: Main party in a relationship between two parties, typically the parent + company, controlling entity, or primary account holder - name: secondary_party - description: '' + description: Related party in a relationship between two parties, typically the + subsidiary, dependent entity, or linked account + desc_done: true - table: tabParty Specific Item description: '' fields: - name: name - description: '' + description: Unique identifier for the party-specific item configuration that + links a particular item to a specific customer or supplier. - name: party_type - description: '' + description: Specifies whether this item configuration applies to a Customer or + Supplier relationship. options: - Customer - Supplier - name: party - description: '' + description: The specific customer or supplier for whom this item has special + pricing, terms, or restrictions. - name: restrict_based_on - description: '' + description: Specifies the field or attribute type used to restrict which items + are available for a specific party, such as by item group, brand, or category. options: - Item - Item Group - Brand - name: based_on_value - description: '' + description: The actual value of the restriction criterion that determines item + availability for the party, such as a specific item group name or brand identifier. + desc_done: true - table: tabParty Type description: '' fields: - name: name - description: '' + description: name - name: party_type - description: '' + description: party_type join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: account_type - description: '' + description: account_type options: - Payable - Receivable + desc_done: true - table: tabPatch Log description: List of patches executed fields: - name: name - description: '' + description: name - name: patch - description: '' + description: Identifier or version number of the software patch or update applied + to the system - name: skipped - description: '' + description: Indicates whether the patch was intentionally bypassed or not applied + during the update process - name: traceback - description: '' + description: Full error stack trace showing the sequence of function calls and + code locations that led to a patch failure or exception + desc_done: true - table: tabPause SLA On Status description: '' fields: - name: name - description: '' + description: Unique identifier or label for the pause SLA configuration rule - name: status - description: '' + description: The specific status value that triggers SLA timer pause when a record + enters this status + desc_done: true - table: tabPayment Entry description: '' fields: - name: name - description: '' + description: Unique identifier for the payment entry transaction - name: naming_series - description: '' + description: Prefix pattern used to auto-generate payment entry names options: - ACC-PAY-.YYYY.- - name: payment_type - description: '' + description: Whether the payment is a receipt from customer, payment to supplier, + or internal transfer between accounts options: - Receive - Pay - Internal Transfer - name: payment_order_status - description: '' + description: Status of the payment order workflow such as initiated, approved, + or completed. options: - Initiated - Payment Ordered - name: posting_date - description: '' + description: Accounting date when the payment transaction is recorded in the general + ledger. - name: company - description: '' + description: Legal entity or business unit that made or received the payment. join_hint: table: tabCompany 'on': company = tabCompany.name - name: mode_of_payment - description: '' + description: Payment method used such as cash, check, credit card, bank transfer, + or wire transfer. join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: party_type - description: '' + description: Type of entity making or receiving payment such as Customer, Supplier, + Employee, or Shareholder. join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: party - description: '' + description: Specific entity name making or receiving the payment corresponding + to the party type. - name: party_name - description: '' + description: Name of the customer or supplier who is making or receiving the payment. - name: book_advance_payments_in_separate_party_account - description: '' + description: Indicates whether advance payments are recorded in a dedicated account + separate from regular receivables or payables. - name: reconcile_on_advance_payment_date - description: '' + description: Indicates whether the payment reconciliation uses the advance payment + date instead of the invoice date. - name: bank_account - description: '' + description: Company's own bank account used for receiving or disbursing payment + funds in this transaction. join_hint: table: tabBank Account 'on': bank_account = tabBank Account.name - name: party_bank_account - description: '' + description: Customer's or supplier's bank account used for receiving or sending + payment funds in this transaction. join_hint: table: tabBank Account 'on': party_bank_account = tabBank Account.name - name: contact_person - description: '' + description: Specific individual at the customer or supplier organization associated + with this payment transaction. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_email - description: '' + description: Email address of the party (customer or supplier) associated with + this payment transaction. - name: party_balance - description: '' + description: Outstanding balance amount of the party after this payment is applied. - name: paid_from - description: '' + description: Source account from which the payment amount is debited or withdrawn. join_hint: table: tabAccount 'on': paid_from = tabAccount.name - name: paid_from_account_type - description: '' + description: Classification of the source account from which payment was made, + such as bank, cash, or credit card account. - name: paid_from_account_currency - description: '' + description: Currency denomination of the source account from which the payment + was disbursed. join_hint: table: tabCurrency 'on': paid_from_account_currency = tabCurrency.name - name: paid_from_account_balance - description: '' + description: Available balance in the source account at the time of payment or + after payment execution. - name: paid_to - description: '' + description: The account receiving the payment funds (bank account, cash account, + or party account). join_hint: table: tabAccount 'on': paid_to = tabAccount.name - name: paid_to_account_type - description: '' + description: The classification of the receiving account (e.g., Bank, Cash, Receivable, + Payable). - name: paid_to_account_currency - description: '' + description: The currency denomination of the receiving account. join_hint: table: tabCurrency 'on': paid_to_account_currency = tabCurrency.name - name: paid_to_account_balance - description: '' + description: Balance in the destination account after this payment was credited + or debited. - name: paid_amount - description: '' + description: Total amount paid before applying any taxes or deductions. - name: paid_amount_after_tax - description: '' + description: Net amount paid after taxes have been applied or withheld. - name: source_exchange_rate - description: '' + description: Exchange rate between the source currency and company base currency + at the time of payment entry. - name: base_paid_amount - description: '' + description: Total payment amount converted to company base currency before applying + any tax adjustments. - name: base_paid_amount_after_tax - description: '' + description: Total payment amount converted to company base currency after including + tax withholdings or deductions. - name: received_amount - description: '' + description: Total amount received from customer or paid to supplier before applying + any withholding tax deductions. - name: received_amount_after_tax - description: '' + description: Net amount received or paid after deducting withholding taxes from + the received amount. - name: target_exchange_rate - description: '' + description: Exchange rate used to convert payment amount from source currency + to target company currency. - name: base_received_amount - description: '' + description: Total amount received in company base currency before tax adjustments + or deductions. - name: base_received_amount_after_tax - description: '' + description: Total amount received in company base currency after applying tax + withholdings or deductions. - name: references - description: '' + description: Related documents or transactions linked to this payment such as + invoices, orders, or other payment entries. - name: total_allocated_amount - description: '' + description: Total amount from this payment that has been allocated or applied + against invoices, bills, or other documents in the payment's currency. - name: base_total_allocated_amount - description: '' + description: Total amount from this payment that has been allocated or applied + against invoices, bills, or other documents converted to the company's base + currency. - name: unallocated_amount - description: '' + description: Remaining payment amount that has not yet been allocated or applied + to any invoices, bills, or other documents. - name: difference_amount - description: '' + description: Variance between allocated payment amount and total references when + payment entry does not fully reconcile - name: purchase_taxes_and_charges_template - description: '' + description: Tax template applied to supplier payments or purchase-related payment + entries join_hint: table: tabPurchase Taxes and Charges Template 'on': purchase_taxes_and_charges_template = tabPurchase Taxes and Charges Template.name - name: sales_taxes_and_charges_template - description: '' + description: Tax template applied to customer payments or sales-related payment + entries join_hint: table: tabSales Taxes and Charges Template 'on': sales_taxes_and_charges_template = tabSales Taxes and Charges Template.name - name: apply_tax_withholding_amount - description: '' + description: Whether tax withholding is applied to this payment, relevant when + users ask about payments with or without tax withholding deductions. - name: tax_withholding_category - description: '' + description: The specific tax withholding category applied to the payment, used + when users need to filter or report payments by withholding tax type. join_hint: table: tabTax Withholding Category 'on': tax_withholding_category = tabTax Withholding Category.name - name: taxes - description: '' + description: Tax line items or tax details associated with the payment, relevant + when users ask about tax amounts, tax breakdowns, or tax components of payments. - name: base_total_taxes_and_charges - description: '' + description: Total amount of all taxes and charges applied to the payment in base + currency, used when analyzing tax components across multi-currency payments. - name: total_taxes_and_charges - description: '' + description: Total amount of all taxes and charges applied to the payment in transaction + currency, used when calculating total payment costs including fees and taxes. - name: deductions - description: '' + description: Total amount deducted or withheld from the payment such as TDS or + other withholdings, used when reconciling net payment amounts. - name: reference_no - description: '' + description: External reference number from bank transaction, check number, or + payment gateway transaction ID used to reconcile payments with bank statements. - name: reference_date - description: '' + description: Date on the external payment document or transaction, such as check + date or bank transfer date, which may differ from the posting date. - name: clearance_date - description: '' + description: Date when the payment was cleared or reconciled in the bank account, + used to track which payments have been matched with bank statements. - name: project - description: '' + description: Project associated with the payment transaction for tracking project-specific + expenses and revenues. join_hint: table: tabProject 'on': project = tabProject.name - name: cost_center - description: '' + description: Cost center allocation for the payment to track departmental or functional + area financial activity. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: status - description: '' + description: Current state of the payment entry such as draft, submitted, or cancelled. options: - Draft - Submitted - Cancelled - name: custom_remarks - description: '' + description: Custom or additional notes specific to business-defined payment workflows + or special instructions not captured in standard remarks. - name: remarks - description: '' + description: Standard internal notes or comments about the payment transaction + for general reference. - name: base_in_words - description: '' + description: Payment amount expressed in words in the base currency for check + printing or formal documentation. - name: is_opening - description: '' + description: Indicates whether this payment entry is an opening balance entry + for migration or initial setup purposes. options: - 'No' - 'Yes' - name: letter_head - description: '' + description: The letterhead template to be used when printing this payment entry + document. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: print_heading - description: '' + description: Custom heading text that appears on the printed version of this payment + entry instead of the default title. join_hint: table: tabPrint Heading 'on': print_heading = tabPrint Heading.name - name: bank - description: '' + description: Bank institution where the payment is processed or received from. - name: bank_account_no - description: '' + description: Account number at the bank used for this payment transaction. - name: payment_order - description: '' + description: Reference number or identifier linking this payment to a specific + payment order or instruction. join_hint: table: tabPayment Order 'on': payment_order = tabPayment Order.name - name: in_words - description: '' + description: Amount of the payment expressed as text in words, used when users + ask for written-out payment amounts. - name: auto_repeat - description: '' + description: Links to recurring payment schedule configuration when users ask + about automated or repeating payments. join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: amended_from - description: '' + description: References the original payment entry that was corrected or modified, + used when users ask about payment corrections or amendments. join_hint: table: tabPayment Entry 'on': amended_from = tabPayment Entry.name - name: title - description: '' + description: User-defined label or reference name for the payment entry to identify + its purpose or context + desc_done: true - table: tabPayment Entry Deduction description: '' fields: - name: name - description: '' + description: Unique identifier for the specific deduction line item applied to + a payment entry - name: account - description: '' + description: General ledger account to which this deduction amount is posted join_hint: table: tabAccount 'on': account = tabAccount.name - name: cost_center - description: '' + description: Cost center assigned to track this deduction for departmental or + project-based expense allocation join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: amount - description: '' + description: Deduction amount subtracted from the payment entry total. - name: is_exchange_gain_loss - description: '' + description: Indicates whether this deduction represents a foreign exchange gain + or loss adjustment. - name: description - description: '' + description: Explanation or reason for the deduction applied to the payment. + desc_done: true - table: tabPayment Entry Reference description: '' fields: - name: name - description: '' + description: Unique identifier for the payment entry reference record - name: reference_doctype - description: '' + description: Type of document being referenced by this payment entry, such as + Sales Invoice, Purchase Invoice, or Journal Entry join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_name - description: '' + description: Specific document ID or number of the referenced transaction that + this payment is allocated against - name: due_date - description: '' + description: Date when the referenced invoice or bill payment is expected or required + to be paid. - name: bill_no - description: '' + description: Identifier of the supplier bill or purchase invoice being paid or + referenced in this payment entry. - name: payment_term - description: '' + description: Credit terms or payment schedule applied to the referenced document, + such as Net 30 or immediate payment. join_hint: table: tabPayment Term 'on': payment_term = tabPayment Term.name - name: payment_term_outstanding - description: '' + description: Outstanding amount remaining for a specific payment term in the payment + entry reference. - name: account_type - description: '' + description: Type of account associated with the payment reference (e.g., receivable, + payable, bank). - name: payment_type - description: '' + description: Classification of payment method or transaction type (e.g., cash, + credit, advance) for the referenced payment. - name: reconcile_effect_on - description: '' + description: Indicates whether the payment reconciliation affects the receivable + or payable account balance. - name: total_amount - description: '' + description: The full original amount of the referenced invoice or document being + paid against. - name: outstanding_amount - description: '' + description: The remaining unpaid balance on the referenced invoice or document + after this payment is applied. - name: allocated_amount - description: '' + description: Amount of payment allocated to a specific invoice or reference document + in the payment's currency. - name: exchange_rate - description: '' + description: Currency conversion rate applied when payment currency differs from + the reference document currency. - name: exchange_gain_loss - description: '' + description: Realized gain or loss amount resulting from currency exchange rate + differences between payment and reference document. - name: account - description: '' + description: The general ledger account associated with this payment entry line + item for accounting purposes. join_hint: table: tabAccount 'on': account = tabAccount.name - name: payment_request - description: '' + description: Links to the payment request document that this payment entry is + fulfilling or referencing. join_hint: table: tabPayment Request 'on': payment_request = tabPayment Request.name - name: payment_request_outstanding - description: '' + description: The remaining unpaid amount on the referenced payment request after + this payment entry is applied. - name: advance_voucher_type - description: '' + description: Document type of the advance payment voucher being referenced or + adjusted in this payment entry. join_hint: table: tabDocType 'on': advance_voucher_type = tabDocType.name - name: advance_voucher_no - description: '' + description: Document number of the specific advance payment voucher being referenced + or adjusted in this payment entry. + desc_done: true - table: tabPayment Gateway Account description: '' fields: - name: name - description: '' + description: Unique identifier or label for the payment gateway account configuration - name: payment_gateway - description: '' + description: The third-party payment provider or service (e.g., Stripe, PayPal, + Razorpay) used for processing transactions join_hint: table: tabPayment Gateway 'on': payment_gateway = tabPayment Gateway.name - name: payment_channel - description: '' + description: The specific payment method or channel type (e.g., credit card, bank + transfer, digital wallet) supported by this account options: - Email - Phone - name: company - description: '' + description: Company entity that owns and operates this payment gateway account + for processing transactions. join_hint: table: tabCompany 'on': company = tabCompany.name - name: is_default - description: '' + description: Indicates whether this payment gateway account is automatically selected + for new payment transactions. - name: payment_account - description: '' + description: General ledger account where funds from this payment gateway are + recorded in the chart of accounts. join_hint: table: tabAccount 'on': payment_account = tabAccount.name - name: currency - description: '' + description: Currency in which this payment gateway account processes transactions + and settles funds. - name: message - description: '' + description: Status or error message from the payment gateway regarding account + configuration or connectivity issues. + desc_done: true - table: tabPayment Ledger Entry description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the payment ledger entry - name: posting_date - description: '' + description: Date when the payment transaction was officially recorded in the + accounting books - name: company - description: '' + description: Legal entity or business unit to which the payment transaction belongs join_hint: table: tabCompany 'on': company = tabCompany.name - name: account_type - description: '' + description: Classifies whether the payment relates to a bank account, cash account, + or other financial account type. options: - Receivable - Payable - name: account - description: '' + description: The specific financial account (bank or cash) where the payment transaction + was recorded. join_hint: table: tabAccount 'on': account = tabAccount.name - name: party_type - description: '' + description: Identifies whether the payment counterparty is a customer, supplier, + employee, or other entity type. join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: party - description: '' + description: Customer or supplier name associated with the payment transaction - name: due_date - description: '' + description: Date when the payment is expected or required to be settled - name: voucher_detail_no - description: '' + description: Reference number linking to the specific voucher or transaction document - name: cost_center - description: '' + description: Department or business unit to which the payment is allocated for + expense tracking and budgeting purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: finance_book - description: '' + description: Accounting book or ledger set used when maintaining multiple parallel + accounting records for different reporting standards or entities. join_hint: table: tabFinance Book 'on': finance_book = tabFinance Book.name - name: voucher_type - description: '' + description: Category of the source transaction document that created this payment + entry, such as Payment Entry, Journal Entry, or Sales Invoice. join_hint: table: tabDocType 'on': voucher_type = tabDocType.name - name: voucher_no - description: '' + description: Unique identifier for the payment transaction document being recorded + in this ledger entry. - name: against_voucher_type - description: '' + description: Type of original document this payment is settling, such as Sales + Invoice, Purchase Invoice, or Journal Entry. join_hint: table: tabDocType 'on': against_voucher_type = tabDocType.name - name: against_voucher_no - description: '' + description: Specific document number of the original transaction being paid or + settled by this payment. - name: amount - description: '' + description: Payment amount in the transaction currency used when asking about + payment values, totals, or filtering by payment size. - name: account_currency - description: '' + description: Currency of the general ledger account receiving or disbursing the + payment, relevant when reconciling payments to account balances in specific + currencies. join_hint: table: tabCurrency 'on': account_currency = tabCurrency.name - name: amount_in_account_currency - description: '' + description: Payment amount converted to the general ledger account's currency, + used when analyzing payments in the context of account-level reporting or multi-currency + reconciliation. - name: delinked - description: '' + description: Indicates whether this payment ledger entry has been disconnected + from its original invoice or transaction reference. - name: remarks - description: '' + description: Free-text notes or comments about this specific payment ledger entry + for additional context or explanations. + desc_done: true - table: tabPayment Order description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the payment order used + when searching for or referencing a specific payment order transaction - name: naming_series - description: '' + description: Prefix pattern or series code that determines how payment order names + are auto-generated for organizational categorization options: - PMO- - name: company - description: '' + description: The specific company entity that owns or processes this payment order, + used to filter payment orders by business unit or legal entity join_hint: table: tabCompany 'on': company = tabCompany.name - name: payment_order_type - description: '' + description: Type of payment order such as outgoing payment, incoming payment, + or internal transfer used to categorize the payment transaction purpose. options: - Payment Request - Payment Entry - name: party - description: '' + description: The external entity (supplier, customer, or other third party) involved + in the payment transaction. join_hint: table: tabSupplier 'on': party = tabSupplier.name - name: posting_date - description: '' + description: The accounting date when the payment order is recorded in the financial + books for period-specific financial reporting. - name: company_bank - description: '' + description: The bank institution where the company holds the account used for + this payment order. join_hint: table: tabBank 'on': company_bank = tabBank.name - name: company_bank_account - description: '' + description: The specific company bank account number or identifier from which + the payment will be made. join_hint: table: tabBank Account 'on': company_bank_account = tabBank Account.name - name: account - description: '' + description: The general ledger account or accounting code to which this payment + order is posted for financial tracking. - name: references - description: '' + description: External reference number or identifier from the payer or payment + gateway used to track or reconcile this payment order. - name: amended_from - description: '' + description: Links to the original payment order document that this payment order + amends or corrects. join_hint: table: tabPayment Order 'on': amended_from = tabPayment Order.name + desc_done: true - table: tabPayment Order Reference description: '' fields: - name: name - description: '' + description: Unique identifier for the payment order reference record used when + linking payments to specific transactions. - name: reference_doctype - description: '' + description: Specifies the type of document being referenced by the payment order + such as Purchase Invoice or Sales Invoice. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_name - description: '' + description: Identifies the specific document instance being paid or referenced + in the payment order transaction. - name: amount - description: '' + description: Monetary value of the payment order reference, used when querying + payment amounts or financial totals. - name: supplier - description: '' + description: Vendor or supplier associated with this payment order reference, + used to identify who is being paid. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: payment_request - description: '' + description: Link to the originating payment request that this order reference + fulfills or responds to. join_hint: table: tabPayment Request 'on': payment_request = tabPayment Request.name - name: mode_of_payment - description: '' + description: Payment method used for the transaction such as cash, credit card, + bank transfer, or check. join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: bank_account - description: '' + description: Specific bank account from which the payment was made or to which + it was received. join_hint: table: tabBank Account 'on': bank_account = tabBank Account.name - name: account - description: '' + description: General ledger account to which this payment is posted for accounting + purposes. join_hint: table: tabAccount 'on': account = tabAccount.name - name: payment_reference - description: '' + description: Unique identifier or reference number for the payment transaction + used to track and reconcile specific payments. + desc_done: true - table: tabPayment Request description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the payment request used + when searching for or referencing a specific payment request - name: payment_request_type - description: '' + description: Category or classification of the payment request such as vendor + payment, employee reimbursement, or advance payment used to filter or group + payment requests by purpose options: - Outward - Inward - name: transaction_date - description: '' + description: Date when the payment request was created or submitted used to find + payment requests within specific time periods or fiscal periods - name: naming_series - description: '' + description: Identifier prefix or pattern used when users search for payment requests + by document number format or series code options: - ACC-PRQ-.YYYY.- - name: company - description: '' + description: Company entity that issued the payment request, used when filtering + payment requests by organizational unit or legal entity join_hint: table: tabCompany 'on': company = tabCompany.name - name: mode_of_payment - description: '' + description: Payment method or channel for the transaction such as credit card, + bank transfer, cash, or digital wallet join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: party_type - description: '' + description: Category of the entity making or receiving the payment request such + as Customer, Supplier, Employee, or Shareholder. join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: party - description: '' + description: Unique identifier or code of the specific entity associated with + the payment request. - name: party_name - description: '' + description: Full display name of the entity making or receiving the payment request + for human-readable identification. - name: reference_doctype - description: '' + description: Type of source document that triggered this payment request such + as Sales Invoice or Purchase Order join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_name - description: '' + description: Specific document ID or number of the source transaction that this + payment request is linked to - name: grand_total - description: '' + description: Total payment amount requested including all taxes and charges - name: currency - description: '' + description: Currency in which the payment request amount is denominated and must + be paid. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: is_a_subscription - description: '' + description: Indicates whether this payment request is part of a recurring subscription + arrangement rather than a one-time payment. - name: outstanding_amount - description: '' + description: Remaining unpaid balance on the payment request after partial payments + or credits have been applied. - name: party_account_currency - description: '' + description: Currency used for the party's account in this payment request, relevant + when users ask about payment currency or multi-currency transactions. join_hint: table: tabCurrency 'on': party_account_currency = tabCurrency.name - name: subscription_plans - description: '' + description: Subscription plans associated with this payment request, used when + users query payments linked to specific recurring subscription services. - name: bank_account - description: '' + description: Bank account designated for receiving or processing this payment, + relevant when users ask which account funds should be transferred to or from. join_hint: table: tabBank Account 'on': bank_account = tabBank Account.name - name: bank - description: '' + description: Bank institution where payment will be sent or received for this + payment request. join_hint: table: tabBank 'on': bank = tabBank.name - name: bank_account_no - description: '' + description: Specific account number at the bank for processing this payment request. - name: account - description: '' + description: General ledger account code for recording the financial transaction + of this payment request. - name: iban - description: '' + description: International Bank Account Number for cross-border payments and identifying + beneficiary accounts in SEPA regions - name: branch_code - description: '' + description: Bank branch identifier for domestic routing and locating the specific + branch where an account is held - name: swift_number - description: '' + description: Bank Identifier Code for international wire transfers and identifying + financial institutions globally - name: cost_center - description: '' + description: Department or business unit responsible for the payment expense for + budgeting and financial tracking purposes join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Specific project to which the payment request is allocated for project-based + accounting and cost allocation join_hint: table: tabProject 'on': project = tabProject.name - name: print_format - description: '' + description: Template layout used when generating printed or PDF versions of the + payment request document - name: email_to - description: '' + description: Recipient email address for payment request notifications or invoices + sent to customers or vendors - name: subject - description: '' + description: Email subject line or payment request title describing the purpose + or reference of the payment - name: payment_gateway_account - description: '' + description: Specific payment gateway or merchant account used to process this + payment request transaction join_hint: table: tabPayment Gateway Account 'on': payment_gateway_account = tabPayment Gateway Account.name - name: status - description: '' + description: Current approval or processing state of the payment request such + as draft, pending, approved, or paid. options: - Draft - Requested @@ -16805,377 +20608,480 @@ tables: - Failed - Cancelled - name: make_sales_invoice - description: '' + description: Indicates whether a sales invoice should be automatically created + from this payment request. - name: message - description: '' + description: User-entered notes or comments explaining the purpose or details + of the payment request. - name: mute_email - description: '' + description: Whether email notifications are suppressed for this payment request. - name: payment_url - description: '' + description: The web link where the customer can view or complete the payment + online. - name: payment_gateway - description: '' + description: The third-party payment processor or gateway used to process this + payment request, such as Stripe, PayPal, or Razorpay. - name: payment_account - description: '' + description: Bank account or financial account from which the payment will be + debited or to which it will be credited. - name: payment_channel - description: '' + description: Method or platform through which the payment is processed, such as + wire transfer, ACH, credit card, or online payment gateway. options: - Email - Phone - name: payment_order - description: '' + description: Reference to the specific order or transaction that this payment + request is intended to settle or fulfill. join_hint: table: tabPayment Order 'on': payment_order = tabPayment Order.name - name: amended_from - description: '' + description: References the original payment request that this document amends + or replaces when corrections are made. join_hint: table: tabPayment Request 'on': amended_from = tabPayment Request.name - name: phone_number - description: '' + description: Contact phone number for the person or entity associated with this + payment request. + desc_done: true - table: tabPayment Schedule description: '' fields: - name: name - description: '' + description: Unique identifier for the payment schedule used to reference specific + payment timing arrangements in contracts and invoices. - name: payment_term - description: '' + description: Defines the payment term or condition associated with this schedule, + used when filtering or matching payment due date calculations. join_hint: table: tabPayment Term 'on': payment_term = tabPayment Term.name - name: description - description: '' + description: Provides additional details about the payment schedule terms, used + when users need to understand payment timing rules or conditions. - name: due_date - description: '' + description: Date when a scheduled payment installment is expected to be paid + by the customer - name: invoice_portion - description: '' + description: Percentage or amount of the total invoice allocated to this specific + payment installment - name: mode_of_payment - description: '' + description: Payment method specified for this scheduled installment such as cash, + check, wire transfer, or credit card join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: due_date_based_on - description: '' + description: Determines the reference date from which payment due dates are calculated + (e.g., invoice date, posting date, delivery date). options: - Day(s) after invoice date - Day(s) after the end of the invoice month - Month(s) after the end of the invoice month - name: credit_days - description: '' + description: Number of days added to the reference date to calculate the payment + due date. - name: credit_months - description: '' + description: Number of months added to the reference date to calculate the payment + due date, typically used for longer payment terms. - name: discount_date - description: '' + description: Date by which payment must be made to qualify for early payment discount - name: discount - description: '' + description: Discount amount or percentage applied when payment is made by the + discount date - name: discount_type - description: '' + description: Indicates whether discount is a percentage or fixed amount options: - Percentage - Amount - name: discount_validity_based_on - description: '' + description: Determines whether the discount expiration is calculated from invoice + date, posting date, or another reference date. options: - Day(s) after invoice date - Day(s) after the end of the invoice month - Month(s) after the end of the invoice month - name: discount_validity - description: '' + description: Number of days or specific date until which the early payment discount + remains valid. - name: payment_amount - description: '' + description: The actual monetary amount due or scheduled to be paid for this installment. - name: outstanding - description: '' + description: Remaining unpaid balance on a scheduled payment after accounting + for payments and discounts - name: paid_amount - description: '' + description: Total amount already paid toward this scheduled payment installment - name: discounted_amount - description: '' + description: Amount reduced from the scheduled payment due to early payment discounts + or other reductions - name: base_payment_amount - description: '' + description: Total scheduled payment amount in base currency for this installment + before any payments are applied. - name: base_outstanding - description: '' + description: Remaining unpaid balance in base currency for this scheduled payment + after partial or full payments. - name: base_paid_amount - description: '' + description: Actual amount paid in base currency against this scheduled payment + installment. + desc_done: true - table: tabPayment Term description: '' fields: - name: name - description: '' + description: Unique identifier for the payment term used when referencing specific + payment arrangements in queries about contract terms or invoice schedules. - name: payment_term_name - description: '' + description: Descriptive label of the payment term used when searching for payment + conditions like 'Net 30' or 'Due on Receipt' in vendor or customer agreements. - name: invoice_portion - description: '' + description: Percentage or amount of invoice due under this term, used when analyzing + partial payment schedules or milestone-based billing structures. - name: mode_of_payment - description: '' + description: Payment method associated with this term such as cash, check, wire + transfer, or credit card join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: due_date_based_on - description: '' + description: Reference date used to calculate payment due date, typically posting + date or invoice date options: - Day(s) after invoice date - Day(s) after the end of the invoice month - Month(s) after the end of the invoice month - name: credit_days - description: '' + description: Number of days allowed from the reference date until payment is due - name: credit_months - description: '' + description: Number of months allowed for payment after invoice date - name: discount_type - description: '' + description: Whether the discount is a percentage or fixed amount options: - Percentage - Amount - name: discount - description: '' + description: Early payment discount value applied when payment terms are met - name: discount_validity_based_on - description: '' + description: Defines whether the discount period is calculated from invoice date, + month end, or other reference point for early payment terms. options: - Day(s) after invoice date - Day(s) after the end of the invoice month - Month(s) after the end of the invoice month - name: discount_validity - description: '' + description: Number of days or periods within which the customer must pay to receive + the early payment discount. - name: description - description: '' + description: Human-readable explanation or label for the payment term arrangement + shown to users and on documents. + desc_done: true - table: tabPayment Terms Template description: '' fields: - name: name - description: '' + description: Unique identifier for the payment terms template record used in lookups + and references. - name: template_name - description: '' + description: Display name of the payment terms template used when selecting payment + schedules for invoices or purchase orders. - name: allocate_payment_based_on_payment_terms - description: '' + description: Flag indicating whether payment amounts should be automatically distributed + according to the defined payment term schedule rather than manual allocation. - name: terms - description: '' + description: Payment terms template name or identifier that users reference when + asking about specific payment conditions, discount schedules, or credit arrangements. + desc_done: true - table: tabPayment Terms Template Detail description: '' fields: - name: name - description: '' + description: name - name: payment_term - description: '' + description: The specific payment term code or identifier being configured in + this template detail line join_hint: table: tabPayment Term 'on': payment_term = tabPayment Term.name - name: description - description: '' + description: Explanatory text describing the purpose or conditions of this payment + term template detail - name: invoice_portion - description: '' + description: Percentage or portion of the invoice amount allocated to this payment + installment. - name: mode_of_payment - description: '' + description: Payment method or channel specified for this installment such as + cash, check, wire transfer, or credit card. join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: due_date_based_on - description: '' + description: Reference point for calculating the payment due date such as invoice + date, delivery date, or end of month. options: - Day(s) after invoice date - Day(s) after the end of the invoice month - Month(s) after the end of the invoice month - name: credit_days - description: '' + description: Number of days after invoice date before payment is due, used when + calculating payment due dates or evaluating credit periods offered to customers. - name: credit_months - description: '' + description: Number of months after invoice date before payment is due, used for + longer-term payment arrangements or when credit terms are specified in months + rather than days. - name: discount_type - description: '' + description: Type of early payment discount offered such as percentage or fixed + amount, used when determining discount calculation method for prompt payment + incentives. options: - Percentage - Amount - name: discount - description: '' + description: Percentage or amount deducted from invoice total when payment terms + conditions are met. - name: discount_validity_based_on - description: '' + description: Criterion that determines how the discount eligibility period is + calculated, such as from invoice date or delivery date. options: - Day(s) after invoice date - Day(s) after the end of the invoice month - Month(s) after the end of the invoice month - name: discount_validity - description: '' + description: Number of days or time period during which the discount remains available + to the customer. + desc_done: true - table: tabPegged Currencies description: '' fields: - name: name - description: '' + description: Name or identifier of the currency that is pegged to another currency. - name: pegged_currency_item - description: '' + description: The specific currency to which this currency is pegged or linked + in value. + desc_done: true - table: tabPegged Currency Details description: '' fields: - name: name - description: '' + description: name - name: source_currency - description: '' + description: The currency that is pegged or fixed to another currency's value. join_hint: table: tabCurrency 'on': source_currency = tabCurrency.name - name: pegged_against - description: '' + description: The target currency that the source currency's exchange rate is fixed + to. join_hint: table: tabCurrency 'on': pegged_against = tabCurrency.name - name: pegged_exchange_rate - description: '' + description: Fixed exchange rate at which a pegged currency is locked to another + currency, used when querying conversion rates for currencies with fixed pegs. + desc_done: true - table: tabPeriod Closing Voucher description: '' fields: - name: name - description: '' + description: Unique identifier for the period closing voucher entry - name: transaction_date - description: '' + description: Date when the period closing transaction was recorded or executed - name: company - description: '' + description: Company entity to which this period closing voucher belongs join_hint: table: tabCompany 'on': company = tabCompany.name - name: fiscal_year - description: '' + description: Fiscal year for which the period closing voucher applies, used when + querying closing entries by year. join_hint: table: tabFiscal Year 'on': fiscal_year = tabFiscal Year.name - name: period_start_date - description: '' + description: Start date of the accounting period being closed, used to identify + which period's transactions are being closed. - name: period_end_date - description: '' + description: End date of the accounting period being closed, used to determine + the cutoff for transactions included in the closing voucher. - name: amended_from - description: '' + description: References the original period closing voucher that this document + amends or corrects. join_hint: table: tabPeriod Closing Voucher 'on': amended_from = tabPeriod Closing Voucher.name - name: closing_account_head - description: '' + description: The account to which period-end balances are transferred during the + closing process. join_hint: table: tabAccount 'on': closing_account_head = tabAccount.name - name: gle_processing_status - description: '' + description: Indicates whether general ledger entries have been successfully processed + for this closing voucher. options: - In Progress - Completed - Failed - name: remarks - description: '' + description: User-entered notes or comments explaining the reason for or context + about the period closing voucher. - name: error_message - description: '' + description: Error or validation message generated when the period closing voucher + fails processing or encounters issues. + desc_done: true - table: tabPersonal Data Deletion Request description: '' fields: - name: name - description: '' + description: Full name of the individual requesting personal data deletion, used + to identify the data subject in GDPR/privacy compliance queries. - name: email - description: '' + description: Email address of the requester used to verify identity and communicate + deletion status in privacy request workflows. - name: status - description: '' + description: Current state of the deletion request (pending, completed, rejected) + used to track compliance progress and audit fulfillment timelines. options: - Pending Verification - Pending Approval - On Hold - Deleted - name: anonymization_matrix - description: '' + description: Configuration defining which personal data fields to anonymize or + mask when processing the deletion request. - name: deletion_steps - description: '' + description: Sequence of actions or procedures executed to complete the personal + data deletion across systems. + desc_done: true - table: tabPersonal Data Deletion Step description: '' fields: - name: name - description: '' + description: Identifier or label for the specific personal data deletion step + in the workflow - name: document_type - description: '' + description: Type of document or record being deleted in this step, such as employee + file, customer record, or applicant data - name: status - description: '' + description: Current state of the deletion step indicating whether it is pending, + completed, failed, or skipped options: - Pending - Deleted - name: partial - description: '' + description: Indicates whether this deletion step removes only some data versus + all data for the affected records. - name: fields - description: '' + description: Specifies which personal data fields or attributes are targeted for + deletion in this step. - name: filtered_by - description: '' + description: Defines the conditions or criteria that determine which records are + affected by this deletion step. + desc_done: true - table: tabPersonal Data Download Request description: '' fields: - name: name - description: '' + description: Unique identifier or title of the personal data download request + used to track and reference specific data export requests. - name: user - description: '' + description: Foreign key linking to the user who submitted the personal data download + request, used to identify whose data is being requested. join_hint: table: tabUser 'on': user = tabUser.name - name: user_name - description: '' + description: Display name of the user who requested the personal data download, + used for reporting and identifying requestors without joining to user table. - name: amended_from - description: '' + description: Links to the original personal data download request that this amended + request replaces or corrects. join_hint: table: tabPersonal Data Download Request 'on': amended_from = tabPersonal Data Download Request.name + desc_done: true - table: tabPick List description: '' fields: - name: name - description: '' + description: Unique identifier or title of the pick list used to reference a specific + picking operation or batch - name: naming_series - description: '' + description: Prefix pattern that determines how pick list names are automatically + formatted and numbered options: - STO-PICK-.YYYY.- - name: company - description: '' + description: Company entity that owns or operates under this pick list for multi-company + inventory operations join_hint: table: tabCompany 'on': company = tabCompany.name - name: purpose - description: '' + description: Reason or intended use for the pick list, such as sales order fulfillment, + transfer, or return. options: - Material Transfer for Manufacture - Material Transfer - Delivery - name: customer - description: '' + description: Customer identifier or code associated with the pick list. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: customer_name - description: '' + description: Full name of the customer associated with the pick list for human-readable + identification. - name: work_order - description: '' + description: Work order number for which materials are being picked from inventory. join_hint: table: tabWork Order 'on': work_order = tabWork Order.name - name: material_request - description: '' + description: Material request document that initiated this pick list. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: for_qty - description: '' + description: Quantity of finished goods or items that this pick list is intended + to produce or fulfill. - name: parent_warehouse - description: '' + description: Warehouse location from which items are picked for this pick list join_hint: table: tabWarehouse 'on': parent_warehouse = tabWarehouse.name - name: consider_rejected_warehouses - description: '' + description: Whether to include warehouses marked as rejected when selecting inventory + for picking - name: pick_manually - description: '' + description: Whether items on this pick list require manual selection rather than + automatic allocation - name: ignore_pricing_rule - description: '' + description: Whether pricing rules are bypassed when picking items for this pick + list. - name: scan_barcode - description: '' + description: Barcode value scanned to identify and add items during the picking + process. - name: scan_mode - description: '' + description: Method or mode used for barcode scanning during pick list execution + (e.g., manual entry vs scanner device). - name: prompt_qty - description: '' + description: Quantity requested or suggested for picking from inventory. - name: locations - description: '' + description: Warehouse locations or bin addresses where items should be picked + from. - name: amended_from - description: '' + description: Reference to the original pick list document that this pick list + amends or replaces. join_hint: table: tabPick List 'on': amended_from = tabPick List.name - name: group_same_items - description: '' + description: Whether identical items are grouped together on the pick list for + consolidated picking. - name: status - description: '' + description: Current workflow state of the pick list such as draft, open, completed, + or cancelled. options: - Draft - Open @@ -17183,169 +21089,210 @@ tables: - Completed - Cancelled - name: delivery_status - description: '' + description: Shipment or delivery fulfillment state indicating whether picked + items have been dispatched or delivered. options: - Not Delivered - Fully Delivered - Partly Delivered - name: per_delivered - description: '' + description: Percentage of pick list items that have been physically delivered + to the customer or destination + desc_done: true - table: tabPick List Item description: '' fields: - name: name - description: '' + description: Unique identifier or reference name for the pick list item record + itself - name: item_code - description: '' + description: SKU or product code of the item being picked from inventory join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Human-readable product name or description of the item being picked - name: description - description: '' + description: Text describing the item being picked from inventory for fulfillment + or transfer purposes - name: item_group - description: '' + description: Category or classification grouping of the picked item for filtering + and organizing pick list items by product type - name: warehouse - description: '' + description: Storage location or facility from which the item is being picked join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: qty - description: '' + description: Quantity of items ordered or requested to be picked from inventory + for this pick list line. - name: stock_qty - description: '' + description: Quantity expressed in stock or base unit of measure, accounting for + unit conversion from the ordered quantity. - name: picked_qty - description: '' + description: Actual quantity that has been physically picked or fulfilled from + the warehouse for this pick list item. - name: stock_reserved_qty - description: '' + description: Quantity of inventory reserved or allocated for this pick list item + that cannot be used for other orders. - name: uom - description: '' + description: Unit of measurement for the pick list item quantity, such as pieces, + boxes, kilograms, or liters. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert between the pick list item's UOM and the base + or stock UOM. - name: stock_uom - description: '' + description: Unit of measurement for inventory quantities in this pick list item. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: delivered_qty - description: '' + description: Quantity that has been delivered or fulfilled from this pick list + item. - name: actual_qty - description: '' + description: Quantity physically picked or available for this pick list item. - name: company_total_stock - description: '' + description: Total stock quantity available across the entire company for this + pick list item. - name: serial_and_batch_bundle - description: '' + description: Reference to the bundled serial numbers or batch numbers assigned + to this pick list item. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: use_serial_batch_fields - description: '' + description: Indicates whether this pick list item tracks inventory using serial + numbers or batch numbers. - name: serial_no - description: '' + description: Unique identifier for individually tracked items in the pick list, + used when querying specific serialized inventory units being picked. - name: batch_no - description: '' + description: Batch or lot number for grouped inventory items in the pick list, + used when tracking items by manufacturing batch or expiration date. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: sales_order - description: '' + description: Sales order document linked to this pick list item, used when finding + which customer order is being fulfilled by this pick. join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: sales_order_item - description: '' + description: Links this pick list item to a specific line item on a sales order + being fulfilled. - name: product_bundle_item - description: '' + description: References a component item within a product bundle that needs to + be picked separately. - name: material_request - description: '' + description: Links this pick list item to a material request that triggered the + picking requirement. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: material_request_item - description: '' + description: Links the pick list item to the specific material request item being + fulfilled or picked for delivery. + desc_done: true - table: tabPlaid Settings description: '' fields: - name: name - description: '' + description: Name or identifier for the Plaid integration configuration - name: enabled - description: '' + description: Whether the Plaid integration is currently active and operational - name: automatic_sync - description: '' + description: Whether bank transactions are automatically synchronized from Plaid + without manual intervention - name: plaid_client_id - description: '' + description: Plaid API client identifier for authenticating bank connection requests. - name: plaid_secret - description: '' + description: Plaid API secret key for secure authentication with Plaid services. - name: plaid_env - description: '' + description: Plaid environment setting indicating whether connections use sandbox, + development, or production mode. options: - sandbox - development - production - name: enable_european_access - description: '' + description: Whether Plaid European access is enabled for connecting to European + bank accounts and financial institutions + desc_done: true - table: tabPlant Floor description: '' fields: - name: name - description: '' + description: Unique identifier or code for the plant floor record - name: floor_name - description: '' + description: Descriptive name of the physical floor or level within the plant + facility - name: company - description: '' + description: Company or business entity that owns or operates this plant floor join_hint: table: tabCompany 'on': company = tabCompany.name - name: warehouse - description: '' + description: Identifies which warehouse facility the plant floor is located in + or associated with for inventory and operations management. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name + desc_done: true - table: tabPortal Menu Item description: '' fields: - name: name - description: '' + description: Unique identifier for the portal menu item used to reference specific + navigation elements in queries about menu structure and access configuration - name: title - description: '' + description: Display text shown to portal users for this menu item, used when + searching for visible navigation labels or menu content - name: enabled - description: '' + description: Indicates whether this menu item is currently active and visible + to users, used to filter available navigation options or troubleshoot missing + menu items - name: route - description: '' + description: URL path or navigation route to access this portal menu item - name: reference_doctype - description: '' + description: DocType that this portal menu item links to or displays join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: role - description: '' + description: User role required to view or access this portal menu item join_hint: table: tabRole 'on': role = tabRole.name - name: target - description: '' + description: URL path, route, or destination that the menu item navigates to when + clicked + desc_done: true - table: tabPortal Settings description: '' fields: - name: name - description: '' + description: Portal name or identifier for the customer/partner portal configuration - name: default_role - description: '' + description: Role automatically assigned to new portal users upon registration + or creation join_hint: table: tabRole 'on': default_role = tabRole.name - name: default_portal_home - description: '' + description: Landing page or homepage URL that portal users see after logging + in - name: hide_standard_menu - description: '' + description: Whether the default navigation menu is hidden from portal users - name: menu - description: '' + description: The active menu configuration displayed to portal users - name: custom_menu - description: '' + description: User-defined menu structure that replaces or supplements the standard + menu + desc_done: true - table: tabPortal User description: '' fields: @@ -17361,103 +21308,129 @@ tables: or both fields: - name: name - description: '' + description: Unique identifier for the price list record, used when referencing + specific pricing configurations in queries. - name: enabled - description: '' + description: Indicates whether this price list is currently active and available + for use in transactions and pricing calculations. - name: price_list_name - description: '' + description: Display name of the price list used when searching for pricing by + customer segment, region, or promotional campaign. - name: currency - description: '' + description: Currency in which the prices in this price list are denominated. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: buying - description: '' + description: Indicates this price list applies to purchase transactions from suppliers. - name: selling - description: '' + description: Indicates this price list applies to sales transactions to customers. - name: price_not_uom_dependent - description: '' + description: Whether pricing remains constant regardless of the unit of measure + selected for the item. - name: countries - description: '' + description: Geographic regions where this price list is valid or applicable for + transactions. + desc_done: true - table: tabPrice List Country description: '' fields: - name: name - description: '' + description: Unique identifier or label for the price list country assignment - name: country - description: '' + description: The specific country to which this price list applies join_hint: table: tabCountry 'on': country = tabCountry.name + desc_done: true - table: tabPricing Rule description: '' fields: - name: name - description: '' + description: Unique identifier for the pricing rule used in queries about specific + pricing rules by code or ID - name: naming_series - description: '' + description: Prefix pattern that determines how pricing rule names are auto-generated + when creating new rules options: - PRLE-.#### - name: title - description: '' + description: Human-readable label for the pricing rule used when searching by + descriptive name rather than technical identifier - name: disable - description: '' + description: Whether the pricing rule is currently inactive and not being applied + to transactions. - name: apply_on - description: '' + description: The entity type the pricing rule targets, such as item code, item + group, brand, or transaction total. options: - Item Code - Item Group - Brand - Transaction - name: price_or_product_discount - description: '' + description: Whether the rule provides a price adjustment or a free/discounted + product as the benefit. options: - Price - Product - name: warehouse - description: '' + description: Specific warehouse location where this pricing rule applies, used + when prices vary by storage facility or distribution center. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: items - description: '' + description: Individual product SKUs or item codes included in this pricing rule, + used when setting prices for specific products. - name: item_groups - description: '' + description: Product categories or classification groups covered by this pricing + rule, used when applying prices to entire product families or categories. - name: brands - description: '' + description: Specific brand names or identifiers that this pricing rule applies + to, used when filtering price adjustments by product brand. - name: mixed_conditions - description: '' + description: Indicates whether the pricing rule allows combining multiple condition + types (item groups, brands, categories) simultaneously in a single rule. - name: is_cumulative - description: '' + description: Determines if this pricing rule can be stacked or combined with other + active pricing rules for the same transaction. - name: coupon_code_based - description: '' + description: Whether this pricing rule requires a coupon code to be applied at + checkout or transaction time. - name: apply_rule_on_other - description: '' + description: Whether the pricing rule discount applies to a different item than + the one triggering the rule. options: - Item Code - Item Group - Brand - name: other_item_code - description: '' + description: The specific item that receives the discount when apply_rule_on_other + is enabled, used for buy X get Y promotions. join_hint: table: tabItem 'on': other_item_code = tabItem.name - name: other_item_group - description: '' + description: Item group that triggers this pricing rule when combined with the + primary item in a transaction. join_hint: table: tabItem Group 'on': other_item_group = tabItem Group.name - name: other_brand - description: '' + description: Brand that triggers this pricing rule when combined with the primary + item in a transaction. join_hint: table: tabBrand 'on': other_brand = tabBrand.name - name: selling - description: '' + description: Indicates whether this pricing rule applies to sales transactions. - name: buying - description: '' + description: Indicates whether this pricing rule applies to purchase transactions + from suppliers. - name: applicable_for - description: '' + description: Defines the scope of entities this pricing rule targets, such as + customer groups, territories, or individual customers. options: - Customer - Customer Group @@ -17467,133 +21440,165 @@ tables: - Supplier - Supplier Group - name: customer - description: '' + description: Specific customer account to which this pricing rule exclusively + applies. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: customer_group - description: '' + description: Specifies which customer segment or classification this pricing rule + applies to, used when filtering prices by customer type or category. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: territory - description: '' + description: Defines the geographic region or sales area where this pricing rule + is valid, used when pricing varies by location. join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: sales_partner - description: '' + description: Identifies the third-party distributor or reseller for whom this + pricing rule applies, used when different partners receive different pricing + terms. join_hint: table: tabSales Partner 'on': sales_partner = tabSales Partner.name - name: campaign - description: '' + description: Marketing or promotional campaign associated with the pricing rule + to track campaign-specific pricing offers. join_hint: table: tabCampaign 'on': campaign = tabCampaign.name - name: supplier - description: '' + description: Specific supplier for whom this pricing rule applies when purchasing + items. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: supplier_group - description: '' + description: Group of suppliers to which this pricing rule applies, used when + the rule should apply to multiple suppliers at once. join_hint: table: tabSupplier Group 'on': supplier_group = tabSupplier Group.name - name: min_qty - description: '' + description: Minimum quantity threshold required for the pricing rule to apply + to a transaction - name: max_qty - description: '' + description: Maximum quantity threshold up to which the pricing rule remains applicable - name: min_amt - description: '' + description: Minimum transaction amount threshold required for the pricing rule + to activate - name: max_amt - description: '' + description: Maximum discount or benefit amount that can be applied under this + pricing rule. - name: same_item - description: '' + description: Indicates whether the pricing rule applies quantity-based discounts + to the same item being purchased. - name: free_item - description: '' + description: Item code or product that is given free as part of this pricing rule + promotion. join_hint: table: tabItem 'on': free_item = tabItem.name - name: free_qty - description: '' + description: Quantity of free items given when pricing rule conditions are met. - name: free_item_rate - description: '' + description: Valuation rate of the free item for accounting and inventory purposes. - name: free_item_uom - description: '' + description: Unit of measurement for the free item quantity being offered. join_hint: table: tabUOM 'on': free_item_uom = tabUOM.name - name: round_free_qty - description: '' + description: Whether free item quantities are rounded to whole numbers in promotional + pricing calculations. - name: dont_enforce_free_item_qty - description: '' + description: Whether the system allows partial or flexible free item quantities + instead of enforcing exact promotional amounts. - name: is_recursive - description: '' + description: Whether the pricing rule applies repeatedly to qualifying transaction + amounts or only once per transaction. - name: recurse_for - description: '' + description: Number of periods or units to recursively apply the pricing rule + forward in time or quantity. - name: apply_recursion_over - description: '' + description: Dimension over which the pricing rule repeats, such as time periods, + quantity tiers, or transaction count. - name: valid_from - description: '' + description: Start date from which the pricing rule becomes active and applicable + to transactions. - name: valid_upto - description: '' + description: End date when the pricing rule expires or stops being applicable + to transactions - name: company - description: '' + description: Company entity to which this pricing rule is restricted or belongs join_hint: table: tabCompany 'on': company = tabCompany.name - name: currency - description: '' + description: Currency in which the pricing rule's amounts or discounts are denominated join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: margin_type - description: '' + description: Whether the pricing rule applies margin as a percentage or fixed + amount. options: - Percentage - Amount - name: margin_rate_or_amount - description: '' + description: The numerical margin value applied when this pricing rule calculates + profit margins. - name: rate_or_discount - description: '' + description: Whether the pricing rule applies a final price rate or a discount + reduction. options: - Rate - Discount Percentage - Discount Amount - name: apply_discount_on - description: '' + description: Specifies whether the pricing rule discount applies to grand total, + net total, or specific item amounts. options: - Grand Total - Net Total - name: rate - description: '' + description: Percentage discount rate applied when the pricing rule is triggered. - name: discount_amount - description: '' + description: Fixed monetary discount amount applied when the pricing rule is triggered, + as opposed to a percentage rate. - name: discount_percentage - description: '' + description: Percentage discount applied when pricing rule conditions are met - name: for_price_list - description: '' + description: Specific price list to which this pricing rule applies join_hint: table: tabPrice List 'on': for_price_list = tabPrice List.name - name: condition - description: '' + description: Expression or criteria that must be satisfied for the pricing rule + to activate - name: apply_multiple_pricing_rules - description: '' + description: Whether multiple pricing rules can be applied simultaneously to the + same transaction or item. - name: apply_discount_on_rate - description: '' + description: Whether the discount calculation is based on the item rate versus + other bases like amount or quantity. - name: threshold_percentage - description: '' + description: Minimum percentage threshold that must be met for the pricing rule + to trigger or apply. - name: validate_applied_rule - description: '' + description: Whether the pricing rule requires validation or confirmation before + being applied to transactions. - name: rule_description - description: '' + description: Text explanation of what the pricing rule does and when it applies. - name: has_priority - description: '' + description: Whether this pricing rule has a priority value set to determine precedence + when multiple rules match. - name: priority - description: '' + description: Determines which pricing rule applies when multiple rules match the + same transaction, with lower numbers taking precedence. options: - '1' - '2' @@ -17616,153 +21621,187 @@ tables: - '19' - '20' - name: promotional_scheme_id - description: '' + description: Unique identifier linking this pricing rule to a specific promotional + campaign or scheme. - name: promotional_scheme - description: '' + description: Name or title of the promotional campaign associated with this pricing + rule, used when searching for rules by promotion name. join_hint: table: tabPromotional Scheme 'on': promotional_scheme = tabPromotional Scheme.name + desc_done: true - table: tabPricing Rule Brand description: '' fields: - name: name - description: '' + description: Unique identifier for the pricing rule brand record - name: brand - description: '' + description: The specific brand to which this pricing rule applies, used when + filtering or applying discounts based on product brand join_hint: table: tabBrand 'on': brand = tabBrand.name - name: uom - description: '' + description: Unit of measurement for which this brand pricing rule is valid, used + when pricing varies by UOM for the same brand join_hint: table: tabUOM 'on': uom = tabUOM.name + desc_done: true - table: tabPricing Rule Detail description: '' fields: - name: name - description: '' + description: Unique identifier for this specific pricing rule detail record - name: pricing_rule - description: '' + description: References the parent pricing rule that this detail line belongs + to join_hint: table: tabPricing Rule 'on': pricing_rule = tabPricing Rule.name - name: item_code - description: '' + description: Specific product or item that this pricing rule detail applies to - name: margin_type - description: '' + description: Specifies whether the pricing rule applies a percentage-based or + amount-based margin calculation. - name: rate_or_discount - description: '' + description: Indicates whether the pricing rule modifies the selling rate directly + or applies a discount to the base price. - name: child_docname - description: '' + description: References the specific item, item group, brand, or other entity + to which this pricing rule detail applies. - name: rule_applied - description: '' + description: Indicates whether this pricing rule detail was actually applied to + a transaction or remains unapplied. + desc_done: true - table: tabPricing Rule Item Code description: '' fields: - name: name - description: '' + description: Unique identifier for this pricing rule item code entry - name: item_code - description: '' + description: Specific product or item SKU that this pricing rule applies to join_hint: table: tabItem 'on': item_code = tabItem.name - name: uom - description: '' + description: Unit of measure for which this pricing rule is valid when selling + or purchasing the item join_hint: table: tabUOM 'on': uom = tabUOM.name + desc_done: true - table: tabPricing Rule Item Group description: '' fields: - name: name - description: '' + description: Unique identifier for the pricing rule item group record, used when + referencing specific pricing rule configurations. - name: item_group - description: '' + description: Specifies which product category this pricing rule applies to, used + when setting up group-based discounts or special pricing. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: uom - description: '' + description: Defines the unit of measurement for which this pricing rule is valid, + used when pricing varies by quantity unit like boxes vs pieces. join_hint: table: tabUOM 'on': uom = tabUOM.name + desc_done: true - table: tabPrint Format description: '' fields: - name: name - description: '' + description: Unique identifier or label for the print format template - name: print_format_for - description: '' + description: The DocType or document type that this print format is designed to + generate printable output for options: - DocType - Report - name: doc_type - description: '' + description: The DocType or document type that this print format is designed to + generate printable output for join_hint: table: tabDocType 'on': doc_type = tabDocType.name - name: report - description: '' + description: The DocType or report name that this print format is designed to + render or display. join_hint: table: tabReport 'on': report = tabReport.name - name: module - description: '' + description: The application module or functional area where this print format + is organized and belongs. join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: default_print_language - description: '' + description: The language used by default when generating printed documents with + this format. join_hint: table: tabLanguage 'on': default_print_language = tabLanguage.name - name: standard - description: '' + description: Indicates whether this is a built-in system print format versus a + user-created custom format. options: - 'No' - 'Yes' - name: custom_format - description: '' + description: Indicates whether this print format uses custom HTML/Jinja templating + instead of the standard builder. - name: disabled - description: '' + description: Indicates whether this print format is currently inactive and unavailable + for selection when printing documents. - name: pdf_generator - description: '' + description: Specifies which PDF generation engine or library is used to create + PDF output from this print format. options: - wkhtmltopdf - name: print_format_type - description: '' + description: Defines whether the print format is standard, custom, server-side, + or client-side rendered. options: - Jinja - JS - name: raw_printing - description: '' + description: Indicates if this format outputs raw printer commands for direct + hardware printing without PDF conversion. - name: html - description: '' + description: Custom HTML template content for rendering the print format layout + and styling - name: raw_commands - description: '' + description: Raw printing commands or instructions for direct printer communication + without standard formatting - name: margin_top - description: '' + description: Top margin spacing in the printed document output - name: margin_bottom - description: '' + description: Bottom margin spacing for printed documents in this print format - name: margin_left - description: '' + description: Left margin spacing for printed documents in this print format - name: margin_right - description: '' + description: Right margin spacing for printed documents in this print format - name: align_labels_right - description: '' + description: Whether field labels are right-aligned in the printed format layout - name: show_section_headings - description: '' + description: Whether section titles are displayed in the printed document output - name: line_breaks - description: '' + description: Whether line breaks are inserted between fields or sections in the + print format - name: absolute_value - description: '' + description: Whether numeric values are displayed without negative signs in printed + output. - name: font_size - description: '' + description: Size of text in points for this print format element. - name: font - description: '' + description: Typeface family used for rendering text in this print format element. - name: page_number - description: '' + description: Page number where a specific print element or section appears in + the formatted output. options: - Hide - Top Left @@ -17772,56 +21811,71 @@ tables: - Bottom Center - Bottom Right - name: css - description: '' + description: Custom styling rules applied to control the visual appearance of + the print format. - name: format_data - description: '' + description: Template structure and layout configuration defining how data is + arranged and displayed when printed. - name: print_format_builder - description: '' + description: Indicates whether the print format uses the visual drag-and-drop + builder interface for layout design. - name: print_format_builder_beta - description: '' + description: Indicates whether the print format uses the beta version of the visual + builder with experimental features. + desc_done: true - table: tabPrint Format Field Template description: '' fields: - name: name - description: '' + description: Unique identifier for the print format field template configuration - name: document_type - description: '' + description: The DocType or module this print format field template applies to join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: field - description: '' + description: The specific field name from the document that this template formats + for printing - name: template_file - description: '' + description: File path or name of the template used for rendering the print format + layout - name: module - description: '' + description: Module or app where this print format field template is defined or + belongs to join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: standard - description: '' + description: Indicates whether this is a default system template or a custom user-created + template - name: template - description: '' + description: Jinja template code that defines how a field is rendered in a print + format, controlling its display logic and formatting. + desc_done: true - table: tabPrint Heading description: '' fields: - name: name - description: '' + description: Unique identifier or code for the print heading record used to reference + specific heading configurations in reports and documents. - name: print_heading - description: '' + description: The actual heading text that appears on printed documents, invoices, + or reports when this configuration is applied. - name: description - description: '' + description: Additional explanatory notes about the print heading's purpose or + usage context to help users select the appropriate heading for their documents. + desc_done: true - table: tabPrint Settings description: '' fields: - name: name - description: '' + description: Name or identifier of the print settings configuration - name: send_print_as_pdf - description: '' + description: Whether documents are automatically sent as PDF format when printing - name: repeat_header_footer - description: '' + description: Whether headers and footers repeat on every page of printed documents - name: pdf_page_size - description: '' + description: Standard page size format for PDF output such as A4, Letter, or Legal. options: - A0 - A1 @@ -17855,36 +21909,44 @@ tables: - Tabloid - Custom - name: pdf_page_height - description: '' + description: Custom page height dimension in units when using non-standard PDF + page sizes. - name: pdf_page_width - description: '' + description: Custom page width dimension in units when using non-standard PDF + page sizes. - name: with_letterhead - description: '' + description: Whether documents print with company letterhead branding and header - name: compact_item_print - description: '' + description: Whether line items print in condensed format to save space on printed + documents - name: print_uom_after_quantity - description: '' + description: Whether unit of measure displays after the quantity value instead + of before it on printed documents - name: allow_print_for_draft - description: '' + description: Whether draft documents can be printed before finalization or approval - name: add_draft_heading - description: '' + description: Whether to display a draft watermark or heading on printed draft + documents - name: allow_page_break_inside_tables - description: '' + description: Whether tables can be split across multiple pages when printing or + generating PDFs - name: allow_print_for_cancelled - description: '' + description: Whether cancelled documents can be printed or reprinted. - name: print_taxes_with_zero_amount - description: '' + description: Whether tax lines with zero value appear on printed documents. - name: enable_print_server - description: '' + description: Whether printing uses a server-side print service instead of client-side + printing. - name: enable_raw_printing - description: '' + description: Whether raw printing mode is activated to send print commands directly + to printer without driver processing. - name: print_style - description: '' + description: The formatting style or template applied to printed documents. join_hint: table: tabPrint Style 'on': print_style = tabPrint Style.name - name: font - description: '' + description: The typeface used for printed output text. options: - Default - Helvetica Neue @@ -17894,98 +21956,124 @@ tables: - Verdana - Monospace - name: font_size - description: '' + description: Size of the font used when printing documents or reports from this + print configuration. + desc_done: true - table: tabPrint Style description: '' fields: - name: name - description: '' + description: Unique identifier code for the print style configuration - name: print_style_name - description: '' + description: Display label or title of the print style shown to users when selecting + print formats - name: disabled - description: '' + description: Whether this print style is currently inactive and unavailable for + selection - name: standard - description: '' + description: Indicates whether this is a default or built-in print format template + versus a custom one. - name: css - description: '' + description: Custom styling rules applied to control the visual appearance and + layout of printed documents. + desc_done: true - table: tabProcess Deferred Accounting description: '' fields: - name: name - description: '' + description: Unique identifier or label for the deferred accounting process entry - name: company - description: '' + description: Company entity to which this deferred accounting process belongs join_hint: table: tabCompany 'on': company = tabCompany.name - name: type - description: '' + description: Classification of the deferred accounting process such as revenue + or expense deferral options: - Income - Expense - name: account - description: '' + description: The accounting ledger account where deferred revenue or expense amounts + are recorded. join_hint: table: tabAccount 'on': account = tabAccount.name - name: posting_date - description: '' + description: The date when the deferred accounting transaction was posted to the + general ledger. - name: start_date - description: '' + description: The date when the deferral period begins for recognizing the deferred + revenue or expense. - name: end_date - description: '' + description: End date of the deferred accounting period for recognizing revenue + or expenses over time. - name: amended_from - description: '' + description: Links to the original deferred accounting document that this record + amends or replaces. join_hint: table: tabProcess Deferred Accounting 'on': amended_from = tabProcess Deferred Accounting.name + desc_done: true - table: tabProcess Payment Reconciliation description: '' fields: - name: name - description: '' + description: Unique identifier or reference code for the payment reconciliation + record - name: company - description: '' + description: Company entity for which the payment reconciliation is being performed join_hint: table: tabCompany 'on': company = tabCompany.name - name: party_type - description: '' + description: Type of party involved in the payment reconciliation such as Customer + or Supplier join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: party - description: '' + description: The customer or supplier whose payments are being reconciled against + invoices or advances. - name: receivable_payable_account - description: '' + description: The main accounts receivable or accounts payable ledger account for + tracking outstanding amounts owed by or to the party. join_hint: table: tabAccount 'on': receivable_payable_account = tabAccount.name - name: default_advance_account - description: '' + description: The ledger account used to record advance payments made to suppliers + or received from customers before invoicing. join_hint: table: tabAccount 'on': default_advance_account = tabAccount.name - name: from_invoice_date - description: '' + description: Start date for filtering invoices by their invoice date in the reconciliation + period - name: to_invoice_date - description: '' + description: End date for filtering invoices by their invoice date in the reconciliation + period - name: from_payment_date - description: '' + description: Start date for filtering payments by their payment date in the reconciliation + period - name: to_payment_date - description: '' + description: End date of the payment period range being reconciled, used when + filtering reconciliations by date range or specific payment cycles. - name: cost_center - description: '' + description: Cost center associated with the payment reconciliation, used when + analyzing or filtering reconciliations by department or business unit. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: bank_cash_account - description: '' + description: Bank or cash account being reconciled against payment records, used + when identifying which account's transactions are being matched. join_hint: table: tabAccount 'on': bank_cash_account = tabAccount.name - name: status - description: '' + description: Current state of the payment reconciliation process such as draft, + submitted, reconciled, or cancelled. options: - Queued - Running @@ -17995,24 +22083,30 @@ tables: - Failed - Cancelled - name: error_log - description: '' + description: Details of errors or issues encountered during the payment reconciliation + process. - name: amended_from - description: '' + description: Reference to the original payment reconciliation record that this + document corrects or replaces. join_hint: table: tabProcess Payment Reconciliation 'on': amended_from = tabProcess Payment Reconciliation.name + desc_done: true - table: tabProcess Payment Reconciliation Log description: '' fields: - name: name - description: '' + description: Unique identifier or label for this specific payment reconciliation + log entry - name: process_pr - description: '' + description: Links to the parent payment reconciliation process that this log + entry tracks or documents join_hint: table: tabProcess Payment Reconciliation 'on': process_pr = tabProcess Payment Reconciliation.name - name: status - description: '' + description: Current state of the payment reconciliation process such as pending, + completed, failed, or in progress options: - Running - Paused @@ -18021,76 +22115,102 @@ tables: - Failed - Cancelled - name: allocated - description: '' + description: Amount of payment that has been assigned or distributed to specific + invoices or obligations in this reconciliation entry. - name: reconciled - description: '' + description: Amount that has been successfully matched and confirmed between payment + records and accounting entries. - name: total_allocations - description: '' + description: Cumulative sum of all payment amounts distributed across all invoices + or line items in this reconciliation process. - name: reconciled_entries - description: '' + description: Number or list of payment entries successfully matched and reconciled + during the payment reconciliation process. - name: error_log - description: '' + description: Details of failures, mismatches, or exceptions encountered during + payment reconciliation attempts. - name: allocations - description: '' + description: How reconciled payment amounts were distributed or assigned across + invoices, orders, or accounts. + desc_done: true - table: tabProcess Payment Reconciliation Log Allocations description: '' fields: - name: name - description: '' + description: Unique identifier for the specific payment reconciliation log allocation + record - name: reference_type - description: '' + description: Type of document or transaction being allocated against in the payment + reconciliation, such as invoice, credit note, or journal entry join_hint: table: tabDocType 'on': reference_type = tabDocType.name - name: reference_name - description: '' + description: Specific document number or transaction identifier that the payment + allocation is linked to - name: reference_row - description: '' + description: Links this allocation to a specific row in the parent payment reconciliation + log entry. - name: invoice_type - description: '' + description: Indicates whether the allocated invoice is a sales invoice, purchase + invoice, credit note, or other document type. join_hint: table: tabDocType 'on': invoice_type = tabDocType.name - name: invoice_number - description: '' + description: The specific invoice or document number that this payment allocation + is applied against. - name: allocated_amount - description: '' + description: Amount successfully matched and applied from a payment to a specific + invoice or transaction during reconciliation. - name: unreconciled_amount - description: '' + description: Remaining amount that could not be matched or allocated to any invoice + or transaction after reconciliation attempts. - name: amount - description: '' + description: Total original amount of the payment or transaction entry before + any allocation or reconciliation processing. - name: is_advance - description: '' + description: Indicates whether the allocation represents an advance payment made + before the invoice or service delivery. - name: difference_amount - description: '' + description: The variance between the allocated payment amount and the invoice + amount, often due to rounding, discounts, or exchange rate fluctuations. - name: gain_loss_posting_date - description: '' + description: The date when foreign exchange gains or losses from this payment + allocation are posted to the accounting ledger. - name: difference_account - description: '' + description: Account where reconciliation differences or variances are posted + when payment amounts don't match exactly join_hint: table: tabAccount 'on': difference_account = tabAccount.name - name: exchange_rate - description: '' + description: Rate used to convert foreign currency payment amounts to base currency + during reconciliation - name: currency - description: '' + description: Currency in which the allocated payment or invoice amount is denominated join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: reconciled - description: '' + description: Whether this payment allocation has been successfully matched and + reconciled with corresponding bank or accounting records + desc_done: true - table: tabProcess Period Closing Voucher description: '' fields: - name: name - description: '' + description: Unique identifier or title of the period closing voucher used when + referencing specific closing entries. - name: parent_pcv - description: '' + description: Links to a parent period closing voucher when this voucher is part + of a hierarchical or multi-level closing process. join_hint: table: tabPeriod Closing Voucher 'on': parent_pcv = tabPeriod Closing Voucher.name - name: status - description: '' + description: Current state of the period closing voucher such as draft, submitted, + approved, or cancelled. options: - Queued - Running @@ -18098,32 +22218,40 @@ tables: - Completed - Cancelled - name: p_l_closing_balance - description: '' + description: Closing balance for profit and loss accounts at period end, used + when querying income statement or P&L account balances after period closing. - name: normal_balances - description: '' + description: Standard expected debit or credit balance type for accounts, used + when validating account balance directions or identifying account nature. - name: bs_closing_balance - description: '' + description: Closing balance for balance sheet accounts at period end, used when + querying asset, liability, or equity account balances after period closing. - name: z_opening_balances - description: '' + description: Indicates whether this voucher represents opening balances for the + period being closed. - name: amended_from - description: '' + description: References the original period closing voucher that this document + amends or corrects. join_hint: table: tabProcess Period Closing Voucher 'on': amended_from = tabProcess Period Closing Voucher.name + desc_done: true - table: tabProcess Period Closing Voucher Detail description: '' fields: - name: name - description: '' + description: Unique identifier or label for the period closing voucher detail + entry - name: processing_date - description: '' + description: Date when the period closing voucher was processed or executed - name: report_type - description: '' + description: Category or classification of the closing report being generated options: - Profit and Loss - Balance Sheet - name: status - description: '' + description: Current state of the period closing voucher detail indicating whether + it is draft, posted, approved, or cancelled. options: - Queued - Running @@ -18131,324 +22259,421 @@ tables: - Completed - Cancelled - name: closing_balance - description: '' + description: Final balance amount for the account or entity at the end of the + closing period. + desc_done: true - table: tabProcess Statement Of Accounts description: '' fields: - name: name - description: '' + description: Unique identifier or label for the statement of accounts process + instance - name: report - description: '' + description: The generated report document or output file containing the statement + of accounts options: - General Ledger - Accounts Receivable - name: from_date - description: '' + description: Starting date of the period covered by the statement of accounts - name: posting_date - description: '' + description: Date when the financial transaction was recorded in the accounting + ledger, used to filter statement of accounts by time period. - name: company - description: '' + description: Legal entity or business unit that owns the account, used to filter + statements by organizational boundary. join_hint: table: tabCompany 'on': company = tabCompany.name - name: account - description: '' + description: Specific ledger account (receivable, payable, or general ledger) + for which the statement of accounts is generated. join_hint: table: tabAccount 'on': account = tabAccount.name - name: categorize_by - description: '' + description: Grouping dimension for organizing statement of accounts entries such + as by customer, invoice, or payment type. options: - Categorize by Voucher - Categorize by Voucher (Consolidated) - name: cost_center - description: '' + description: Cost center associated with the transactions in the statement for + expense allocation and financial tracking. - name: territory - description: '' + description: Geographic or organizational territory assigned to the customer or + transactions in the statement. join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: ignore_exchange_rate_revaluation_journals - description: '' + description: Whether to exclude foreign currency revaluation entries when generating + the statement of accounts. - name: ignore_cr_dr_notes - description: '' + description: Whether to exclude credit notes and debit notes when generating the + statement of accounts. - name: to_date - description: '' + description: The ending date for transactions and balances included in the statement + of accounts. - name: finance_book - description: '' + description: Identifies which accounting book or ledger this statement of accounts + belongs to for multi-book accounting scenarios. join_hint: table: tabFinance Book 'on': finance_book = tabFinance Book.name - name: currency - description: '' + description: The currency in which the statement of accounts amounts are denominated + and displayed. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: project - description: '' + description: Links the statement of accounts to a specific project for project-based + financial tracking and reporting. - name: payment_terms_template - description: '' + description: Payment terms template applied to the customer account for this statement + period. join_hint: table: tabPayment Terms Template 'on': payment_terms_template = tabPayment Terms Template.name - name: sales_partner - description: '' + description: External sales partner or channel partner associated with the customer's + transactions in this statement. join_hint: table: tabSales Partner 'on': sales_partner = tabSales Partner.name - name: sales_person - description: '' + description: Internal sales representative or employee responsible for the customer + account in this statement. join_hint: table: tabSales Person 'on': sales_person = tabSales Person.name - name: show_remarks - description: '' + description: Whether to display remarks or comments on the statement of accounts + document. - name: based_on_payment_terms - description: '' + description: Whether the statement is organized or filtered according to the customer's + payment terms. - name: customer_collection - description: '' + description: The specific group or set of customers included in this statement + of accounts. options: - Customer Group - Territory - Sales Partner - Sales Person - name: collection_name - description: '' + description: Name or identifier of the collection group this statement of accounts + belongs to for organizing multiple statements together. - name: primary_mandatory - description: '' + description: Indicates whether this statement of accounts is the primary mandatory + one that must be processed or sent. - name: show_net_values_in_party_account - description: '' + description: Controls whether net values (after adjustments, returns, or offsets) + are displayed in the party's account statement instead of gross amounts. - name: customers - description: '' + description: Customer accounts to include in the statement of accounts report + or process - name: orientation - description: '' + description: Page layout direction for the statement document, either portrait + or landscape format options: - Landscape - Portrait - name: include_break - description: '' + description: Whether to insert page breaks between different customers or sections + in the statement - name: include_ageing - description: '' + description: Whether to show aging analysis of outstanding amounts by time period + on the statement of accounts. - name: ageing_based_on - description: '' + description: The date field used to calculate aging buckets (e.g., posting date, + due date, or invoice date). options: - Due Date - Posting Date - name: letter_head - description: '' + description: The company letterhead template to display at the top of the printed + statement of accounts. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: terms_and_conditions - description: '' + description: Legal terms or payment conditions text included on the statement + of accounts document sent to customers. join_hint: table: tabTerms and Conditions 'on': terms_and_conditions = tabTerms and Conditions.name - name: enable_auto_email - description: '' + description: Whether the statement of accounts is automatically emailed to customers + on a scheduled basis. - name: sender - description: '' + description: Email address or user account that sends the statement of accounts + to customers. join_hint: table: tabEmail Account 'on': sender = tabEmail Account.name - name: frequency - description: '' + description: How often statement of accounts are generated or sent to customers + (daily, weekly, monthly, quarterly). options: - Weekly - Monthly - Quarterly - name: filter_duration - description: '' + description: Time period or date range used to filter transactions included in + the statement of accounts. - name: start_date - description: '' + description: Beginning date from which statement of accounts processing or transaction + inclusion starts. - name: pdf_name - description: '' + description: Name of the generated PDF file for the statement of accounts document. - name: subject - description: '' + description: Email subject line used when sending the statement of accounts to + customers. - name: cc_to - description: '' + description: Email addresses to be copied when sending the statement of accounts. - name: body - description: '' + description: Main content or detailed text of the statement of accounts, typically + referenced when searching for specific transaction descriptions, notes, or detailed + account information within the statement. + desc_done: true - table: tabProcess Statement Of Accounts CC description: '' fields: - name: name - description: '' + description: Unique identifier or reference name for the process statement of + accounts record - name: cc - description: '' + description: Carbon copy recipient or cost center associated with the statement + of accounts process join_hint: table: tabUser 'on': cc = tabUser.name + desc_done: true - table: tabProcess Statement Of Accounts Customer description: '' fields: - name: name - description: '' + description: Unique identifier for this specific statement of accounts process + instance - name: customer - description: '' + description: Customer account ID for whom the statement of accounts is being generated join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: customer_name - description: '' + description: Display name of the customer receiving the statement of accounts - name: billing_email - description: '' + description: Email address where invoices and billing statements are sent to the + customer. - name: primary_email - description: '' + description: Main contact email address for general customer communication and + correspondence. + desc_done: true - table: tabProcess Subscription description: '' fields: - name: name - description: '' + description: Unique identifier for the process subscription record, used when + searching for specific subscription processing instances or tracking individual + subscription events. - name: posting_date - description: '' + description: Date when the subscription transaction was posted to the system, + used when filtering subscription activities by time period or analyzing subscription + processing timelines. - name: subscription - description: '' + description: Reference to the subscription plan or agreement being processed, + used when analyzing which subscriptions are being executed or linking process + records to subscription master data. join_hint: table: tabSubscription 'on': subscription = tabSubscription.name - name: amended_from - description: '' + description: Links to the original subscription that was amended or corrected + by this subscription record. join_hint: table: tabProcess Subscription 'on': amended_from = tabProcess Subscription.name + desc_done: true - table: tabProduct Bundle description: Aggregate a group of Items into another Item. This is useful if you are maintaining the stock of the packed items and not the bundled item fields: - name: name - description: '' + description: The product bundle's primary identifier or title used when searching + for or referencing a specific bundle by name. - name: new_item_code - description: '' + description: The SKU or item code assigned to the bundled product as a single + sellable unit, distinct from individual component item codes. join_hint: table: tabItem 'on': new_item_code = tabItem.name - name: description - description: '' + description: Detailed explanation of what the bundle contains or its purpose, + used when searching for bundles by their contents or characteristics rather + than name. - name: disabled - description: '' + description: Whether the product bundle is inactive and unavailable for use in + transactions or sales. - name: items - description: '' + description: The individual products or components included in this bundle with + their quantities. + desc_done: true - table: tabProduct Bundle Item description: '' fields: - name: name - description: '' + description: Identifies the specific product included in a bundle for inventory + tracking and order fulfillment purposes. - name: item_code - description: '' + description: References the SKU or product identifier of the bundled item for + linking to master product data and pricing. join_hint: table: tabItem 'on': item_code = tabItem.name - name: qty - description: '' + description: Specifies how many units of this item are included in the bundle + for calculating total quantities and costs. - name: description - description: '' + description: Text description of the individual item included in the product bundle. - name: rate - description: '' + description: Quantity or ratio of this item included per unit of the parent bundle + product. - name: uom - description: '' + description: Unit of measurement for the bundle item quantity (e.g., pieces, kg, + liters). join_hint: table: tabUOM 'on': uom = tabUOM.name + desc_done: true - table: tabProduction Plan description: '' fields: - name: name - description: '' + description: Unique identifier or title of the production plan used to reference + a specific manufacturing schedule or batch production run - name: naming_series - description: '' + description: Prefix pattern used to auto-generate production plan names following + organizational numbering conventions options: - MFG-PP-.YYYY.- - name: company - description: '' + description: Company entity that owns and executes this production plan, relevant + when filtering plans by business unit or legal entity join_hint: table: tabCompany 'on': company = tabCompany.name - name: get_items_from - description: '' + description: Source location or document type from which items are pulled into + the production plan, such as sales orders or material requests. options: - Sales Order - Material Request - name: posting_date - description: '' + description: Date when the production plan is officially recorded or executed + in the system. - name: item_code - description: '' + description: Unique identifier of the finished good or product being planned for + production. join_hint: table: tabItem 'on': item_code = tabItem.name - name: customer - description: '' + description: The customer for whom the production is being planned or executed. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: warehouse - description: '' + description: The warehouse location where produced goods will be stored or from + which materials will be sourced for production. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: project - description: '' + description: The specific project associated with this production plan, linking + production activities to project-based manufacturing or custom orders. join_hint: table: tabProject 'on': project = tabProject.name - name: sales_order_status - description: '' + description: Status of the sales order linked to this production plan, used to + filter production by order fulfillment state like pending, confirmed, or completed. options: - To Deliver and Bill - To Bill - To Deliver - name: from_date - description: '' + description: Start date of the production plan period, used when querying production + scheduled to begin within a specific timeframe. - name: to_date - description: '' + description: End date of the production plan period, used when querying production + scheduled to complete by a specific deadline. - name: from_delivery_date - description: '' + description: Start date of the delivery date range for production planning purposes. - name: to_delivery_date - description: '' + description: End date of the delivery date range for production planning purposes. - name: sales_orders - description: '' + description: Sales orders included in or linked to this production plan. - name: material_requests - description: '' + description: Referenced when users ask about raw material or component requirements + needed to fulfill this production plan. - name: combine_items - description: '' + description: Referenced when users ask whether multiple items or materials should + be consolidated or grouped together in this production plan. - name: po_items - description: '' + description: Referenced when users ask about purchase order line items linked + to or generated from this production plan. - name: prod_plan_references - description: '' + description: Reference numbers or identifiers linking this production plan to + related documents, orders, or external systems - name: combine_sub_items - description: '' + description: Flag indicating whether sub-assembly components should be consolidated + or kept separate in the production plan - name: sub_assembly_warehouse - description: '' + description: Warehouse location where sub-assemblies or intermediate components + are stored during production join_hint: table: tabWarehouse 'on': sub_assembly_warehouse = tabWarehouse.name - name: skip_available_sub_assembly_item - description: '' + description: Whether to exclude sub-assembly items that are already in stock when + planning production requirements. - name: sub_assembly_items - description: '' + description: List of intermediate assemblies or components that need to be produced + before the final product can be manufactured. - name: include_non_stock_items - description: '' + description: Whether to include items not normally held in inventory (non-stock + items) in the production plan. - name: include_subcontracted_items - description: '' + description: Whether items manufactured by external subcontractors are included + in this production plan. - name: consider_minimum_order_qty - description: '' + description: Whether minimum order quantity constraints are applied when calculating + production quantities. - name: include_safety_stock - description: '' + description: Whether safety stock buffer quantities are factored into production + planning calculations. - name: ignore_existing_ordered_qty - description: '' + description: Whether to exclude already ordered quantities when calculating material + requirements for this production plan - name: for_warehouse - description: '' + description: Target warehouse where the planned production items will be stored + upon completion join_hint: table: tabWarehouse 'on': for_warehouse = tabWarehouse.name - name: mr_items - description: '' + description: List of material request items generated from this production plan + for procuring required raw materials - name: total_planned_qty - description: '' + description: Target quantity intended to be manufactured according to the production + plan. - name: total_produced_qty - description: '' + description: Actual quantity that has been manufactured so far against the plan. - name: status - description: '' + description: Current state of the production plan such as draft, in progress, + completed, or cancelled. options: - Draft - Submitted @@ -18459,338 +22684,425 @@ tables: - Cancelled - Material Requested - name: warehouses - description: '' + description: Target warehouse where the production output will be stored after + manufacturing completion. - name: amended_from - description: '' + description: Reference to the original production plan document that this plan + amends or replaces. join_hint: table: tabProduction Plan 'on': amended_from = tabProduction Plan.name + desc_done: true - table: tabProduction Plan Item description: '' fields: - name: name - description: '' + description: Unique identifier or title of the production plan item record - name: include_exploded_items - description: '' + description: Whether to expand and include sub-components or bill of materials + items in the production plan - name: item_code - description: '' + description: The product or material code being planned for production join_hint: table: tabItem 'on': item_code = tabItem.name - name: bom_no - description: '' + description: Bill of materials identifier for the production plan item specifying + which BOM version to use for manufacturing. join_hint: table: tabBOM 'on': bom_no = tabBOM.name - name: planned_qty - description: '' + description: Target quantity scheduled to be produced for this production plan + item. - name: stock_uom - description: '' + description: Unit of measurement for the planned production quantity (pieces, + kg, liters, etc). join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: warehouse - description: '' + description: Location where the production plan item will be manufactured or stored + after production join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: planned_start_date - description: '' + description: Scheduled date when production of this item is intended to begin - name: pending_qty - description: '' + description: Quantity of the item that is planned but not yet started or completed + in production - name: ordered_qty - description: '' + description: Quantity planned or requested to be produced for this production + plan item. - name: description - description: '' + description: Text description or details about what is being produced in this + production plan item. - name: produced_qty - description: '' + description: Actual quantity that has been manufactured or completed so far for + this production plan item. - name: sales_order - description: '' + description: Links production plan item to the originating customer sales order + driving production demand. join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: sales_order_item - description: '' + description: Specific line item from the sales order that this production plan + item fulfills. - name: material_request - description: '' + description: Material request document generated or linked to procure raw materials + needed for this production plan item. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: material_request_item - description: '' + description: Links to the specific material request line item that triggered or + is associated with this production plan item. - name: product_bundle_item - description: '' + description: References a component item within a product bundle when the production + plan involves bundled products. join_hint: table: tabItem 'on': product_bundle_item = tabItem.name - name: item_reference - description: '' + description: General reference identifier for the item being produced, used when + querying what is planned for manufacturing. - name: temporary_name - description: '' + description: Temporary or working name assigned to a production plan item during + draft or planning stages before finalization. + desc_done: true - table: tabProduction Plan Item Reference description: '' fields: - name: name - description: '' + description: Unique identifier for the production plan item reference record - name: item_reference - description: '' + description: The specific item or product code being referenced in the production + plan - name: sales_order - description: '' + description: The sales order number that triggered or is linked to this production + plan item join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: sales_order_item - description: '' + description: Links production plan to the specific sales order line item that + triggered or requires this production. - name: qty - description: '' + description: Quantity of items to be produced for this production plan reference. + desc_done: true - table: tabProduction Plan Material Request description: '' fields: - name: name - description: '' + description: Unique identifier for the production plan material request record - name: material_request - description: '' + description: Reference to the specific material request document linked to this + production plan join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: material_request_date - description: '' + description: Date when the material request was created or submitted for this + production plan + desc_done: true - table: tabProduction Plan Material Request Warehouse description: '' fields: - name: name - description: '' + description: Unique identifier for the production plan material request warehouse + record - name: warehouse - description: '' + description: Warehouse location where materials for the production plan are requested + from or stored join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name + desc_done: true - table: tabProduction Plan Sales Order description: '' fields: - name: name - description: '' + description: Unique identifier for the production plan linked to a specific sales + order - name: sales_order - description: '' + description: Reference to the sales order that triggered or is associated with + this production plan join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: sales_order_date - description: '' + description: Date when the associated sales order was created or placed - name: customer - description: '' + description: Customer name or identifier associated with the sales order in the + production plan join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: grand_total - description: '' + description: Total monetary value of the sales order including all items, taxes, + and charges + desc_done: true - table: tabProduction Plan Sub Assembly Item description: '' fields: - name: name - description: '' + description: Unique identifier for the sub-assembly item record in the production + plan - name: production_item - description: '' + description: Item code or SKU of the sub-assembly component being produced or + consumed in the production plan join_hint: table: tabItem 'on': production_item = tabItem.name - name: item_name - description: '' + description: Human-readable name or description of the sub-assembly item for display + and search purposes - name: fg_warehouse - description: '' + description: Warehouse location where the finished goods from this sub-assembly + will be stored after production completion. join_hint: table: tabWarehouse 'on': fg_warehouse = tabWarehouse.name - name: parent_item_code - description: '' + description: Item code of the parent finished good or higher-level assembly that + requires this sub-assembly component. join_hint: table: tabItem 'on': parent_item_code = tabItem.name - name: schedule_date - description: '' + description: Planned date when this sub-assembly production should be completed + to meet the parent item's production timeline. - name: qty - description: '' + description: Quantity of the sub-assembly item required for the production plan. - name: bom_no - description: '' + description: Bill of materials number identifying which BOM structure this sub-assembly + belongs to. join_hint: table: tabBOM 'on': bom_no = tabBOM.name - name: bom_level - description: '' + description: Hierarchical level of the sub-assembly within the BOM structure, + indicating its depth in the assembly tree. - name: type_of_manufacturing - description: '' + description: Specifies whether the sub-assembly is manufactured in-house, outsourced, + or produced through another manufacturing method. options: - In House - Subcontract - Material Request - name: supplier - description: '' + description: Identifies the vendor supplying the sub-assembly when manufacturing + is outsourced or purchased externally. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: wo_produced_qty - description: '' + description: Tracks the actual quantity of the sub-assembly that has been completed + or produced against the work order. - name: purchase_order - description: '' + description: Purchase order number linked to procure this sub-assembly item for + the production plan. join_hint: table: tabPurchase Order 'on': purchase_order = tabPurchase Order.name - name: production_plan_item - description: '' + description: Specific item from the parent production plan that requires this + sub-assembly. - name: ordered_qty - description: '' + description: Quantity of the sub-assembly item ordered to fulfill production requirements. - name: received_qty - description: '' + description: Quantity of sub-assembly items actually received into inventory for + this production plan. - name: indent - description: '' + description: Hierarchical level or nesting depth of this sub-assembly item within + the production plan structure. - name: uom - description: '' + description: Unit of measurement for the sub-assembly item quantity (e.g., pieces, + kg, liters). join_hint: table: tabUOM 'on': uom = tabUOM.name - name: stock_uom - description: '' + description: Unit of measurement for the sub-assembly item quantity in the production + plan join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: description - description: '' + description: Detailed text describing the sub-assembly item or component in the + production plan - name: actual_qty - description: '' + description: Current available quantity of the sub-assembly item in stock - name: projected_qty - description: '' + description: Quantity of the sub-assembly item planned or forecasted to be produced + in this production plan. + desc_done: true - table: tabProject description: '' fields: - name: name - description: '' + description: Unique identifier or code for the project, used when searching or + filtering by project ID or reference number - name: naming_series - description: '' + description: Prefix pattern that determines how project identifiers are auto-generated, + relevant when asking about project numbering schemes or conventions options: - PROJ-.#### - name: project_name - description: '' + description: Full descriptive title of the project, used when searching by what + the project is called or its business purpose - name: status - description: '' + description: Current stage or state of the project such as planning, in progress, + on hold, completed, or cancelled. options: - Open - Completed - Cancelled - name: project_type - description: '' + description: Category or classification of the project such as internal, customer, + research, maintenance, or implementation. join_hint: table: tabProject Type 'on': project_type = tabProject Type.name - name: is_active - description: '' + description: Whether the project is currently active and ongoing versus inactive, + closed, or archived. options: - 'Yes' - 'No' - name: percent_complete_method - description: '' + description: Method used to calculate project completion percentage, such as manual + entry, task-based, or effort-based calculation. options: - Manual - Task Completion - Task Progress - Task Weight - name: percent_complete - description: '' + description: Current completion percentage of the project, used when users ask + how far along or what progress a project has made. - name: project_template - description: '' + description: Indicates whether this project is a reusable template for creating + new projects rather than an active project instance. join_hint: table: tabProject Template 'on': project_template = tabProject Template.name - name: expected_start_date - description: '' + description: When the project is planned or scheduled to begin work. - name: expected_end_date - description: '' + description: When the project is planned or scheduled to be completed. - name: priority - description: '' + description: Urgency or importance level assigned to the project for resource + allocation and scheduling decisions. options: - Medium - Low - High - name: department - description: '' + description: Department responsible for or assigned to the project join_hint: table: tabDepartment 'on': department = tabDepartment.name - name: customer - description: '' + description: Customer or client for whom the project is being performed join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: sales_order - description: '' + description: Sales order that initiated or is linked to the project join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: users - description: '' + description: Users assigned to or associated with the project for collaboration + and access control purposes. - name: copied_from - description: '' + description: The source project from which this project was duplicated or cloned. - name: notes - description: '' + description: Free-text comments, remarks, or additional information about the + project. - name: actual_start_date - description: '' + description: Date when work on the project actually began, used to compare against + planned start or analyze project delays. - name: actual_time - description: '' + description: Total time actually spent on the project, used to compare against + estimated time or analyze project effort and overruns. - name: actual_end_date - description: '' + description: Date when the project actually completed, used to compare against + planned end date or analyze project duration and delays. - name: estimated_costing - description: '' + description: Projected or budgeted cost for the project before actual expenses + are incurred. - name: total_costing_amount - description: '' + description: Actual total cost accumulated for the project including all expense + categories. - name: total_purchase_cost - description: '' + description: Total amount spent specifically on purchases or procurement for the + project. - name: company - description: '' + description: Company that owns or is responsible for the project join_hint: table: tabCompany 'on': company = tabCompany.name - name: total_sales_amount - description: '' + description: Total revenue value of the project including all billable and non-billable + amounts - name: total_billable_amount - description: '' + description: Amount that can be invoiced to the customer, excluding non-billable + costs or internal expenses - name: total_billed_amount - description: '' + description: Total revenue invoiced to the customer for this project across all + billing milestones and transactions. - name: total_consumed_material_cost - description: '' + description: Actual cost of materials used or consumed during project execution, + distinct from labor or overhead costs. - name: cost_center - description: '' + description: Accounting department or business unit to which project expenses + and revenues are allocated for financial tracking. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: gross_margin - description: '' + description: Total profit amount from the project calculated as revenue minus + direct costs. - name: per_gross_margin - description: '' + description: Gross margin expressed as a percentage of total project revenue. - name: collect_progress - description: '' + description: Current status or completion percentage of payment collection from + the customer for the project. - name: holiday_list - description: '' + description: Which holidays or non-working days apply to this project for scheduling + and resource planning purposes join_hint: table: tabHoliday List 'on': holiday_list = tabHoliday List.name - name: frequency - description: '' + description: How often project tasks, reports, or recurring activities are scheduled + or repeated options: - Hourly - Twice Daily - Daily - Weekly - name: from_time - description: '' + description: Start time of day for project work hours or time-based project activities - name: to_time - description: '' + description: Project end time or deadline when the project is scheduled to complete + or finish - name: first_email - description: '' + description: Primary email contact for the project, typically the main point of + contact or project owner - name: second_email - description: '' + description: Secondary or alternate email contact for the project, used when additional + notification or backup contact is needed - name: daily_time_to_send - description: '' + description: Time of day when daily project notifications or reports are scheduled + to be sent - name: day_to_send - description: '' + description: Specific day of the week or month when recurring project notifications + or reports are scheduled to be sent options: - Monday - Tuesday @@ -18800,157 +23112,211 @@ tables: - Saturday - Sunday - name: weekly_time_to_send - description: '' + description: Time of day when weekly project notifications or reports are scheduled + to be sent - name: subject - description: '' + description: Project title or name used to identify and search for specific projects - name: message - description: '' + description: Detailed project description, notes, or additional context about + the project scope and objectives + desc_done: true - table: tabProject Template description: '' fields: - name: name - description: '' + description: Template name or title used to identify and select predefined project + configurations - name: project_type - description: '' + description: Category or classification of projects this template is designed + for join_hint: table: tabProject Type 'on': project_type = tabProject Type.name - name: tasks - description: '' + description: Predefined task list or task structure included in this template + for new projects + desc_done: true - table: tabProject Template Task description: '' fields: - name: name - description: '' + description: Identifies the project template name used when users search for which + templates contain specific task configurations or when filtering tasks by their + parent template. - name: task - description: '' + description: Specifies the individual task within a template, used when querying + what tasks are included in a template or when comparing task sequences across + different project templates. join_hint: table: tabTask 'on': task = tabTask.name - name: subject - description: '' + description: Describes the task topic or category, used when searching for tasks + related to specific business areas or when grouping template tasks by functional + domain. + desc_done: true - table: tabProject Type description: '' fields: - name: name - description: '' + description: Project type name or label used to categorize and identify different + kinds of projects - name: project_type - description: '' + description: Unique code or identifier for the project type used in system references + and lookups - name: description - description: '' + description: Detailed explanation of what the project type represents and when + it should be applied to projects + desc_done: true - table: tabProject Update description: '' fields: - name: name - description: '' + description: Unique identifier for the project update record, used when referencing + or retrieving a specific update entry. - name: naming_series - description: '' + description: Prefix pattern for auto-generating project update names, used when + configuring numbering schemes for update tracking. - name: project - description: '' + description: Links to the parent project being updated, used when filtering or + reporting updates for a specific project. join_hint: table: tabProject 'on': project = tabProject.name - name: sent - description: '' + description: Whether the project update has been sent or distributed to stakeholders + or team members - name: date - description: '' + description: The calendar date when the project update was created or issued - name: time - description: '' + description: The specific time of day when the project update was created or issued - name: users - description: '' + description: Users who have been notified or are associated with this project + update for collaboration and visibility purposes. - name: amended_from - description: '' + description: Reference to the previous project update that this update corrects + or replaces when amendments are made. join_hint: table: tabProject Update 'on': amended_from = tabProject Update.name + desc_done: true - table: tabProject User description: '' fields: - name: name - description: '' + description: Project name used when filtering or reporting on specific projects + or initiatives. - name: user - description: '' + description: User assigned to the project, used when identifying project team + members or filtering by resource allocation. join_hint: table: tabUser 'on': user = tabUser.name - name: email - description: '' + description: Contact email for project-related user, used when looking up communication + details or notifying stakeholders. - name: image - description: '' + description: Profile picture or avatar for the project user - name: full_name - description: '' + description: Complete name of the project user for display and identification + purposes - name: welcome_email_sent - description: '' + description: Whether an initial welcome email has been delivered to the project + user - name: view_attachments - description: '' + description: Whether the user has permission to view files and documents attached + to the project. - name: hide_timesheets - description: '' + description: Whether timesheet entries are hidden from this user's view of the + project. - name: project_status - description: '' + description: The current lifecycle stage or state of the project such as active, + completed, on hold, or cancelled. + desc_done: true - table: tabProjects Settings description: '' fields: - name: name - description: '' + description: Unique identifier or label for the project settings configuration - name: ignore_workstation_time_overlap - description: '' + description: Whether to allow multiple time entries for the same workstation during + overlapping periods - name: ignore_user_time_overlap - description: '' + description: Whether to allow a user to log time on multiple tasks or projects + during overlapping periods - name: ignore_employee_time_overlap - description: '' + description: Controls whether the system allows employees to log overlapping time + entries across multiple projects or tasks. - name: fetch_timesheet_in_sales_invoice - description: '' + description: Determines whether timesheet data is automatically pulled into sales + invoices for billing purposes. + desc_done: true - table: tabPromotional Scheme description: '' fields: - name: name - description: '' + description: Name or title of the promotional scheme used to identify and reference + specific marketing campaigns or discount programs - name: apply_on - description: '' + description: Specifies whether the promotion applies to item codes, item groups, + or brands to determine eligible products options: - Item Code - Item Group - Brand - Transaction - name: disable - description: '' + description: Indicates if the promotional scheme is currently inactive and should + not be applied to transactions - name: items - description: '' + description: Specific product SKUs or item codes included in this promotional + scheme. - name: item_groups - description: '' + description: Product categories or groups eligible for this promotional scheme + when targeting broader product classifications rather than individual items. - name: brands - description: '' + description: Brand names or manufacturers whose products are included in this + promotional scheme. - name: mixed_conditions - description: '' + description: Whether the promotional scheme allows combining different types of + conditions like quantity and amount thresholds together. - name: is_cumulative - description: '' + description: Whether benefits from this promotional scheme can stack with other + active promotions or are applied exclusively. - name: apply_rule_on_other - description: '' + description: Whether the scheme's pricing or discount rules apply to other items + beyond those meeting the qualifying conditions. options: - Item Code - Item Group - Brand - name: other_item_code - description: '' + description: Identifies the additional or alternative product offered as part + of the promotional scheme. join_hint: table: tabItem 'on': other_item_code = tabItem.name - name: other_item_group - description: '' + description: Categorizes the additional or alternative product by its product + group in the promotional scheme. join_hint: table: tabItem Group 'on': other_item_group = tabItem Group.name - name: other_brand - description: '' + description: Specifies the brand of the additional or alternative product included + in the promotional scheme. join_hint: table: tabBrand 'on': other_brand = tabBrand.name - name: selling - description: '' + description: Indicates whether this promotional scheme applies to sales transactions + or customer-facing pricing. - name: buying - description: '' + description: Indicates whether this promotional scheme applies to purchase transactions + or supplier-facing pricing. - name: applicable_for - description: '' + description: Specifies the scope or entity type this promotional scheme targets, + such as specific items, item groups, customers, or territories. options: - Customer - Customer Group @@ -18960,84 +23326,112 @@ tables: - Supplier - Supplier Group - name: customer - description: '' + description: Specific customer account to which this promotional scheme applies + or is restricted. - name: customer_group - description: '' + description: Customer classification or segment eligible for this promotional + scheme when not targeting individual customers. - name: territory - description: '' + description: Geographic region or sales territory where this promotional scheme + is valid or applicable. - name: sales_partner - description: '' + description: Identifies the external sales partner or distributor associated with + this promotional scheme for partner-specific incentive programs. - name: campaign - description: '' + description: Links this promotional scheme to a specific marketing campaign to + track campaign-driven discounts and offers. - name: supplier - description: '' + description: Specifies the supplier providing promotional support or funding for + this scheme, typically for vendor-funded promotions. - name: supplier_group - description: '' + description: Identifies which group of suppliers this promotional scheme applies + to for filtering or analyzing promotions by supplier category. - name: valid_from - description: '' + description: Start date when the promotional scheme becomes active and can be + applied to transactions. - name: valid_upto - description: '' + description: End date when the promotional scheme expires and is no longer applicable + to transactions. - name: company - description: '' + description: Identifies which company entity the promotional scheme applies to + for multi-company filtering. join_hint: table: tabCompany 'on': company = tabCompany.name - name: currency - description: '' + description: Specifies the currency in which promotional scheme discounts, thresholds, + or pricing are denominated. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: price_discount_slabs - description: '' + description: Defines tiered discount levels based on quantity or value thresholds + within the promotional scheme. - name: product_discount_slabs - description: '' + description: Tiered discount levels or brackets applied to products based on quantity, + value, or other criteria within the promotional scheme. + desc_done: true - table: tabPromotional Scheme Price Discount description: '' fields: - name: name - description: '' + description: Unique identifier or title of the promotional scheme price discount - name: disable - description: '' + description: Whether this promotional scheme price discount is currently inactive + or deactivated - name: apply_multiple_pricing_rules - description: '' + description: Whether multiple pricing rules can be stacked or combined for this + promotional scheme - name: rule_description - description: '' + description: Text explanation of the promotional discount rule conditions and + terms for this price discount tier. - name: min_qty - description: '' + description: Minimum purchase quantity required to qualify for this promotional + price discount tier. - name: max_qty - description: '' + description: Maximum purchase quantity allowed for this promotional price discount + tier before moving to next tier. - name: min_amount - description: '' + description: Minimum purchase amount required to qualify for this promotional + discount tier - name: max_amount - description: '' + description: Maximum purchase amount threshold for this promotional discount tier - name: rate_or_discount - description: '' + description: Percentage or fixed discount value applied when purchase amount falls + within this tier's range options: - Rate - Discount Percentage - Discount Amount - name: rate - description: '' + description: Price per unit after applying the promotional scheme discount. - name: discount_amount - description: '' + description: Fixed monetary value deducted from the original price in the promotional + scheme. - name: discount_percentage - description: '' + description: Percentage reduction applied to the original price in the promotional + scheme. - name: for_price_list - description: '' + description: Price list to which this promotional discount scheme applies, used + when querying promotions for specific customer pricing tiers or regions. join_hint: table: tabPrice List 'on': for_price_list = tabPrice List.name - name: warehouse - description: '' + description: Warehouse location where this promotional discount is valid, used + when filtering promotions by inventory or fulfillment location. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: threshold_percentage - description: '' + description: Minimum percentage threshold that must be met to trigger this promotional + discount, used when checking discount eligibility conditions. - name: validate_applied_rule - description: '' + description: Whether the promotional scheme validates or checks if the discount + rule was correctly applied to transactions. - name: priority - description: '' + description: Order of precedence when multiple promotional schemes or discount + rules could apply to the same transaction. options: - '1' - '2' @@ -19060,53 +23454,70 @@ tables: - '19' - '20' - name: apply_discount_on_rate - description: '' + description: Whether the discount percentage or amount is calculated based on + the item's rate or price. + desc_done: true - table: tabPromotional Scheme Product Discount description: '' fields: - name: name - description: '' + description: Unique identifier or label for the promotional scheme product discount - name: disable - description: '' + description: Whether this promotional scheme product discount is inactive and + should not be applied to transactions - name: apply_multiple_pricing_rules - description: '' + description: Whether multiple promotional pricing rules can be stacked or combined + for the same product in this scheme - name: rule_description - description: '' + description: Describes the specific discount rule or condition applied to products + in this promotional scheme. - name: min_qty - description: '' + description: Minimum product quantity required to qualify for this promotional + discount. - name: max_qty - description: '' + description: Maximum product quantity eligible for this promotional discount tier. - name: min_amount - description: '' + description: Minimum purchase amount or quantity threshold required to qualify + for the promotional discount on products. - name: max_amount - description: '' + description: Maximum purchase amount or quantity threshold up to which the promotional + discount applies to products. - name: same_item - description: '' + description: Indicates whether the discount applies only when purchasing multiple + units of the same product versus mixed products. - name: free_item - description: '' + description: The product code or item that is given for free as part of this promotional + discount scheme. join_hint: table: tabItem 'on': free_item = tabItem.name - name: free_qty - description: '' + description: The quantity of the free item provided when the promotional scheme + conditions are met. - name: free_item_uom - description: '' + description: The unit of measure for the free item quantity in this promotional + scheme. join_hint: table: tabUOM 'on': free_item_uom = tabUOM.name - name: free_item_rate - description: '' + description: Rate or price assigned to the free item given as part of the promotional + discount scheme. - name: round_free_qty - description: '' + description: Whether to round the calculated free quantity to the nearest whole + number in the promotion. - name: warehouse - description: '' + description: Specific warehouse location where the promotional product discount + scheme is applicable or valid. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: threshold_percentage - description: '' + description: Minimum percentage threshold required for the product discount to + apply in the promotional scheme. - name: priority - description: '' + description: Ranking order that determines which promotional discount applies + when multiple schemes are eligible for the same product. options: - '1' - '2' @@ -19129,25 +23540,31 @@ tables: - '19' - '20' - name: is_recursive - description: '' + description: Whether the promotional discount applies repeatedly or cascades through + multiple levels of the product hierarchy or transaction. - name: recurse_for - description: '' + description: Specifies the entity or dimension (like customer group or territory) + for which the discount applies recursively to child records in the hierarchy. - name: apply_recursion_over - description: '' + description: Defines the specific hierarchical field or relationship path over + which the promotional discount recursion is applied. + desc_done: true - table: tabProspect description: '' fields: - name: name - description: '' + description: Full name of the prospect individual or primary contact person - name: company_name - description: '' + description: Name of the organization or business entity the prospect represents - name: customer_group - description: '' + description: Classification or segment assigned to the prospect for targeting + and qualification purposes join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: no_of_employees - description: '' + description: Number of employees at the prospect company, used to assess company + size and sales opportunity scale. options: - 1-10 - 11-50 @@ -19156,172 +23573,227 @@ tables: - 501-1000 - 1000+ - name: annual_revenue - description: '' + description: Yearly revenue of the prospect company, used to evaluate financial + capacity and prioritize high-value opportunities. - name: market_segment - description: '' + description: Industry or business category the prospect operates in, used to target + specific verticals or filter by sector. join_hint: table: tabMarket Segment 'on': market_segment = tabMarket Segment.name - name: industry - description: '' + description: The business sector or market vertical of the prospect, used when + filtering or analyzing prospects by their type of business activity. join_hint: table: tabIndustry Type 'on': industry = tabIndustry Type.name - name: territory - description: '' + description: The geographic region or sales area assigned to the prospect, used + when routing leads or analyzing prospects by location-based assignments. join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: prospect_owner - description: '' + description: The salesperson or team member responsible for managing and following + up with the prospect. join_hint: table: tabUser 'on': prospect_owner = tabUser.name - name: website - description: '' + description: URL of the prospect's company website for online presence and contact + information - name: fax - description: '' + description: Fax number for the prospect, used when traditional document transmission + methods are required - name: company - description: '' + description: Name of the company or organization the prospect represents or is + affiliated with join_hint: table: tabCompany 'on': company = tabCompany.name - name: leads - description: '' + description: Potential customers or contacts who have shown initial interest but + have not yet been qualified or converted into active sales opportunities. - name: opportunities - description: '' + description: Qualified sales prospects with defined potential value, timeline, + and probability of closing a deal. - name: notes - description: '' + description: Free-text comments, observations, or additional information recorded + about the prospect's interactions, preferences, or status. + desc_done: true - table: tabProspect Lead description: '' fields: - name: name - description: '' + description: Unique identifier or full name of the prospect lead record used to + reference and track individual leads throughout the sales pipeline. - name: lead - description: '' + description: Foreign key linking to the lead record, used when querying prospect + conversion status or analyzing lead source effectiveness. join_hint: table: tabLead 'on': lead = tabLead.name - name: lead_name - description: '' + description: Display name of the associated lead, used for reporting and filtering + prospects by their originating lead information. - name: email - description: '' + description: Email address of the prospect for contact and communication purposes. - name: mobile_no - description: '' + description: Mobile phone number of the prospect for direct contact. - name: lead_owner - description: '' + description: Sales representative or team member responsible for managing and + following up with this prospect. - name: status - description: '' + description: Current stage of the prospect lead in the sales pipeline, such as + new, contacted, qualified, or converted. + desc_done: true - table: tabProspect Opportunity description: '' fields: - name: name - description: '' + description: Identifies the prospect or customer associated with the opportunity + for filtering and reporting on specific accounts. - name: opportunity - description: '' + description: Describes the sales opportunity or deal being pursued, used when + searching for specific deals or opportunity types. join_hint: table: tabOpportunity 'on': opportunity = tabOpportunity.name - name: amount - description: '' + description: Contains the monetary value of the opportunity, used when analyzing + deal sizes, revenue forecasts, or filtering by value thresholds. - name: stage - description: '' + description: Current sales pipeline stage of the opportunity such as prospecting, + qualification, proposal, negotiation, or closed. - name: deal_owner - description: '' + description: Sales representative or team member responsible for managing and + closing this opportunity. - name: probability - description: '' + description: Likelihood percentage that this opportunity will close successfully + and convert to a sale. - name: expected_closing - description: '' + description: Date when the sales opportunity is anticipated to close or convert + to a won deal. - name: currency - description: '' + description: Currency in which the opportunity value and revenue amounts are denominated. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: contact_person - description: '' + description: Primary contact or decision-maker associated with this sales opportunity + at the prospect organization. join_hint: table: tabContact 'on': contact_person = tabContact.name + desc_done: true - table: tabPurchase Invoice description: '' fields: - name: name - description: '' + description: Unique identifier for the purchase invoice used in queries asking + for a specific invoice by its number or ID - name: title - description: '' + description: Supplier name associated with the purchase invoice, used when searching + invoices by vendor or supplier - name: naming_series - description: '' + description: Prefix pattern that determines how purchase invoice numbers are automatically + formatted and sequenced options: - ACC-PINV-.YYYY.- - ACC-PINV-RET-.YYYY.- - name: supplier - description: '' + description: Unique identifier for the vendor who issued the purchase invoice, + used when filtering or joining supplier records. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: supplier_name - description: '' + description: Display name of the vendor on the purchase invoice, used when searching + by vendor name or displaying human-readable reports. - name: tax_id - description: '' + description: Tax registration number of the supplier on the purchase invoice, + used for tax compliance queries and vendor verification. - name: company - description: '' + description: The company entity that received goods or services and is responsible + for paying this purchase invoice. join_hint: table: tabCompany 'on': company = tabCompany.name - name: posting_date - description: '' + description: The date when this purchase invoice was officially recorded in the + accounting ledger, used for financial period reporting and aging analysis. - name: posting_time - description: '' + description: The time of day when this purchase invoice was posted to the accounting + system, used when precise transaction timing matters for audit trails or same-day + sequencing. - name: set_posting_time - description: '' + description: Indicates whether the posting date was manually specified rather + than defaulting to the transaction creation time. - name: due_date - description: '' + description: The date by which payment for this purchase invoice must be made + to the supplier. - name: is_paid - description: '' + description: Indicates whether the purchase invoice has been fully paid or remains + outstanding. - name: is_return - description: '' + description: Indicates whether this purchase invoice represents a return of goods + to the supplier rather than a new purchase. - name: return_against - description: '' + description: References the original purchase invoice document that this return + invoice is reversing or crediting. join_hint: table: tabPurchase Invoice 'on': return_against = tabPurchase Invoice.name - name: update_outstanding_for_self - description: '' + description: Controls whether this purchase invoice updates its own outstanding + amount when it is also referenced as a return document by another invoice. - name: update_billed_amount_in_purchase_order - description: '' + description: Whether this invoice updates the billed amount on the linked purchase + order to track billing progress against the order. - name: update_billed_amount_in_purchase_receipt - description: '' + description: Whether this invoice updates the billed amount on the linked purchase + receipt to track billing against received goods. - name: apply_tds - description: '' + description: Whether tax deducted at source is applied to this purchase invoice + for withholding tax compliance. - name: tax_withholding_category - description: '' + description: Category for tax withholding applied to this purchase invoice, used + when filtering or reporting on invoices by withholding tax type. join_hint: table: tabTax Withholding Category 'on': tax_withholding_category = tabTax Withholding Category.name - name: amended_from - description: '' + description: Reference to the original purchase invoice that this invoice amends + or corrects. join_hint: table: tabPurchase Invoice 'on': amended_from = tabPurchase Invoice.name - name: custom_zatca_summary_invoice - description: '' + description: Indicates whether this purchase invoice is a ZATCA-compliant summary + invoice for Saudi Arabian tax reporting. - name: custom_zatca_3rd_party_invoice - description: '' + description: Indicates if this purchase invoice was issued by a third party on + behalf of the supplier for ZATCA compliance purposes. - name: custom_zatca_self_billed_invoice - description: '' + description: Indicates if this purchase invoice was created by the buyer instead + of the supplier for ZATCA compliance purposes. - name: custom_zatca_import_invoice - description: '' + description: Indicates if this purchase invoice is for imported goods requiring + ZATCA import tax treatment. - name: custom_zatca_nominal_invoice - description: '' + description: Indicates if this is a nominal invoice under ZATCA regulations for + Saudi Arabia tax compliance purposes. - name: custom_zatca_tax_category - description: '' + description: ZATCA tax category classification code for Saudi Arabia e-invoicing + compliance determining applicable VAT treatment. options: - Standard - Zero Rated - Exempted - Services outside scope of tax / Not subject to VAT - name: custom_exemption_reason_code - description: '' + description: Code explaining why the invoice is exempt from standard tax under + ZATCA regulations for Saudi Arabia compliance reporting. options: - Standard 15% - VATEX-SA-29 @@ -19341,262 +23813,343 @@ tables: - VATEX-SA-MLTRY - VATEX-SA-OOS - name: bill_no - description: '' + description: Supplier's invoice or bill number used to reference or search for + specific purchase invoices from vendors. - name: bill_date - description: '' + description: Date on the supplier's invoice, used when filtering or searching + purchases by when the vendor issued the bill. - name: cost_center - description: '' + description: Accounting cost center assigned to this purchase invoice for expense + allocation and departmental cost tracking. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Links the purchase invoice to a specific project for tracking project-related + procurement costs and expenses. join_hint: table: tabProject 'on': project = tabProject.name - name: currency - description: '' + description: The currency in which the purchase invoice amount is denominated + and will be paid. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: conversion_rate - description: '' + description: The exchange rate used to convert the invoice currency to the company's + base currency for accounting purposes. - name: use_transaction_date_exchange_rate - description: '' + description: Whether the invoice uses the exchange rate from the transaction date + rather than a manually specified rate. - name: buying_price_list - description: '' + description: The price list applied to determine purchase prices for items on + this invoice. join_hint: table: tabPrice List 'on': buying_price_list = tabPrice List.name - name: price_list_currency - description: '' + description: The currency in which the price list is denominated, which may differ + from the invoice currency. join_hint: table: tabCurrency 'on': price_list_currency = tabCurrency.name - name: plc_conversion_rate - description: '' + description: Exchange rate used to convert price list currency to transaction + currency for this purchase invoice. - name: ignore_pricing_rule - description: '' + description: Whether automated pricing rules and discounts were bypassed when + creating this purchase invoice. - name: scan_barcode - description: '' + description: Barcode scanned to quickly add items to the purchase invoice during + data entry. - name: last_scanned_warehouse - description: '' + description: Warehouse location most recently scanned during purchase invoice + item receipt or barcode processing. - name: update_stock - description: '' + description: Indicates whether this purchase invoice automatically updates inventory + stock levels upon submission. - name: set_warehouse - description: '' + description: Default warehouse location assigned to all items in this purchase + invoice for stock receipt. join_hint: table: tabWarehouse 'on': set_warehouse = tabWarehouse.name - name: set_from_warehouse - description: '' + description: Warehouse from which purchased items are received or set to be stocked + after invoice processing. join_hint: table: tabWarehouse 'on': set_from_warehouse = tabWarehouse.name - name: is_subcontracted - description: '' + description: Indicates whether the purchase invoice relates to subcontracted manufacturing + or production work. - name: rejected_warehouse - description: '' + description: Warehouse where rejected or non-conforming items from this purchase + are stored or returned. join_hint: table: tabWarehouse 'on': rejected_warehouse = tabWarehouse.name - name: supplier_warehouse - description: '' + description: Warehouse location from which the supplier ships or delivers the + purchased items. join_hint: table: tabWarehouse 'on': supplier_warehouse = tabWarehouse.name - name: items - description: '' + description: Line items detailing individual products, quantities, rates, and + amounts included in the purchase invoice. - name: total_qty - description: '' + description: Sum of quantities across all line items in the purchase invoice. - name: total_net_weight - description: '' + description: Total weight of all items in the purchase invoice excluding packaging + or container weight. - name: base_total - description: '' + description: Total amount of the purchase invoice in company's base currency before + any taxes or discounts are applied. - name: base_net_total - description: '' + description: Total amount of the purchase invoice in company's base currency after + discounts but before taxes. - name: total - description: '' + description: Grand total amount of the purchase invoice including all taxes, charges, + and discounts. - name: net_total - description: '' + description: Subtotal amount before applying taxes and additional charges but + after item-level discounts. - name: tax_withholding_net_total - description: '' + description: Net amount subject to tax withholding or tax deducted at source calculations. - name: base_tax_withholding_net_total - description: '' + description: Net total amount after tax withholding in base currency, used when + calculating vendor payments with withholding tax deductions. - name: tax_category - description: '' + description: Classification of tax treatment applied to the invoice, used to determine + which tax rules or rates apply based on vendor or transaction type. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: taxes_and_charges - description: '' + description: Template or configuration name defining which specific taxes and + additional charges are applied to this purchase invoice. join_hint: table: tabPurchase Taxes and Charges Template 'on': taxes_and_charges = tabPurchase Taxes and Charges Template.name - name: shipping_rule - description: '' + description: Shipping method or carrier rule applied to the purchase invoice for + freight calculation and logistics tracking. join_hint: table: tabShipping Rule 'on': shipping_rule = tabShipping Rule.name - name: incoterm - description: '' + description: International commercial terms code defining responsibility transfer + point between buyer and seller for shipping costs and risk. join_hint: table: tabIncoterm 'on': incoterm = tabIncoterm.name - name: named_place - description: '' + description: Specific geographic location or port referenced in the incoterm where + responsibility transfers between parties. - name: taxes - description: '' + description: Total tax amount applied to the purchase invoice including all tax + types and components. - name: base_taxes_and_charges_added - description: '' + description: Total value of additional taxes and charges in base currency that + increase the invoice amount. - name: base_taxes_and_charges_deducted - description: '' + description: Total value of taxes and charges in base currency that decrease the + invoice amount such as tax credits or deductions. - name: base_total_taxes_and_charges - description: '' + description: Net total of all taxes and charges in base currency after adding + and deducting applicable amounts. - name: taxes_and_charges_added - description: '' + description: Sum of all tax and charge amounts that increase the invoice total. - name: taxes_and_charges_deducted - description: '' + description: Sum of all tax and charge amounts that decrease the invoice total. - name: total_taxes_and_charges - description: '' + description: Sum of all tax and charge amounts applied to the purchase invoice, + used when analyzing tax costs or verifying tax calculations. - name: base_grand_total - description: '' + description: Final total amount of the purchase invoice in base currency including + all items, taxes, and charges. - name: base_rounding_adjustment - description: '' + description: Adjustment amount in base currency applied to round the final invoice + total to the nearest acceptable value. - name: base_rounded_total - description: '' + description: Total amount in base currency after applying rounding adjustments + to the invoice. - name: base_in_words - description: '' + description: Text representation of the base currency total amount written out + in words for formal documentation. - name: grand_total - description: '' + description: Final total amount of the invoice in transaction currency including + all taxes, charges, and discounts. - name: rounding_adjustment - description: '' + description: Amount added or subtracted to round the invoice total to the nearest + whole number or decimal place. - name: use_company_roundoff_cost_center - description: '' + description: Whether the company's default cost center is applied to the rounding + adjustment line item. - name: rounded_total - description: '' + description: Final invoice total after applying rounding adjustment to the calculated + total. - name: in_words - description: '' + description: Total invoice amount expressed as text words for check printing and + formal documentation - name: total_advance - description: '' + description: Sum of all advance payments or prepayments applied against this purchase + invoice - name: outstanding_amount - description: '' + description: Remaining unpaid balance on the purchase invoice after deducting + payments and advances - name: disable_rounded_total - description: '' + description: Whether invoice total rounding is disabled, relevant when users ask + about exact unrounded totals or rounding behavior. - name: apply_discount_on - description: '' + description: Specifies whether discounts apply to grand total or net total, used + when users ask how discounts are calculated. options: - Grand Total - Net Total - name: base_discount_amount - description: '' + description: Total discount amount in base currency, used when users ask about + total discounts applied to the invoice in company's default currency. - name: additional_discount_percentage - description: '' + description: Percentage discount applied to the entire invoice beyond item-level + discounts, used when calculating total invoice discount. - name: discount_amount - description: '' + description: Total monetary value of all discounts applied to the invoice, used + when analyzing actual discount given in currency. - name: tax_withheld_vouchers - description: '' + description: References to tax withholding certificates or vouchers associated + with this purchase invoice for compliance tracking. - name: other_charges_calculation - description: '' + description: Additional fees or charges beyond item costs, such as freight, handling, + or insurance charges added to the purchase invoice total. - name: pricing_rules - description: '' + description: Special pricing agreements or discount rules applied to this purchase + invoice, such as volume discounts or supplier-specific pricing terms. - name: supplied_items - description: '' + description: Materials or components provided by the buyer to the supplier for + use in manufacturing or processing the purchased goods. - name: mode_of_payment - description: '' + description: Payment method used for the purchase invoice such as cash, check, + credit card, or bank transfer. join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: base_paid_amount - description: '' + description: Amount already paid against this purchase invoice in the company's + base currency. - name: clearance_date - description: '' + description: Date when the payment for this purchase invoice was cleared or reconciled + in the bank account. - name: cash_bank_account - description: '' + description: Account from which payment for this purchase invoice was made or + will be made. join_hint: table: tabAccount 'on': cash_bank_account = tabAccount.name - name: paid_amount - description: '' + description: Total amount already paid against this purchase invoice. - name: allocate_advances_automatically - description: '' + description: Whether advance payments to the supplier are automatically applied + to this invoice. - name: only_include_allocated_payments - description: '' + description: Whether to include only payments that have been allocated to specific + invoices, excluding unallocated or advance payments. - name: advances - description: '' + description: Total amount received as advance payment before the invoice was issued. - name: advance_tax - description: '' + description: Tax amount calculated or withheld on advance payments received. - name: write_off_amount - description: '' + description: Amount written off from the purchase invoice in transaction currency, + used when querying invoice adjustments or discrepancies that were written off. - name: base_write_off_amount - description: '' + description: Amount written off from the purchase invoice in company base currency, + used for consolidated reporting across multiple currencies. - name: write_off_account - description: '' + description: General ledger account where the write-off amount is posted, used + when analyzing where invoice write-offs are recorded financially. join_hint: table: tabAccount 'on': write_off_account = tabAccount.name - name: write_off_cost_center - description: '' + description: Cost center assigned when writing off discrepancies or variances + on this purchase invoice. join_hint: table: tabCost Center 'on': write_off_cost_center = tabCost Center.name - name: supplier_address - description: '' + description: Specific supplier address linked to this purchase invoice, relevant + when supplier has multiple locations. join_hint: table: tabAddress 'on': supplier_address = tabAddress.name - name: address_display - description: '' + description: Formatted full address text for display purposes, combining all address + components into readable format. - name: contact_person - description: '' + description: Name of the specific individual at the supplier who is the point + of contact for this purchase invoice. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_display - description: '' + description: Formatted display name or full contact information for the supplier + contact person on this purchase invoice. - name: contact_mobile - description: '' + description: Mobile phone number of the supplier contact person associated with + this purchase invoice. - name: contact_email - description: '' + description: Email address of the supplier contact person for this purchase invoice. - name: dispatch_address - description: '' + description: Address identifier where purchased goods are to be delivered or received. join_hint: table: tabAddress 'on': dispatch_address = tabAddress.name - name: dispatch_address_display - description: '' + description: Formatted delivery address text for display purposes, differs from + dispatch_address which is the identifier. - name: shipping_address - description: '' + description: Linked address record where purchased goods are delivered to the + buyer's location join_hint: table: tabAddress 'on': shipping_address = tabAddress.name - name: shipping_address_display - description: '' + description: Formatted text showing the complete delivery address as it appears + on shipping documents - name: billing_address - description: '' + description: Address where invoice is sent and payment correspondence is directed, + often differs from delivery location join_hint: table: tabAddress 'on': billing_address = tabAddress.name - name: billing_address_display - description: '' + description: Full formatted billing address for the purchase invoice, used when + searching by supplier billing location or address details. - name: payment_terms_template - description: '' + description: Template defining payment due dates and conditions for this purchase + invoice, referenced when querying payment schedules or terms agreements. join_hint: table: tabPayment Terms Template 'on': payment_terms_template = tabPayment Terms Template.name - name: ignore_default_payment_terms_template - description: '' + description: Indicates whether the supplier's default payment terms were overridden + for this specific purchase invoice. - name: payment_schedule - description: '' + description: Payment schedule template defining installment structure for the + purchase invoice - name: tc_name - description: '' + description: Terms and conditions template name applied to the purchase invoice join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Payment terms defining due date calculation such as net 30 or due + on receipt - name: status - description: '' + description: Current state of the purchase invoice such as draft, submitted, paid, + or cancelled. options: - Draft - Return @@ -19609,627 +24162,827 @@ tables: - Cancelled - Internal Transfer - name: per_received - description: '' + description: Percentage of items or quantity that has been physically received + against this purchase invoice. - name: credit_to - description: '' + description: General ledger account that will be credited when this purchase invoice + is posted, typically accounts payable or a liability account. join_hint: table: tabAccount 'on': credit_to = tabAccount.name - name: party_account_currency - description: '' + description: Currency in which the supplier's account balance is maintained, relevant + when asking about foreign currency purchases or supplier payment currencies. join_hint: table: tabCurrency 'on': party_account_currency = tabCurrency.name - name: is_opening - description: '' + description: Indicates whether this purchase invoice is an opening balance entry + from a previous accounting period or system migration. options: - 'No' - 'Yes' - name: against_expense_account - description: '' + description: Expense account(s) debited by this purchase invoice, used when analyzing + spending by expense category or cost center allocation. - name: unrealized_profit_loss_account - description: '' + description: Account used to record unrealized gains or losses on this purchase + invoice, typically for foreign currency or valuation adjustments. join_hint: table: tabAccount 'on': unrealized_profit_loss_account = tabAccount.name - name: subscription - description: '' + description: Links this purchase invoice to a recurring subscription plan if the + invoice is part of a subscription billing arrangement. join_hint: table: tabSubscription 'on': subscription = tabSubscription.name - name: auto_repeat - description: '' + description: Links this purchase invoice to an automatic repetition schedule for + recurring purchases at defined intervals. join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: from_date - description: '' + description: Start date of the billing period or service period covered by this + purchase invoice. - name: to_date - description: '' + description: End date of the billing period or service period covered by this + purchase invoice. - name: letter_head - description: '' + description: Letterhead template or branding header used when printing or displaying + this purchase invoice. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: group_same_items - description: '' + description: Whether identical line items are consolidated together on the purchase + invoice display or print output. - name: select_print_heading - description: '' + description: Custom heading or title that appears when printing this purchase + invoice instead of the default label. join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: language - description: '' + description: Language in which this purchase invoice is displayed or printed for + vendor communication. - name: on_hold - description: '' + description: Whether the purchase invoice is currently on hold and blocked from + payment or processing. - name: release_date - description: '' + description: The date when a held purchase invoice was released or is scheduled + to be released for payment. - name: hold_comment - description: '' + description: The reason or explanation for why the purchase invoice was placed + on hold. - name: is_internal_supplier - description: '' + description: Whether the supplier is an internal company entity for inter-company + transactions. - name: represents_company - description: '' + description: The company entity that the supplier represents in inter-company + or group transactions. join_hint: table: tabCompany 'on': represents_company = tabCompany.name - name: supplier_group - description: '' + description: The classification or category grouping for the supplier used for + segmentation and reporting. join_hint: table: tabSupplier Group 'on': supplier_group = tabSupplier Group.name - name: inter_company_invoice_reference - description: '' + description: Links to the corresponding invoice in inter-company transactions + when one company entity purchases from another within the same organization. join_hint: table: tabSales Invoice 'on': inter_company_invoice_reference = tabSales Invoice.name - name: is_old_subcontracting_flow - description: '' + description: Indicates whether this purchase invoice follows the legacy subcontracting + process rather than the current subcontracting workflow. - name: remarks - description: '' + description: Additional notes or comments about the purchase invoice for internal + reference or special instructions. + desc_done: true - table: tabPurchase Invoice Advance description: '' fields: - name: name - description: '' + description: Unique identifier for the purchase invoice advance record - name: reference_type - description: '' + description: Type of document this advance is linked to, such as Purchase Order + or Payment Entry join_hint: table: tabDocType 'on': reference_type = tabDocType.name - name: reference_name - description: '' + description: Specific document ID or number that this advance payment references - name: remarks - description: '' + description: Comments or notes explaining the reason for or details about the + advance payment allocation. - name: reference_row - description: '' + description: Links to the specific row in the referenced advance document being + allocated against this purchase invoice. - name: advance_amount - description: '' + description: The monetary value of advance payment being applied or allocated + to this purchase invoice. - name: allocated_amount - description: '' + description: Amount of advance payment that has been applied or allocated against + a purchase invoice. - name: exchange_gain_loss - description: '' + description: Gain or loss resulting from currency exchange rate differences between + advance payment and invoice settlement. - name: ref_exchange_rate - description: '' + description: Exchange rate used to convert the advance payment amount to the reference + or base currency. - name: difference_posting_date - description: '' + description: Date when exchange rate differences or payment variances from the + advance are posted to accounting ledgers. + desc_done: true - table: tabPurchase Invoice Item description: '' fields: - name: name - description: '' + description: Unique identifier for the purchase invoice item line - name: item_code - description: '' + description: Code of the product or service being purchased on this invoice line join_hint: table: tabItem 'on': item_code = tabItem.name - name: product_bundle - description: '' + description: Indicates if this line item represents a bundled set of products + sold together as a package join_hint: table: tabProduct Bundle 'on': product_bundle = tabProduct Bundle.name - name: item_name - description: '' + description: The product or service being purchased, used when identifying what + was bought on the invoice. - name: description - description: '' + description: Additional details or specifications about the purchased item beyond + its name, used when users need extended product information or technical specifications. - name: brand - description: '' + description: The manufacturer or brand name of the purchased item, used when filtering + or searching purchases by specific brands or suppliers. join_hint: table: tabBrand 'on': brand = tabBrand.name - name: item_group - description: '' + description: Category or classification of the purchased item for grouping similar + products together in analysis and reporting. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: image_view - description: '' + description: Visual representation or picture of the purchased item for identification + and verification purposes. - name: received_qty - description: '' + description: Actual quantity of items physically received against this purchase + invoice line, used to track delivery fulfillment and discrepancies. - name: qty - description: '' + description: Quantity of items invoiced by the supplier for this line item. - name: rejected_qty - description: '' + description: Quantity of items rejected or returned from the invoiced amount due + to quality issues or discrepancies. - name: uom - description: '' + description: Unit of measurement for the invoiced quantity such as pieces, kilograms, + or liters. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier used when user asks about converting between purchase + unit and stock unit quantities. - name: stock_uom - description: '' + description: Base inventory unit of measure for the item, relevant when user asks + about stock or inventory units rather than purchase units. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: stock_qty - description: '' + description: Quantity in base inventory units after conversion, relevant when + user asks about inventory impact or stock-level quantities from purchases. - name: price_list_rate - description: '' + description: Item price from the price list in transaction currency before any + discounts or margin adjustments are applied. - name: base_price_list_rate - description: '' + description: Item price from the price list converted to company base currency + for multi-currency purchase invoice reporting. - name: margin_type - description: '' + description: Defines whether margin is calculated as a percentage or fixed amount + when marking up or down from the price list rate. options: - Percentage - Amount - name: margin_rate_or_amount - description: '' + description: Margin added to the base purchase rate, either as a percentage or + absolute amount, used when calculating marked-up item costs. - name: rate_with_margin - description: '' + description: Final purchase rate after applying margin to the base rate, representing + the actual cost per unit including markup. - name: discount_percentage - description: '' + description: Percentage discount applied to the purchase invoice item, reducing + the total cost from the supplier. - name: discount_amount - description: '' + description: Discount applied directly to this invoice line item, used when calculating + item-level price reductions or promotional discounts. - name: distributed_discount_amount - description: '' + description: Portion of invoice-level or header discount allocated to this line + item, used when header discounts are apportioned across items. - name: base_rate_with_margin - description: '' + description: Item rate including markup or margin added to the base cost, used + when analyzing pricing that includes profit margin before other adjustments. - name: rate - description: '' + description: Unit price per item on the purchase invoice line before taxes and + discounts. - name: amount - description: '' + description: Total line amount for this purchase invoice item after applying quantity, + rate, and discounts but before taxes. - name: item_tax_template - description: '' + description: Tax configuration template applied to this purchase invoice item + to determine applicable tax rates and accounts. join_hint: table: tabItem Tax Template 'on': item_tax_template = tabItem Tax Template.name - name: base_rate - description: '' + description: Unit price of the purchased item in company's base currency before + any currency conversion. - name: base_amount - description: '' + description: Total line amount in company's base currency after currency conversion + from transaction currency. - name: pricing_rules - description: '' + description: Applied pricing rule or discount scheme that determined the final + rate for this purchase item. - name: stock_uom_rate - description: '' + description: Rate per stock unit of measure when user needs pricing in base inventory + units rather than purchase units. - name: is_free_item - description: '' + description: Indicates item was received at no charge as promotional or complimentary + goods. - name: apply_tds - description: '' + description: Whether tax deducted at source should be calculated on this line + item for withholding tax compliance. - name: net_rate - description: '' + description: Rate per unit after applying discounts but before taxes, used when + asking about discounted unit pricing on purchase invoice items. - name: net_amount - description: '' + description: Total amount for the line item after discounts but before taxes, + used when calculating or querying pre-tax totals. - name: base_net_rate - description: '' + description: Rate per unit after discounts in the company's base currency, used + when querying purchase costs in standardized currency across multi-currency + transactions. - name: base_net_amount - description: '' + description: Net amount of the purchase invoice line item in the company's base + currency, used when analyzing purchase costs in standardized currency. - name: valuation_rate - description: '' + description: Rate used to value inventory for this purchased item, relevant when + calculating stock value or cost of goods sold. - name: sales_incoming_rate - description: '' + description: Incoming exchange rate for sales-related currency conversion on this + purchase item, used when purchase involves foreign currency transactions. - name: item_tax_amount - description: '' + description: Tax amount charged on this specific line item of the purchase invoice. - name: landed_cost_voucher_amount - description: '' + description: Additional costs allocated to this item from landed cost vouchers + such as freight, customs, or insurance. - name: rm_supp_cost - description: '' + description: Raw material supplementary cost for this purchased item beyond the + base price. - name: warehouse - description: '' + description: Warehouse location where purchased items are received or stored for + this invoice line item. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: serial_and_batch_bundle - description: '' + description: Reference to bundled serial numbers and batch numbers assigned to + this purchased item. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: use_serial_batch_fields - description: '' + description: Indicates whether this invoice item tracks inventory using serial + numbers or batch numbers. - name: from_warehouse - description: '' + description: Warehouse location from which purchased items are received or stocked + upon invoice processing. join_hint: table: tabWarehouse 'on': from_warehouse = tabWarehouse.name - name: quality_inspection - description: '' + description: Reference to the quality inspection record performed on purchased + items before acceptance. join_hint: table: tabQuality Inspection 'on': quality_inspection = tabQuality Inspection.name - name: rejected_warehouse - description: '' + description: Warehouse location where items failing quality inspection or rejected + goods are stored. join_hint: table: tabWarehouse 'on': rejected_warehouse = tabWarehouse.name - name: rejected_serial_and_batch_bundle - description: '' + description: References the bundle containing serial numbers and batch numbers + for items rejected during purchase invoice receipt. join_hint: table: tabSerial and Batch Bundle 'on': rejected_serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: serial_no - description: '' + description: Serial number assigned to the purchased item being invoiced for tracking + individual units. - name: rejected_serial_no - description: '' + description: Serial number of the specific item unit that was rejected during + purchase invoice receipt or quality inspection. - name: batch_no - description: '' + description: Batch or lot number assigned to the purchased items for tracking + and quality control purposes. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: manufacturer - description: '' + description: Company that manufactured the purchased item, distinct from the supplier + or vendor. join_hint: table: tabManufacturer 'on': manufacturer = tabManufacturer.name - name: manufacturer_part_no - description: '' + description: Manufacturer's unique part number or SKU for the purchased item, + different from internal item codes or supplier part numbers. - name: expense_account - description: '' + description: General ledger account where the cost of this purchased item is recorded + as an expense. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: wip_composite_asset - description: '' + description: Links this purchase to a work-in-progress composite asset being constructed + or assembled. join_hint: table: tabAsset 'on': wip_composite_asset = tabAsset.name - name: is_fixed_asset - description: '' + description: Indicates whether this purchased item is a fixed asset (equipment, + property, vehicles) rather than inventory or expense. - name: asset_location - description: '' + description: Physical location or site where the purchased asset will be placed + or used join_hint: table: tabLocation 'on': asset_location = tabLocation.name - name: asset_category - description: '' + description: Classification of the purchased item as a fixed asset type for depreciation + and accounting purposes join_hint: table: tabAsset Category 'on': asset_category = tabAsset Category.name - name: deferred_expense_account - description: '' + description: General ledger account for expenses that will be recognized over + time rather than immediately upon purchase join_hint: table: tabAccount 'on': deferred_expense_account = tabAccount.name - name: service_stop_date - description: '' + description: End date of the service period for this purchased item, used when + querying service duration or subscription end dates. - name: enable_deferred_expense - description: '' + description: Indicates whether this purchase invoice item uses deferred expense + accounting to spread costs over multiple periods. - name: service_start_date - description: '' + description: Start date of the service period for this purchased item, used when + querying service duration or subscription start dates. - name: service_end_date - description: '' + description: End date of the service period for service items on the purchase + invoice, used when querying service duration or subscription end dates. - name: allow_zero_valuation_rate - description: '' + description: Indicates whether this invoice item permits a zero valuation rate, + relevant when users ask about items purchased without standard costing or valuation. - name: item_tax_rate - description: '' + description: Tax rate percentage or tax configuration applied specifically to + this invoice line item, used when analyzing item-level tax amounts or rates + that differ from invoice defaults. - name: bom - description: '' + description: Bill of Materials reference for the purchased item, used when tracking + manufactured or assembled items received through purchase invoices. join_hint: table: tabBOM 'on': bom = tabBOM.name - name: include_exploded_items - description: '' + description: Indicates whether sub-components from the BOM are individually listed + in the invoice rather than showing only the parent item. - name: purchase_invoice_item - description: '' + description: Unique identifier for this specific line item on the purchase invoice. - name: purchase_order - description: '' + description: Reference to the original purchase order that authorized this invoice + item purchase. join_hint: table: tabPurchase Order 'on': purchase_order = tabPurchase Order.name - name: po_detail - description: '' + description: Specific line item from the purchase order that this invoice item + corresponds to. - name: purchase_receipt - description: '' + description: Reference to the goods receipt document confirming physical delivery + of this invoiced item. join_hint: table: tabPurchase Receipt 'on': purchase_receipt = tabPurchase Receipt.name - name: pr_detail - description: '' + description: Links to the specific purchase receipt item that this invoice item + is billing against, used when matching invoices to received goods. - name: sales_invoice_item - description: '' + description: References the original sales invoice item in inter-company transactions + or drop-ship scenarios where a purchase directly fulfills a sale. - name: material_request - description: '' + description: Links to the material request that initiated this purchase, used + when tracking procurement from requisition through invoicing. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: material_request_item - description: '' + description: Links to the specific material request line item that triggered this + purchase, used when tracing purchases back to internal requisitions. - name: weight_per_unit - description: '' + description: Weight of a single unit of the purchased item, used for calculating + shipping costs or total weight per individual item. - name: total_weight - description: '' + description: Combined weight of all units on this invoice line, used for freight + calculations and logistics planning. - name: weight_uom - description: '' + description: Unit of measurement for the weight of the purchased item (e.g., kg, + lbs, tons). join_hint: table: tabUOM 'on': weight_uom = tabUOM.name - name: project - description: '' + description: Project to which this purchase invoice item is allocated for tracking + project-specific procurement costs. join_hint: table: tabProject 'on': project = tabProject.name - name: cost_center - description: '' + description: Cost center to which this purchase invoice item's expense is assigned + for departmental or functional cost allocation. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: page_break - description: '' + description: Indicates whether a page break should occur before this invoice item + when printing or generating PDF documents. + desc_done: true - table: tabPurchase Order description: '' fields: - name: name - description: '' + description: Unique identifier or number assigned to the purchase order, used + when referencing a specific PO by its ID or code - name: title - description: '' + description: Descriptive label or subject line for the purchase order, used when + searching by what the order is about or its purpose - name: naming_series - description: '' + description: Prefix pattern or series code that determines how purchase order + numbers are auto-generated, used when filtering or grouping POs by their numbering + scheme options: - PUR-ORD-.YYYY.- - name: supplier - description: '' + description: Unique identifier code for the vendor fulfilling the purchase order, + used when filtering or joining supplier records. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: supplier_name - description: '' + description: Human-readable name of the vendor, used when users ask about purchases + from a specific company by name. - name: order_confirmation_no - description: '' + description: Confirmation number provided by the supplier acknowledging receipt + of the purchase order, used to track supplier acceptance and reference external + supplier systems. - name: order_confirmation_date - description: '' + description: Date when the supplier confirmed acceptance of the purchase order. - name: transaction_date - description: '' + description: Date when the purchase order transaction was recorded in the system. - name: schedule_date - description: '' + description: Date when goods or services are scheduled to be delivered or received. - name: company - description: '' + description: The legal entity or business unit that owns this purchase order. join_hint: table: tabCompany 'on': company = tabCompany.name - name: apply_tds - description: '' + description: Whether tax deducted at source is applied to this purchase order. - name: tax_withholding_category - description: '' + description: The specific type or classification of tax withholding applied to + this purchase order. join_hint: table: tabTax Withholding Category 'on': tax_withholding_category = tabTax Withholding Category.name - name: is_subcontracted - description: '' + description: Indicates whether this purchase order involves subcontracting work + to an external vendor who will perform manufacturing or processing operations. - name: has_unit_price_items - description: '' + description: Indicates whether this purchase order contains line items priced + per unit rather than as lump sum or other pricing methods. - name: supplier_warehouse - description: '' + description: The warehouse location owned or managed by the supplier from which + goods on this purchase order will be shipped or sourced. join_hint: table: tabWarehouse 'on': supplier_warehouse = tabWarehouse.name - name: amended_from - description: '' + description: Links to the original purchase order that was cancelled and replaced + by this amended version. join_hint: table: tabPurchase Order 'on': amended_from = tabPurchase Order.name - name: cost_center - description: '' + description: Accounting department or division to which purchase order expenses + are allocated for budgeting and financial tracking. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Specific project or job to which this purchase order is assigned + for tracking project-related procurement costs. join_hint: table: tabProject 'on': project = tabProject.name - name: currency - description: '' + description: Currency in which the purchase order total and line item prices are + denominated. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: conversion_rate - description: '' + description: Exchange rate used to convert purchase order amounts from the transaction + currency to the company's base currency. - name: buying_price_list - description: '' + description: Price list applied to determine default item prices and discounts + for this purchase order. join_hint: table: tabPrice List 'on': buying_price_list = tabPrice List.name - name: price_list_currency - description: '' + description: Currency in which the price list is denominated for this purchase + order. join_hint: table: tabCurrency 'on': price_list_currency = tabCurrency.name - name: plc_conversion_rate - description: '' + description: Exchange rate used to convert price list currency to the purchase + order's transaction currency. - name: ignore_pricing_rule - description: '' + description: Indicates whether automatic pricing rules are bypassed for this purchase + order. - name: scan_barcode - description: '' + description: Barcode scanned during purchase order receiving or warehouse operations + to identify items. - name: last_scanned_warehouse - description: '' + description: Warehouse location where the most recent barcode scan occurred for + this purchase order. - name: set_from_warehouse - description: '' + description: Source warehouse designated for fulfilling or transferring items + in this purchase order. join_hint: table: tabWarehouse 'on': set_from_warehouse = tabWarehouse.name - name: set_warehouse - description: '' + description: The warehouse location where all items in this purchase order will + be received and stored upon delivery. join_hint: table: tabWarehouse 'on': set_warehouse = tabWarehouse.name - name: items - description: '' + description: The line items or products being purchased in this order, including + details like item codes, quantities, and prices for each product. - name: total_qty - description: '' + description: The sum of quantities across all line items in the purchase order, + used when asking about total units being ordered. - name: total_net_weight - description: '' + description: Total weight of all items in the purchase order excluding packaging, + used when calculating shipping costs or logistics capacity. - name: base_total - description: '' + description: Total purchase order amount in company's base currency before any + taxes or discounts are applied. - name: base_net_total - description: '' + description: Total purchase order amount in company's base currency after discounts + but before taxes. - name: total - description: '' + description: Grand total amount of the purchase order including all taxes, charges, + and discounts. - name: net_total - description: '' + description: Subtotal amount before taxes and additional charges are applied. - name: tax_withholding_net_total - description: '' + description: Net amount after deducting withholding tax that must be withheld + at source for tax compliance. - name: base_tax_withholding_net_total - description: '' + description: Net total amount after tax withholding deductions in base currency, + used when calculating final payment obligations to suppliers. - name: pricing_rules - description: '' + description: Applied pricing rule configurations that determined discounts or + special pricing for this purchase order. - name: set_reserve_warehouse - description: '' + description: Designated warehouse location where purchased items will be reserved + or held upon receipt. join_hint: table: tabWarehouse 'on': set_reserve_warehouse = tabWarehouse.name - name: supplied_items - description: '' + description: Items provided by the customer to the supplier for use in manufacturing + or processing the purchased goods. - name: tax_category - description: '' + description: Classification determining which tax rules apply to this purchase + order based on supplier location, item type, or regulatory requirements. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: taxes_and_charges - description: '' + description: Template or configuration defining the specific tax rates, additional + charges, and calculation methods applied to this purchase order. join_hint: table: tabPurchase Taxes and Charges Template 'on': taxes_and_charges = tabPurchase Taxes and Charges Template.name - name: shipping_rule - description: '' + description: Defines the shipping method or carrier service selected for delivering + the purchased goods. join_hint: table: tabShipping Rule 'on': shipping_rule = tabShipping Rule.name - name: incoterm - description: '' + description: International commercial term specifying which party bears shipping + costs, risks, and responsibilities during transport. join_hint: table: tabIncoterm 'on': incoterm = tabIncoterm.name - name: named_place - description: '' + description: Specific geographic location referenced in the incoterm where risk + and cost transfer occurs between buyer and seller. - name: taxes - description: '' + description: Total tax amount applied to the purchase order in transaction currency. - name: base_taxes_and_charges_added - description: '' + description: Total additional taxes and charges in base currency, such as freight, + handling fees, or VAT added to the purchase order. - name: base_taxes_and_charges_deducted - description: '' + description: Total taxes and charges subtracted in base currency, such as discounts, + rebates, or tax exemptions applied to the purchase order. - name: base_total_taxes_and_charges - description: '' + description: Net total of all taxes and charges applied to the purchase order + in base currency, used when asking for total tax amounts or tax impact on order + value. - name: taxes_and_charges_added - description: '' + description: Sum of only the tax and charge amounts that increase the purchase + order total, used when asking specifically about additional costs or markup + taxes. - name: taxes_and_charges_deducted - description: '' + description: Sum of only the tax and charge amounts that decrease the purchase + order total, used when asking about discounts, rebates, or deductions applied + through the tax system. - name: total_taxes_and_charges - description: '' + description: Sum of all tax and charge amounts applied to the purchase order, + used when analyzing tax costs or total charges separate from item costs. - name: base_grand_total - description: '' + description: Final total amount of the purchase order in base currency including + all items, taxes, charges, and adjustments. - name: base_rounding_adjustment - description: '' + description: Amount added or subtracted in base currency to round the final purchase + order total to a standard precision. - name: base_in_words - description: '' + description: Total purchase order amount written in words in base currency for + check printing and formal documentation - name: base_rounded_total - description: '' + description: Purchase order total in base currency after applying rounding adjustments, + used when rounding rules differ from grand_total - name: grand_total - description: '' + description: Final total purchase order amount in transaction currency including + all taxes, charges, and discounts - name: rounding_adjustment - description: '' + description: Amount added or subtracted to round the purchase order total to a + whole number or specified precision. - name: rounded_total - description: '' + description: Final purchase order total after applying rounding adjustment. - name: disable_rounded_total - description: '' + description: Indicates whether automatic rounding of the purchase order total + is turned off. - name: in_words - description: '' + description: Total purchase order amount expressed as text words for check writing + or formal documentation - name: advance_paid - description: '' + description: Amount paid upfront to supplier before goods are received or invoice + is finalized - name: apply_discount_on - description: '' + description: Specifies whether discounts calculate from grand total or net total + before taxes and charges options: - Grand Total - Net Total - name: base_discount_amount - description: '' + description: Initial discount amount applied to the purchase order before any + additional discounts. - name: additional_discount_percentage - description: '' + description: Extra discount percentage applied on top of the base discount to + calculate final discount. - name: discount_amount - description: '' + description: Total final discount amount on the purchase order after applying + all discounts. - name: other_charges_calculation - description: '' + description: Additional fees or costs beyond item prices such as freight, handling, + or miscellaneous charges applied to the purchase order. - name: supplier_address - description: '' + description: The specific address identifier or name of the supplier's location + for this purchase order. join_hint: table: tabAddress 'on': supplier_address = tabAddress.name - name: address_display - description: '' + description: The formatted, human-readable full address text showing complete + supplier address details for display purposes. - name: contact_person - description: '' + description: Name of the individual at the supplier who is the primary point of + contact for this purchase order. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_display - description: '' + description: Formatted display name combining contact person details for showing + in lists and reports. - name: contact_mobile - description: '' + description: Mobile phone number of the supplier contact person for urgent purchase + order communications. - name: contact_email - description: '' + description: Email address of the supplier contact person for this purchase order. - name: dispatch_address - description: '' + description: Address identifier where ordered goods should be delivered or dispatched + to. join_hint: table: tabAddress 'on': dispatch_address = tabAddress.name - name: dispatch_address_display - description: '' + description: Formatted delivery address text showing where ordered goods should + be shipped. - name: shipping_address - description: '' + description: Physical location where purchased goods will be delivered to the + buyer join_hint: table: tabAddress 'on': shipping_address = tabAddress.name - name: shipping_address_display - description: '' + description: Formatted shipping address text for display purposes, typically used + when showing the delivery destination in reports or documents - name: billing_address - description: '' + description: Address where invoices are sent and payment is processed, may differ + from the delivery location join_hint: table: tabAddress 'on': billing_address = tabAddress.name - name: billing_address_display - description: '' + description: Formatted billing address for the purchase order used when users + ask where invoices should be sent or what the billing location is. - name: customer - description: '' + description: Customer identifier or code referenced when users search by customer + ID or need to link to customer records. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: customer_name - description: '' + description: Customer's display name used when users ask about purchase orders + by company or organization name rather than customer code. - name: customer_contact_person - description: '' + description: Name of the customer's contact person for this purchase order, used + when searching for orders by who to communicate with at the customer. join_hint: table: tabContact 'on': customer_contact_person = tabContact.name - name: customer_contact_display - description: '' + description: Formatted display name of the customer contact combining multiple + name fields, used when users want the full presentable contact name. - name: customer_contact_mobile - description: '' + description: Mobile phone number of the customer's contact person, used when searching + for orders by contact phone or needing to reach the customer contact. - name: customer_contact_email - description: '' + description: Email address of the customer contact person for this purchase order, + used when searching for orders by customer communication details. - name: payment_terms_template - description: '' + description: Named template defining standard payment conditions (e.g., Net 30, + 2/10 Net 30), used when filtering orders by payment term type rather than specific + schedules. join_hint: table: tabPayment Terms Template 'on': payment_terms_template = tabPayment Terms Template.name - name: payment_schedule - description: '' + description: Detailed breakdown of payment due dates and amounts for this purchase + order, used when querying specific installment timing or milestone-based payments. - name: tc_name - description: '' + description: Terms and conditions template name applied to the purchase order + for legal and contractual requirements. join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Specific payment terms negotiated with the supplier such as net 30, + net 60, or early payment discounts. - name: status - description: '' + description: Current state of the purchase order in the procurement workflow such + as draft, submitted, approved, or closed. options: - Draft - On Hold @@ -20241,570 +24994,757 @@ tables: - Closed - Delivered - name: per_billed - description: '' + description: Percentage of the purchase order that has been invoiced by the supplier, + used to track billing completion status. - name: per_received - description: '' + description: Percentage of the purchase order that has been physically received + into inventory, used to track delivery completion status. - name: letter_head - description: '' + description: Company letterhead template applied to the printed purchase order + document. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: group_same_items - description: '' + description: Whether identical line items are consolidated together on the purchase + order display or print output. - name: select_print_heading - description: '' + description: Custom heading or title that appears when printing this purchase + order document. join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: language - description: '' + description: Language in which the purchase order document is generated or displayed + for the supplier. - name: from_date - description: '' + description: Start date of the purchase order validity period or delivery schedule + timeframe. - name: to_date - description: '' + description: End date of the purchase order validity period or delivery schedule + timeframe. - name: auto_repeat - description: '' + description: Indicates whether this purchase order automatically recurs on a scheduled + basis. join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: is_internal_supplier - description: '' + description: Indicates whether the purchase order is placed with an internal supplier + or external vendor. - name: represents_company - description: '' + description: The company entity that this purchase order represents or is issued + on behalf of in multi-company scenarios. join_hint: table: tabCompany 'on': represents_company = tabCompany.name - name: ref_sq - description: '' + description: Reference to the supplier quotation document that this purchase order + was created from or is linked to. join_hint: table: tabSupplier Quotation 'on': ref_sq = tabSupplier Quotation.name - name: party_account_currency - description: '' + description: Currency used for the supplier's accounting transactions and balances + in this purchase order. join_hint: table: tabCurrency 'on': party_account_currency = tabCurrency.name - name: inter_company_order_reference - description: '' + description: Reference to the linked sales order when this purchase order is part + of an inter-company transaction between related entities. join_hint: table: tabSales Order 'on': inter_company_order_reference = tabSales Order.name - name: is_old_subcontracting_flow - description: '' + description: Indicates whether this purchase order follows the legacy subcontracting + process rather than the current subcontracting workflow. + desc_done: true - table: tabPurchase Order Item description: '' fields: - name: name - description: '' + description: Purchase order line item identifier or description of the specific + product or material being ordered - name: fg_item - description: '' + description: Finished goods item code linked to this purchase order line when + the purchased material is intended for a specific finished product join_hint: table: tabItem 'on': fg_item = tabItem.name - name: fg_item_qty - description: '' + description: Quantity of the finished goods item that will be produced using the + materials from this purchase order line - name: item_code - description: '' + description: Internal SKU or product identifier used when searching for what specific + item was ordered from a supplier. join_hint: table: tabItem 'on': item_code = tabItem.name - name: supplier_part_no - description: '' + description: Vendor's own part number or catalog code used when matching supplier + documentation or invoices to purchase orders. - name: item_name - description: '' + description: Human-readable product description used when searching by item type + or category rather than codes. - name: brand - description: '' + description: Brand name or manufacturer of the purchased item, used when filtering + or analyzing purchases by specific brands. join_hint: table: tabBrand 'on': brand = tabBrand.name - name: product_bundle - description: '' + description: Indicates if the item is part of a bundled product package, used + when identifying grouped or kit-based purchases. join_hint: table: tabProduct Bundle 'on': product_bundle = tabProduct Bundle.name - name: schedule_date - description: '' + description: Expected delivery or fulfillment date for the purchase order item, + used when tracking when items should arrive or be received. - name: expected_delivery_date - description: '' + description: Date when the purchased item is expected to arrive, used when users + ask about delivery timing or when materials will be available. - name: item_group - description: '' + description: Category or classification of the purchased item, used when users + filter or analyze purchases by product type or grouping. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: description - description: '' + description: Detailed text describing the specific purchased item, used when users + search for items by characteristics or need to identify what was ordered. - name: image_view - description: '' + description: Visual representation of the purchased item for verification and + identification purposes in purchase orders. - name: qty - description: '' + description: Quantity of items ordered in this purchase order line, used when + asking about order volumes or amounts. - name: stock_uom - description: '' + description: Unit of measurement for the ordered quantity such as pieces, kilograms, + or boxes, used to specify how items are counted or measured. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: subcontracted_quantity - description: '' + description: Quantity of items sent to a subcontractor for processing or manufacturing + as part of this purchase order line. - name: uom - description: '' + description: Unit of measurement for the item quantity on this purchase order + line, such as pieces, kilograms, or liters. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert between the purchase order unit of measurement + and the item's base or stock unit of measurement. - name: stock_qty - description: '' + description: Current available stock quantity of the item at time of purchase + order creation, used when checking inventory levels before ordering. - name: price_list_rate - description: '' + description: Standard catalog price for the item from the supplier's price list, + used when comparing quoted prices to list prices. - name: last_purchase_rate - description: '' + description: Actual price paid in the most recent previous purchase of this item, + used when comparing current order pricing to historical costs. - name: base_price_list_rate - description: '' + description: Original list price per unit from the price list before any discounts, + margins, or pricing rules are applied to the purchase order item. - name: margin_type - description: '' + description: Indicates whether the margin is calculated as a percentage or a fixed + amount when determining the final rate from the base price. options: - Percentage - Amount - name: margin_rate_or_amount - description: '' + description: The specific margin value applied to the base price, interpreted + as either a percentage or absolute amount based on the margin_type. - name: rate_with_margin - description: '' + description: Unit price including margin markup applied to the base cost, used + when users ask about marked-up pricing or selling rates on purchase orders. - name: discount_percentage - description: '' + description: Percentage discount applied to the item, used when users ask about + discount rates or percentage-based price reductions. - name: discount_amount - description: '' + description: Absolute monetary value of the discount applied to the item, used + when users ask about the actual dollar amount saved or deducted. - name: distributed_discount_amount - description: '' + description: Discount amount allocated to this purchase order line item after + distributing header-level or bulk discounts across items. - name: base_rate_with_margin - description: '' + description: Unit price including the supplier's margin or markup before applying + discounts or taxes. - name: rate - description: '' + description: Final unit price for the purchase order item used to calculate the + line total. - name: amount - description: '' + description: Total line amount for the purchase order item after applying quantity, + rate, and discounts but before taxes. - name: item_tax_template - description: '' + description: Tax configuration template applied to this purchase order item to + determine applicable tax rates and rules. join_hint: table: tabItem Tax Template 'on': item_tax_template = tabItem Tax Template.name - name: base_rate - description: '' + description: Unit price of the item in the company's base currency before any + currency conversion. - name: base_amount - description: '' + description: Total line item value in company's base currency before taxes, used + when analyzing purchase costs in standardized currency. - name: pricing_rules - description: '' + description: Applied promotional or contractual pricing rules that modified the + item's standard price, used when investigating discounts or special pricing. - name: stock_uom_rate - description: '' + description: Price per stock unit of measure, used when the purchase unit differs + from inventory unit and per-stock-unit cost analysis is needed. - name: is_free_item - description: '' + description: Indicates whether this purchase order line item is a promotional + or bonus item with no charge. - name: apply_tds - description: '' + description: Indicates whether tax deducted at source should be calculated and + withheld on this purchase order item. - name: net_rate - description: '' + description: Final unit price after applying all discounts, taxes, and adjustments + for this purchase order item. - name: net_amount - description: '' + description: Line item total after discounts but before taxes in transaction currency, + used when asking about item-level purchase amounts or order line totals. - name: base_net_rate - description: '' + description: Unit price after discounts in company base currency, used when asking + about standardized per-unit costs across different currency transactions. - name: base_net_amount - description: '' + description: Line item total after discounts but before taxes in company base + currency, used when asking about purchase amounts in home currency for consolidated + reporting. - name: from_warehouse - description: '' + description: Source warehouse when transferring stock between warehouses as part + of the purchase order fulfillment. join_hint: table: tabWarehouse 'on': from_warehouse = tabWarehouse.name - name: warehouse - description: '' + description: Target warehouse where purchased items will be received and stored. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: actual_qty - description: '' + description: Current available quantity of the item in stock at the time of purchase + order creation. - name: company_total_stock - description: '' + description: Total stock quantity available across the company for the item being + purchased, relevant when checking inventory levels before ordering. - name: material_request - description: '' + description: Reference to the material request document that triggered this purchase + order item, used to trace procurement back to the original requisition. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: material_request_item - description: '' + description: Specific line item from the material request that this purchase order + item fulfills, used to link individual requested items to their procurement. - name: sales_order - description: '' + description: Links this purchase order item to the originating sales order when + purchasing to fulfill a specific customer order. join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: sales_order_item - description: '' + description: Links this purchase order item to the specific line item on the sales + order being fulfilled. - name: sales_order_packed_item - description: '' + description: Links this purchase order item to a packed sales order item when + purchasing materials for already packed customer orders. - name: supplier_quotation - description: '' + description: Links to the supplier's quote document that this purchase order item + was created from or references. join_hint: table: tabSupplier Quotation 'on': supplier_quotation = tabSupplier Quotation.name - name: supplier_quotation_item - description: '' + description: Links to the specific line item in the supplier's quotation that + corresponds to this purchase order item. join_hint: table: tabSupplier Quotation Item 'on': supplier_quotation_item = tabSupplier Quotation Item.name - name: delivered_by_supplier - description: '' + description: Identifies which supplier actually delivered this item, relevant + when the delivering supplier differs from the ordering supplier or for tracking + delivery responsibility. - name: against_blanket_order - description: '' + description: Indicates whether this purchase order item is created from a blanket + purchase order agreement. - name: blanket_order - description: '' + description: References the specific blanket purchase order agreement from which + this item was created. join_hint: table: tabBlanket Order 'on': blanket_order = tabBlanket Order.name - name: blanket_order_rate - description: '' + description: The negotiated price per unit from the blanket purchase order agreement + applied to this item. - name: received_qty - description: '' + description: Quantity of items physically received from the supplier for this + purchase order line. - name: returned_qty - description: '' + description: Quantity of items sent back to the supplier after receipt due to + defects, overages, or other issues. - name: billed_amt - description: '' + description: Total invoiced amount from the supplier for this purchase order line + item. - name: expense_account - description: '' + description: General ledger account charged when the purchased item is expensed + rather than capitalized or inventoried. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: wip_composite_asset - description: '' + description: Links the purchase order item to a work-in-progress composite asset + being assembled or constructed. join_hint: table: tabAsset 'on': wip_composite_asset = tabAsset.name - name: manufacturer - description: '' + description: Original manufacturer or brand of the item being purchased, which + may differ from the supplier or vendor. join_hint: table: tabManufacturer 'on': manufacturer = tabManufacturer.name - name: manufacturer_part_no - description: '' + description: Manufacturer's part number for the purchased item, used when searching + by vendor-specific part identifiers rather than internal item codes. - name: bom - description: '' + description: Bill of materials linked to this purchase order item, relevant when + purchasing items that have component breakdowns or subassemblies. join_hint: table: tabBOM 'on': bom = tabBOM.name - name: include_exploded_items - description: '' + description: Indicates whether to show individual BOM components as separate line + items instead of the parent item, used when analyzing detailed component-level + purchases. - name: weight_per_unit - description: '' + description: Weight of a single unit of the purchased item, used when calculating + shipping costs or comparing item specifications per unit. - name: total_weight - description: '' + description: Combined weight of all units in this purchase order line, used for + freight planning and total shipment weight calculations. - name: weight_uom - description: '' + description: Unit of measurement for weight fields (e.g., kg, lbs, tons), used + to interpret weight_per_unit and total_weight values. join_hint: table: tabUOM 'on': weight_uom = tabUOM.name - name: project - description: '' + description: Project code or identifier to which the purchased item will be charged + or allocated for tracking project-specific procurement costs. join_hint: table: tabProject 'on': project = tabProject.name - name: cost_center - description: '' + description: Cost center code to which the purchased item expense will be allocated + for departmental or organizational budget tracking. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: is_fixed_asset - description: '' + description: Indicates whether the purchased item is a fixed asset that will be + capitalized rather than expensed immediately. - name: item_tax_rate - description: '' + description: Tax percentage applied to this purchase order line item for calculating + tax amounts. - name: production_plan - description: '' + description: Links this purchase order item to a specific production plan when + materials are procured for manufacturing. join_hint: table: tabProduction Plan 'on': production_plan = tabProduction Plan.name - name: production_plan_item - description: '' + description: Links to the specific line item within a production plan that triggered + this purchase requirement. - name: production_plan_sub_assembly_item - description: '' + description: Links this purchase order item to a specific sub-assembly component + in a production plan when procuring materials for manufacturing. - name: page_break - description: '' + description: Controls whether a page break appears before this line item when + printing or generating PDF versions of the purchase order. + desc_done: true - table: tabPurchase Order Item Supplied description: '' fields: - name: name - description: '' + description: Unique identifier or reference name for the specific supplied item + record in the purchase order - name: main_item_code - description: '' + description: Code of the finished or main product item that was ordered in the + purchase order join_hint: table: tabItem 'on': main_item_code = tabItem.name - name: rm_item_code - description: '' + description: Code of the raw material or component item that was actually supplied + to fulfill the main item join_hint: table: tabItem 'on': rm_item_code = tabItem.name - name: stock_uom - description: '' + description: Unit of measurement for inventory tracking when users ask about stock + quantities or warehouse units for supplied items join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: reserve_warehouse - description: '' + description: Specific warehouse location where inventory is reserved when users + ask where supplied materials are allocated or held join_hint: table: tabWarehouse 'on': reserve_warehouse = tabWarehouse.name - name: conversion_factor - description: '' + description: Multiplier to convert between purchase unit and stock unit when users + ask about unit conversions or quantity reconciliation - name: bom_detail_no - description: '' + description: Bill of materials detail number linking the supplied item to a specific + BOM component or subassembly line. - name: reference_name - description: '' + description: Name or identifier of the supplier, vendor, or source providing this + purchase order item. - name: rate - description: '' + description: Unit price or cost per item for this supplied purchase order line. - name: amount - description: '' + description: Total monetary value of the supplied items for this purchase order + line. - name: required_qty - description: '' + description: Quantity of items originally ordered or still needed to fulfill the + purchase order. - name: supplied_qty - description: '' + description: Quantity of items actually received or delivered against the purchase + order. - name: consumed_qty - description: '' + description: Quantity of supplied items that have been consumed or used in production + or operations. - name: returned_qty - description: '' + description: Quantity of supplied items that were returned to the supplier after + delivery. - name: total_supplied_qty - description: '' + description: Total quantity of items delivered by the supplier for this purchase + order line, including both consumed and returned amounts. + desc_done: true - table: tabPurchase Receipt description: '' fields: - name: name - description: '' + description: Unique identifier for the purchase receipt document, typically auto-generated + following a naming pattern - name: title - description: '' + description: Custom display name or label for the purchase receipt that provides + human-readable context beyond the system identifier - name: naming_series - description: '' + description: Prefix pattern that determines how purchase receipt identifiers are + automatically generated and sequenced options: - MAT-PRE-.YYYY.- - MAT-PR-RET-.YYYY.- - name: supplier - description: '' + description: Vendor ID or code for the supplier providing the purchased goods + in this receipt. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: supplier_name - description: '' + description: Full business name of the vendor who delivered the goods, used when + searching by supplier company name rather than code. - name: supplier_delivery_note - description: '' + description: External reference number or note from the supplier's delivery documentation + accompanying the shipment. - name: subcontracting_receipt - description: '' + description: Indicates whether this purchase receipt is for materials received + from a subcontractor who performed manufacturing or processing work. join_hint: table: tabSubcontracting Receipt 'on': subcontracting_receipt = tabSubcontracting Receipt.name - name: posting_date - description: '' + description: The accounting date when the purchase receipt transaction is recorded + in the financial ledger. - name: posting_time - description: '' + description: The time of day when the purchase receipt transaction was posted + to the system. - name: set_posting_time - description: '' + description: Indicates whether the posting date and time were manually specified + instead of using the current timestamp. - name: company - description: '' + description: The company entity that received the purchased goods or materials. join_hint: table: tabCompany 'on': company = tabCompany.name - name: apply_putaway_rule - description: '' + description: Indicates whether automatic warehouse putaway rules should be applied + to determine storage locations for received items. - name: is_return - description: '' + description: Indicates whether this purchase receipt represents returned goods + to the supplier rather than received goods. - name: return_against - description: '' + description: References the original purchase receipt document that this return + is being made against. join_hint: table: tabPurchase Receipt 'on': return_against = tabPurchase Receipt.name - name: cost_center - description: '' + description: The cost center to which the expenses or inventory from this purchase + receipt should be allocated for accounting purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: The project associated with this purchase receipt for tracking project-specific + procurement and costs. join_hint: table: tabProject 'on': project = tabProject.name - name: currency - description: '' + description: The currency in which the purchase receipt transaction amounts are + denominated. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: conversion_rate - description: '' + description: The exchange rate used to convert the purchase receipt currency to + the company's base currency. - name: buying_price_list - description: '' + description: Price list applied to this purchase receipt for determining item + rates and currency join_hint: table: tabPrice List 'on': buying_price_list = tabPrice List.name - name: price_list_currency - description: '' + description: Currency of the price list used in this purchase receipt join_hint: table: tabCurrency 'on': price_list_currency = tabCurrency.name - name: plc_conversion_rate - description: '' + description: Exchange rate used to convert price list currency to company base + currency for this purchase receipt - name: ignore_pricing_rule - description: '' + description: Whether pricing rules were bypassed when processing this purchase + receipt. - name: scan_barcode - description: '' + description: Barcode value scanned during receipt entry for item identification. - name: last_scanned_warehouse - description: '' + description: Most recent warehouse location captured during barcode scanning operations + for this receipt. - name: set_warehouse - description: '' + description: Target warehouse where accepted purchased items are received and + stored upon delivery join_hint: table: tabWarehouse 'on': set_warehouse = tabWarehouse.name - name: set_from_warehouse - description: '' + description: Source warehouse from which items are being transferred in an inter-warehouse + purchase receipt scenario join_hint: table: tabWarehouse 'on': set_from_warehouse = tabWarehouse.name - name: rejected_warehouse - description: '' + description: Warehouse designated for storing items that failed quality inspection + or were rejected during receipt join_hint: table: tabWarehouse 'on': rejected_warehouse = tabWarehouse.name - name: is_subcontracted - description: '' + description: Indicates whether this purchase receipt involves subcontracted manufacturing + where materials are sent to a supplier for processing. - name: supplier_warehouse - description: '' + description: The warehouse location at the supplier's facility where goods are + stored or staged before delivery. join_hint: table: tabWarehouse 'on': supplier_warehouse = tabWarehouse.name - name: items - description: '' + description: Line items detailing the individual products, materials, or goods + received in this purchase receipt including quantities and specifications. - name: total_qty - description: '' + description: Total quantity of all items received in this purchase receipt across + all line items. - name: total_net_weight - description: '' + description: Combined net weight of all items received in this purchase receipt. - name: base_total - description: '' + description: Total value of received items in base currency before taxes and charges. - name: base_net_total - description: '' + description: Net total of all items in base currency before taxes and charges, + used when querying receipt values in company's default currency. - name: total - description: '' + description: Grand total of the purchase receipt including all taxes, charges, + and discounts in transaction currency. - name: net_total - description: '' + description: Net total of all items in transaction currency before applying taxes + and additional charges. - name: tax_withholding_net_total - description: '' + description: Net total amount after applying tax withholding deductions on the + purchase receipt in transaction currency. - name: base_tax_withholding_net_total - description: '' + description: Net total amount after applying tax withholding deductions on the + purchase receipt in base company currency. - name: tax_category - description: '' + description: Tax classification applied to the purchase receipt determining which + tax rules and rates apply to the transaction. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: taxes_and_charges - description: '' + description: Tax template applied to calculate taxes on this purchase receipt join_hint: table: tabPurchase Taxes and Charges Template 'on': taxes_and_charges = tabPurchase Taxes and Charges Template.name - name: shipping_rule - description: '' + description: Shipping cost calculation rule applied to determine freight charges + for this receipt join_hint: table: tabShipping Rule 'on': shipping_rule = tabShipping Rule.name - name: incoterm - description: '' + description: International commercial terms defining delivery responsibilities + and risk transfer between buyer and supplier join_hint: table: tabIncoterm 'on': incoterm = tabIncoterm.name - name: named_place - description: '' + description: Delivery location or place name where purchased goods are received + or shipped to. - name: taxes - description: '' + description: Tax template or tax configuration applied to calculate taxes on the + purchase receipt. - name: base_taxes_and_charges_added - description: '' + description: Total tax amount added to the purchase receipt in base currency before + any currency conversion. - name: base_taxes_and_charges_deducted - description: '' + description: Total amount of taxes and charges deducted from the purchase receipt + value in base currency. - name: base_total_taxes_and_charges - description: '' + description: Total sum of all taxes and charges applied to the purchase receipt + in base currency. - name: taxes_and_charges_added - description: '' + description: Total amount of taxes and charges added to the purchase receipt value + in transaction currency. - name: taxes_and_charges_deducted - description: '' + description: Tax amount deducted at source (TDS/TCS) from the purchase receipt + total, used when calculating net payable amount to supplier. - name: total_taxes_and_charges - description: '' + description: Total sum of all taxes and charges added to the purchase receipt + before any deductions, used when analyzing tax burden or comparing gross vs + net amounts. - name: base_grand_total - description: '' + description: Final total amount of the purchase receipt in company's base currency + including items, taxes, and charges, used for financial reporting and cross-currency + purchase comparisons. - name: base_rounding_adjustment - description: '' + description: Amount added or subtracted to round the total to a convenient value + in base currency. - name: base_rounded_total - description: '' + description: Final total amount after applying rounding adjustment in base currency. - name: base_in_words - description: '' + description: Text representation of the base currency total amount spelled out + in words for formal documentation. - name: grand_total - description: '' + description: Total amount of the purchase receipt including all items, taxes, + and charges before any rounding adjustments. - name: rounding_adjustment - description: '' + description: Amount added or subtracted to round the grand total to a convenient + figure. - name: rounded_total - description: '' + description: Final total amount after applying rounding adjustment to the grand + total, typically used for actual payment. - name: in_words - description: '' + description: Total amount of the purchase receipt expressed as text words for + check writing or formal documentation - name: disable_rounded_total - description: '' + description: Whether to prevent automatic rounding of the total amount to the + nearest whole number - name: apply_discount_on - description: '' + description: Whether discounts are calculated on the grand total or on individual + line item net amounts options: - Grand Total - Net Total - name: base_discount_amount - description: '' + description: Discount amount calculated from line items before applying any additional + document-level discounts. - name: additional_discount_percentage - description: '' + description: Extra discount percentage applied at the document level after line + item discounts. - name: discount_amount - description: '' + description: Total final discount amount including both line item and additional + document-level discounts. - name: other_charges_calculation - description: '' + description: Formula or method used to calculate additional charges beyond item + costs on the purchase receipt. - name: pricing_rules - description: '' + description: Applied pricing rules that determined discounts, promotions, or special + pricing for items on this purchase receipt. - name: supplied_items - description: '' + description: Materials or components provided by the buyer to the supplier for + manufacturing or processing, tracked separately from purchased items. - name: supplier_address - description: '' + description: Link to the specific supplier address record used for this purchase + receipt delivery or billing location. join_hint: table: tabAddress 'on': supplier_address = tabAddress.name - name: address_display - description: '' + description: Formatted full address text showing where goods were received or + supplier location for display purposes. - name: contact_person - description: '' + description: Person at the supplier organization who is the point of contact for + this purchase receipt transaction. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_display - description: '' + description: Name of the contact person at the supplier who handled or coordinated + the purchase receipt delivery. - name: contact_mobile - description: '' + description: Mobile phone number of the supplier contact person associated with + the purchase receipt. - name: contact_email - description: '' + description: Email address of the supplier contact person associated with the + purchase receipt. - name: dispatch_address - description: '' + description: Address from which the supplier dispatched or shipped the goods to + the buyer. join_hint: table: tabAddress 'on': dispatch_address = tabAddress.name - name: dispatch_address_display - description: '' + description: Formatted display version of the supplier's dispatch address for + presentation purposes. - name: shipping_address - description: '' + description: Destination address where the purchased goods are being delivered + or received by the buyer. join_hint: table: tabAddress 'on': shipping_address = tabAddress.name - name: shipping_address_display - description: '' + description: Formatted shipping address where purchased goods are delivered, used + when users ask where items were or will be received. - name: billing_address - description: '' + description: Address associated with the supplier's billing or invoice for the + purchase receipt. join_hint: table: tabAddress 'on': billing_address = tabAddress.name - name: billing_address_display - description: '' + description: Formatted billing address for the supplier, used when users need + the invoice or payment address for a purchase receipt. - name: tc_name - description: '' + description: Tax category applied to the purchase receipt for tax calculation + and compliance purposes. join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Payment terms agreed with the supplier specifying when payment is + due for the received goods. - name: status - description: '' + description: Current state of the purchase receipt such as draft, submitted, completed, + or cancelled. options: - Draft - Partly Billed @@ -20814,408 +25754,537 @@ tables: - Cancelled - Closed - name: per_billed - description: '' + description: Percentage of the purchase receipt quantity that has been converted + into purchase invoices. - name: per_returned - description: '' + description: Percentage of the purchase receipt quantity that has been returned + to the supplier. - name: auto_repeat - description: '' + description: Reference to a recurring schedule if this purchase receipt is part + of an automated repeat pattern. join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: letter_head - description: '' + description: Letterhead template used when printing or emailing this purchase + receipt document. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: group_same_items - description: '' + description: Whether identical items are consolidated into single lines when printing + this purchase receipt. - name: select_print_heading - description: '' + description: Custom heading text that appears at the top of the printed purchase + receipt instead of the default title. join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: language - description: '' + description: Language used for printing or displaying the purchase receipt document. - name: transporter_name - description: '' + description: Name of the shipping or logistics company that delivered the purchased + goods. - name: lr_no - description: '' + description: Lorry receipt number or transport document reference number for tracking + the shipment. - name: lr_date - description: '' + description: Date on the lorry receipt or transport document accompanying the + goods delivery - name: instructions - description: '' + description: Special handling or processing instructions provided for receiving + the purchased goods - name: is_internal_supplier - description: '' + description: Indicates whether the supplier is an internal company entity or branch + rather than an external vendor - name: represents_company - description: '' + description: The company entity that this purchase receipt is recorded for in + multi-company scenarios. join_hint: table: tabCompany 'on': represents_company = tabCompany.name - name: inter_company_reference - description: '' + description: Links to a related inter-company transaction when goods are received + from another company within the same corporate group. join_hint: table: tabDelivery Note 'on': inter_company_reference = tabDelivery Note.name - name: remarks - description: '' + description: Additional notes or comments about the purchase receipt transaction. - name: range - description: '' + description: Specifies the number range or series prefix used for generating purchase + receipt document numbers. - name: amended_from - description: '' + description: References the original purchase receipt document that this record + amends or corrects. join_hint: table: tabPurchase Receipt 'on': amended_from = tabPurchase Receipt.name - name: is_old_subcontracting_flow - description: '' + description: Indicates whether this purchase receipt follows the legacy subcontracting + process instead of the current workflow. + desc_done: true - table: tabPurchase Receipt Item description: '' fields: - name: name - description: '' + description: Unique identifier or code for the purchase receipt item line entry - name: barcode - description: '' + description: Barcode scanned or entered for the received item to verify product + identity during goods receipt - name: has_item_scanned - description: '' + description: Indicates whether the item was physically scanned with a barcode + scanner during the receipt process - name: item_code - description: '' + description: Identifies the specific product or material received in the purchase + receipt. join_hint: table: tabItem 'on': item_code = tabItem.name - name: product_bundle - description: '' + description: Indicates if the received item is a bundled package of multiple products + sold together as one unit. join_hint: table: tabProduct Bundle 'on': product_bundle = tabProduct Bundle.name - name: supplier_part_no - description: '' + description: The vendor's unique part number or SKU for the received item, used + when referencing supplier catalogs or cross-referencing vendor documentation. - name: item_name - description: '' + description: The specific product or material code received from the supplier, + used when querying what items were purchased. - name: description - description: '' + description: Detailed text explaining the item's specifications or characteristics, + used when searching by product features or attributes rather than item code. - name: brand - description: '' + description: The manufacturer or brand name of the received item, used when filtering + purchases by specific brands or comparing brand-level procurement. join_hint: table: tabBrand 'on': brand = tabBrand.name - name: item_group - description: '' + description: Category or classification of the purchased item for grouping similar + products together join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: image_view - description: '' + description: Visual representation or photo of the received item for verification + and identification purposes - name: received_qty - description: '' + description: Actual quantity of items physically received from the supplier in + this receipt transaction - name: qty - description: '' + description: Quantity of items received and accepted in this purchase receipt + line. - name: rejected_qty - description: '' + description: Quantity of items rejected or not accepted during receipt inspection. - name: uom - description: '' + description: Unit of measurement for the received quantity (e.g., pieces, kg, + boxes). join_hint: table: tabUOM 'on': uom = tabUOM.name - name: stock_uom - description: '' + description: Unit of measurement for inventory tracking of the received item. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert between the purchase unit and stock unit for + the received item. - name: retain_sample - description: '' + description: Indicates whether a sample of the received item should be kept for + quality testing or reference. - name: sample_quantity - description: '' + description: Quantity of items received as free samples or for testing purposes, + not added to regular inventory. - name: received_stock_qty - description: '' + description: Actual quantity of items physically received in the warehouse or + storage location in stock UOM. - name: stock_qty - description: '' + description: Total quantity added to inventory after accounting for UOM conversion, + rejections, and samples. - name: returned_qty - description: '' + description: Quantity of this item that has been returned to the supplier after + receipt. - name: price_list_rate - description: '' + description: Standard catalog price per unit in transaction currency before discounts + or negotiations. - name: base_price_list_rate - description: '' + description: Standard catalog price per unit converted to company base currency. - name: margin_type - description: '' + description: Whether the margin on the purchase receipt item is calculated as + a percentage or fixed amount. options: - Percentage - Amount - name: margin_rate_or_amount - description: '' + description: The numeric value of the margin, interpreted as either a percentage + rate or absolute amount depending on margin_type. - name: rate_with_margin - description: '' + description: The final unit rate of the item after applying the margin to the + base purchase rate. - name: discount_percentage - description: '' + description: Percentage discount applied directly to this purchase receipt item + line. - name: discount_amount - description: '' + description: Absolute monetary discount applied directly to this purchase receipt + item line before distribution. - name: distributed_discount_amount - description: '' + description: Portion of invoice-level or header-level discount allocated to this + specific item line. - name: base_rate_with_margin - description: '' + description: Unit price in company base currency after applying margin percentage + but before taxes, used when analyzing purchase costs with margin adjustments + across different currencies. - name: rate - description: '' + description: Actual unit price per item in transaction currency as agreed with + supplier, used when querying what was paid per unit for received items. - name: amount - description: '' + description: Total line value for the received quantity before taxes (rate × quantity), + used when asking about total cost or value of specific items received. - name: base_rate - description: '' + description: Unit price of the purchased item in company's base currency before + any currency conversion. - name: base_amount - description: '' + description: Total line amount for the purchased item in company's base currency + before any currency conversion. - name: pricing_rules - description: '' + description: Specific pricing rule or discount scheme applied to this purchase + receipt line item. - name: stock_uom_rate - description: '' + description: Rate per unit in the stock unit of measurement, used when querying + item costs in base inventory units rather than purchase units. - name: is_free_item - description: '' + description: Indicates whether this item was received as a free or promotional + item without charge. - name: apply_tds - description: '' + description: Indicates whether tax deducted at source should be applied to this + purchase receipt item. - name: net_rate - description: '' + description: Rate per unit of the item after applying discounts but before taxes, + used when analyzing pre-tax unit pricing on purchase receipts. - name: net_amount - description: '' + description: Total amount for the line item after discounts but before taxes, + used when calculating pre-tax purchase values. - name: item_tax_template - description: '' + description: Tax template applied to this specific item, used when identifying + which tax rules or rates govern this purchased item. join_hint: table: tabItem Tax Template 'on': item_tax_template = tabItem Tax Template.name - name: base_net_rate - description: '' + description: Price per unit in company base currency after discounts and before + taxes, used for financial reporting and margin analysis. - name: base_net_amount - description: '' + description: Total line amount in company base currency after discounts and before + taxes, used for financial totals and accounting entries. - name: valuation_rate - description: '' + description: Cost per unit used for inventory valuation and stock ledger entries, + may differ from purchase price when including landed costs. - name: sales_incoming_rate - description: '' + description: Exchange rate used to convert purchase receipt amounts to sales or + reporting currency for items received from suppliers. - name: item_tax_amount - description: '' + description: Total tax amount calculated for this specific item line in the purchase + receipt. - name: rm_supp_cost - description: '' + description: Raw material cost charged by the supplier for this item, excluding + taxes and additional charges. - name: landed_cost_voucher_amount - description: '' + description: Additional costs allocated to this receipt item from landed cost + vouchers such as freight, customs, or insurance charges. - name: amount_difference_with_purchase_invoice - description: '' + description: Variance between the purchase receipt item amount and the corresponding + purchase invoice amount, used to identify billing discrepancies. - name: billed_amt - description: '' + description: Total amount that has been invoiced for this receipt item, used to + track how much of the received goods have been billed. - name: warehouse - description: '' + description: The warehouse where purchased items are received and stored after + acceptance. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: rejected_warehouse - description: '' + description: The warehouse where rejected or non-conforming purchased items are + stored separately. join_hint: table: tabWarehouse 'on': rejected_warehouse = tabWarehouse.name - name: from_warehouse - description: '' + description: The source warehouse when transferring items between warehouses during + purchase receipt processing. join_hint: table: tabWarehouse 'on': from_warehouse = tabWarehouse.name - name: material_request - description: '' + description: Links to the original material request document that initiated the + procurement process for this received item. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: purchase_order - description: '' + description: Links to the purchase order document that authorized the purchase + of this received item. join_hint: table: tabPurchase Order 'on': purchase_order = tabPurchase Order.name - name: purchase_invoice - description: '' + description: Links to the supplier invoice document associated with this received + item for payment processing. join_hint: table: tabPurchase Invoice 'on': purchase_invoice = tabPurchase Invoice.name - name: allow_zero_valuation_rate - description: '' + description: Indicates whether this receipt item can have zero cost or valuation, + relevant when querying items received without assigned value. - name: return_qty_from_rejected_warehouse - description: '' + description: Quantity being returned specifically from the rejected warehouse + location, used when tracking returns of previously rejected goods. - name: is_fixed_asset - description: '' + description: Identifies whether the received item is a fixed asset rather than + regular inventory, relevant for asset procurement and capitalization queries. - name: asset_location - description: '' + description: Physical location where the received asset will be placed or stored + after receipt join_hint: table: tabLocation 'on': asset_location = tabLocation.name - name: asset_category - description: '' + description: Classification of the received item as a fixed asset type for accounting + and depreciation purposes join_hint: table: tabAsset Category 'on': asset_category = tabAsset Category.name - name: schedule_date - description: '' + description: Planned or expected date for the purchase receipt delivery or processing - name: quality_inspection - description: '' + description: References the quality inspection record performed on this received + item to verify it meets acceptance criteria. join_hint: table: tabQuality Inspection 'on': quality_inspection = tabQuality Inspection.name - name: material_request_item - description: '' + description: Links to the original material request line that triggered this purchase + receipt item. - name: purchase_order_item - description: '' + description: Links to the specific purchase order line item that this receipt + fulfills or partially fulfills. - name: purchase_invoice_item - description: '' + description: Links to the corresponding purchase invoice line item when the received + goods have been invoiced by the supplier. - name: purchase_receipt_item - description: '' + description: Self-reference to this purchase receipt line item, used for tracking + item-level receipt details like quantity received, rate, and item code. - name: delivery_note_item - description: '' + description: Links to the customer delivery note line item when this purchase + receipt is for a drop-ship or inter-warehouse transfer scenario. - name: putaway_rule - description: '' + description: Rule determining warehouse location assignment for received items + during putaway operations. join_hint: table: tabPutaway Rule 'on': putaway_rule = tabPutaway Rule.name - name: serial_and_batch_bundle - description: '' + description: Bundled collection linking this receipt item to its serial numbers + and batch numbers for inventory tracking. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: use_serial_batch_fields - description: '' + description: Indicates whether serial and batch numbers are managed through individual + fields rather than bundles for this receipt item. - name: rejected_serial_and_batch_bundle - description: '' + description: References the bundle containing serial numbers and batch numbers + for items rejected during receipt inspection or quality control. join_hint: table: tabSerial and Batch Bundle 'on': rejected_serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: serial_no - description: '' + description: The serial number assigned to the accepted item received in this + purchase receipt line. - name: rejected_serial_no - description: '' + description: The serial number of the item that was rejected during receipt inspection, + separate from accepted items. - name: batch_no - description: '' + description: Batch number assigned to the received items for inventory tracking + and traceability purposes. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: include_exploded_items - description: '' + description: Indicates whether sub-assembly or component items from a bill of + materials are expanded and shown as separate line items in the receipt. - name: bom - description: '' + description: Bill of materials reference used when receiving manufactured or assembled + items that need component tracking. join_hint: table: tabBOM 'on': bom = tabBOM.name - name: weight_per_unit - description: '' + description: Weight of a single unit of the received item, used when calculating + total shipment weight or analyzing per-unit logistics costs. - name: total_weight - description: '' + description: Total combined weight of all units received in this line item, used + for freight cost verification and warehouse capacity planning. - name: weight_uom - description: '' + description: Unit of measurement for weight values (kg, lbs, etc.), used to interpret + weight_per_unit and total_weight in the correct measurement system. join_hint: table: tabUOM 'on': weight_uom = tabUOM.name - name: manufacturer - description: '' + description: The company that manufactured the received item, relevant when users + need to filter or report purchases by manufacturer brand or source. join_hint: table: tabManufacturer 'on': manufacturer = tabManufacturer.name - name: manufacturer_part_no - description: '' + description: The manufacturer's specific part number for the received item, used + when users need to identify items by vendor-specific SKU rather than internal + item codes. - name: expense_account - description: '' + description: The general ledger expense account to which the cost of this received + item is posted, relevant when users need to track spending by accounting category + or cost center. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: item_tax_rate - description: '' + description: Tax rate percentage applied to this purchased item for calculating + tax amounts on the receipt. - name: wip_composite_asset - description: '' + description: Asset account used when the received item is part of a work-in-progress + composite or bundled asset. join_hint: table: tabAsset 'on': wip_composite_asset = tabAsset.name - name: provisional_expense_account - description: '' + description: Temporary expense account used to record costs when the purchase + invoice has not yet been received or matched. join_hint: table: tabAccount 'on': provisional_expense_account = tabAccount.name - name: project - description: '' + description: Project associated with this purchased item for tracking project-specific + procurement costs and materials. join_hint: table: tabProject 'on': project = tabProject.name - name: cost_center - description: '' + description: Cost center to which this purchased item's expenses are allocated + for departmental or divisional accounting. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: page_break - description: '' + description: Indicates whether a page break should occur before this item when + printing the purchase receipt document. - name: sales_order - description: '' + description: Links the purchased item to the originating sales order when the + purchase is made to fulfill a specific customer order (drop ship or make-to-order + scenarios). join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: sales_order_item - description: '' + description: Links to the specific line item on the sales order that this purchase + receipt item fulfills. - name: subcontracting_receipt_item - description: '' + description: References the subcontracted item being received back from the subcontractor + after processing or manufacturing. + desc_done: true - table: tabPurchase Receipt Item Supplied description: '' fields: - name: name - description: '' + description: Unique identifier for the supplied item record in the purchase receipt - name: main_item_code - description: '' + description: Finished or parent product code that was manufactured or assembled + using the supplied raw material join_hint: table: tabItem 'on': main_item_code = tabItem.name - name: rm_item_code - description: '' + description: Raw material or component item code that was supplied by the vendor + for subcontracting or manufacturing join_hint: table: tabItem 'on': rm_item_code = tabItem.name - name: item_name - description: '' + description: Raw material or component item supplied to subcontractor for manufacturing + or processing. - name: bom_detail_no - description: '' + description: Reference to specific bill of materials line item that defines which + component is being supplied. - name: description - description: '' + description: Additional details or specifications about the supplied item beyond + the item name. - name: stock_uom - description: '' + description: Unit of measurement for the supplied item in inventory stock terms. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert between the purchase unit and stock unit for + the supplied item. - name: reference_name - description: '' + description: Identifier linking this supplied item record to its source purchase + order or receipt item. - name: rate - description: '' + description: Price per unit of the supplied item received in the purchase receipt. - name: amount - description: '' + description: Total monetary value of the supplied item quantity received (rate + multiplied by quantity). - name: required_qty - description: '' + description: Quantity of the supplied item that was needed or requested for the + purchase receipt. - name: consumed_qty - description: '' + description: Quantity of raw material consumed or used during the purchase receipt + process for subcontracting or manufacturing. - name: current_stock - description: '' + description: Available stock quantity of the item at the time of the purchase + receipt transaction. - name: batch_no - description: '' + description: Batch or lot number identifying the specific production batch of + the supplied raw material or component. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: serial_no - description: '' + description: Unique identifier for tracking individual serialized items supplied + in the purchase receipt. - name: purchase_order - description: '' + description: Reference to the original purchase order document that authorized + this item receipt. join_hint: table: tabPurchase Order 'on': purchase_order = tabPurchase Order.name + desc_done: true - table: tabPurchase Taxes and Charges description: '' fields: - name: name - description: '' + description: Unique identifier for the specific tax or charge line item in a purchase + transaction - name: category - description: '' + description: Classification of the charge as either a tax type or an additional + charge type applied to the purchase options: - Valuation and Total - Valuation - Total - name: add_deduct_tax - description: '' + description: Whether this tax or charge increases or decreases the total purchase + amount options: - Add - Deduct - name: charge_type - description: '' + description: Whether this tax or charge is applied on the net total, previous + row total, or as a flat amount. options: - Actual - On Net Total @@ -21223,219 +26292,278 @@ tables: - On Previous Row Total - On Item Quantity - name: row_id - description: '' + description: Reference to a specific line item in the purchase order or invoice + to which this tax or charge applies. - name: included_in_print_rate - description: '' + description: Whether this tax or charge amount is already included in the item + rate shown on printed documents. - name: included_in_paid_amount - description: '' + description: Whether this tax or charge was already included in the amount paid + to the supplier rather than added separately. - name: account_head - description: '' + description: The general ledger account where this tax or charge amount is posted + for accounting purposes. join_hint: table: tabAccount 'on': account_head = tabAccount.name - name: description - description: '' + description: Explanatory text describing the nature or purpose of this specific + tax or charge line item. - name: is_tax_withholding_account - description: '' + description: Indicates whether this tax line represents a withholding tax deducted + from supplier payment rather than an additional tax charge. - name: rate - description: '' + description: The percentage or fixed amount applied to calculate this specific + tax or charge on the purchase transaction. - name: cost_center - description: '' + description: The cost center to which this particular tax or charge line is allocated + for expense tracking and budgeting purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Project associated with this purchase tax or charge line item for + cost allocation and tracking. join_hint: table: tabProject 'on': project = tabProject.name - name: account_currency - description: '' + description: Currency of the accounting ledger where this tax or charge is recorded. join_hint: table: tabCurrency 'on': account_currency = tabCurrency.name - name: tax_amount - description: '' + description: Calculated monetary value of the tax or charge applied to the purchase + transaction. - name: tax_amount_after_discount_amount - description: '' + description: Tax amount calculated after applying discounts to the purchase item + or invoice. - name: total - description: '' + description: Total amount including both the base charge and tax for this purchase + tax line item. - name: base_tax_amount - description: '' + description: Tax amount in the company's base currency before any discounts are + applied. - name: base_total - description: '' + description: Total tax amount in company base currency before any discounts are + applied to the tax. - name: base_tax_amount_after_discount_amount - description: '' + description: Tax amount in company base currency after applying discount on the + tax itself. - name: item_wise_tax_detail - description: '' + description: Breakdown of tax amounts calculated separately for each item in the + purchase transaction. + desc_done: true - table: tabPurchase Taxes and Charges Template description: Standard tax template that can be applied to all Purchase Transactions. This template can contain a list of tax heads and also other expense heads like "Shipping", "Insurance", "Handling", etc. fields: - name: name - description: '' + description: Unique identifier for the purchase taxes and charges template used + in procurement transactions. - name: title - description: '' + description: Display name of the purchase taxes and charges template shown to + users when selecting tax configurations for purchases. - name: is_default - description: '' + description: Indicates whether this purchase tax template is automatically applied + to new purchase transactions. - name: disabled - description: '' + description: Whether this purchase tax template is inactive and unavailable for + use in transactions. - name: company - description: '' + description: The specific company entity this purchase tax template applies to. join_hint: table: tabCompany 'on': company = tabCompany.name - name: tax_category - description: '' + description: The classification of tax type this template represents, such as + VAT, GST, or customs duty categories. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: taxes - description: '' + description: List of individual tax line items with rates, amounts, and accounts + that make up this purchase tax template. + desc_done: true - table: tabPush Notification Settings description: Enabling this will register your site on a central relay server to send push notifications for all installed apps through Firebase Cloud Messaging. This server only stores user tokens and error logs, and no messages are saved. fields: - name: name - description: '' + description: Unique identifier or label for the push notification configuration - name: enable_push_notification_relay - description: '' + description: Controls whether push notifications are actively relayed or sent + to recipients - name: api_key - description: '' + description: Authentication credential used to authorize push notification service + requests - name: api_secret - description: '' + description: Secret key or token used to authenticate and authorize push notification + API requests to external services. + desc_done: true - table: tabPutaway Rule description: '' fields: - name: name - description: '' + description: Unique identifier or label for the putaway rule used when referencing + or searching for specific putaway configurations - name: disable - description: '' + description: Indicates whether the putaway rule is currently active or inactive + for warehouse operations - name: item_code - description: '' + description: Specific product or material identifier that this putaway rule applies + to when determining storage locations join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Item being assigned a putaway location rule for warehouse storage + placement. - name: warehouse - description: '' + description: Warehouse facility where the putaway rule applies for incoming item + placement. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: priority - description: '' + description: Execution order when multiple putaway rules match the same item and + warehouse combination. - name: company - description: '' + description: Identifies which company or business entity the putaway rule applies + to in multi-company environments. join_hint: table: tabCompany 'on': company = tabCompany.name - name: capacity - description: '' + description: Maximum quantity or volume that can be stored in the location governed + by this putaway rule. - name: uom - description: '' + description: Unit of measure for the capacity value, such as pallets, cases, kilograms, + or cubic meters. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Factor to convert between the putaway unit of measure and the stock + unit of measure for warehouse storage calculations. - name: stock_uom - description: '' + description: Unit of measure used for tracking inventory quantities in the warehouse + location. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: stock_capacity - description: '' + description: Maximum quantity of items that can be stored in the warehouse location + based on the stock unit of measure. + desc_done: true - table: tabQuality Action description: '' fields: - name: name - description: '' + description: Name or title of the quality action taken in response to a quality + issue or inspection finding - name: corrective_preventive - description: '' + description: Whether the quality action addresses an existing problem (corrective) + or prevents future occurrences (preventive) options: - Corrective - Preventive - name: review - description: '' + description: Review notes, comments, or evaluation details documenting the assessment + or outcome of the quality action join_hint: table: tabQuality Review 'on': review = tabQuality Review.name - name: feedback - description: '' + description: Comments or notes describing the corrective or preventive action + taken in response to a quality issue join_hint: table: tabQuality Feedback 'on': feedback = tabQuality Feedback.name - name: status - description: '' + description: Current state of the quality action such as open, in progress, completed, + or closed options: - Open - Completed - name: date - description: '' + description: When the quality action was recorded, initiated, or is due for completion - name: goal - description: '' + description: Target or objective that the quality action aims to achieve or address join_hint: table: tabQuality Goal 'on': goal = tabQuality Goal.name - name: procedure - description: '' + description: Steps or methods to be followed when executing the quality action join_hint: table: tabQuality Procedure 'on': procedure = tabQuality Procedure.name - name: resolutions - description: '' + description: Outcomes, solutions, or corrective measures resulting from the quality + action + desc_done: true - table: tabQuality Action Resolution description: '' fields: - name: name - description: '' + description: Unique identifier or title for the quality action used when tracking + or referencing specific quality improvement initiatives. - name: problem - description: '' + description: Description of the quality issue or defect identified, used when + analyzing root causes or searching for similar past problems. - name: resolution - description: '' + description: Documented solution or corrective action taken, used when looking + up how quality issues were resolved or finding resolution patterns. - name: status - description: '' + description: Current state of the quality action resolution such as open, in progress, + completed, or closed. options: - Open - Completed - name: responsible - description: '' + description: Person or team assigned to resolve or complete the quality action. join_hint: table: tabUser 'on': responsible = tabUser.name - name: completion_by - description: '' + description: Target deadline or due date by which the quality action must be resolved. + desc_done: true - table: tabQuality Feedback description: '' fields: - name: name - description: '' + description: name - name: template - description: '' + description: template join_hint: table: tabQuality Feedback Template 'on': template = tabQuality Feedback Template.name - name: document_type - description: '' + description: document_type options: - User - Customer - name: document_name - description: '' + description: Name or identifier of the quality feedback document or record being + referenced - name: parameters - description: '' + description: Configuration settings or criteria defining quality standards, thresholds, + or evaluation metrics for the feedback + desc_done: true - table: tabQuality Feedback Parameter description: '' fields: - name: name - description: '' + description: Identifies the specific quality feedback parameter being measured + or evaluated in quality assessments and audits. - name: parameter - description: '' + description: Defines the measurable criterion or metric used to assess quality + performance against standards. - name: rating - description: '' + description: Captures the score or evaluation result assigned to a quality parameter + during inspection or review processes. options: - '1' - '2' @@ -21443,32 +26571,44 @@ tables: - '4' - '5' - name: feedback - description: '' + description: Quality feedback comments or observations recorded about a product, + process, or service defect or issue + desc_done: true - table: tabQuality Feedback Template description: '' fields: - name: name - description: '' + description: Name or title of the quality feedback template used to identify and + select specific feedback forms - name: template - description: '' + description: Actual content or structure of the quality feedback form including + questions, rating scales, and evaluation criteria - name: parameters - description: '' + description: Configuration settings or variables that customize how the quality + feedback template behaves or what data it collects + desc_done: true - table: tabQuality Feedback Template Parameter description: '' fields: - name: name - description: '' + description: Name or title of the quality feedback template parameter for identification + and selection - name: parameter - description: '' + description: Specific parameter or variable being measured or evaluated within + the quality feedback template + desc_done: true - table: tabQuality Goal description: '' fields: - name: name - description: '' + description: Unique identifier or label for the quality goal used when referencing + specific quality objectives in reports and tracking. - name: goal - description: '' + description: Target quality metric or performance threshold used when evaluating + whether quality standards are being met. - name: frequency - description: '' + description: How often the quality goal is measured or reviewed, used when scheduling + quality assessments and determining reporting periods. options: - None - Daily @@ -21476,12 +26616,14 @@ tables: - Monthly - Quarterly - name: procedure - description: '' + description: Quality control procedure or inspection method being tracked for + goal-setting and performance measurement join_hint: table: tabQuality Procedure 'on': procedure = tabQuality Procedure.name - name: weekday - description: '' + description: Day of the week for scheduled quality inspections or recurring quality + goal targets options: - Monday - Tuesday @@ -21490,7 +26632,8 @@ tables: - Friday - Saturday - name: date - description: '' + description: Specific calendar date when a quality goal is set, measured, or due + for achievement options: - '1' - '2' @@ -21523,52 +26666,66 @@ tables: - '29' - '30' - name: objectives - description: '' + description: The specific quality targets, standards, or performance criteria + that the organization aims to achieve through this quality goal. + desc_done: true - table: tabQuality Goal Objective description: '' fields: - name: name - description: '' + description: Name or title of the quality goal objective used to identify and + reference specific quality targets - name: objective - description: '' + description: Description of what the quality goal aims to achieve or measure in + terms of quality improvement or standards - name: target - description: '' + description: Numeric or measurable target value that the quality objective is + trying to reach or maintain - name: uom - description: '' + description: Unit of measurement for the quality goal objective, such as percentage, + count, or defect rate. join_hint: table: tabUOM 'on': uom = tabUOM.name + desc_done: true - table: tabQuality Inspection description: '' fields: - name: name - description: '' + description: Unique identifier for the quality inspection record, used when referencing + specific inspection results or tracking inspection history. - name: naming_series - description: '' + description: Auto-numbering pattern for quality inspection documents, used when + searching or filtering inspections by series prefix or organizational unit. options: - MAT-QA-.YYYY.- - name: company - description: '' + description: Company entity that performed the quality inspection, used when filtering + inspection records by business unit or legal entity. join_hint: table: tabCompany 'on': company = tabCompany.name - name: report_date - description: '' + description: Date when the quality inspection was reported or recorded. - name: status - description: '' + description: Current state of the quality inspection such as pending, approved, + rejected, or completed. options: - Accepted - Rejected - name: child_row_reference - description: '' + description: Links to detailed inspection line items or sub-records associated + with this quality inspection. - name: inspection_type - description: '' + description: Type of quality inspection performed such as incoming, in-process, + final, or audit inspection. options: - Incoming - Outgoing - In Process - name: reference_type - description: '' + description: Category of the document or transaction being inspected such as Purchase + Receipt, Delivery Note, Stock Entry, or Job Card. options: - Purchase Receipt - Purchase Invoice @@ -21578,543 +26735,697 @@ tables: - Stock Entry - Job Card - name: reference_name - description: '' + description: Specific document ID or transaction number of the item being inspected. - name: item_code - description: '' + description: Product or material identifier for the inspected item join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_serial_no - description: '' + description: Unique serial number for individually tracked items undergoing quality + inspection join_hint: table: tabSerial No 'on': item_serial_no = tabSerial No.name - name: batch_no - description: '' + description: Production batch or lot number for items inspected as a group join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: sample_size - description: '' + description: Number of units or quantity selected from a batch for quality inspection + testing - name: item_name - description: '' + description: Name or identifier of the product or material being inspected for + quality - name: description - description: '' + description: Detailed notes or findings about the quality inspection results, + defects, or observations - name: bom_no - description: '' + description: Bill of materials number associated with the inspected item or production + batch. join_hint: table: tabBOM 'on': bom_no = tabBOM.name - name: quality_inspection_template - description: '' + description: Template defining the inspection criteria, parameters, and standards + applied to this quality check. join_hint: table: tabQuality Inspection Template 'on': quality_inspection_template = tabQuality Inspection Template.name - name: manual_inspection - description: '' + description: Indicates whether the inspection was performed manually by personnel + rather than through automated systems. - name: readings - description: '' + description: Measurement values or test results recorded during the quality inspection + process - name: inspected_by - description: '' + description: Person who performed the quality inspection and collected the readings join_hint: table: tabUser 'on': inspected_by = tabUser.name - name: verified_by - description: '' + description: Person who reviewed and approved the inspection results after initial + inspection - name: remarks - description: '' + description: Additional notes or comments about the quality inspection results, + issues found, or special observations - name: amended_from - description: '' + description: Reference to the original quality inspection document that this record + corrects or replaces join_hint: table: tabQuality Inspection 'on': amended_from = tabQuality Inspection.name - name: letter_head - description: '' + description: Company letterhead template used when printing or emailing the quality + inspection report join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name + desc_done: true - table: tabQuality Inspection Parameter description: '' fields: - name: name - description: '' + description: Unique identifier or label for the quality inspection parameter record. - name: parameter - description: '' + description: Specific quality metric or characteristic being measured during inspection + processes. - name: parameter_group - description: '' + description: Category or classification grouping related quality parameters together + for organizational purposes. join_hint: table: tabQuality Inspection Parameter Group 'on': parameter_group = tabQuality Inspection Parameter Group.name - name: description - description: '' + description: Detailed explanation or specification of the quality inspection parameter + being measured or evaluated + desc_done: true - table: tabQuality Inspection Parameter Group description: '' fields: - name: name - description: '' + description: description - name: group_name - description: '' + description: description + desc_done: true - table: tabQuality Inspection Reading description: '' fields: - name: name - description: '' + description: Unique identifier or label for the specific quality inspection reading + record - name: specification - description: '' + description: The quality standard, requirement, or acceptance criteria being measured + or verified in this inspection reading join_hint: table: tabQuality Inspection Parameter 'on': specification = tabQuality Inspection Parameter.name - name: parameter_group - description: '' + description: Category or grouping that organizes related inspection parameters + or measurements together join_hint: table: tabQuality Inspection Parameter Group 'on': parameter_group = tabQuality Inspection Parameter Group.name - name: status - description: '' + description: Indicates whether the quality inspection reading passed, failed, + or is pending review. options: - Accepted - Rejected - name: value - description: '' + description: The actual recorded measurement or observation from the quality inspection, + which may be text, numeric, or categorical. - name: numeric - description: '' + description: The numerical representation of the inspection reading value, used + when the measurement is quantitative rather than qualitative. - name: manual_inspection - description: '' + description: Whether the quality inspection reading requires manual verification + or measurement by an inspector rather than automated testing. - name: min_value - description: '' + description: The minimum acceptable threshold or lower specification limit for + this quality inspection measurement. - name: max_value - description: '' + description: The maximum acceptable threshold or upper specification limit for + this quality inspection measurement. - name: formula_based_criteria - description: '' + description: Indicates whether the quality inspection uses a formula to determine + pass/fail rather than simple threshold values. - name: acceptance_formula - description: '' + description: The formula expression used to calculate whether an inspection reading + meets acceptance criteria. - name: reading_value - description: '' + description: The actual measured or recorded value from the quality inspection + test or measurement. - name: reading_1 - description: '' + description: First measurement value recorded during quality inspection for a + specific parameter or characteristic. - name: reading_2 - description: '' + description: Second measurement value recorded during quality inspection for a + specific parameter or characteristic. - name: reading_3 - description: '' + description: Third measurement value recorded during quality inspection for a + specific parameter or characteristic. - name: reading_4 - description: '' + description: Fourth measurement value recorded during quality inspection for multi-point + testing scenarios. - name: reading_5 - description: '' + description: Fifth measurement value recorded during quality inspection for multi-point + testing scenarios. - name: reading_6 - description: '' + description: Sixth measurement value recorded during quality inspection for multi-point + testing scenarios. - name: reading_7 - description: '' + description: Seventh measurement value recorded during quality inspection for + multi-point testing scenarios - name: reading_8 - description: '' + description: Eighth measurement value recorded during quality inspection for multi-point + testing scenarios - name: reading_9 - description: '' + description: Ninth measurement value recorded during quality inspection for multi-point + testing scenarios - name: reading_10 - description: '' + description: The tenth measurement value recorded during a quality inspection, + used when users ask about the 10th reading or measurement in a multi-point inspection + sequence. + desc_done: true - table: tabQuality Inspection Template description: '' fields: - name: name - description: '' + description: Unique identifier for the quality inspection template record - name: quality_inspection_template_name - description: '' + description: The descriptive title or label of the quality inspection template + used when searching or referencing specific inspection procedures - name: item_quality_inspection_parameter - description: '' + description: The specific quality parameters or criteria to be inspected for items + using this template, such as dimensions, defects, or specifications + desc_done: true - table: tabQuality Meeting description: '' fields: - name: name - description: '' + description: Meeting title or identifier used when searching for or referring + to a specific quality meeting - name: status - description: '' + description: Current state of the quality meeting such as scheduled, completed, + or cancelled options: - Open - Closed - name: agenda - description: '' + description: Topics, issues, or discussion points planned or covered in the quality + meeting - name: minutes - description: '' + description: Meeting notes and discussion points recorded during the quality meeting + desc_done: true - table: tabQuality Meeting Agenda description: '' fields: - name: name - description: '' + description: Title or identifier of the quality meeting agenda item - name: agenda - description: '' + description: Detailed content or topics to be discussed in the quality meeting + desc_done: true - table: tabQuality Meeting Minutes description: '' fields: - name: name - description: '' + description: Unique identifier or title of the quality meeting minutes record - name: document_type - description: '' + description: Category or classification of the quality meeting document (e.g., + audit, review, inspection) options: - Quality Review - Quality Action - Quality Feedback - name: document_name - description: '' + description: File name or descriptive title of the attached quality meeting minutes + document - name: minute - description: '' + description: The detailed notes, discussion points, action items, and decisions + recorded during the quality meeting + desc_done: true - table: tabQuality Procedure description: '' fields: - name: name - description: '' + description: Unique identifier or code for the quality procedure - name: quality_procedure_name - description: '' + description: Full descriptive name of the quality procedure used when searching + by procedure title or description - name: process_owner - description: '' + description: Person or role responsible for managing and overseeing the quality + procedure join_hint: table: tabUser 'on': process_owner = tabUser.name - name: process_owner_full_name - description: '' + description: Full name of the person responsible for the quality procedure, used + when searching by owner or accountability. - name: processes - description: '' + description: Business processes or operations covered by this quality procedure, + used when finding procedures applicable to specific workflows or activities. - name: parent_quality_procedure - description: '' + description: Links to a higher-level quality procedure when this is a sub-procedure + or nested component, used for hierarchical procedure navigation. join_hint: table: tabQuality Procedure 'on': parent_quality_procedure = tabQuality Procedure.name - name: is_group - description: '' + description: Indicates whether this quality procedure is a parent grouping container + for organizing other procedures rather than an individual executable procedure. - name: rgt - description: '' + description: Right boundary value in nested set model for hierarchical quality + procedure tree traversal and ancestor-descendant queries. - name: lft - description: '' + description: Left boundary value in nested set model for hierarchical quality + procedure tree traversal and ancestor-descendant queries. - name: old_parent - description: '' + description: Previous parent quality procedure before reassignment or hierarchy + change, used when tracking procedure reorganization history or auditing what + the prior parent procedure was. + desc_done: true - table: tabQuality Procedure Process description: '' fields: - name: name - description: '' + description: Short identifier or title of the quality procedure process step or + stage - name: process_description - description: '' + description: Detailed explanation of what happens during this quality procedure + process step, including actions, requirements, and expected outcomes - name: procedure - description: '' + description: Reference to the parent quality procedure that this process belongs + to or implements join_hint: table: tabQuality Procedure 'on': procedure = tabQuality Procedure.name + desc_done: true - table: tabQuality Review description: '' fields: - name: name - description: '' + description: Identifies the specific quality review instance or title for tracking + and referencing quality assessment activities. - name: goal - description: '' + description: Defines the target objective or performance standard being evaluated + during the quality review process. join_hint: table: tabQuality Goal 'on': goal = tabQuality Goal.name - name: date - description: '' + description: Specifies when the quality review was conducted or scheduled, used + for tracking review timing and historical analysis. - name: procedure - description: '' + description: The quality control procedure or inspection method being followed + during the review process. join_hint: table: tabQuality Procedure 'on': procedure = tabQuality Procedure.name - name: status - description: '' + description: Current state of the quality review such as pending, approved, rejected, + or in progress. options: - Open - Passed - Failed - name: reviews - description: '' + description: Count or collection of quality review records, used when asking about + total reviews or review history. - name: additional_information - description: '' + description: Free-text notes or supplementary details about the quality review + that don't fit in structured fields. + desc_done: true - table: tabQuality Review Objective description: '' fields: - name: name - description: '' + description: Unique identifier or title of the quality review objective - name: objective - description: '' + description: Description of what quality aspect or goal is being evaluated or + measured in the review - name: target - description: '' + description: Desired outcome, benchmark value, or performance threshold the quality + review objective aims to achieve - name: uom - description: '' + description: Unit of measurement for the quality review objective, such as percentage, + count, or defect rate. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: status - description: '' + description: Current state of the quality review objective, such as active, completed, + or pending. options: - Open - Passed - Failed - name: review - description: '' + description: The quality review process or assessment that this objective belongs + to or is being evaluated under. + desc_done: true - table: tabQuery Parameters description: '' fields: - name: name - description: '' + description: Identifies the query parameter name used when filtering or searching + data in reports and analytics. - name: key - description: '' + description: Specifies the parameter key used to match against field names or + filter criteria in query operations. - name: value - description: '' + description: Contains the actual filter value or search term applied to narrow + down results in data retrieval requests. + desc_done: true - table: tabQuick Stock Balance description: '' fields: - name: name - description: '' + description: Item code or product identifier for which stock balance is tracked - name: warehouse - description: '' + description: Storage location or facility where the stock quantity is held join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: date - description: '' + description: Snapshot date when the stock balance was recorded or calculated - name: item_barcode - description: '' + description: Scannable barcode identifier for the inventory item, used when users + reference products by barcode number or scan code. - name: item - description: '' + description: Unique item code or SKU identifier, used when users reference products + by their internal item number or product code. join_hint: table: tabItem 'on': item = tabItem.name - name: item_name - description: '' + description: Human-readable product name or description, used when users reference + products by their common name or title. - name: item_description - description: '' + description: Name or description of the inventory item for identifying what product + or material is in stock. - name: image - description: '' + description: Visual representation or photo of the inventory item for product + identification. - name: qty - description: '' + description: Current quantity or stock level of the item available in inventory. - name: value - description: '' + description: Current monetary worth or total value of stock inventory at a point + in time, used when asking about stock valuation or inventory worth. + desc_done: true - table: tabQuotation description: '' fields: - name: name - description: '' + description: Unique identifier or number assigned to the quotation document - name: title - description: '' + description: Customer or prospect name associated with the quotation - name: naming_series - description: '' + description: Prefix pattern used to generate the quotation number options: - SAL-QTN-.YYYY.- - name: quotation_to - description: '' + description: Specifies whether the quotation is issued to a customer, lead, or + prospect entity type. join_hint: table: tabDocType 'on': quotation_to = tabDocType.name - name: party_name - description: '' + description: The unique identifier or code of the entity receiving the quotation + (customer ID, lead ID, or prospect ID). - name: customer_name - description: '' + description: The display name of the customer, lead, or prospect receiving the + quotation. - name: transaction_date - description: '' + description: Date when the quotation was created or issued to the customer. - name: valid_till - description: '' + description: Expiration date until which the quoted prices and terms remain valid + for customer acceptance. - name: order_type - description: '' + description: Category or classification of the quotation such as standard sale, + service, project-based, or custom order type. options: - Sales - Maintenance - Shopping Cart - name: company - description: '' + description: The company entity that issued or owns this quotation. join_hint: table: tabCompany 'on': company = tabCompany.name - name: has_unit_price_items - description: '' + description: Indicates whether this quotation includes line items with individual + unit pricing. - name: amended_from - description: '' + description: References the original quotation that this quotation amends or revises. join_hint: table: tabQuotation 'on': amended_from = tabQuotation.name - name: currency - description: '' + description: Currency in which the quotation prices and amounts are denominated join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: conversion_rate - description: '' + description: Exchange rate used to convert quotation amounts from the quotation + currency to the base company currency - name: selling_price_list - description: '' + description: Price list applied to determine item rates and pricing rules for + this quotation join_hint: table: tabPrice List 'on': selling_price_list = tabPrice List.name - name: price_list_currency - description: '' + description: Currency in which the quotation prices are listed and displayed to + the customer. join_hint: table: tabCurrency 'on': price_list_currency = tabCurrency.name - name: plc_conversion_rate - description: '' + description: Exchange rate used to convert price list currency amounts to the + quotation's base currency. - name: ignore_pricing_rule - description: '' + description: Indicates whether automatic pricing rules and discounts are bypassed + for this quotation. - name: scan_barcode - description: '' + description: Barcode scanned or associated with the quotation for tracking or + identification purposes. - name: last_scanned_warehouse - description: '' + description: Warehouse location where the quotation or its items were most recently + scanned. - name: items - description: '' + description: Line items or products included in the quotation with quantities + and pricing details. - name: total_qty - description: '' + description: Total quantity of all items in the quotation across all line items - name: total_net_weight - description: '' + description: Combined net weight of all items in the quotation - name: base_total - description: '' + description: Quotation subtotal in base currency before taxes, discounts, and + shipping charges - name: base_net_total - description: '' + description: Net total amount in company's base currency before taxes, used when + analyzing quotation values across multiple currencies. - name: total - description: '' + description: Final quotation amount including all taxes, discounts, and charges, + used when asking about the complete quotation value the customer sees. - name: net_total - description: '' + description: Subtotal amount in quotation currency after discounts but before + taxes, used when asking about pre-tax quotation value. - name: tax_category - description: '' + description: Tax classification applied to the quotation determining which tax + rules apply based on customer type, location, or product category. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: taxes_and_charges - description: '' + description: Specific tax template or charge configuration defining the actual + tax rates, accounts, and calculation methods applied to this quotation. join_hint: table: tabSales Taxes and Charges Template 'on': taxes_and_charges = tabSales Taxes and Charges Template.name - name: shipping_rule - description: '' + description: Shipping cost calculation rule applied to determine freight charges + based on order value, weight, or destination. join_hint: table: tabShipping Rule 'on': shipping_rule = tabShipping Rule.name - name: incoterm - description: '' + description: Shipping terms code defining buyer and seller responsibilities for + delivery, risk, and costs (e.g., FOB, CIF, EXW). join_hint: table: tabIncoterm 'on': incoterm = tabIncoterm.name - name: named_place - description: '' + description: Specific location associated with the incoterm where risk and cost + transfer occurs (port, warehouse, or delivery address). - name: taxes - description: '' + description: Total tax amount or tax details applied to the quotation, separate + from line item prices. - name: base_total_taxes_and_charges - description: '' + description: Total amount of all taxes and charges in base currency before any + currency conversion or exchange rate adjustments. - name: total_taxes_and_charges - description: '' + description: Total amount of all taxes and charges in the quotation's transaction + currency after applying exchange rates. - name: base_grand_total - description: '' + description: Final total amount of the quotation including all items, taxes, and + charges in base currency before currency conversion. - name: base_rounding_adjustment - description: '' + description: Amount added or subtracted to round the quotation total to a convenient + number in base currency. - name: base_rounded_total - description: '' + description: Final quotation total after applying rounding adjustment in base + currency. - name: base_in_words - description: '' + description: Text representation of the quotation total amount in base currency, + typically used for formal quotation documents. - name: grand_total - description: '' + description: Total quotation amount before any rounding adjustments are applied. - name: rounding_adjustment - description: '' + description: Amount added or subtracted to round the grand total to a convenient + figure. - name: rounded_total - description: '' + description: Final quotation amount after applying rounding adjustment to the + grand total. - name: disable_rounded_total - description: '' + description: Whether the quotation total should be displayed without rounding + to the nearest whole number. - name: in_words - description: '' + description: The quotation total amount expressed as text words rather than numeric + digits. - name: apply_discount_on - description: '' + description: Whether discounts are calculated on the grand total or on individual + line items in the quotation. options: - Grand Total - Net Total - name: base_discount_amount - description: '' + description: Discount amount applied before any additional discounts or coupons, + used when calculating the initial price reduction on the quotation. - name: coupon_code - description: '' + description: Promotional or marketing code entered by customer to receive special + discounts or offers on the quotation. join_hint: table: tabCoupon Code 'on': coupon_code = tabCoupon Code.name - name: additional_discount_percentage - description: '' + description: Extra percentage discount applied on top of base discounts, typically + for negotiated deals or special customer pricing. - name: discount_amount - description: '' + description: Total discount value applied to the quotation in currency units, + used when asking about discount totals or quotation price reductions. - name: referral_sales_partner - description: '' + description: External partner or agent who referred the customer for this quotation, + used when tracking partner-sourced opportunities or commission eligibility. join_hint: table: tabSales Partner 'on': referral_sales_partner = tabSales Partner.name - name: other_charges_calculation - description: '' + description: Additional fees or charges beyond line items such as handling fees, + setup costs, or miscellaneous charges added to the quotation total. - name: packed_items - description: '' + description: Items grouped or bundled together in the quotation for packaging + purposes. - name: pricing_rules - description: '' + description: Special pricing conditions or discount rules applied to this quotation. - name: customer_address - description: '' + description: Delivery or billing address associated with the customer for this + quotation. join_hint: table: tabAddress 'on': customer_address = tabAddress.name - name: address_display - description: '' + description: Formatted address of the customer or prospect receiving the quotation. - name: contact_person - description: '' + description: Name or identifier of the individual at the customer organization + who is the primary contact for this quotation. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_display - description: '' + description: Formatted display name and details of the contact person associated + with this quotation. - name: contact_mobile - description: '' + description: Mobile phone number of the customer contact person for this quotation - name: contact_email - description: '' + description: Email address of the customer contact person for this quotation - name: shipping_address_name - description: '' + description: Name or label identifying the delivery location for quoted items join_hint: table: tabAddress 'on': shipping_address_name = tabAddress.name - name: shipping_address - description: '' + description: Address where quoted goods will be delivered if the quotation is + accepted and converted to an order. - name: company_address - description: '' + description: Address of the company issuing the quotation, used as the sender + or return address. join_hint: table: tabAddress 'on': company_address = tabAddress.name - name: company_address_display - description: '' + description: Formatted version of the company address for display on printed quotations + and customer-facing documents. - name: company_contact_person - description: '' + description: The internal employee or representative from the selling company + who is responsible for this quotation. join_hint: table: tabContact 'on': company_contact_person = tabContact.name - name: payment_terms_template - description: '' + description: The predefined payment terms template applied to this quotation, + such as Net 30 or COD. join_hint: table: tabPayment Terms Template 'on': payment_terms_template = tabPayment Terms Template.name - name: payment_schedule - description: '' + description: The specific payment schedule or installment plan agreed upon for + this quotation, detailing when payments are due. - name: tc_name - description: '' + description: Name of the terms and conditions template applied to the quotation join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Full text of the terms and conditions or special clauses included + in the quotation - name: auto_repeat - description: '' + description: Whether this quotation is set to automatically recur or regenerate + on a schedule join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: letter_head - description: '' + description: Letterhead template used when printing or emailing this quotation join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: group_same_items - description: '' + description: Whether identical items are consolidated into single lines on the + printed quotation - name: select_print_heading - description: '' + description: Custom heading text that appears at the top of the printed quotation + document join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: language - description: '' + description: Language in which the quotation document is written or will be presented + to the customer. - name: lost_reasons - description: '' + description: Reasons why the quotation was not converted to a sale or why the + deal was lost. - name: competitors - description: '' + description: Competing companies or vendors that the customer is considering as + alternatives to this quotation. - name: order_lost_reason - description: '' + description: Reason why the quotation was lost or not converted to a sales order, + used when analyzing why deals failed. - name: status - description: '' + description: Current state of the quotation such as draft, submitted, accepted, + or lost, used to filter quotations by their progress stage. options: - Draft - Open @@ -22125,297 +27436,391 @@ tables: - Cancelled - Expired - name: customer_group - description: '' + description: Classification or category of the customer receiving the quotation, + used to segment quotations by customer type or market segment. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: territory - description: '' + description: Geographic sales region or area assigned to the quotation for tracking + regional sales performance and assignments join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: campaign - description: '' + description: Marketing campaign that generated or is associated with this quotation + for tracking campaign effectiveness join_hint: table: tabCampaign 'on': campaign = tabCampaign.name - name: source - description: '' + description: Origin or channel through which the quotation request was received, + such as website, referral, or direct contact join_hint: table: tabLead Source 'on': source = tabLead Source.name - name: opportunity - description: '' + description: Sales opportunity or lead associated with this quotation for tracking + potential deals. join_hint: table: tabOpportunity 'on': opportunity = tabOpportunity.name - name: supplier_quotation - description: '' + description: Indicates this is a quotation received from a supplier rather than + sent to a customer. join_hint: table: tabSupplier Quotation 'on': supplier_quotation = tabSupplier Quotation.name - name: enq_det - description: '' + description: Reference to the enquiry or request for quotation that prompted this + quotation. + desc_done: true - table: tabQuotation Item description: '' fields: - name: name - description: '' + description: Unique identifier for the quotation item row, auto-generated from + item code and quotation number - name: item_code - description: '' + description: The seller's internal product or service identifier for the quoted + item join_hint: table: tabItem 'on': item_code = tabItem.name - name: customer_item_code - description: '' + description: The customer's own product identifier or part number for the quoted + item, used when customer references items by their internal codes - name: item_name - description: '' + description: Product or service code being quoted to the customer - name: description - description: '' + description: Detailed specification or additional information about the quoted + item beyond its name - name: item_group - description: '' + description: Product category or classification for the quoted item used for grouping + and filtering join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: brand - description: '' + description: Brand or manufacturer name of the quoted item, used when filtering + or searching quotations by product brand. join_hint: table: tabBrand 'on': brand = tabBrand.name - name: image_view - description: '' + description: Visual representation or image attachment of the quoted item, referenced + when users need to see or verify product appearance in quotations. - name: qty - description: '' + description: Quantity of the item being quoted, used when asking about volumes, + amounts, or total units in quotation line items. - name: stock_uom - description: '' + description: Base unit of measure for the item in inventory (e.g., pieces, kg) + used when asking about standard stock units regardless of quotation UOM. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: uom - description: '' + description: Unit of measure for this specific quotation line (e.g., box, dozen) + used when asking about quoted quantities or pricing units that may differ from + stock units. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert the quotation UOM to stock UOM used when asking + how many stock units equal one quotation unit. - name: stock_qty - description: '' + description: Quantity available in stock at the time of quotation creation, used + when checking if quoted items can be fulfilled from current inventory. - name: actual_qty - description: '' + description: Real-time quantity currently available in warehouse, used when verifying + current stock levels against quoted amounts. - name: company_total_stock - description: '' + description: Total quantity available across all warehouses company-wide, used + when checking overall inventory availability beyond single warehouse. - name: price_list_rate - description: '' + description: Price per unit from the price list in the quotation's currency, before + any discounts or margins are applied. - name: base_price_list_rate - description: '' + description: Price per unit from the price list converted to the company's base + currency for standardized reporting. - name: margin_type - description: '' + description: Whether margin is calculated as a percentage or fixed amount on top + of the rate. options: - Percentage - Amount - name: margin_rate_or_amount - description: '' + description: Margin added to the base rate, either as a percentage or fixed amount, + used when calculating profitability or markup on quoted items. - name: rate_with_margin - description: '' + description: Final rate after applying margin to the base rate, representing the + actual quoted price per unit before discounts. - name: discount_percentage - description: '' + description: Percentage discount applied to reduce the quoted price, used when + analyzing price reductions or promotional offers. - name: discount_amount - description: '' + description: Total discount applied to this quotation line item, used when asking + about discounts given on specific quoted products or services. - name: distributed_discount_amount - description: '' + description: Portion of header-level or distributed discount allocated to this + line item, used when analyzing how overall quotation discounts are spread across + items. - name: base_rate_with_margin - description: '' + description: Unit price including margin before discounts, used when asking about + pricing with profit margin factored in but before any discount reductions. - name: rate - description: '' + description: Price per unit of the item before applying any discounts or additional + charges on the quotation line. - name: net_rate - description: '' + description: Final price per unit after applying discounts, pricing rules, or + other adjustments to the base rate. - name: amount - description: '' + description: Total line value calculated from quantity and net rate, representing + the final extended price for this quotation item. - name: net_amount - description: '' + description: Total amount for this quotation line item after applying discounts + but before taxes. - name: item_tax_template - description: '' + description: Tax template applied to this quotation item defining which tax rates + and rules apply. join_hint: table: tabItem Tax Template 'on': item_tax_template = tabItem Tax Template.name - name: base_rate - description: '' + description: Unit price of the item in the company's base currency before any + discounts or taxes. - name: base_net_rate - description: '' + description: Unit price after applying discounts but before taxes, in company + base currency. - name: base_amount - description: '' + description: Total line amount before discounts and taxes, in company base currency. - name: base_net_amount - description: '' + description: Total line amount after applying discounts but before taxes, in company + base currency. - name: pricing_rules - description: '' + description: Identifies which pricing rule was applied to calculate this quotation + item's price or discount. - name: stock_uom_rate - description: '' + description: Price per unit in the item's base stock unit of measure, before quantity + or UOM conversions. - name: is_free_item - description: '' + description: Indicates whether this item is provided at no charge as part of a + promotion or bundle. - name: is_alternative - description: '' + description: Indicates this quotation item is offered as an alternative option + rather than a primary item. - name: has_alternative_item - description: '' + description: Indicates this quotation item has one or more alternative items associated + with it. - name: valuation_rate - description: '' + description: Cost or internal valuation rate of the item used for margin calculations, + distinct from the selling price shown to customers. - name: gross_profit - description: '' + description: Profit margin or amount calculated for this quotation line item, + used when analyzing profitability or pricing strategy of quoted products. - name: weight_per_unit - description: '' + description: Weight of a single unit of the quoted item, used when calculating + shipping costs or comparing product specifications per unit. - name: total_weight - description: '' + description: Combined weight of all units in this quotation line, used when determining + total shipping weight or logistics requirements for the quoted quantity. - name: weight_uom - description: '' + description: Unit of measurement for the quoted item's weight (e.g., kg, lbs) + used when users ask about weight specifications or shipping calculations. join_hint: table: tabUOM 'on': weight_uom = tabUOM.name - name: warehouse - description: '' + description: Warehouse location from which the quoted item will be fulfilled, + relevant when users ask about stock availability or delivery source for quotations. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: against_blanket_order - description: '' + description: Indicates whether this quotation item is linked to an existing blanket + purchase order, used when users ask about items quoted under long-term or framework + agreements. - name: blanket_order - description: '' + description: Reference to a blanket order agreement when this quotation item is + linked to a pre-negotiated bulk purchase arrangement. join_hint: table: tabBlanket Order 'on': blanket_order = tabBlanket Order.name - name: blanket_order_rate - description: '' + description: Pre-negotiated price from the blanket order agreement applied to + this quotation item. - name: prevdoc_doctype - description: '' + description: Type of the previous document that generated or is linked to this + quotation item, such as Opportunity or Lead. join_hint: table: tabDocType 'on': prevdoc_doctype = tabDocType.name - name: prevdoc_docname - description: '' + description: Reference to the previous document that generated this quotation + item, such as an opportunity or lead identifier. - name: projected_qty - description: '' + description: Expected available quantity of the item considering current stock + and planned production or procurement. - name: item_tax_rate - description: '' + description: Tax rate percentage applied specifically to this quotation line item. - name: additional_notes - description: '' + description: Free-text notes or comments specific to this quotation line item, + used when users ask about special instructions, remarks, or additional details + for individual quoted items. - name: page_break - description: '' + description: Controls whether a page break occurs before this quotation item when + printing or generating PDF documents, relevant when users ask about quotation + formatting or print layout. + desc_done: true - table: tabQuotation Lost Reason description: '' fields: - name: name - description: '' + description: Unique identifier or label for the specific reason why a quotation + was lost - name: order_lost_reason - description: '' + description: Detailed explanation or category describing why the customer did + not accept the quotation + desc_done: true - table: tabQuotation Lost Reason Detail description: '' fields: - name: name - description: '' + description: Unique identifier or code for this specific quotation lost reason + detail record - name: lost_reason - description: '' + description: The reason why a quotation was lost or not converted to a sale join_hint: table: tabQuotation Lost Reason 'on': lost_reason = tabQuotation Lost Reason.name + desc_done: true - table: tabReminder description: '' fields: - name: name - description: '' + description: Reminder title or description text that identifies what the reminder + is about - name: user - description: '' + description: User assigned to receive or responsible for the reminder join_hint: table: tabUser 'on': user = tabUser.name - name: remind_at - description: '' + description: Date and time when the reminder is scheduled to trigger or be sent - name: description - description: '' + description: Text content or message of the reminder explaining what needs to + be done or remembered - name: reminder_doctype - description: '' + description: Type or category of document that this reminder is associated with join_hint: table: tabDocType 'on': reminder_doctype = tabDocType.name - name: reminder_docname - description: '' + description: Specific document identifier or name that this reminder references - name: notified - description: '' + description: Indicates whether the reminder notification has been sent to the + recipient + desc_done: true - table: tabRename Tool description: '' fields: - name: name - description: '' + description: Name or identifier of the rename tool configuration - name: select_doctype - description: '' + description: Document type being targeted for the rename operation + desc_done: true - table: tabReport description: '' fields: - name: name - description: '' + description: Unique identifier or code for the report used in technical references + and API calls - name: report_name - description: '' + description: Display title of the report shown to users in the interface and menus - name: ref_doctype - description: '' + description: The source document type or table that this report queries data from join_hint: table: tabDocType 'on': ref_doctype = tabDocType.name - name: reference_report - description: '' + description: Unique identifier or code name used to locate and reference a specific + report template or report definition. - name: is_standard - description: '' + description: Indicates whether the report is a default system report versus a + custom or user-created report. options: - 'No' - 'Yes' - name: module - description: '' + description: The functional area or business module the report belongs to, such + as Finance, Sales, Inventory, or HR. join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: report_type - description: '' + description: Type or category of the report such as financial, sales, inventory, + or custom report classification options: - Report Builder - Query Report - Script Report - Custom Report - name: letter_head - description: '' + description: Letterhead template or company header branding applied to the printed + or exported report join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: add_total_row - description: '' + description: Whether the report includes a totals or summary row at the bottom + aggregating numeric columns - name: disabled - description: '' + description: Whether the report is inactive or unavailable for use - name: prepared_report - description: '' + description: Indicates if the report has been pre-generated or is ready to run - name: add_translate_data - description: '' + description: Whether to include translated or multi-language data in the report + output - name: timeout - description: '' + description: Maximum execution time limit for the report query before it is automatically + terminated - name: filters - description: '' + description: Criteria or conditions applied to limit which records are included + in the report results - name: columns - description: '' + description: Specific data fields or attributes selected to display in the report + output - name: query - description: '' + description: SQL query that retrieves the data displayed in the report - name: report_script - description: '' + description: Server-side script that processes or transforms report data before + rendering - name: javascript - description: '' + description: Client-side JavaScript code that controls report interactivity and + display behavior in the browser - name: json - description: '' + description: Full report definition including layout, filters, columns, groupings, + and formatting configuration - name: roles - description: '' + description: User roles or permission groups that have access to view or run this + report + desc_done: true - table: tabReport Column description: '' fields: - name: name - description: '' + description: Unique identifier for the report column used when referencing specific + columns in report configurations or queries. - name: fieldname - description: '' + description: Database field name that maps the report column to the underlying + data source table column. - name: label - description: '' + description: Display text shown to end users in report headers and filters when + viewing or configuring reports. - name: fieldtype - description: '' + description: Data type of the report column such as text, number, date, or link + that determines how values are displayed and formatted options: - Check - Currency @@ -22431,18 +27836,22 @@ tables: - Select - Time - name: options - description: '' + description: Configuration value specifying linked document type for link fields + or source for select/dropdown field values - name: width - description: '' + description: Display width of the report column in pixels or relative units controlling + visual layout + desc_done: true - table: tabReport Filter description: '' fields: - name: name - description: '' + description: Unique identifier of the filter used in queries and API references - name: label - description: '' + description: Display text shown to end users when selecting or viewing the filter - name: fieldtype - description: '' + description: Data type of the filter such as text, number, date, or select used + to determine input validation and UI control options: - Check - Currency @@ -22457,98 +27866,118 @@ tables: - Select - Time - name: fieldname - description: '' + description: Name of the field being filtered in the report - name: mandatory - description: '' + description: Whether the filter must be specified by the user when running the + report - name: wildcard_filter - description: '' + description: Whether the filter accepts wildcard pattern matching for partial + text searches - name: options - description: '' + description: Available filter choices or values that can be selected for this + report filter. - name: default - description: '' + description: Pre-selected filter value applied when the report is first loaded + or run. + desc_done: true - table: tabRepost Accounting Ledger description: '' fields: - name: name - description: '' + description: Unique identifier or label for the accounting ledger entry - name: company - description: '' + description: Company entity to which this accounting ledger entry belongs join_hint: table: tabCompany 'on': company = tabCompany.name - name: delete_cancelled_entries - description: '' + description: Whether cancelled or voided accounting entries should be permanently + removed from this ledger - name: vouchers - description: '' + description: Child table containing individual journal entry line items with account, + debit, and credit amounts for this repost accounting ledger transaction. - name: amended_from - description: '' + description: Reference to the original repost accounting ledger document that + this entry amends or corrects. join_hint: table: tabRepost Accounting Ledger 'on': amended_from = tabRepost Accounting Ledger.name + desc_done: true - table: tabRepost Accounting Ledger Items description: '' fields: - name: name - description: '' + description: Unique identifier or label for the specific accounting ledger item + entry - name: voucher_type - description: '' + description: Category or classification of the accounting voucher such as payment, + receipt, journal, sales, or purchase join_hint: table: tabDocType 'on': voucher_type = tabDocType.name - name: voucher_no - description: '' + description: Sequential or reference number assigned to the voucher document for + tracking and audit purposes + desc_done: true - table: tabRepost Accounting Ledger Settings description: '' fields: - name: name - description: '' + description: Name or identifier of the repost accounting ledger configuration - name: allowed_types - description: '' + description: Transaction or entry types permitted for reposting in this ledger + configuration + desc_done: true - table: tabRepost Allowed Types description: '' fields: - name: name - description: '' + description: name - name: document_type - description: '' + description: The type of document that can be reposted from or to join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: allowed - description: '' + description: Whether reposting is permitted between the document types + desc_done: true - table: tabRepost Item Valuation description: '' fields: - name: name - description: '' + description: Unique identifier for the repost item valuation record - name: based_on - description: '' + description: Source document or transaction type that triggered the repost valuation + entry options: - Transaction - Item and Warehouse - name: voucher_type - description: '' + description: Classification of the accounting voucher created during the repost + valuation process join_hint: table: tabDocType 'on': voucher_type = tabDocType.name - name: voucher_no - description: '' + description: Reference number of the repost transaction used to track or filter + specific item valuation adjustments. - name: item_code - description: '' + description: Identifier of the product or material whose valuation is being reposted. join_hint: table: tabItem 'on': item_code = tabItem.name - name: warehouse - description: '' + description: Storage location where the item valuation repost applies. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: posting_date - description: '' + description: Date when the item revaluation transaction was posted to the ledger. - name: posting_time - description: '' + description: Time when the item revaluation transaction was posted to the ledger. - name: status - description: '' + description: Current processing state of the revaluation entry such as draft, + submitted, or cancelled. options: - Queued - In Progress @@ -22556,377 +27985,473 @@ tables: - Skipped - Failed - name: company - description: '' + description: Company entity for which this item valuation record applies. join_hint: table: tabCompany 'on': company = tabCompany.name - name: allow_negative_stock - description: '' + description: Indicates whether stock quantity was permitted to go below zero for + this valuation entry. - name: via_landed_cost_voucher - description: '' + description: Indicates whether this valuation adjustment was created through a + landed cost voucher allocation. - name: allow_zero_rate - description: '' + description: Whether items with zero valuation rate are permitted in this repost + valuation operation. - name: recreate_stock_ledgers - description: '' + description: Whether to rebuild stock ledger entries from scratch during the reposting + process. - name: amended_from - description: '' + description: Reference to the original repost item valuation document that this + one corrects or replaces. join_hint: table: tabRepost Item Valuation 'on': amended_from = tabRepost Item Valuation.name - name: error_log - description: '' + description: Errors encountered during reposting of item valuations for troubleshooting + failed repost operations. - name: items_to_be_repost - description: '' + description: Items queued or pending for valuation reposting to correct inventory + accounting discrepancies. - name: distinct_item_and_warehouse - description: '' + description: Unique combinations of items and warehouses requiring separate valuation + reposting to ensure location-specific inventory accuracy. - name: total_reposting_count - description: '' + description: Total number of reposting entries generated when revaluing inventory + items across multiple accounting periods or ledgers. - name: current_index - description: '' + description: Sequential position of this specific reposting entry within the complete + set of revaluation repostings. - name: gl_reposting_index - description: '' + description: Index specifically tracking the general ledger reposting sequence + for this item valuation adjustment. - name: affected_transactions - description: '' + description: Number of inventory transactions impacted or revalued during the + reposting process. + desc_done: true - table: tabRepost Payment Ledger description: '' fields: - name: name - description: '' + description: Unique identifier for the repost payment ledger entry - name: company - description: '' + description: Company entity associated with this reposted payment transaction join_hint: table: tabCompany 'on': company = tabCompany.name - name: posting_date - description: '' + description: Date when the reposted payment was recorded in the accounting ledger - name: voucher_type - description: '' + description: Type of accounting voucher or transaction document being reposted, + used when filtering repost operations by document category. join_hint: table: tabDocType 'on': voucher_type = tabDocType.name - name: add_manually - description: '' + description: Indicates whether the repost entry was created by manual user action + rather than automated system process. - name: repost_status - description: '' + description: Current processing state of the repost operation, used to track whether + reposting is pending, completed, or failed. options: - Queued - Failed - Completed - name: repost_error_log - description: '' + description: Error messages or logs generated when payment ledger reposting fails + or encounters issues. - name: repost_vouchers - description: '' + description: Accounting vouchers or journal entries that were regenerated or reprocessed + during the repost operation. - name: amended_from - description: '' + description: Reference to the original repost payment ledger document that this + record amends or corrects. join_hint: table: tabRepost Payment Ledger 'on': amended_from = tabRepost Payment Ledger.name + desc_done: true - table: tabRepost Payment Ledger Items description: '' fields: - name: name - description: '' + description: Unique identifier or title for the repost payment ledger item entry - name: voucher_type - description: '' + description: Category or classification of the payment voucher such as payment + entry, journal entry, or expense claim join_hint: table: tabDocType 'on': voucher_type = tabDocType.name - name: voucher_no - description: '' + description: Reference number of the specific voucher document associated with + this repost payment ledger transaction + desc_done: true - table: tabRequest for Quotation description: '' fields: - name: name - description: '' + description: Unique identifier or title of the request for quotation used to reference + or search for specific RFQ documents - name: naming_series - description: '' + description: Prefix pattern that determines the automatic numbering format for + RFQ document names options: - PUR-RFQ-.YYYY.- - name: company - description: '' + description: The company entity issuing the request for quotation to suppliers join_hint: table: tabCompany 'on': company = tabCompany.name - name: billing_address - description: '' + description: Structured billing address identifier for the vendor in this request + for quotation. join_hint: table: tabAddress 'on': billing_address = tabAddress.name - name: billing_address_display - description: '' + description: Formatted billing address text as it appears on printed or displayed + request for quotation documents. - name: vendor - description: '' + description: Supplier or vendor being asked to provide a price quotation for goods + or services. join_hint: table: tabSupplier 'on': vendor = tabSupplier.name - name: transaction_date - description: '' + description: Date when the request for quotation was created or submitted to vendors. - name: schedule_date - description: '' + description: Target or planned date for receiving vendor quotations or completing + the RFQ process. - name: status - description: '' + description: Current state of the request for quotation such as draft, sent, responded, + or closed. options: - Draft - Submitted - Cancelled - name: has_unit_price_items - description: '' + description: Indicates whether the quotation request includes items with specified + unit prices for supplier comparison. - name: amended_from - description: '' + description: References the original quotation request that this document revises + or replaces. join_hint: table: tabRequest for Quotation 'on': amended_from = tabRequest for Quotation.name - name: suppliers - description: '' + description: List of vendors invited to submit price quotes for the requested + items. - name: items - description: '' + description: Line items or products being requested from suppliers in this quotation + request - name: email_template - description: '' + description: Template used to format the email sent to suppliers when requesting + quotations join_hint: table: tabEmail Template 'on': email_template = tabEmail Template.name - name: send_attached_files - description: '' + description: Whether supporting documents or attachments are included when sending + the quotation request to suppliers - name: send_document_print - description: '' + description: Indicates whether to send a printed document version to the supplier + when transmitting the RFQ. - name: message_for_supplier - description: '' + description: Custom message or instructions included in the RFQ communication + to the supplier. - name: incoterm - description: '' + description: International commercial terms defining delivery responsibilities + and costs between buyer and supplier for this RFQ. join_hint: table: tabIncoterm 'on': incoterm = tabIncoterm.name - name: named_place - description: '' + description: Delivery location or destination specified in the request for quotation + where goods or services should be delivered. - name: tc_name - description: '' + description: Name of the terms and conditions template or agreement applied to + this request for quotation. join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Payment terms or conditions defining when and how payment should + be made for the quoted items. - name: select_print_heading - description: '' + description: Heading text that appears at the top of the printed or PDF version + of the request for quotation document. join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: letter_head - description: '' + description: Company letterhead template applied to the request for quotation + for branding and official correspondence formatting. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: opportunity - description: '' + description: Sales opportunity or lead that originated or is associated with this + request for quotation. join_hint: table: tabOpportunity 'on': opportunity = tabOpportunity.name + desc_done: true - table: tabRequest for Quotation Item description: '' fields: - name: name - description: '' + description: Unique identifier or title for this specific line item in the request + for quotation - name: item_code - description: '' + description: Internal product or material code being requested for quotation from + suppliers join_hint: table: tabItem 'on': item_code = tabItem.name - name: supplier_part_no - description: '' + description: Vendor's own part number or SKU for the item being quoted, as provided + by the supplier - name: item_name - description: '' + description: The name or title of the product or service being requested for quotation. - name: schedule_date - description: '' + description: The expected delivery date or timeline when the quoted item should + be supplied. - name: description - description: '' + description: Detailed specifications, requirements, or additional information + about the item being quoted beyond its name. - name: item_group - description: '' + description: Product category or classification of the requested item for grouping + similar materials or products together join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: brand - description: '' + description: Manufacturer or brand name of the requested item for vendor or quality + specification purposes join_hint: table: tabBrand 'on': brand = tabBrand.name - name: image_view - description: '' + description: Visual representation or picture of the requested item for identification + and specification verification - name: qty - description: '' + description: Quantity of the item being requested from the supplier in the specified + unit of measurement. - name: stock_uom - description: '' + description: Standard unit of measurement used for inventory tracking of this + item in the warehouse. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: uom - description: '' + description: Unit of measurement for the quotation request, which may differ from + the stock unit for purchasing purposes. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Factor used to convert between the requested unit of measure and + the stock unit of measure for this item. - name: stock_qty - description: '' + description: Quantity of the item expressed in stock keeping units after applying + the conversion factor. - name: warehouse - description: '' + description: Warehouse location where the requested item is expected to be sourced + or delivered from. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: material_request - description: '' + description: Links to the originating material request document that triggered + this RFQ item, used when tracing procurement back to internal requisitions. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: material_request_item - description: '' + description: References the specific line item from the material request that + corresponds to this RFQ item, used for detailed item-level traceability. - name: project_name - description: '' + description: Identifies the project this RFQ item will be charged to or used for, + relevant when filtering procurement by project or analyzing project-specific + purchasing. join_hint: table: tabProject 'on': project_name = tabProject.name - name: page_break - description: '' + description: Indicates whether a page break should occur before this item when + printing the request for quotation document. + desc_done: true - table: tabRequest for Quotation Supplier description: '' fields: - name: name - description: '' + description: name - name: supplier - description: '' + description: The vendor or company being asked to provide a price quote. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: contact - description: '' + description: The specific person at the supplier organization who is the point + of contact for this quotation request. join_hint: table: tabContact 'on': contact = tabContact.name - name: quote_status - description: '' + description: Current status of the supplier's quotation response such as pending, + submitted, accepted, or rejected. options: - Pending - Received - name: supplier_name - description: '' + description: Name of the supplier invited to provide a quotation for the request. - name: email_id - description: '' + description: Email address of the supplier contact for quotation communication + and submission. - name: send_email - description: '' + description: Whether to send email notification to this supplier for the quotation + request. - name: email_sent - description: '' + description: Whether the email notification has already been sent to this supplier. + desc_done: true - table: tabReview Level description: '' fields: - name: name - description: '' + description: Unique identifier for the review level used when filtering or grouping + approval hierarchies. - name: level_name - description: '' + description: Display name of the review level used when searching for specific + approval stages in workflows. - name: role - description: '' + description: Role or position assigned to this review level used when determining + who can approve at each stage. join_hint: table: tabRole 'on': role = tabRole.name - name: review_points - description: '' + description: Points or score assigned during a review level evaluation, used when + querying performance ratings or approval thresholds + desc_done: true - table: tabRole Permission for Page and Report description: '' fields: - name: name - description: '' + description: Name or identifier of the role that has permissions assigned - name: set_role_for - description: '' + description: Indicates whether the permission applies to a page or report options: - Page - Report - name: page - description: '' + description: The specific page or report name that the role has access to join_hint: table: tabPage 'on': page = tabPage.name - name: report - description: '' + description: The specific page or report name that permissions are being granted + for. join_hint: table: tabReport 'on': report = tabReport.name - name: enable_prepared_report - description: '' + description: Whether the role has permission to access or generate prepared versions + of the report. - name: roles - description: '' + description: The role or roles that have been granted access permissions to the + page or report. + desc_done: true - table: tabRole Profile description: '' fields: - name: name - description: '' + description: Name or title of the role profile used to identify and reference + it in queries about user permissions and access configurations - name: role_profile - description: '' + description: Unique identifier code for the role profile used when searching by + specific profile ID rather than descriptive name - name: roles - description: '' + description: List of individual roles assigned to this profile, relevant when + querying which specific role permissions are grouped together + desc_done: true - table: tabRoute History description: '' fields: - name: name - description: '' + description: Identifies the specific route history record for tracking changes + and auditing route modifications over time. - name: route - description: '' + description: Links to the route being tracked, used when analyzing route changes, + modifications, or historical route configurations. - name: user - description: '' + description: Identifies who made the route change, essential for audit trails + and accountability questions about route modifications. join_hint: table: tabUser 'on': user = tabUser.name + desc_done: true - table: tabRouting description: '' fields: - name: name - description: '' + description: Unique identifier code for the routing record - name: routing_name - description: '' + description: Descriptive display name of the routing used in manufacturing operations + and work orders - name: disabled - description: '' + description: Indicates whether this routing is currently inactive and unavailable + for use in production - name: operations - description: '' + description: Manufacturing operations or steps required to produce an item, including + work centers, sequence, and process details. + desc_done: true - table: tabS3 Backup Settings description: '' fields: - name: name - description: '' + description: Identifier or label for the S3 backup configuration - name: enabled - description: '' + description: Whether the S3 backup is currently active or turned on - name: access_key_id - description: '' + description: AWS access key credential used to authenticate S3 backup operations - name: secret_access_key - description: '' + description: AWS secret key credential for authenticating S3 backup operations. - name: notify_email - description: '' + description: Email address to receive backup notifications and alerts. - name: send_email_for_successful_backup - description: '' + description: Whether to send email notifications when backups complete successfully, + not just on failures. - name: bucket - description: '' + description: S3 bucket name where backup files are stored - name: endpoint_url - description: '' + description: S3 service endpoint URL for connecting to the storage provider - name: backup_path - description: '' + description: Directory path or prefix within the bucket where backups are organized - name: frequency - description: '' + description: How often S3 backups run, such as daily, weekly, or hourly schedules. options: - Daily - Weekly - Monthly - None - name: backup_files - description: '' + description: List or count of files included in or produced by the S3 backup operation. + desc_done: true - table: tabSLA Fulfilled On Status description: '' fields: - name: name - description: '' + description: Unique identifier or label for the SLA fulfillment status record - name: status - description: '' + description: Current state indicating whether the SLA was met, missed, or is pending + desc_done: true - table: tabSMS Center description: '' fields: - name: name - description: '' + description: Unique identifier or label for the SMS message or campaign - name: send_to - description: '' + description: Mobile phone number or recipient identifier where the SMS will be + delivered options: - All Contact - All Customer Contact @@ -22936,177 +28461,230 @@ tables: - All Employee (Active) - All Sales Person - name: customer - description: '' + description: Customer account linked to this SMS for tracking communication history + or targeted messaging join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: supplier - description: '' + description: Vendor or supplier associated with the SMS communication for purchase-related + messaging. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: sales_partner - description: '' + description: External sales partner or distributor linked to the SMS for partner + communication tracking. join_hint: table: tabSales Partner 'on': sales_partner = tabSales Partner.name - name: department - description: '' + description: Internal department responsible for or associated with the SMS message. join_hint: table: tabDepartment 'on': department = tabDepartment.name - name: branch - description: '' + description: Branch or location associated with the SMS being sent or received. join_hint: table: tabBranch 'on': branch = tabBranch.name - name: receiver_list - description: '' + description: List of phone numbers or contacts who will receive or have received + the SMS. - name: message - description: '' + description: Text content of the SMS being sent or that was sent. - name: total_characters - description: '' + description: Character count of SMS content, relevant for queries about message + length, character limits, or SMS billing calculations. - name: total_messages - description: '' + description: Number of SMS messages sent or processed, used for volume tracking, + delivery counts, and messaging activity analysis. + desc_done: true - table: tabSMS Log description: '' fields: - name: name - description: '' + description: Unique identifier or reference code for the SMS log entry - name: sender_name - description: '' + description: Name of the person or system that sent the SMS message - name: sent_on - description: '' + description: Date and time when the SMS message was actually sent - name: message - description: '' + description: Text content of the SMS that was sent or attempted to be sent. - name: no_of_requested_sms - description: '' + description: Count of SMS messages requested to be sent in this transaction. - name: requested_numbers - description: '' + description: Phone numbers to which the SMS was requested to be delivered. - name: no_of_sent_sms - description: '' + description: Count of SMS messages sent in this log entry, used when querying + total or aggregated message volumes. - name: sent_to - description: '' + description: Recipient phone number or contact identifier for the SMS, used when + searching for messages sent to specific recipients. + desc_done: true - table: tabSMS Parameter description: '' fields: - name: name - description: '' + description: Unique identifier or label for the SMS parameter configuration entry - name: parameter - description: '' + description: The specific SMS setting or configuration option being defined (e.g., + sender ID, API endpoint, timeout) - name: value - description: '' + description: The assigned value or setting for the corresponding SMS parameter - name: header - description: '' + description: SMS message header or sender name displayed to recipients when sending + SMS notifications or alerts + desc_done: true - table: tabSMS Settings description: '' fields: - name: name - description: '' + description: Unique identifier for the SMS settings configuration used when referencing + or selecting specific SMS provider setups. - name: sms_gateway_url - description: '' + description: API endpoint URL for the SMS gateway service used when configuring + outbound SMS message routing. - name: message_parameter - description: '' + description: Parameter name expected by the SMS gateway API for the message body + content used when formatting SMS requests. - name: receiver_parameter - description: '' + description: Parameter name used to specify the recipient phone number when sending + SMS messages through the configured gateway - name: parameters - description: '' + description: Additional configuration parameters required by the SMS gateway provider + for authentication and message delivery - name: use_post - description: '' + description: Whether to send SMS requests using HTTP POST method instead of GET + when communicating with the gateway + desc_done: true - table: tabSales Invoice description: '' fields: - name: name - description: '' + description: Unique identifier for the sales invoice used in queries about specific + invoice numbers or invoice lookups - name: custom_ksa_einvoicing_xml - description: '' + description: XML data for Saudi Arabia e-invoicing compliance used when querying + KSA tax authority submission requirements or ZATCA integration - name: title - description: '' + description: Customer or account name associated with the invoice used when searching + invoices by customer identity - name: naming_series - description: '' + description: Prefix pattern for invoice numbering used when searching by invoice + number format or series options: - ACC-SINV-.YYYY.- - ACC-SINV-RET-.YYYY.- - name: customer - description: '' + description: Customer name or ID who is being billed, used when querying invoices + by customer join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: custom_b2c - description: '' + description: Indicates whether this is a business-to-consumer transaction, used + to filter retail vs business sales - name: customer_name - description: '' + description: Name of the customer who is being invoiced for goods or services + sold. - name: tax_id - description: '' + description: Tax identification number of the customer for tax reporting and compliance + purposes. - name: company - description: '' + description: The company entity that issued this sales invoice, relevant when + operating multiple legal entities or subsidiaries. join_hint: table: tabCompany 'on': company = tabCompany.name - name: company_tax_id - description: '' + description: Tax identification number of the company issuing the sales invoice + for tax compliance and reporting. - name: posting_date - description: '' + description: Date when the sales invoice was officially recorded in the accounting + books, used for financial period analysis and revenue recognition. - name: posting_time - description: '' + description: Time when the sales invoice was posted to the accounting system, + used for precise transaction sequencing and audit trails. - name: set_posting_time - description: '' + description: Indicates whether the invoice posting date and time were manually + specified rather than automatically set at creation. - name: due_date - description: '' + description: The date by which payment for the invoice is expected or required + from the customer. - name: custom_uuid - description: '' + description: A unique identifier for the sales invoice used for external system + integration or custom tracking purposes. - name: custom_zatca_status - description: '' + description: Status of the invoice submission to ZATCA (Saudi Arabian tax authority) + for e-invoicing compliance. - name: is_pos - description: '' + description: Indicates whether this invoice was created through a point-of-sale + system rather than standard invoicing. - name: pos_profile - description: '' + description: The specific point-of-sale configuration or terminal profile used + when creating this POS invoice. join_hint: table: tabPOS Profile 'on': pos_profile = tabPOS Profile.name - name: is_consolidated - description: '' + description: Indicates whether this sales invoice combines multiple shipments + or delivery notes into a single invoice. - name: is_return - description: '' + description: Indicates whether this sales invoice represents a customer return + or credit note transaction. - name: return_against - description: '' + description: References the original sales invoice document that this return invoice + is issued against. join_hint: table: tabSales Invoice 'on': return_against = tabSales Invoice.name - name: update_outstanding_for_self - description: '' + description: Whether this invoice automatically updates its own outstanding amount + when payments are received or credit notes are applied - name: update_billed_amount_in_sales_order - description: '' + description: Whether this invoice automatically updates the billed amount in the + linked sales order when posted - name: update_billed_amount_in_delivery_note - description: '' + description: Whether this invoice automatically updates the billed amount in the + linked delivery note when posted - name: is_debit_note - description: '' + description: Indicates whether this invoice is a debit note used to increase the + amount owed by the customer due to additional charges or corrections. - name: amended_from - description: '' + description: References the original sales invoice that this document amends or + corrects. join_hint: table: tabSales Invoice 'on': amended_from = tabSales Invoice.name - name: custom_zatca_third_party_invoice - description: '' + description: Indicates whether this invoice involves a third party for Saudi ZATCA + e-invoicing compliance purposes. - name: custom_zatca_nominal_invoice - description: '' + description: Indicates if this is a ZATCA-compliant nominal invoice for Saudi + Arabia tax authority reporting purposes. - name: custom_zatca_export_invoice - description: '' + description: Indicates if this is a ZATCA-compliant export invoice for goods or + services sold outside Saudi Arabia. - name: custom_summary_invoice - description: '' + description: Indicates if this is a summary invoice consolidating multiple transactions + into a single billing document. - name: custom_self_billed_invoice - description: '' + description: Indicates whether the invoice was created by the buyer on behalf + of the supplier rather than by the supplier themselves. - name: custom_user_invoice_number - description: '' + description: User-defined invoice number that differs from the system invoice + number, often used for custom numbering schemes or external reference requirements. - name: custom_zatca_tax_category - description: '' + description: Saudi Arabia ZATCA tax classification code determining the applicable + VAT treatment and reporting category for the invoice. options: - Standard - Zero Rated - Exempted - Services outside scope of tax / Not subject to VAT - name: custom_exemption_reason_code - description: '' + description: Code indicating why the invoice is exempt from tax or specific regulations. options: - Standard 15% - VATEX-SA-29 @@ -23126,351 +28704,458 @@ tables: - VATEX-SA-MLTRY - VATEX-SA-OOS - name: custom_zatca_discount_reason_code - description: '' + description: ZATCA-compliant code specifying the reason for applying a discount + on the invoice. - name: custom_zatca_discount_reason - description: '' + description: Text description explaining why a discount was applied, for ZATCA + compliance reporting. - name: custom_submit_line_item_discount_to_zatca - description: '' + description: Whether line item discounts are submitted to ZATCA (Saudi tax authority) + for this sales invoice. - name: cost_center - description: '' + description: Cost center assigned to the sales invoice for financial tracking + and allocation purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Project associated with the sales invoice for tracking revenue and + costs by project. join_hint: table: tabProject 'on': project = tabProject.name - name: currency - description: '' + description: Currency in which the sales invoice total and line items are denominated + and billed to the customer. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: conversion_rate - description: '' + description: Exchange rate applied to convert foreign currency amounts to the + company's base currency for this invoice. - name: selling_price_list - description: '' + description: Price list used to determine item rates and pricing rules applied + when creating this sales invoice. join_hint: table: tabPrice List 'on': selling_price_list = tabPrice List.name - name: price_list_currency - description: '' + description: Currency in which the price list is denominated, relevant when analyzing + sales in original price list currency rather than transaction or company currency. join_hint: table: tabCurrency 'on': price_list_currency = tabCurrency.name - name: plc_conversion_rate - description: '' + description: Exchange rate used to convert from price list currency to transaction + currency, relevant when reconciling pricing differences across currencies. - name: ignore_pricing_rule - description: '' + description: Indicates whether automatic pricing rules were bypassed for this + invoice, relevant when identifying manual pricing overrides or exceptions. - name: scan_barcode - description: '' + description: Barcode scanned during sales invoice processing for item identification + and tracking. - name: update_stock - description: '' + description: Indicates whether this sales invoice triggers automatic inventory + stock level reduction. - name: last_scanned_warehouse - description: '' + description: Warehouse location where the barcode was most recently scanned during + invoice fulfillment. - name: set_warehouse - description: '' + description: Warehouse location from which all invoice items are delivered or + sourced when user asks about fulfillment origin or stock depletion location + for the entire sales invoice. join_hint: table: tabWarehouse 'on': set_warehouse = tabWarehouse.name - name: set_target_warehouse - description: '' + description: Destination warehouse for stock transfers or inter-warehouse sales + when user asks where goods are being moved or delivered to at the warehouse + level. join_hint: table: tabWarehouse 'on': set_target_warehouse = tabWarehouse.name - name: items - description: '' + description: Line items on the sales invoice including products sold, quantities, + prices, and item-level details when user asks what was sold or invoice composition. - name: total_qty - description: '' + description: Total quantity of all items sold in the invoice, used when asking + about units or volume sold. - name: total_net_weight - description: '' + description: Combined net weight of all items in the invoice, used when asking + about shipping weight or physical mass of goods sold. - name: base_total - description: '' + description: Invoice subtotal in company's base currency before taxes and discounts, + used when asking about pre-tax revenue or base amounts. - name: base_net_total - description: '' + description: Net total amount in company's base currency, used when analyzing + sales across multiple currencies or for consolidated financial reporting. - name: total - description: '' + description: Final invoice amount including all taxes and charges, used when asking + about the actual amount customer must pay. - name: net_total - description: '' + description: Invoice subtotal before taxes and additional charges in transaction + currency, used when analyzing pre-tax sales revenue. - name: tax_category - description: '' + description: Tax classification determining which tax rates apply to the invoice + based on customer type, location, or product category. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: taxes_and_charges - description: '' + description: Specific tax template or configuration defining the actual tax rates, + accounts, and calculation rules applied to this invoice. join_hint: table: tabSales Taxes and Charges Template 'on': taxes_and_charges = tabSales Taxes and Charges Template.name - name: shipping_rule - description: '' + description: Shipping cost calculation rule applied to determine freight charges + based on order value, weight, or destination. join_hint: table: tabShipping Rule 'on': shipping_rule = tabShipping Rule.name - name: incoterm - description: '' + description: International commercial term defining delivery responsibility and + cost allocation between buyer and seller (e.g., FOB, CIF, EXW). join_hint: table: tabIncoterm 'on': incoterm = tabIncoterm.name - name: named_place - description: '' + description: Specific geographic location associated with the incoterm where risk + and cost transfer occurs. - name: taxes - description: '' + description: Total tax amount charged on the sales invoice including all applicable + tax types. - name: base_total_taxes_and_charges - description: '' + description: Total amount of all taxes and charges in company's base currency, + used when analyzing tax amounts across invoices with different transaction currencies. - name: total_taxes_and_charges - description: '' + description: Total amount of all taxes and charges in the invoice's transaction + currency, used when reviewing tax amounts as they appear to the customer. - name: base_grand_total - description: '' + description: Final invoice amount including all items, taxes, and charges in company's + base currency, used for financial reporting and cross-currency invoice analysis. - name: base_rounding_adjustment - description: '' + description: Amount added or subtracted to round the invoice total to the nearest + whole number in base currency. - name: base_rounded_total - description: '' + description: Final invoice total after applying rounding adjustment in base currency. - name: base_in_words - description: '' + description: Text representation of the base currency invoice total amount spelled + out in words for printing on documents. - name: grand_total - description: '' + description: Final total amount payable by customer after all taxes, discounts, + and adjustments including rounding. - name: rounding_adjustment - description: '' + description: Amount added or subtracted to round the invoice total to nearest + currency unit. - name: use_company_roundoff_cost_center - description: '' + description: Whether rounding adjustment amounts are allocated to the default + company-level cost center instead of invoice line item cost centers. - name: rounded_total - description: '' + description: Final invoice amount after applying rounding adjustments to the grand + total - name: in_words - description: '' + description: Grand total amount expressed as text words for printing on invoice + documents - name: total_advance - description: '' + description: Sum of all advance payments received from customer prior to this + invoice - name: outstanding_amount - description: '' + description: Remaining unpaid balance on the invoice after accounting for payments + and credits - name: disable_rounded_total - description: '' + description: Whether invoice total rounding is turned off for this transaction - name: apply_discount_on - description: '' + description: Specifies whether discounts are calculated on grand total or net + total before taxes options: - Grand Total - Net Total - name: base_discount_amount - description: '' + description: Discount amount in base currency before taxes and additional discounts, + used when calculating total invoice value or analyzing discount trends. - name: is_cash_or_non_trade_discount - description: '' + description: Indicates whether the discount is a cash/prompt payment discount + or non-trade discount rather than a standard trade discount, relevant for accounting + classification and payment term analysis. - name: additional_discount_account - description: '' + description: General ledger account where additional discounts beyond standard + trade discounts are posted, used when tracking discount expenses or reconciling + discount accounting entries. join_hint: table: tabAccount 'on': additional_discount_account = tabAccount.name - name: additional_discount_percentage - description: '' + description: Percentage discount applied to the entire invoice total after line-item + discounts, used when users ask about overall invoice-level discount rates or + additional discounts beyond item discounts. - name: discount_amount - description: '' + description: Absolute monetary value of total discounts on the invoice, used when + users ask about the dollar amount of discounts given rather than percentages. - name: other_charges_calculation - description: '' + description: Formula or method used to calculate miscellaneous charges like shipping, + handling, or fees added to the invoice, relevant when users ask how additional + charges are computed. - name: pricing_rules - description: '' + description: Pricing rules or discounts applied to this sales invoice affecting + item rates or totals. - name: packed_items - description: '' + description: Items that have been physically packed or prepared for delivery against + this sales invoice. - name: timesheets - description: '' + description: Timesheet entries linked to this sales invoice for billing time-based + services or labor hours. - name: total_billing_hours - description: '' + description: Total hours billed on this sales invoice, used when analyzing time-based + billing or hourly service revenue. - name: total_billing_amount - description: '' + description: Total monetary amount billed on this sales invoice, used when querying + invoice totals, revenue, or amounts owed by customers. - name: cash_bank_account - description: '' + description: Bank account designated for cash payments related to this sales invoice, + used when tracking which account received or will receive payment. join_hint: table: tabAccount 'on': cash_bank_account = tabAccount.name - name: payments - description: '' + description: Total amount received from customer payments applied to this invoice - name: base_paid_amount - description: '' + description: Amount paid in company's default accounting currency for multi-currency + reporting - name: paid_amount - description: '' + description: Amount paid in the invoice's transaction currency - name: base_change_amount - description: '' + description: Change amount returned to customer in base currency when payment + exceeds invoice total. - name: change_amount - description: '' + description: Change amount returned to customer in transaction currency when payment + exceeds invoice total. - name: account_for_change_amount - description: '' + description: General ledger account where change amounts returned to customers + are posted. join_hint: table: tabAccount 'on': account_for_change_amount = tabAccount.name - name: allocate_advances_automatically - description: '' + description: Whether advance payments are automatically applied to this invoice + without manual allocation - name: only_include_allocated_payments - description: '' + description: Whether to restrict payment display or processing to payments that + have been explicitly allocated to this invoice - name: advances - description: '' + description: Advance payments received from the customer that can be applied against + this invoice amount - name: write_off_amount - description: '' + description: Amount written off from the invoice in transaction currency when + closing with a small remaining balance or bad debt. - name: base_write_off_amount - description: '' + description: Amount written off from the invoice converted to company base currency + for consolidated reporting. - name: write_off_outstanding_amount_automatically - description: '' + description: Whether the system automatically writes off small remaining balances + when the invoice is marked as paid. - name: write_off_account - description: '' + description: Account used when writing off small differences or rounding amounts + on the invoice. join_hint: table: tabAccount 'on': write_off_account = tabAccount.name - name: write_off_cost_center - description: '' + description: Cost center assigned to track write-off amounts for budgeting and + financial analysis. join_hint: table: tabCost Center 'on': write_off_cost_center = tabCost Center.name - name: redeem_loyalty_points - description: '' + description: Indicates whether customer loyalty points were redeemed as payment + on this invoice. - name: loyalty_points - description: '' + description: Points earned or redeemed by the customer on this sales invoice transaction. - name: loyalty_amount - description: '' + description: Monetary value equivalent of loyalty points for this sales invoice. - name: loyalty_program - description: '' + description: Name or identifier of the loyalty program applied to this sales invoice. join_hint: table: tabLoyalty Program 'on': loyalty_program = tabLoyalty Program.name - name: loyalty_redemption_account - description: '' + description: Accounting ledger account where loyalty points redeemed by the customer + on this invoice are recorded as expense or contra-revenue. join_hint: table: tabAccount 'on': loyalty_redemption_account = tabAccount.name - name: loyalty_redemption_cost_center - description: '' + description: Cost center allocated for tracking loyalty point redemptions applied + to this invoice. join_hint: table: tabCost Center 'on': loyalty_redemption_cost_center = tabCost Center.name - name: customer_address - description: '' + description: Billing or primary address of the customer associated with this sales + invoice. join_hint: table: tabAddress 'on': customer_address = tabAddress.name - name: address_display - description: '' + description: Formatted billing or shipping address shown on the sales invoice + for customer correspondence and delivery purposes. - name: contact_person - description: '' + description: Individual person at the customer organization responsible for or + associated with this sales invoice transaction. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_display - description: '' + description: Formatted display name and details of the customer contact shown + on the sales invoice. - name: contact_mobile - description: '' + description: Mobile phone number of the customer contact for this sales invoice - name: contact_email - description: '' + description: Email address of the customer contact for this sales invoice - name: territory - description: '' + description: Geographic sales territory or region assigned to this sales invoice join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: shipping_address_name - description: '' + description: Name of the location or recipient where goods are to be delivered + to the customer. join_hint: table: tabAddress 'on': shipping_address_name = tabAddress.name - name: shipping_address - description: '' + description: Full address details where goods are to be delivered to the customer. - name: dispatch_address_name - description: '' + description: Name of the warehouse or location from which goods are shipped out. join_hint: table: tabAddress 'on': dispatch_address_name = tabAddress.name - name: dispatch_address - description: '' + description: Address from which goods are shipped or dispatched to the customer + for this sales invoice. - name: company_address - description: '' + description: Company's address used as the billing or legal address on this sales + invoice. join_hint: table: tabAddress 'on': company_address = tabAddress.name - name: company_address_display - description: '' + description: Formatted display version of the company address shown on the printed + or rendered sales invoice. - name: company_contact_person - description: '' + description: Contact person representing the company issuing the sales invoice, + used when identifying who from the seller's organization is responsible for + the transaction. join_hint: table: tabContact 'on': company_contact_person = tabContact.name - name: ignore_default_payment_terms_template - description: '' + description: Indicates whether to bypass the standard payment terms template for + this specific sales invoice. - name: payment_terms_template - description: '' + description: Template defining payment conditions and schedules applied to this + sales invoice, such as net 30 or installment terms. join_hint: table: tabPayment Terms Template 'on': payment_terms_template = tabPayment Terms Template.name - name: payment_schedule - description: '' + description: Payment plan or installment schedule defining when and how invoice + payments are due over time - name: tc_name - description: '' + description: Name of the terms and conditions template or agreement applied to + this sales invoice join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Payment terms specifying the due date calculation such as net 30, + due on receipt, or end of month - name: po_no - description: '' + description: Customer's purchase order number referenced when matching invoices + to customer PO documents or tracking which customer order triggered the sale. - name: po_date - description: '' + description: Date on the customer's purchase order, used when verifying order + timing or reconciling invoice dates against customer PO dates. - name: debit_to - description: '' + description: Accounts receivable ledger account debited for this invoice, used + when identifying which customer account or receivable account was charged. join_hint: table: tabAccount 'on': debit_to = tabAccount.name - name: party_account_currency - description: '' + description: Currency in which the customer's account balance is maintained, relevant + when analyzing foreign currency transactions or customer-specific currency exposure. join_hint: table: tabCurrency 'on': party_account_currency = tabCurrency.name - name: is_opening - description: '' + description: Indicates whether this sales invoice is an opening balance entry + from a prior accounting period, used to filter out historical migration data. options: - 'No' - 'Yes' - name: unrealized_profit_loss_account - description: '' + description: Account where unrealized gains or losses from foreign exchange rate + changes on this invoice are recorded before payment settlement. join_hint: table: tabAccount 'on': unrealized_profit_loss_account = tabAccount.name - name: against_income_account - description: '' + description: Income account credited when posting this sales invoice revenue. - name: sales_partner - description: '' + description: External partner or affiliate who referred or facilitated this sale. join_hint: table: tabSales Partner 'on': sales_partner = tabSales Partner.name - name: amount_eligible_for_commission - description: '' + description: Portion of invoice amount qualifying for commission calculation to + sales partner or team. - name: commission_rate - description: '' + description: Percentage rate applied to calculate sales commission for this invoice. - name: total_commission - description: '' + description: Total commission amount earned from this invoice across all sales + team members. - name: sales_team - description: '' + description: Sales team or group responsible for or credited with this invoice + sale. - name: letter_head - description: '' + description: Letterhead template used when printing or emailing this sales invoice join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: group_same_items - description: '' + description: Whether identical items are consolidated into single lines when printing + this invoice - name: select_print_heading - description: '' + description: Custom heading text that appears on the printed sales invoice instead + of the default title join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: language - description: '' + description: Language code for the invoice document, relevant when filtering invoices + by customer language preference or generating localized reports. - name: subscription - description: '' + description: Links invoice to a recurring subscription contract, used to identify + subscription-based revenue versus one-time sales. join_hint: table: tabSubscription 'on': subscription = tabSubscription.name - name: from_date - description: '' + description: Start date of the billing period covered by this invoice, particularly + for subscription or service-based invoices spanning a date range. - name: auto_repeat - description: '' + description: Linked recurring invoice schedule that automatically generates this + sales invoice at specified intervals. join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: to_date - description: '' + description: End date of the billing period or service delivery timeframe covered + by this sales invoice. - name: status - description: '' + description: Current state of the sales invoice such as draft, submitted, paid, + unpaid, overdue, cancelled, or returned. options: - Draft - Return @@ -23486,602 +29171,790 @@ tables: - Cancelled - Internal Transfer - name: inter_company_invoice_reference - description: '' + description: Links to the corresponding invoice in another company entity when + this invoice is part of an inter-company transaction between related legal entities. join_hint: table: tabPurchase Invoice 'on': inter_company_invoice_reference = tabPurchase Invoice.name - name: campaign - description: '' + description: Marketing campaign associated with this sales invoice to track revenue + attribution and campaign effectiveness. join_hint: table: tabCampaign 'on': campaign = tabCampaign.name - name: represents_company - description: '' + description: The company entity that this invoice legally represents when operating + in a multi-company or franchise structure. join_hint: table: tabCompany 'on': represents_company = tabCompany.name - name: source - description: '' + description: Identifies the origin or channel through which the sales invoice + was created, such as web, POS, or API integration. join_hint: table: tabLead Source 'on': source = tabLead Source.name - name: customer_group - description: '' + description: Categorizes the customer into a segment or classification for pricing, + discounts, or reporting purposes. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: custom_zatca_full_response - description: '' + description: Contains the complete response from ZATCA (Saudi tax authority) e-invoicing + system for compliance and audit verification. - name: is_internal_customer - description: '' + description: Whether the invoice is for an internal customer or inter-company + transaction rather than an external third-party customer. - name: is_discounted - description: '' + description: Whether any discount has been applied to the invoice, useful for + filtering invoices with or without discounts. - name: remarks - description: '' + description: Additional notes or comments about the sales invoice such as special + instructions, delivery notes, or payment terms. - name: custom_zatca_pos_name - description: '' + description: Point of sale terminal or device name for Saudi ZATCA e-invoicing + compliance and tax reporting. join_hint: table: tabZATCA Multiple Setting 'on': custom_zatca_pos_name = tabZATCA Multiple Setting.name + desc_done: true - table: tabSales Invoice Advance description: '' fields: - name: name - description: '' + description: Unique identifier for the sales invoice advance record - name: reference_type - description: '' + description: Type of document linked to this advance payment such as Sales Order + or Payment Entry join_hint: table: tabDocType 'on': reference_type = tabDocType.name - name: reference_name - description: '' + description: Specific document number or ID of the referenced transaction that + this advance is allocated against - name: remarks - description: '' + description: Comments or notes explaining the reason for or details about the + advance payment allocation. - name: reference_row - description: '' + description: Links to the specific row in the referenced advance document being + allocated against this invoice. - name: advance_amount - description: '' + description: The monetary value of the advance payment being applied or allocated + to this sales invoice. - name: allocated_amount - description: '' + description: Amount of advance payment that has been applied or allocated against + the sales invoice. - name: exchange_gain_loss - description: '' + description: Gain or loss resulting from currency exchange rate differences between + advance payment and invoice allocation. - name: ref_exchange_rate - description: '' + description: Exchange rate used to convert the advance payment currency to the + invoice currency at time of allocation. - name: difference_posting_date - description: '' + description: Date when the difference amount between advance payment and actual + invoice is posted to accounting ledger. + desc_done: true - table: tabSales Invoice Item description: '' fields: - name: name - description: '' + description: Unique identifier or code for the sales invoice item line - name: barcode - description: '' + description: Barcode value scanned or associated with the item at point of sale - name: has_item_scanned - description: '' + description: Indicates whether the item was added by scanning a barcode versus + manual entry - name: item_code - description: '' + description: Internal product identifier used when asking about specific items + sold, inventory SKUs, or product performance in sales. join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Product or service name as it appears on the sales invoice, used + when searching by product description rather than code. - name: customer_item_code - description: '' + description: Customer's own product identifier for the item, used when customers + reference their internal part numbers or SKUs in sales inquiries. - name: description - description: '' + description: Text description of the specific product or service sold on this + invoice line item - name: item_group - description: '' + description: Product category or classification for grouping similar items in + sales analysis join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: brand - description: '' + description: Manufacturer or brand name of the product sold - name: image_view - description: '' + description: Visual representation of the invoiced item for verification or display + purposes in sales documents. - name: qty - description: '' + description: Quantity of the item sold on this invoice line, used when asking + about units sold or invoice volume. - name: stock_uom - description: '' + description: Unit of measurement for the item quantity (e.g., pieces, kg, liters), + used when specifying or filtering by measurement units. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: uom - description: '' + description: Unit of measurement for the item quantity on the sales invoice line + (e.g., boxes, kilograms, pieces). join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert the invoice line item quantity from the transaction + UOM to the base stock UOM. - name: stock_qty - description: '' + description: Quantity of the item in base stock units after applying the conversion + factor from the transaction UOM. - name: price_list_rate - description: '' + description: Item's standard selling price from the price list in transaction + currency before any discounts or margin adjustments. - name: base_price_list_rate - description: '' + description: Item's standard selling price from the price list converted to company's + base currency. - name: margin_type - description: '' + description: Whether profit margin is calculated as a percentage or fixed amount + on this line item. options: - Percentage - Amount - name: margin_rate_or_amount - description: '' + description: Profit margin added to base cost, used when calculating selling price + from cost price or analyzing markup on items sold. - name: rate_with_margin - description: '' + description: Final item rate after applying margin to base cost, used when querying + actual selling price including markup before discounts. - name: discount_percentage - description: '' + description: Percentage discount applied to item price, used when analyzing price + reductions or promotional discounts given to customers. - name: discount_amount - description: '' + description: Direct discount applied to this invoice line item, used when calculating + item-level price reductions or promotional discounts. - name: distributed_discount_amount - description: '' + description: Portion of invoice-level or header discount allocated to this line + item, used when analyzing how document-wide discounts affect individual items. - name: base_rate_with_margin - description: '' + description: Item rate including profit margin before discounts, used when analyzing + markup or comparing selling price to cost. - name: rate - description: '' + description: Unit price per item on the sales invoice line before applying quantity + or discounts. - name: amount - description: '' + description: Total line item value after multiplying rate by quantity and applying + any item-level discounts. - name: item_tax_template - description: '' + description: Tax rule or template applied to calculate taxes for this specific + invoice line item. join_hint: table: tabItem Tax Template 'on': item_tax_template = tabItem Tax Template.name - name: base_rate - description: '' + description: Unit price in company's base currency before any discounts, taxes, + or currency conversion. - name: base_amount - description: '' + description: Total line amount in company's base currency (base_rate × quantity) + before discounts and taxes. - name: pricing_rules - description: '' + description: Applied promotional or tiered pricing rules that determined the final + rate for this item. - name: stock_uom_rate - description: '' + description: Rate per stock unit of measure when the item is sold in a different + UOM than the base stock UOM. - name: is_free_item - description: '' + description: Indicates whether this item was given at no charge as part of a promotion + or bundle. - name: grant_commission - description: '' + description: Indicates whether sales commission should be calculated and paid + for this particular item. - name: net_rate - description: '' + description: Price per unit after applying item-level discounts but before taxes, + used when asking about discounted unit pricing or margin calculations. - name: net_amount - description: '' + description: Total line item value after item-level discounts but before taxes, + used when asking about discounted line totals or pre-tax revenue. - name: base_net_rate - description: '' + description: Price per unit after item-level discounts in company's base currency, + used for multi-currency reporting or consolidated financial analysis. - name: base_net_amount - description: '' + description: Net invoice line amount in company base currency, used when analyzing + revenue or invoice totals across multiple currencies. - name: delivered_by_supplier - description: '' + description: Indicates whether the item was shipped directly from supplier to + customer in a drop-shipping scenario. - name: income_account - description: '' + description: General ledger revenue account where this invoice line item's income + is recorded for financial reporting. join_hint: table: tabAccount 'on': income_account = tabAccount.name - name: is_fixed_asset - description: '' + description: Indicates whether the sold item is a fixed asset requiring depreciation + tracking rather than a regular inventory item. - name: asset - description: '' + description: References the specific fixed asset record being sold or disposed + of in this invoice line. join_hint: table: tabAsset 'on': asset = tabAsset.name - name: finance_book - description: '' + description: Specifies which accounting book or ledger to use for recording depreciation + and asset transactions when selling fixed assets. join_hint: table: tabFinance Book 'on': finance_book = tabFinance Book.name - name: expense_account - description: '' + description: Account where the cost of goods sold or expense for this invoice + item is recorded when using perpetual inventory. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: discount_account - description: '' + description: Account where discounts given on this invoice item are recorded as + contra-revenue or expense offsets. join_hint: table: tabAccount 'on': discount_account = tabAccount.name - name: deferred_revenue_account - description: '' + description: Account where revenue for this invoice item is initially recorded + when revenue recognition is delayed until delivery or service completion. join_hint: table: tabAccount 'on': deferred_revenue_account = tabAccount.name - name: service_stop_date - description: '' + description: End date of service period for subscription or time-based items on + the invoice, used when calculating revenue recognition or service duration. - name: enable_deferred_revenue - description: '' + description: Indicates whether this invoice item's revenue should be deferred + and recognized over time rather than immediately upon invoicing. - name: service_start_date - description: '' + description: Start date of service period for subscription or time-based items + on the invoice, used when calculating revenue recognition or service duration. - name: service_end_date - description: '' + description: End date of service period for subscription or service-based invoice + line items. - name: weight_per_unit - description: '' + description: Weight of a single unit of the invoiced item, used for calculating + shipping costs or logistics planning. - name: total_weight - description: '' + description: Combined weight of all units on this invoice line, calculated as + quantity times weight per unit. - name: weight_uom - description: '' + description: Unit of measurement for the item's weight on this invoice line. join_hint: table: tabUOM 'on': weight_uom = tabUOM.name - name: warehouse - description: '' + description: Warehouse from which the invoiced item was shipped or delivered. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: target_warehouse - description: '' + description: Destination warehouse for items being transferred or delivered to + a different location than the source warehouse. join_hint: table: tabWarehouse 'on': target_warehouse = tabWarehouse.name - name: quality_inspection - description: '' + description: References the quality inspection record associated with this invoice + item when users need to verify inspection results or link invoices to quality + checks. join_hint: table: tabQuality Inspection 'on': quality_inspection = tabQuality Inspection.name - name: serial_and_batch_bundle - description: '' + description: Links to the bundled serial numbers and batch numbers for this invoice + item when tracking specific units or lots sold. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: use_serial_batch_fields - description: '' + description: Indicates whether this invoice item uses individual serial/batch + field entries instead of bundles when users need to understand the tracking + method applied. - name: allow_zero_valuation_rate - description: '' + description: Indicates whether this invoice item can have a zero valuation rate + for inventory costing purposes. - name: incoming_rate - description: '' + description: The original purchase or stock valuation rate of the item at the + time it entered inventory, used to calculate profit margins. - name: item_tax_rate - description: '' + description: The specific tax rate or tax configuration applied to this individual + invoice item, which may differ from the default tax rate. - name: actual_batch_qty - description: '' + description: Quantity of items from a specific batch included in this invoice + line, used when tracking batch-level inventory movements in sales. - name: serial_no - description: '' + description: Unique serial number of the individual item sold, used when querying + sales of specific serialized products or tracking warranty and service history. - name: batch_no - description: '' + description: Batch or lot identifier for the items sold, used when tracing product + batches for quality control, expiration tracking, or recall purposes. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: actual_qty - description: '' + description: Quantity of this item physically available in stock at the warehouse + at the time of invoice creation. - name: company_total_stock - description: '' + description: Total quantity of this item available across all warehouses in the + company at the time of invoice creation. - name: sales_order - description: '' + description: Reference to the originating sales order document that this invoice + item was created from. join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: so_detail - description: '' + description: Links invoice line item to the originating sales order line for tracking + fulfillment and order-to-invoice reconciliation. - name: sales_invoice_item - description: '' + description: Unique identifier for this specific line item on the sales invoice. - name: delivery_note - description: '' + description: Links invoice line item to the delivery note that recorded the physical + shipment of these goods. join_hint: table: tabDelivery Note 'on': delivery_note = tabDelivery Note.name - name: dn_detail - description: '' + description: Links to the specific delivery note line item that fulfilled this + invoice item, used when tracking which delivery corresponds to which invoice. - name: delivered_qty - description: '' + description: Actual quantity delivered to the customer for this invoice line, + used when verifying fulfillment or comparing billed versus delivered amounts. - name: pos_invoice - description: '' + description: Indicates whether this invoice was created through the point-of-sale + system, used when filtering retail versus regular sales transactions. join_hint: table: tabPOS Invoice 'on': pos_invoice = tabPOS Invoice.name - name: pos_invoice_item - description: '' + description: Links to the point-of-sale invoice item when the sales invoice originated + from a POS transaction. - name: purchase_order - description: '' + description: References the original purchase order when the sales invoice is + related to a drop-ship or back-to-back sales scenario. join_hint: table: tabPurchase Order 'on': purchase_order = tabPurchase Order.name - name: purchase_order_item - description: '' + description: References the specific purchase order line item when the sales invoice + item is linked to procurement for drop-ship or back-to-back fulfillment. - name: cost_center - description: '' + description: Department or business unit to which this invoice line item's revenue + or expense is allocated for financial tracking and analysis. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Specific project associated with this invoice line item for project-based + billing and cost allocation. join_hint: table: tabProject 'on': project = tabProject.name - name: page_break - description: '' + description: Indicates whether a page break should occur before this line item + when printing the sales invoice. + desc_done: true - table: tabSales Invoice Payment description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the specific payment transaction + on the sales invoice - name: default - description: '' + description: Indicates whether this is the default or primary payment method selected + for the sales invoice - name: mode_of_payment - description: '' + description: The payment method used for this transaction such as cash, credit + card, bank transfer, or check join_hint: table: tabMode of Payment 'on': mode_of_payment = tabMode of Payment.name - name: amount - description: '' + description: Payment amount received or applied against the sales invoice - name: reference_no - description: '' + description: External reference number from the payment transaction such as check + number, transaction ID, or bank reference - name: account - description: '' + description: Financial account or bank account where the payment was deposited + or processed join_hint: table: tabAccount 'on': account = tabAccount.name - name: type - description: '' + description: Identifies the payment method or instrument used (e.g., cash, check, + credit card) when analyzing payment preferences or reconciliation. - name: base_amount - description: '' + description: The payment amount in the company's base currency, used when calculating + total payments received or analyzing cash flow across invoices. - name: clearance_date - description: '' + description: The date when the payment was confirmed or cleared by the bank, used + when reconciling payments or analyzing actual cash receipt timing. + desc_done: true - table: tabSales Invoice Timesheet description: '' fields: - name: name - description: '' + description: Unique identifier for the timesheet entry linked to the sales invoice - name: activity_type - description: '' + description: Category or type of billable activity performed during the timesheet + period join_hint: table: tabActivity Type 'on': activity_type = tabActivity Type.name - name: description - description: '' + description: Detailed notes or explanation of the work performed in this timesheet + entry - name: from_time - description: '' + description: Start time of the timesheet entry for billing a specific work period + on the sales invoice - name: to_time - description: '' + description: End time of the timesheet entry for billing a specific work period + on the sales invoice - name: billing_hours - description: '' + description: Total billable hours calculated for this timesheet entry that will + be invoiced to the customer - name: billing_amount - description: '' + description: Amount billed to customer for this timesheet entry on the sales invoice. - name: time_sheet - description: '' + description: Reference to the timesheet document from which this billable time + was invoiced. join_hint: table: tabTimesheet 'on': time_sheet = tabTimesheet.name - name: timesheet_detail - description: '' + description: Specific line item or detail row from the timesheet that corresponds + to this invoice charge. - name: project_name - description: '' + description: Name of the project associated with the timesheet entries being invoiced. + desc_done: true - table: tabSales Order description: '' fields: - name: name - description: '' + description: Unique identifier for the sales order, typically auto-generated or + manually entered based on naming series configuration. - name: title - description: '' + description: Customer's purchase order number or reference name they use to identify + this order. - name: naming_series - description: '' + description: Prefix pattern used to generate the sales order name, determining + the numbering format for orders. options: - SAL-ORD-.YYYY.- - name: customer - description: '' + description: Unique identifier linking to the customer account that placed the + sales order. join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: customer_name - description: '' + description: Display name of the customer for human-readable queries about who + ordered. - name: tax_id - description: '' + description: Tax identification number of the customer for tax reporting and compliance + queries. - name: order_type - description: '' + description: Category or classification of the sales order such as standard sale, + return, exchange, or wholesale transaction. options: - Sales - Maintenance - Shopping Cart - name: transaction_date - description: '' + description: Date when the sales order was created or recorded in the system. - name: delivery_date - description: '' + description: Date when the order is scheduled to be delivered or was actually + delivered to the customer. - name: po_no - description: '' + description: Customer's purchase order number used to match sales orders to customer + procurement documents and inquiries. - name: po_date - description: '' + description: Date on the customer's purchase order, used to track customer order + timing and resolve discrepancies between customer records and sales orders. - name: company - description: '' + description: Company entity that owns this sales order, used to filter orders + by legal entity or business unit in multi-company environments. join_hint: table: tabCompany 'on': company = tabCompany.name - name: skip_delivery_note - description: '' + description: Whether this sales order bypasses delivery note creation and ships + directly, relevant when users ask about orders with direct shipping or no intermediate + delivery documentation. - name: has_unit_price_items - description: '' + description: Indicates if the sales order contains line items priced per unit + rather than bulk or alternative pricing methods, useful for filtering orders + by pricing structure type. - name: amended_from - description: '' + description: References the original sales order that this order amends or corrects, + used when tracking order corrections, amendments, or version history. join_hint: table: tabSales Order 'on': amended_from = tabSales Order.name - name: cost_center - description: '' + description: Department or business unit to which the sales order revenue or costs + are allocated for internal accounting and profitability analysis. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Specific project or job associated with the sales order for tracking + project-based revenue and deliverables. join_hint: table: tabProject 'on': project = tabProject.name - name: currency - description: '' + description: Currency in which the sales order prices, totals, and payment are + denominated. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: conversion_rate - description: '' + description: Exchange rate applied to convert transaction currency to company + base currency for this sales order - name: selling_price_list - description: '' + description: Name or identifier of the price list used to determine item prices + for this sales order join_hint: table: tabPrice List 'on': selling_price_list = tabPrice List.name - name: price_list_currency - description: '' + description: Currency in which the price list prices are denominated, may differ + from transaction or base currency join_hint: table: tabCurrency 'on': price_list_currency = tabCurrency.name - name: plc_conversion_rate - description: '' + description: Exchange rate used to convert price list currency to transaction + currency for this sales order. - name: ignore_pricing_rule - description: '' + description: Indicates whether automatic pricing rules and discounts are bypassed + for this sales order. - name: scan_barcode - description: '' + description: Barcode value scanned to quickly add items to the sales order. - name: last_scanned_warehouse - description: '' + description: Warehouse location captured from the most recent barcode or scanner + input during order processing or fulfillment. - name: set_warehouse - description: '' + description: Default or assigned warehouse designated for fulfilling items on + this sales order. join_hint: table: tabWarehouse 'on': set_warehouse = tabWarehouse.name - name: reserve_stock - description: '' + description: Indicates whether inventory is reserved or allocated for this sales + order to prevent overselling. - name: items - description: '' + description: Line items or products included in the sales order - name: total_qty - description: '' + description: Total quantity of all items ordered across all line items in the + sales order - name: total_net_weight - description: '' + description: Combined net weight of all items in the sales order excluding packaging - name: base_total - description: '' + description: Grand total of the sales order in company's base currency including + taxes and charges. - name: base_net_total - description: '' + description: Sum of all line item amounts in company's base currency before applying + taxes, discounts, or additional charges. - name: total - description: '' + description: Grand total of the sales order in transaction currency including + taxes and charges. - name: net_total - description: '' + description: Total sales order amount before applying any taxes or additional + charges - name: tax_category - description: '' + description: Classification that determines which tax rules apply to this sales + order based on customer type or location join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: taxes_and_charges - description: '' + description: Template or rule set defining specific tax rates and additional charges + applied to calculate the final order amount join_hint: table: tabSales Taxes and Charges Template 'on': taxes_and_charges = tabSales Taxes and Charges Template.name - name: shipping_rule - description: '' + description: Defines how shipping charges are calculated or applied to the order, + such as free shipping, flat rate, or carrier-based pricing. join_hint: table: tabShipping Rule 'on': shipping_rule = tabShipping Rule.name - name: incoterm - description: '' + description: International commercial term specifying which party bears shipping + costs, risks, and responsibilities during delivery (e.g., FOB, CIF, EXW). join_hint: table: tabIncoterm 'on': incoterm = tabIncoterm.name - name: named_place - description: '' + description: Specific geographic location associated with the incoterm where risk + and cost transfer occurs, such as port of loading or destination city. - name: taxes - description: '' + description: Line items detailing individual tax components applied to the sales + order, including tax type, rate, and amount for each tax rule. - name: base_total_taxes_and_charges - description: '' + description: Total sum of all taxes and additional charges in the company's base + currency before any currency conversion. - name: total_taxes_and_charges - description: '' + description: Total sum of all taxes and additional charges in the transaction + currency after applying tax rules and rates. - name: base_grand_total - description: '' + description: Total sales order value in company base currency before any rounding + adjustments are applied. - name: base_rounding_adjustment - description: '' + description: Amount added or subtracted in base currency to round the final total + to a convenient number. - name: base_rounded_total - description: '' + description: Final sales order total in base currency after applying rounding + adjustment, used for actual payment amount. - name: base_in_words - description: '' + description: Grand total amount expressed as text words for check writing or formal + documentation purposes. - name: grand_total - description: '' + description: Final total amount of the sales order including all items, taxes, + charges, and adjustments that the customer must pay. - name: rounding_adjustment - description: '' + description: Small amount added or subtracted to round the final total to a convenient + number, typically to nearest whole currency unit. - name: rounded_total - description: '' + description: Final invoice amount after applying rounding adjustments to the grand + total - name: in_words - description: '' + description: Grand total amount expressed as text words for printing on invoices + and official documents - name: advance_paid - description: '' + description: Amount of advance payment or deposit received from customer before + order fulfillment - name: disable_rounded_total - description: '' + description: Whether rounding is disabled for the total amount on this sales order, + relevant when users ask about exact vs rounded totals. - name: apply_discount_on - description: '' + description: Specifies whether discounts are calculated on grand total or net + total, used when users need to understand discount calculation basis. options: - Grand Total - Net Total - name: base_discount_amount - description: '' + description: Total discount amount in base currency before any currency conversion, + used for multi-currency discount analysis and reporting. - name: coupon_code - description: '' + description: Promotional or marketing code applied to the sales order for tracking + campaign-based discounts. join_hint: table: tabCoupon Code 'on': coupon_code = tabCoupon Code.name - name: additional_discount_percentage - description: '' + description: Extra percentage discount applied beyond standard pricing or coupon + discounts. - name: discount_amount - description: '' + description: Total monetary value of all discounts applied to the sales order. - name: other_charges_calculation - description: '' + description: Additional fees or charges applied to the sales order beyond standard + item pricing, such as shipping, handling, or service fees. - name: packed_items - description: '' + description: Items that have been physically packed or bundled together for shipment + in this sales order. - name: pricing_rules - description: '' + description: Special pricing conditions or discount rules applied to determine + final prices for items in this sales order. - name: customer_address - description: '' + description: Specific address record linked to the customer where the order will + be shipped or billed. join_hint: table: tabAddress 'on': customer_address = tabAddress.name - name: address_display - description: '' + description: Formatted full address text showing the complete shipping or billing + address for display purposes. - name: customer_group - description: '' + description: Classification or segment of the customer such as wholesale, retail, + or VIP for pricing and business rules. join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: territory - description: '' + description: Geographic sales region or area assigned to this sales order for + regional performance tracking and commission allocation join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: contact_person - description: '' + description: Primary contact person ID or reference at the customer organization + for this sales order join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_display - description: '' + description: Formatted display name of the contact person for this sales order, + used when showing human-readable contact information - name: contact_phone - description: '' + description: Primary landline or office phone number for reaching the customer + about this sales order - name: contact_mobile - description: '' + description: Mobile or cell phone number for reaching the customer about this + sales order - name: contact_email - description: '' + description: Email address for sending order confirmations, invoices, and updates + to the customer - name: shipping_address_name - description: '' + description: Name or label identifying the shipping destination (e.g., 'Main Warehouse', + 'Customer Site B') where the order will be delivered. join_hint: table: tabAddress 'on': shipping_address_name = tabAddress.name - name: shipping_address - description: '' + description: Full physical address details where the order will be shipped to + the customer or end recipient. - name: dispatch_address_name - description: '' + description: Name or label identifying the origin location (e.g., 'Distribution + Center A', 'Factory 1') from where the order will be dispatched or sent. join_hint: table: tabAddress 'on': dispatch_address_name = tabAddress.name - name: dispatch_address - description: '' + description: Address where ordered goods will be shipped or delivered to the customer. - name: company_address - description: '' + description: Address of the company location or branch processing this sales order. join_hint: table: tabAddress 'on': company_address = tabAddress.name - name: company_address_display - description: '' + description: Formatted version of the company address for display on documents + like invoices and sales order printouts. - name: company_contact_person - description: '' + description: Primary contact person at the customer's company for this sales order. join_hint: table: tabContact 'on': company_contact_person = tabContact.name - name: payment_terms_template - description: '' + description: Template defining standard payment conditions like net 30 or due + on receipt applied to this order. join_hint: table: tabPayment Terms Template 'on': payment_terms_template = tabPayment Terms Template.name - name: payment_schedule - description: '' + description: Custom installment or milestone-based payment plan for this specific + sales order. - name: tc_name - description: '' + description: Terms and conditions document name or identifier associated with + the sales order join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Payment terms specifying when payment is due such as net 30, due + on receipt, or installment schedules - name: status - description: '' + description: Current state of the sales order such as draft, confirmed, shipped, + invoiced, or cancelled options: - Draft - On Hold @@ -24092,7 +29965,8 @@ tables: - Cancelled - Closed - name: delivery_status - description: '' + description: Current fulfillment state of the order such as not delivered, partially + delivered, fully delivered, or closed. options: - Not Delivered - Fully Delivered @@ -24100,398 +29974,526 @@ tables: - Closed - Not Applicable - name: per_delivered - description: '' + description: Percentage of ordered quantity that has been physically delivered + to the customer. - name: per_billed - description: '' + description: Percentage of the order value that has been invoiced to the customer. - name: per_picked - description: '' + description: Percentage of ordered items that have been physically picked from + inventory for this sales order. - name: billing_status - description: '' + description: Current invoicing state of the sales order indicating whether it + is unbilled, partially billed, or fully billed. options: - Not Billed - Fully Billed - Partly Billed - Closed - name: sales_partner - description: '' + description: External partner or intermediary who referred or facilitated this + sales order and may receive commission. join_hint: table: tabSales Partner 'on': sales_partner = tabSales Partner.name - name: amount_eligible_for_commission - description: '' + description: Sales order revenue amount that qualifies for commission calculation, + excluding non-commissionable items or adjustments. - name: commission_rate - description: '' + description: Percentage rate applied to eligible amount to calculate sales commission + for this order. - name: total_commission - description: '' + description: Final commission amount earned on this sales order after applying + the commission rate to eligible amount. - name: sales_team - description: '' + description: Team or group responsible for closing this sales order, used when + filtering or analyzing performance by team assignment. - name: loyalty_points - description: '' + description: Number of reward points earned or redeemed through this sales order + transaction. - name: loyalty_amount - description: '' + description: Monetary value in currency associated with loyalty points for this + sales order, used when calculating loyalty program costs or customer rewards + in financial terms. - name: from_date - description: '' + description: Start date of the sales order validity period or delivery schedule. - name: to_date - description: '' + description: End date of the sales order validity period or delivery schedule. - name: auto_repeat - description: '' + description: Indicates whether this sales order automatically recurs on a scheduled + basis. join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: letter_head - description: '' + description: Letterhead template used when printing or emailing this sales order + document join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: group_same_items - description: '' + description: Whether identical items are consolidated into single lines when printing + the sales order - name: select_print_heading - description: '' + description: Custom heading text that appears at the top of the printed sales + order instead of the default title join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: language - description: '' + description: Language preference for the sales order document and customer communications. - name: is_internal_customer - description: '' + description: Indicates whether the customer is an internal entity within the organization + for inter-company transactions. - name: represents_company - description: '' + description: The company entity that this sales order represents in multi-company + or subsidiary scenarios. join_hint: table: tabCompany 'on': represents_company = tabCompany.name - name: source - description: '' + description: Origin or channel through which the sales order was created, such + as website, phone, email, or partner referral. join_hint: table: tabLead Source 'on': source = tabLead Source.name - name: inter_company_order_reference - description: '' + description: Reference to the corresponding purchase order when this sales order + is between related company entities. join_hint: table: tabPurchase Order 'on': inter_company_order_reference = tabPurchase Order.name - name: campaign - description: '' + description: Marketing campaign or promotion associated with this sales order + for tracking campaign effectiveness and attribution. join_hint: table: tabCampaign 'on': campaign = tabCampaign.name - name: party_account_currency - description: '' + description: Currency used for the customer's account balance and transactions + in this sales order join_hint: table: tabCurrency 'on': party_account_currency = tabCurrency.name + desc_done: true - table: tabSales Order Item description: '' fields: - name: name - description: '' + description: Unique identifier or auto-generated name for the sales order line + item record - name: item_code - description: '' + description: Internal product/SKU code used to identify what item is being sold + in this order line join_hint: table: tabItem 'on': item_code = tabItem.name - name: customer_item_code - description: '' + description: Customer's own product code or SKU for the item, used when customer + references items by their internal numbering system - name: ensure_delivery_based_on_produced_serial_no - description: '' + description: Whether this item requires delivery only after a specific serial + number is manufactured or produced. - name: is_stock_item - description: '' + description: Whether this item is a physical inventory item that requires stock + tracking, as opposed to a service or non-inventory item. - name: reserve_stock - description: '' + description: Whether inventory quantity is reserved or allocated for this sales + order item to prevent overselling. - name: delivery_date - description: '' + description: Date when the ordered item is scheduled to be delivered to the customer - name: item_name - description: '' + description: Name or title of the product being sold in this order line - name: description - description: '' + description: Detailed text explaining the item specifications, features, or custom + requirements for this order line - name: item_group - description: '' + description: Product category or classification for filtering and analyzing sales + by product type. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: brand - description: '' + description: Manufacturer or brand name of the sold item for brand-specific sales + analysis. join_hint: table: tabBrand 'on': brand = tabBrand.name - name: image_view - description: '' + description: Visual representation or photo of the item included in the sales + order. - name: qty - description: '' + description: Quantity of the item ordered by the customer in the specified unit + of measure. - name: stock_uom - description: '' + description: Base inventory unit of measure for the item as maintained in stock + records. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: uom - description: '' + description: Unit of measure for the ordered quantity as specified on this sales + order line, which may differ from the stock unit. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert the sales order item quantity from its sales + unit of measure to the stock/inventory unit of measure. - name: stock_qty - description: '' + description: Total quantity of the sales order item expressed in the stock/inventory + unit of measure after applying conversion factor. - name: stock_reserved_qty - description: '' + description: Quantity of inventory physically reserved or allocated from warehouse + stock specifically for this sales order item. - name: price_list_rate - description: '' + description: Item's standard catalog price in transaction currency before discounts + or negotiations. - name: base_price_list_rate - description: '' + description: Item's standard catalog price converted to company base currency. - name: margin_type - description: '' + description: Whether profit margin is calculated as a percentage or fixed amount. options: - Percentage - Amount - name: margin_rate_or_amount - description: '' + description: Profit margin added to base cost, used when calculating selling price + from cost or analyzing markup on individual line items. - name: rate_with_margin - description: '' + description: Final unit price after applying margin to base cost, used when comparing + marked-up price versus discounted price or analyzing pre-discount selling price. - name: discount_percentage - description: '' + description: Percentage reduction applied to selling price, used when analyzing + price concessions, promotional discounts, or customer-specific pricing adjustments. - name: discount_amount - description: '' + description: Discount applied directly to this sales order line item, used when + calculating item-level price reductions or promotional discounts. - name: distributed_discount_amount - description: '' + description: Portion of order-level or header discount allocated to this line + item, used when header discounts are apportioned across items. - name: base_rate_with_margin - description: '' + description: Item unit price including profit margin before discounts, used when + analyzing pricing with markup or comparing to cost. - name: rate - description: '' + description: Unit price per item before taxes and discounts applied to the line + item. - name: amount - description: '' + description: Total line item value after applying quantity, rate, and discounts + but before taxes. - name: item_tax_template - description: '' + description: Tax configuration template applied to calculate taxes for this specific + line item. join_hint: table: tabItem Tax Template 'on': item_tax_template = tabItem Tax Template.name - name: base_rate - description: '' + description: Unit price of the item before applying pricing rules, discounts, + or currency conversions. - name: base_amount - description: '' + description: Total line amount in base currency before applying pricing rules + or discounts (base_rate × quantity). - name: pricing_rules - description: '' + description: Specific promotional or conditional pricing rules applied to calculate + the final item price. - name: stock_uom_rate - description: '' + description: Rate per unit in the stock unit of measure, used when querying item + pricing in base inventory units rather than sales units. - name: is_free_item - description: '' + description: Indicates whether the item is provided at no charge as a promotion + or bundle component. - name: grant_commission - description: '' + description: Indicates whether this line item is eligible for sales commission + calculation. - name: net_rate - description: '' + description: Price per unit after applying item-level discounts but before taxes, + in transaction currency. - name: net_amount - description: '' + description: Total line item value after item-level discounts but before taxes, + in transaction currency. - name: base_net_rate - description: '' + description: Price per unit after applying item-level discounts but before taxes, + converted to company's base currency. - name: base_net_amount - description: '' + description: Net sales value of the line item in base currency after discounts + but before taxes. - name: billed_amt - description: '' + description: Total amount already invoiced for this sales order line item, used + to track billing progress against ordered quantity. - name: valuation_rate - description: '' + description: Cost or inventory valuation rate per unit used for margin analysis + and COGS calculation, distinct from selling price. - name: gross_profit - description: '' + description: Profit amount for this sales order line item calculated as revenue + minus cost of goods sold. - name: delivered_by_supplier - description: '' + description: Indicates whether this item is shipped directly from the supplier + to the customer rather than from company inventory. - name: supplier - description: '' + description: The vendor who supplies or drop-ships this specific item on the sales + order. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: weight_per_unit - description: '' + description: Weight of a single unit of the ordered item, used when calculating + shipping costs or comparing product weights per piece. - name: total_weight - description: '' + description: Combined weight of all units in this order line item, used for total + shipment weight and freight calculations. - name: weight_uom - description: '' + description: Unit of measurement for weight fields (e.g., kg, lbs, oz), used to + interpret weight_per_unit and total_weight values. join_hint: table: tabUOM 'on': weight_uom = tabUOM.name - name: warehouse - description: '' + description: Warehouse from which the ordered item will be delivered or fulfilled + to the customer. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: target_warehouse - description: '' + description: Destination warehouse where the item should be transferred or moved + as part of the sales order. join_hint: table: tabWarehouse 'on': target_warehouse = tabWarehouse.name - name: prevdoc_docname - description: '' + description: Reference to the preceding document that generated this sales order + item, such as a quotation or sales inquiry number. join_hint: table: tabQuotation 'on': prevdoc_docname = tabQuotation.name - name: quotation_item - description: '' + description: Links this sales order line item to the original quotation line item + it was created from. - name: against_blanket_order - description: '' + description: Indicates whether this sales order item is fulfilling a blanket order + agreement. - name: blanket_order - description: '' + description: References the specific blanket order contract that this sales order + item is drawn against. join_hint: table: tabBlanket Order 'on': blanket_order = tabBlanket Order.name - name: blanket_order_rate - description: '' + description: Price per unit from a blanket purchase agreement applied to this + sales order line item. - name: actual_qty - description: '' + description: Quantity of this item currently available in stock at the time of + the sales order. - name: company_total_stock - description: '' + description: Total quantity of this item available across all warehouses company-wide + when the sales order was created. - name: bom_no - description: '' + description: Bill of materials number for manufactured or assembled items on the + sales order line. join_hint: table: tabBOM 'on': bom_no = tabBOM.name - name: projected_qty - description: '' + description: Expected available quantity after accounting for pending stock movements + and reservations. - name: ordered_qty - description: '' + description: Quantity of the item that the customer ordered on this sales order + line. - name: planned_qty - description: '' + description: Quantity planned for delivery or fulfillment on this sales order + line item. - name: production_plan_qty - description: '' + description: Quantity allocated to production planning for manufacturing this + item to fulfill the sales order. - name: work_order_qty - description: '' + description: Quantity already issued to active work orders for manufacturing this + sales order item. - name: delivered_qty - description: '' + description: Quantity of items actually delivered to the customer for this sales + order line. - name: produced_qty - description: '' + description: Quantity of items manufactured or produced to fulfill this sales + order line. - name: returned_qty - description: '' + description: Quantity of items returned by the customer after delivery for this + sales order line. - name: picked_qty - description: '' + description: Quantity of items physically picked from inventory for this order + line, used when tracking fulfillment progress or comparing picked versus ordered + amounts. - name: additional_notes - description: '' + description: Free-text notes or comments specific to this individual order line + item, used when searching for special instructions or item-level remarks. - name: page_break - description: '' + description: Controls whether a page break occurs before this line item when printing + or generating sales order documents. - name: item_tax_rate - description: '' + description: Tax percentage applied to this specific line item for calculating + tax amounts on the ordered product. - name: transaction_date - description: '' + description: Date when the sales order transaction was recorded or posted in the + system. - name: material_request - description: '' + description: Reference to the material request document that triggered or is linked + to this sales order item. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: purchase_order - description: '' + description: Customer's purchase order number or reference provided when placing + the sales order. join_hint: table: tabPurchase Order 'on': purchase_order = tabPurchase Order.name - name: material_request_item - description: '' + description: Link to the internal material request item that triggered or is fulfilled + by this sales order item. - name: purchase_order_item - description: '' + description: Link to the purchase order item when this sales order item is directly + tied to procurement or drop-shipping. - name: cost_center - description: '' + description: Department or business unit to which the sales order item's revenue + or costs are allocated for financial tracking and internal accounting. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Specific project or job to which the sales order item is linked for + project-based billing, tracking, and profitability analysis. join_hint: table: tabProject 'on': project = tabProject.name + desc_done: true - table: tabSales Partner description: A third party distributor / dealer / commission agent / affiliate / reseller who sells the companies products for a commission. fields: - name: name - description: '' + description: Unique identifier code or short name for the sales partner record - name: partner_name - description: '' + description: Full official business name of the sales partner organization - name: partner_type - description: '' + description: Category or classification of the sales partner such as distributor, + reseller, agent, or affiliate join_hint: table: tabSales Partner Type 'on': partner_type = tabSales Partner Type.name - name: territory - description: '' + description: Geographic region or area assigned to the sales partner for managing + sales activities and customer accounts join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: commission_rate - description: '' + description: Percentage or rate used to calculate commission earnings for the + sales partner based on their sales performance - name: targets - description: '' + description: Sales goals or quotas set for the sales partner to achieve within + a specific time period - name: show_in_website - description: '' + description: Whether this sales partner is displayed or visible on the public + website or partner portal. - name: referral_code - description: '' + description: Unique code used by this sales partner to track referrals, commissions, + or customer acquisitions attributed to them. - name: route - description: '' + description: URL slug or web path for accessing this sales partner's dedicated + page or profile on the website. - name: partner_website - description: '' + description: URL of the sales partner's official website for contact or reference + purposes - name: introduction - description: '' + description: Brief summary or tagline about the sales partner, typically used + for quick identification or overview - name: description - description: '' + description: Detailed information about the sales partner including capabilities, + specializations, or business relationship details + desc_done: true - table: tabSales Partner Item description: '' fields: - name: name - description: '' + description: Unique identifier or label for the specific item associated with + the sales partner - name: sales_partner - description: '' + description: The partner, distributor, or third-party entity involved in selling + this item join_hint: table: tabSales Partner 'on': sales_partner = tabSales Partner.name + desc_done: true - table: tabSales Partner Type description: '' fields: - name: name - description: '' + description: Name or label of the sales partner type for display and identification + purposes - name: sales_partner_type - description: '' + description: Unique identifier code or key for the sales partner type used in + transactions and classifications + desc_done: true - table: tabSales Person description: All Sales Transactions can be tagged against multiple Sales Persons so that you can set and monitor targets. fields: - name: name - description: '' + description: Unique identifier code or ID for the sales person record - name: sales_person_name - description: '' + description: Full display name of the sales person used for reporting and user-facing + contexts - name: parent_sales_person - description: '' + description: Manager or supervising sales person in the sales hierarchy join_hint: table: tabSales Person 'on': parent_sales_person = tabSales Person.name - name: commission_rate - description: '' + description: Percentage or rate used to calculate commission earned by the sales + person on their sales transactions. - name: is_group - description: '' + description: Indicates whether this represents a team or group of sales people + rather than an individual sales person. - name: enabled - description: '' + description: Indicates whether the sales person is currently active and available + for assignment to new sales transactions. - name: employee - description: '' + description: Links to the employee record representing this salesperson for identifying + who made sales or managing sales team members. join_hint: table: tabEmployee 'on': employee = tabEmployee.name - name: department - description: '' + description: The department this salesperson belongs to for filtering sales by + organizational unit or team. join_hint: table: tabDepartment 'on': department = tabDepartment.name - name: lft - description: '' + description: Left boundary value in nested set model for representing salesperson + hierarchy or territory structure. - name: rgt - description: '' + description: Right boundary value in nested set model for sales person hierarchy + positioning and organizational structure queries. - name: old_parent - description: '' + description: Previous parent sales person before organizational reassignment or + territory restructuring. - name: targets - description: '' + description: Sales targets or quotas assigned to the sales person for performance + tracking and goal achievement queries. + desc_done: true - table: tabSales Stage description: '' fields: - name: name - description: '' + description: Unique identifier or code for the sales stage - name: stage_name - description: '' + description: Descriptive label of the sales stage such as Lead, Qualified, Proposal, + Negotiation, or Closed Won + desc_done: true - table: tabSales Taxes and Charges description: '' fields: - name: name - description: '' + description: Unique identifier for the specific sales tax or charge line item - name: charge_type - description: '' + description: Categorizes whether this is a tax (VAT, GST, sales tax) or other + charge (shipping, handling, customs duty) options: - Actual - On Net Total @@ -24499,144 +30501,181 @@ tables: - On Previous Row Total - On Item Quantity - name: row_id - description: '' + description: Sequential position of this tax or charge within the parent sales + document - name: account_head - description: '' + description: Ledger account where this sales tax or charge amount is posted for + accounting purposes join_hint: table: tabAccount 'on': account_head = tabAccount.name - name: description - description: '' + description: Text explanation of the specific tax or charge line item appearing + on the sales document - name: included_in_print_rate - description: '' + description: Whether this tax or charge is already included in the displayed item + rate or added separately - name: included_in_paid_amount - description: '' + description: Whether this tax or charge was already included in the payment amount + received from the customer. - name: cost_center - description: '' + description: Cost center to which this sales tax or charge is allocated for expense + tracking and financial analysis. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Project to which this sales tax or charge is linked for project-specific + cost tracking and profitability analysis. join_hint: table: tabProject 'on': project = tabProject.name - name: rate - description: '' + description: Tax or charge percentage applied to the transaction base amount - name: account_currency - description: '' + description: Currency of the accounting ledger where this tax or charge is posted join_hint: table: tabCurrency 'on': account_currency = tabCurrency.name - name: tax_amount - description: '' + description: Calculated monetary value of the tax or charge in transaction currency - name: total - description: '' + description: Cumulative tax total including this charge and all previous charges + in the tax calculation sequence. - name: tax_amount_after_discount_amount - description: '' + description: Tax amount calculated after applying any item-level or invoice-level + discounts. - name: base_tax_amount - description: '' + description: Tax amount in the company's base currency before any currency conversion. - name: base_total - description: '' + description: Total tax amount in company base currency before applying any discounts + to the tax itself. - name: base_tax_amount_after_discount_amount - description: '' + description: Final tax amount in company base currency after applying discounts + to the tax charge. - name: item_wise_tax_detail - description: '' + description: Breakdown showing how this tax charge applies to each individual + item in the transaction. - name: dont_recompute_tax - description: '' + description: Indicates whether tax amounts should remain fixed and not be automatically + recalculated when transaction values change. + desc_done: true - table: tabSales Taxes and Charges Template description: Standard tax template that can be applied to all Sales Transactions. This template can contain a list of tax heads and also other expense/income heads like "Shipping", "Insurance", "Handling" etc. fields: - name: name - description: '' + description: Unique identifier for the sales tax and charges template - name: title - description: '' + description: Display name of the sales tax and charges template shown to users - name: is_default - description: '' + description: Whether this template is automatically applied to new sales transactions - name: disabled - description: '' + description: Whether this sales tax template is currently inactive and unavailable + for use in transactions. - name: company - description: '' + description: The specific company entity to which this sales tax template applies. join_hint: table: tabCompany 'on': company = tabCompany.name - name: tax_category - description: '' + description: The classification of tax type such as VAT, service tax, or GST that + this template represents. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: taxes - description: '' + description: List of individual tax line items with their rates, amounts, and + account assignments within this sales tax template + desc_done: true - table: tabSales Team description: '' fields: - name: name - description: '' + description: Name of the sales team or group for identifying and organizing sales + territories or divisions - name: sales_person - description: '' + description: Individual salesperson assigned to or member of this sales team join_hint: table: tabSales Person 'on': sales_person = tabSales Person.name - name: contact_no - description: '' + description: Phone number to reach this sales team - name: allocated_percentage - description: '' + description: Percentage of sales or revenue assigned to this team member for quota + or territory allocation purposes. - name: allocated_amount - description: '' + description: Specific dollar or currency amount allocated to this team member + as quota, budget, or target. - name: commission_rate - description: '' + description: Percentage rate used to calculate commission earnings for this sales + team member based on their sales performance. - name: incentives - description: '' + description: Compensation bonuses or commission structures offered to the sales + team for achieving targets or closing deals. + desc_done: true - table: tabSalutation description: '' fields: - name: name - description: '' + description: Name of the salutation record for internal identification or reference + purposes - name: salutation - description: '' + description: Formal greeting or title used to address a person in communications, + such as Mr., Ms., Dr., or Prof. + desc_done: true - table: tabScheduled Job Log description: '' fields: - name: name - description: '' + description: Unique identifier or label for the scheduled job execution instance - name: status - description: '' + description: Current execution state of the scheduled job such as completed, failed, + running, or pending options: - Scheduled - Complete - Failed - name: scheduled_job_type - description: '' + description: Category or type of scheduled job being executed such as backup, + report generation, data sync, or maintenance task join_hint: table: tabScheduled Job Type 'on': scheduled_job_type = tabScheduled Job Type.name - name: details - description: '' + description: Human-readable summary or status message about what the scheduled + job did or any issues encountered during execution. - name: debug_log - description: '' + description: Technical diagnostic information and verbose execution traces used + when troubleshooting scheduled job failures or performance issues. + desc_done: true - table: tabScheduled Job Type description: '' fields: - name: name - description: '' + description: Name or identifier of the scheduled job type that users reference + when asking about specific automated tasks or recurring processes. - name: stopped - description: '' + description: Indicates whether the scheduled job type is currently inactive or + paused, relevant when users ask which jobs are not running. - name: method - description: '' + description: The specific function or procedure executed by this scheduled job + type, used when users need to know what action the job performs. - name: server_script - description: '' + description: The Python script or code that executes when this scheduled job runs join_hint: table: tabServer Script 'on': server_script = tabServer Script.name - name: scheduler_event - description: '' + description: The timing trigger or event type that determines when this job executes + (e.g., daily, hourly, weekly, cron) join_hint: table: tabScheduler Event 'on': scheduler_event = tabScheduler Event.name - name: frequency - description: '' + description: How often the scheduled job runs, specified as a time interval or + recurrence pattern options: - All - Hourly @@ -24653,138 +30692,171 @@ tables: - Yearly - Annual - name: cron_format - description: '' + description: Schedule pattern defining when the job runs using cron syntax. - name: create_log - description: '' + description: Whether execution logs are created each time this scheduled job runs. - name: last_execution - description: '' + description: Timestamp of the most recent time this scheduled job was executed. - name: next_execution - description: '' + description: When the scheduled job is planned to run next, used to find jobs + about to execute or check upcoming automation timing. + desc_done: true - table: tabScheduler Event description: '' fields: - name: name - description: '' + description: Name or title of the scheduled event used to identify and search + for specific automated tasks or jobs - name: scheduled_against - description: '' + description: The document type or module that this scheduled event operates on + or targets for execution join_hint: table: tabDocType 'on': scheduled_against = tabDocType.name - name: method - description: '' + description: The specific function or procedure name that gets executed when this + scheduled event runs + desc_done: true - table: tabSelling Settings description: Settings for Selling Module fields: - name: name - description: '' + description: Unique identifier for the selling settings configuration record - name: cust_master_name - description: '' + description: Naming series pattern or template used for generating customer IDs options: - Customer Name - Naming Series - Auto Name - name: customer_group - description: '' + description: Default customer group assigned to new customers when none is specified join_hint: table: tabCustomer Group 'on': customer_group = tabCustomer Group.name - name: territory - description: '' + description: Default sales territory assigned to new customers and transactions + for regional sales tracking and commission allocation. join_hint: table: tabTerritory 'on': territory = tabTerritory.name - name: selling_price_list - description: '' + description: Default price list applied to sales transactions to determine item + pricing for customers. join_hint: table: tabPrice List 'on': selling_price_list = tabPrice List.name - name: maintain_same_rate_action - description: '' + description: Action taken when item prices change mid-transaction, controlling + whether to keep original rates or update to new prices. options: - Stop - Warn - name: role_to_override_stop_action - description: '' + description: Role permitted to bypass stop actions on blocked customers or credit + limit violations during sales transactions. join_hint: table: tabRole 'on': role_to_override_stop_action = tabRole.name - name: maintain_same_sales_rate - description: '' + description: Whether to keep the original sales rate unchanged when converting + between sales documents like quotations to orders. - name: fallback_to_default_price_list - description: '' + description: Whether to automatically use the default price list when a customer-specific + price list is unavailable or missing items. - name: editable_price_list_rate - description: '' + description: Controls whether sales users can manually modify price list rates + during transaction entry. - name: validate_selling_price - description: '' + description: Enforces validation that selling prices must meet or exceed valuation + rates to prevent selling below cost. - name: editable_bundle_item_rates - description: '' + description: Allows modification of individual item prices within product bundles + during sales transactions. - name: allow_negative_rates_for_items - description: '' + description: Controls whether items can have negative prices in sales transactions. - name: so_required - description: '' + description: Determines if a Sales Order is mandatory before creating Delivery + Notes or Sales Invoices. options: - 'No' - 'Yes' - name: dn_required - description: '' + description: Determines if a Delivery Note is mandatory before creating Sales + Invoices. options: - 'No' - 'Yes' - name: sales_update_frequency - description: '' + description: How often sales data or metrics are refreshed or recalculated in + the system. options: - Monthly - Each Transaction - Daily - name: blanket_order_allowance - description: '' + description: Maximum percentage or amount allowed for blanket orders to exceed + their original value. - name: allow_multiple_items - description: '' + description: Whether sales transactions can include more than one item or product + line. - name: allow_against_multiple_purchase_orders - description: '' + description: Controls whether a single sales order or delivery can reference and + fulfill items from multiple purchase orders simultaneously. - name: allow_sales_order_creation_for_expired_quotation - description: '' + description: Determines if sales orders can be created from quotations that have + passed their valid until date. - name: dont_reserve_sales_order_qty_on_sales_return - description: '' + description: Controls whether returned items from sales returns should bypass + automatic quantity reservation against existing sales orders. - name: hide_tax_id - description: '' + description: Controls whether tax identification numbers are hidden on sales documents + like invoices and quotations. - name: enable_discount_accounting - description: '' + description: Determines if discounts are tracked in separate accounting ledger + entries rather than reducing line item amounts directly. - name: allow_zero_qty_in_quotation - description: '' + description: Permits creating quotation line items with zero quantity, useful + for displaying optional or informational items. - name: allow_zero_qty_in_sales_order - description: '' + description: Whether sales orders can be created with line items having zero quantity, + relevant when users ask about creating placeholder or template orders without + actual quantities. + desc_done: true - table: tabSerial No description: Distinct unit of an Item fields: - name: name - description: '' + description: Unique identifier for this serial number record - name: serial_no - description: '' + description: Actual serial number value assigned to a specific item unit for tracking + individual pieces - name: item_code - description: '' + description: Product or item type that this serial number belongs to join_hint: table: tabItem 'on': item_code = tabItem.name - name: batch_no - description: '' + description: Batch identifier for tracking groups of serialized items that were + manufactured or purchased together. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: warehouse - description: '' + description: Storage location where this specific serialized item is currently + held. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: purchase_rate - description: '' + description: Unit cost paid when this serialized item was originally purchased. - name: customer - description: '' + description: Customer who purchased or received the serialized item join_hint: table: tabCustomer 'on': customer = tabCustomer.name - name: status - description: '' + description: Current state of the serial number such as available, delivered, + or inactive options: - Active - Inactive @@ -24792,192 +30864,239 @@ tables: - Delivered - Expired - name: item_name - description: '' + description: Product or item associated with this serial number - name: description - description: '' + description: Text description or name of the serialized item for identifying what + the serial number represents - name: item_group - description: '' + description: Product category or classification that the serialized item belongs + to for grouping similar items join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: brand - description: '' + description: Manufacturer or brand name of the serialized item for filtering by + vendor or make join_hint: table: tabBrand 'on': brand = tabBrand.name - name: asset - description: '' + description: Links the serial number to a specific fixed asset or equipment item + being tracked. join_hint: table: tabAsset 'on': asset = tabAsset.name - name: asset_status - description: '' + description: Current operational or lifecycle status of the serialized asset (e.g., + active, in maintenance, retired). options: - Issue - Receipt - Transfer - name: location - description: '' + description: Physical location or warehouse where the serialized item is currently + stored or deployed. join_hint: table: tabLocation 'on': location = tabLocation.name - name: employee - description: '' + description: Employee assigned to or responsible for this serialized item join_hint: table: tabEmployee 'on': employee = tabEmployee.name - name: warranty_expiry_date - description: '' + description: Date when the manufacturer's warranty coverage ends for this serial + numbered item - name: amc_expiry_date - description: '' + description: Date when the Annual Maintenance Contract service period ends for + this serial numbered item - name: maintenance_status - description: '' + description: Current maintenance state of the serialized item such as under maintenance, + operational, or out of service. options: - Under Warranty - Out of Warranty - Under AMC - Out of AMC - name: warranty_period - description: '' + description: Duration or timeframe during which the serialized item is covered + under warranty. - name: company - description: '' + description: Company entity that owns or is associated with this serial numbered + item. join_hint: table: tabCompany 'on': company = tabCompany.name - name: work_order - description: '' + description: Work order or manufacturing order associated with this serial number + for production tracking join_hint: table: tabWork Order 'on': work_order = tabWork Order.name - name: purchase_document_no - description: '' + description: Purchase receipt or purchase order document number when this serial + numbered item was received or procured + desc_done: true - table: tabSerial and Batch Bundle description: '' fields: - name: name - description: '' + description: Unique identifier for the serial and batch bundle record - name: naming_series - description: '' + description: Prefix pattern used to auto-generate the bundle name options: - SABB-.######## - name: company - description: '' + description: Company that owns or manages this serial and batch bundle join_hint: table: tabCompany 'on': company = tabCompany.name - name: item_name - description: '' + description: Item for which serial numbers or batch numbers are being tracked + and bundled. - name: has_serial_no - description: '' + description: Whether this item uses serial number tracking for individual unit + identification. - name: has_batch_no - description: '' + description: Whether this item uses batch number tracking for grouping units by + production lot or expiry. - name: item_code - description: '' + description: Identifies which product or material the serial/batch bundle applies + to. join_hint: table: tabItem 'on': item_code = tabItem.name - name: warehouse - description: '' + description: Specifies the storage location where the serial/batch bundle is held + or transacted. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: type_of_transaction - description: '' + description: Indicates whether the bundle transaction is inbound, outbound, or + another movement type. options: - Inward - Outward - Maintenance - Asset Repair - name: entries - description: '' + description: Child table containing individual serial numbers or batch numbers + with their quantities for the bundled item. - name: total_qty - description: '' + description: Aggregate quantity across all serial/batch entries in this bundle. - name: item_group - description: '' + description: Product category or classification that the bundled serial/batch + items belong to. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: avg_rate - description: '' + description: Average rate per unit calculated across all serial numbers or batches + in this bundle. - name: total_amount - description: '' + description: Total monetary value of all serial numbers or batches combined in + this bundle. - name: voucher_type - description: '' + description: Type of transaction document that created or references this serial + and batch bundle. join_hint: table: tabDocType 'on': voucher_type = tabDocType.name - name: voucher_no - description: '' + description: Transaction document number linking serial and batch bundles to their + source voucher - name: voucher_detail_no - description: '' + description: Line item number within the voucher identifying the specific transaction + detail for this bundle - name: posting_date - description: '' + description: Date when the serial and batch bundle transaction was posted to the + ledger - name: posting_time - description: '' + description: Time when the serial and batch bundle transaction was posted or recorded. - name: returned_against - description: '' + description: Reference to the original serial and batch bundle document that this + return transaction is reversing. - name: is_cancelled - description: '' + description: Indicates whether this serial and batch bundle transaction has been + cancelled or voided. - name: is_rejected - description: '' + description: Indicates whether the serial and batch bundle has been rejected during + quality inspection or receiving process. - name: amended_from - description: '' + description: Links to the original serial and batch bundle document that this + record corrects or replaces after amendment. join_hint: table: tabSerial and Batch Bundle 'on': amended_from = tabSerial and Batch Bundle.name + desc_done: true - table: tabSerial and Batch Entry description: '' fields: - name: name - description: '' + description: Unique identifier for this serial and batch entry record - name: serial_no - description: '' + description: Individual serial number assigned to a specific item unit for tracking + unique pieces of inventory join_hint: table: tabSerial No 'on': serial_no = tabSerial No.name - name: batch_no - description: '' + description: Batch or lot number assigned to a group of items manufactured or + received together for tracking production runs or shipments join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: qty - description: '' + description: Quantity of items assigned to a specific serial number or batch in + the transaction. - name: warehouse - description: '' + description: Storage location where the serial or batch numbered items are kept + or transferred. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: delivered_qty - description: '' + description: Actual quantity of serial or batch numbered items that have been + physically delivered to the customer. - name: incoming_rate - description: '' + description: Valuation rate per unit for items being received or added to inventory + in this serial/batch transaction. - name: outgoing_rate - description: '' + description: Valuation rate per unit for items being issued, consumed, or removed + from inventory in this serial/batch transaction. - name: stock_value_difference - description: '' + description: Net change in total inventory value resulting from this serial/batch + transaction. - name: is_outward - description: '' + description: Indicates whether the serial/batch transaction represents inventory + leaving the warehouse (sales, material issue) versus incoming stock. - name: stock_queue - description: '' + description: FIFO/LIFO queue data structure tracking the chronological order and + valuation of serial numbers or batches for consumption sequencing. + desc_done: true - table: tabServer Script description: '' fields: - name: name - description: '' + description: Unique identifier or label for the server script - name: script_type - description: '' + description: Type of server script execution context such as API, DocType Event, + Permission Query, or Scheduler Event options: - DocType Event - Scheduler Event - Permission Query - API - name: reference_doctype - description: '' + description: The specific DocType that this server script is associated with or + operates on join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: event_frequency - description: '' + description: How often the server script runs, such as hourly, daily, weekly, + or on a custom schedule. options: - All - Hourly @@ -24991,9 +31110,11 @@ tables: - Monthly Long - Cron - name: cron_format - description: '' + description: The cron expression defining the exact schedule when the script executes + (e.g., '0 0 * * *' for daily at midnight). - name: doctype_event - description: '' + description: The specific document event that triggers the script, such as before + save, after insert, on update, or on submit. options: - Before Insert - Before Validate @@ -25013,31 +31134,40 @@ tables: - Before Print - On Payment Authorization - name: api_method - description: '' + description: The specific API endpoint or method name that this server script + exposes or handles - name: allow_guest - description: '' + description: Whether unauthenticated or guest users can execute this server script + without logging in - name: module - description: '' + description: The application module or functional area that this server script + belongs to for organizational grouping join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: disabled - description: '' + description: Whether the server script is currently inactive and will not execute - name: script - description: '' + description: The actual code or logic that executes when the server script runs - name: enable_rate_limit - description: '' + description: Whether execution frequency restrictions are applied to prevent excessive + server script calls - name: rate_limit_count - description: '' + description: Maximum number of executions allowed within the rate limit time window + for this server script. - name: rate_limit_seconds - description: '' + description: Time window in seconds during which the rate limit count applies + for this server script. + desc_done: true - table: tabService Day description: '' fields: - name: name - description: '' + description: Name or label identifying the specific service day (e.g., 'Monday + Morning', 'Weekend Shift'). - name: workday - description: '' + description: Indicates whether this service day is a working day or non-working + day (weekend/holiday). options: - Monday - Tuesday @@ -25047,353 +31177,445 @@ tables: - Saturday - Sunday - name: start_time - description: '' + description: Time when the service day begins or service operations start. - name: end_time - description: '' + description: Time when the service day or work shift concludes, used to calculate + duration or filter service periods by completion time. + desc_done: true - table: tabService Level Agreement description: '' fields: - name: name - description: '' + description: The title or identifier of the service level agreement used when + referencing a specific SLA by name - name: document_type - description: '' + description: The entity or module this SLA applies to such as Issue, Support Ticket, + or Project Task join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: default_priority - description: '' + description: The priority level automatically assigned to new items created under + this SLA join_hint: table: tabIssue Priority 'on': default_priority = tabIssue Priority.name - name: service_level - description: '' + description: The name or identifier of the service level commitment tier (e.g., + Gold, Silver, Standard) that defines response and resolution time expectations. - name: enabled - description: '' + description: Whether this service level agreement is currently active and available + for assignment to customers or cases. - name: default_service_level_agreement - description: '' + description: Whether this SLA is automatically applied to new customers or service + requests when no specific SLA is specified. - name: entity_type - description: '' + description: Type of record the SLA applies to, such as customer, project, or + ticket category. options: - Customer - Customer Group - Territory - name: entity - description: '' + description: Specific record or identifier the SLA is assigned to within the entity + type. - name: condition - description: '' + description: Criteria or rules that must be met for the SLA to apply or trigger. - name: start_date - description: '' + description: When the service level agreement becomes active or effective for + the customer or contract. - name: end_date - description: '' + description: When the service level agreement expires or is no longer valid for + the customer or contract. - name: apply_sla_for_resolution - description: '' + description: Whether this SLA enforces resolution time commitments for incidents, + requests, or cases. - name: priorities - description: '' + description: Priority levels or urgency tiers that this SLA applies to, relevant + when filtering SLAs by case or ticket priority. - name: sla_fulfilled_on - description: '' + description: Date and time when the SLA was successfully met or completed, used + to verify compliance and measure performance. - name: pause_sla_on - description: '' + description: Conditions or statuses that trigger pausing the SLA timer, such as + awaiting customer response or external dependencies. - name: holiday_list - description: '' + description: Which holidays or non-working days are excluded when calculating + SLA response and resolution times. join_hint: table: tabHoliday List 'on': holiday_list = tabHoliday List.name - name: support_and_resolution - description: '' + description: Defines the specific response time and resolution time commitments + for this service level agreement. + desc_done: true - table: tabService Level Priority description: '' fields: - name: name - description: '' + description: Service level priority name or identifier - name: default_priority - description: '' + description: Initial priority value automatically assigned when this service level + is applied to a new case or ticket - name: priority - description: '' + description: Current or active priority level for cases under this service level + agreement join_hint: table: tabIssue Priority 'on': priority = tabIssue Priority.name - name: response_time - description: '' + description: Time allowed to initially respond to a service request at this priority + level. - name: resolution_time - description: '' + description: Time allowed to fully resolve a service request at this priority + level. + desc_done: true - table: tabSession Default description: '' fields: - name: name - description: '' + description: Session identifier or name for tracking user login instances and + activity periods - name: ref_doctype - description: '' + description: Document type associated with this session, indicating which module + or form the user is currently accessing or working within join_hint: table: tabDocType 'on': ref_doctype = tabDocType.name + desc_done: true - table: tabSession Default Settings description: '' fields: - name: name - description: '' + description: Name or identifier of the session defaults configuration - name: session_defaults - description: '' + description: Default settings and preferences applied to user sessions + desc_done: true - table: tabShare Balance description: '' fields: - name: name - description: '' + description: Description or identifier of the share balance record used when searching + for specific share allocations or ownership details. - name: share_type - description: '' + description: Classification of shares (e.g., common, preferred) used when filtering + or analyzing share balances by ownership class or equity type. join_hint: table: tabShare Type 'on': share_type = tabShare Type.name - name: from_no - description: '' + description: Starting share certificate or sequence number used when querying + share number ranges or tracking share issuance blocks. - name: rate - description: '' + description: Price per share for valuing the shareholding position - name: no_of_shares - description: '' + description: Total quantity of shares held by the shareholder - name: to_no - description: '' + description: Ending share certificate number in a range of consecutively numbered + shares - name: amount - description: '' + description: The monetary value of shares held or transferred in this balance + record. - name: is_company - description: '' + description: Indicates whether the shareholder is a corporate entity rather than + an individual person. - name: current_state - description: '' + description: The active status of this share balance record, such as draft, confirmed, + or cancelled. options: - Issued - Purchased + desc_done: true - table: tabShare Transfer description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the share transfer transaction - name: transfer_type - description: '' + description: Category indicating whether shares are being transferred, sold, gifted, + or moved between parties options: - Issue - Purchase - Transfer - name: date - description: '' + description: Date when the share transfer was executed or became effective - name: from_shareholder - description: '' + description: Shareholder who is transferring or selling their shares to another + party. join_hint: table: tabShareholder 'on': from_shareholder = tabShareholder.name - name: from_folio_no - description: '' + description: Folio number of the shareholder account from which shares are being + transferred. - name: to_shareholder - description: '' + description: Shareholder who is receiving or purchasing the transferred shares. join_hint: table: tabShareholder 'on': to_shareholder = tabShareholder.name - name: to_folio_no - description: '' + description: Folio number of the recipient shareholder receiving the transferred + shares - name: equity_or_liability_account - description: '' + description: Account used to record equity or liability side of the share transfer + transaction join_hint: table: tabAccount 'on': equity_or_liability_account = tabAccount.name - name: asset_account - description: '' + description: Account used to record the asset side of the share transfer transaction join_hint: table: tabAccount 'on': asset_account = tabAccount.name - name: share_type - description: '' + description: Type or class of shares being transferred in the transaction join_hint: table: tabShare Type 'on': share_type = tabShare Type.name - name: from_no - description: '' + description: Starting certificate number or share number in the range being transferred + from the original holder - name: rate - description: '' + description: Price per share or transfer rate at which the shares are being transferred - name: no_of_shares - description: '' + description: Number of shares being transferred from one shareholder to another - name: to_no - description: '' + description: Ending share certificate number or sequence number after the transfer - name: amount - description: '' + description: Monetary value or consideration paid for the transferred shares - name: company - description: '' + description: The company entity where the share transfer transaction is being + recorded or executed. join_hint: table: tabCompany 'on': company = tabCompany.name - name: remarks - description: '' + description: Additional notes or comments explaining the reason, context, or special + conditions of the share transfer. - name: amended_from - description: '' + description: Reference to the original share transfer document that this record + corrects or modifies. join_hint: table: tabShare Transfer 'on': amended_from = tabShare Transfer.name + desc_done: true - table: tabShare Type description: '' fields: - name: name - description: '' + description: Unique identifier or code for the share type - name: title - description: '' + description: Display name or label shown to users for the share type - name: description - description: '' + description: Detailed explanation of what the share type represents and its purpose + desc_done: true - table: tabShareholder description: '' fields: - name: name - description: '' + description: Unique identifier or full name of the shareholder individual or entity - name: title - description: '' + description: Formal salutation or honorific prefix for the shareholder (Mr., Mrs., + Dr., etc.) - name: naming_series - description: '' + description: Prefix pattern used to auto-generate shareholder record identifiers options: - ACC-SH-.YYYY.- - name: folio_no - description: '' + description: Unique identifier assigned to a shareholder's account for tracking + their holdings and transactions. - name: company - description: '' + description: Name or identifier of the shareholder when the shareholder is a corporate + entity rather than an individual. join_hint: table: tabCompany 'on': company = tabCompany.name - name: is_company - description: '' + description: Indicates whether the shareholder is a corporate entity or an individual + person. - name: share_balance - description: '' + description: Number of shares currently owned by the shareholder, used when querying + ownership amounts or equity positions. - name: contact_list - description: '' + description: Contact information or list of contacts associated with the shareholder, + used when looking up communication details or shareholder representatives. + desc_done: true - table: tabShipment description: '' fields: - name: name - description: '' + description: Unique identifier or reference code for the shipment used when tracking + or referencing specific shipments - name: pickup_from_type - description: '' + description: Category or classification of the pickup location such as warehouse, + customer site, supplier, or distribution center options: - Company - Customer - Supplier - name: pickup_company - description: '' + description: Name of the company or organization where goods are being picked + up from join_hint: table: tabCompany 'on': pickup_company = tabCompany.name - name: pickup_customer - description: '' + description: Customer from whom goods are being picked up in reverse logistics + or return scenarios. join_hint: table: tabCustomer 'on': pickup_customer = tabCustomer.name - name: pickup_supplier - description: '' + description: Supplier from whom goods are being picked up for inbound shipments + or direct procurement. join_hint: table: tabSupplier 'on': pickup_supplier = tabSupplier.name - name: pickup - description: '' + description: General pickup location or address where the shipment originates, + regardless of whether it's from a customer, supplier, or other entity. - name: pickup_address_name - description: '' + description: Name or label of the location where goods are collected from the + sender, such as warehouse name or facility identifier. join_hint: table: tabAddress 'on': pickup_address_name = tabAddress.name - name: pickup_address - description: '' + description: Full street address and location details where the shipment is physically + picked up from. - name: pickup_contact_person - description: '' + description: Name of the individual responsible for coordinating or authorizing + the pickup at the origin location. join_hint: table: tabUser 'on': pickup_contact_person = tabUser.name - name: pickup_contact_name - description: '' + description: Name of the person to contact at the pickup location for shipment + collection. join_hint: table: tabContact 'on': pickup_contact_name = tabContact.name - name: pickup_contact_email - description: '' + description: Email address of the person to contact at the pickup location for + shipment collection. - name: pickup_contact - description: '' + description: Primary contact identifier or phone number for the person handling + pickup at the origin location. - name: delivery_to_type - description: '' + description: Indicates whether the shipment is being delivered to a company, customer, + or other entity type. options: - Company - Customer - Supplier - name: delivery_company - description: '' + description: The company receiving the shipment when delivery_to_type is company. join_hint: table: tabCompany 'on': delivery_company = tabCompany.name - name: delivery_customer - description: '' + description: The customer receiving the shipment when delivery_to_type is customer. join_hint: table: tabCustomer 'on': delivery_customer = tabCustomer.name - name: delivery_supplier - description: '' + description: The carrier or logistics company responsible for transporting the + shipment. join_hint: table: tabSupplier 'on': delivery_supplier = tabSupplier.name - name: delivery_to - description: '' + description: The recipient customer or location receiving the shipment. - name: delivery_address_name - description: '' + description: The named location or site identifier where the shipment is being + delivered, distinct from the recipient entity. join_hint: table: tabAddress 'on': delivery_address_name = tabAddress.name - name: delivery_address - description: '' + description: Physical location where the shipment is being delivered to the customer + or recipient. - name: delivery_contact_name - description: '' + description: Name of the person receiving or responsible for accepting the shipment + at the delivery location. join_hint: table: tabContact 'on': delivery_contact_name = tabContact.name - name: delivery_contact_email - description: '' + description: Email address of the person receiving the shipment, used for delivery + notifications and coordination. - name: delivery_contact - description: '' + description: Person or contact information at the destination who receives or + signs for the shipment delivery. - name: shipment_parcel - description: '' + description: Individual package or parcel unit within a shipment, used when tracking + or counting specific boxes or containers. - name: parcel_template - description: '' + description: Predefined parcel configuration with standard dimensions, weight, + or packaging specifications applied to shipments. join_hint: table: tabShipment Parcel Template 'on': parcel_template = tabShipment Parcel Template.name - name: total_weight - description: '' + description: Combined weight of all items in the shipment, used when filtering + or analyzing shipments by weight capacity or shipping cost calculations. - name: shipment_delivery_note - description: '' + description: Special instructions or notes for the delivery driver or recipient + at the destination, referenced when users ask about delivery requirements or + handling instructions. - name: pallets - description: '' + description: Number of pallets used in the shipment, relevant for warehouse space + planning, loading dock scheduling, or LTL freight calculations. options: - 'No' - 'Yes' - name: value_of_goods - description: '' + description: Total monetary value of items being shipped, used when filtering + or analyzing shipments by cargo worth or insurance requirements. - name: pickup_date - description: '' + description: Date when the shipment was or will be collected from origin, used + for scheduling queries and pickup timeline analysis. - name: pickup_from - description: '' + description: Origin location or address where the shipment is collected, used + when searching by source warehouse, vendor location, or departure point. - name: pickup_to - description: '' + description: Identifies the destination or recipient location for pickup delivery, + used when tracking where picked-up goods are being transported to. - name: shipment_type - description: '' + description: Categorizes the shipment method or service level (e.g., express, + standard, freight), used when filtering shipments by delivery speed or transportation + mode. options: - Goods - Documents - name: pickup_type - description: '' + description: Defines how goods are collected from origin (e.g., scheduled, on-demand, + customer drop-off), used when analyzing pickup logistics and collection methods. options: - Pickup - Self delivery - name: incoterm - description: '' + description: International commercial terms defining buyer and seller responsibilities + for shipping costs, risk transfer, and delivery obligations (e.g., FOB, CIF, + DDP). join_hint: table: tabIncoterm 'on': incoterm = tabIncoterm.name - name: description_of_content - description: '' + description: Textual description of the goods or items being shipped in the shipment. - name: service_provider - description: '' + description: Carrier or logistics company responsible for transporting the shipment + (e.g., FedEx, DHL, Maersk). - name: shipment_id - description: '' + description: Unique identifier for referencing a specific shipment in queries + about tracking, status updates, or shipment details. - name: shipment_amount - description: '' + description: Total monetary value or cost of the shipment, used when filtering + or analyzing shipments by financial value. - name: status - description: '' + description: Current state of the shipment in its lifecycle, used when searching + for shipments by delivery stage or completion state. options: - Draft - Submitted @@ -25401,172 +31623,224 @@ tables: - Cancelled - Completed - name: tracking_url - description: '' + description: Web link to track the shipment's delivery status and location with + the carrier - name: carrier - description: '' + description: Shipping company or logistics provider handling the delivery such + as FedEx, UPS, or DHL - name: carrier_service - description: '' + description: Specific delivery service level or method used such as ground, overnight, + express, or standard shipping - name: awb_number - description: '' + description: Air waybill number used to identify and track air freight shipments + with carriers. - name: tracking_status - description: '' + description: Current status code or stage of the shipment in transit (e.g., in-transit, + delivered, pending). options: - In Progress - Delivered - Returned - Lost - name: tracking_status_info - description: '' + description: Detailed explanation or additional context about the current tracking + status, including reasons for delays or status changes. - name: amended_from - description: '' + description: References the original shipment record when this shipment was created + as a correction or amendment of a previous shipment. join_hint: table: tabShipment 'on': amended_from = tabShipment.name + desc_done: true - table: tabShipment Delivery Note description: '' fields: - name: name - description: '' + description: Unique identifier for the shipment delivery note record, used when + referencing specific delivery transactions or tracking shipment history. - name: delivery_note - description: '' + description: Links to the associated delivery note document, used when querying + which items were delivered or matching shipments to customer orders. join_hint: table: tabDelivery Note 'on': delivery_note = tabDelivery Note.name - name: grand_total - description: '' + description: Total value of the shipment including all charges, used when analyzing + shipment costs, revenue recognition, or financial reconciliation of deliveries. + desc_done: true - table: tabShipment Parcel description: '' fields: - name: name - description: '' + description: Unique identifier for the parcel used when tracking or referencing + specific packages in a shipment. - name: length - description: '' + description: Parcel length dimension used when calculating shipping costs, validating + carrier requirements, or optimizing container loading. - name: width - description: '' + description: Parcel width dimension used when calculating shipping costs, validating + carrier requirements, or optimizing container loading. - name: height - description: '' + description: Physical height dimension of the parcel used when users ask about + package size, dimensions, or shipping volume calculations - name: weight - description: '' + description: Physical weight of the parcel used when users ask about shipping + costs, weight limits, or freight calculations - name: count - description: '' + description: Number of parcels in the shipment used when users ask how many packages + or boxes are included in a shipment + desc_done: true - table: tabShipment Parcel Template description: '' fields: - name: name - description: '' + description: Unique identifier for the shipment parcel template record used when + referencing specific template configurations. - name: parcel_template_name - description: '' + description: Display name of the parcel template used when selecting standard + package dimensions for shipments. - name: length - description: '' + description: Physical length dimension of the parcel template used when calculating + shipping costs and validating package sizes. - name: width - description: '' + description: Physical width dimension of the parcel template used when users ask + about package size, shipping dimensions, or carrier requirements. - name: height - description: '' + description: Physical height dimension of the parcel template used when users + ask about package size, vertical clearance, or stacking constraints. - name: weight - description: '' + description: Standard weight specification for the parcel template used when users + ask about shipping costs, weight limits, or carrier restrictions. + desc_done: true - table: tabShipping Rule description: Specify conditions to calculate shipping amount fields: - name: name - description: '' + description: Unique identifier for the shipping rule used in technical queries + and system references - name: label - description: '' + description: Display name of the shipping rule shown to users when selecting or + viewing shipping options - name: disabled - description: '' + description: Indicates whether the shipping rule is currently inactive and unavailable + for use in transactions - name: shipping_rule_type - description: '' + description: Identifies the category or method of shipping rule such as price-based, + weight-based, or region-based conditions. options: - Selling - Buying - name: company - description: '' + description: The specific company entity to which this shipping rule applies when + operating in multi-company environments. join_hint: table: tabCompany 'on': company = tabCompany.name - name: account - description: '' + description: The general ledger account used to record shipping charges or revenue + when this shipping rule is applied to transactions. join_hint: table: tabAccount 'on': account = tabAccount.name - name: cost_center - description: '' + description: Cost center to which shipping charges should be allocated for accounting + purposes join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Project to which shipping charges should be allocated when shipping + is project-specific join_hint: table: tabProject 'on': project = tabProject.name - name: calculate_based_on - description: '' + description: Basis for calculating shipping charges such as net weight, gross + weight, net amount, or number of items options: - Fixed - Net Total - Net Weight - name: shipping_amount - description: '' + description: Cost or fee charged for shipping when this rule applies - name: conditions - description: '' + description: Criteria that must be met for this shipping rule to be triggered, + such as order value thresholds or product types - name: countries - description: '' + description: Geographic regions or nations where this shipping rule is valid and + applicable + desc_done: true - table: tabShipping Rule Condition description: A condition for a Shipping Rule fields: - name: name - description: '' + description: Unique identifier for the specific condition rule within the shipping + rule configuration - name: from_value - description: '' + description: Minimum threshold value that triggers this shipping rule condition - name: to_value - description: '' + description: Maximum threshold value that triggers this shipping rule condition - name: shipping_amount - description: '' + description: Threshold shipping cost value used to evaluate whether this shipping + rule condition is met for order routing or carrier selection. + desc_done: true - table: tabShipping Rule Country description: '' fields: - name: name - description: '' + description: Unique identifier for the shipping rule country record - name: country - description: '' + description: Country to which this shipping rule applies join_hint: table: tabCountry 'on': country = tabCountry.name + desc_done: true - table: tabSlack Webhook URL description: '' fields: - name: name - description: '' + description: Unique identifier or label for the Slack webhook configuration record - name: webhook_name - description: '' + description: Display name or friendly label assigned to the Slack webhook for + identification purposes - name: webhook_url - description: '' + description: The actual Slack webhook endpoint URL where messages and notifications + are sent - name: show_document_link - description: '' + description: Whether the Slack webhook message includes a clickable link to the + source document or record + desc_done: true - table: tabSocial Link Settings description: '' fields: - name: name - description: '' + description: Unique identifier or label for the social media link configuration - name: social_link_type - description: '' + description: Platform or service type of the social media link such as Facebook, + Twitter, LinkedIn, or Instagram options: - facebook - linkedin - twitter - email - name: color - description: '' + description: Display color or theme color associated with the social media link + for visual presentation - name: background_color - description: '' + description: Color used as the background for social media link displays or sharing + previews. + desc_done: true - table: tabSocial Login Key description: '' fields: - name: name - description: '' + description: name - name: enable_social_login - description: '' + description: Whether social login authentication is activated for this provider + configuration - name: social_login_provider - description: '' + description: The specific third-party authentication service (Google, Facebook, + GitHub, etc.) configured for user login options: - Custom - Facebook @@ -25578,79 +31852,103 @@ tables: - fairlogin - Keycloak - name: client_id - description: '' + description: OAuth application identifier issued by the social login provider + for authentication integration. - name: provider_name - description: '' + description: Name of the social authentication service such as Google, Facebook, + GitHub, or LinkedIn. - name: client_secret - description: '' + description: Confidential OAuth credential used to authenticate the application + with the social login provider. - name: icon - description: '' + description: Icon image or identifier representing the social login provider (e.g., + Facebook, Google, LinkedIn). - name: base_url - description: '' + description: Base URL endpoint for the social login provider's authentication + service. - name: sign_ups - description: '' + description: Number of user registrations or accounts created through this social + login provider. options: - Allow - Deny - name: authorize_url - description: '' + description: URL where users are redirected to authenticate with the social login + provider - name: access_token_url - description: '' + description: URL endpoint used to exchange authorization codes for access tokens + from the social login provider - name: redirect_url - description: '' + description: URL where the social login provider sends users back after authentication + is complete - name: api_endpoint - description: '' + description: URL or endpoint path for the social login provider's authentication + API. - name: custom_base_url - description: '' + description: Custom domain or base URL that overrides the default social login + provider URL. - name: api_endpoint_args - description: '' + description: Query parameters or arguments appended to the social login API endpoint + for authentication requests. - name: auth_url_data - description: '' + description: OAuth authorization URL and parameters for initiating social login + authentication flow - name: user_id_property - description: '' + description: Field name or property path used to extract the unique user identifier + from the social provider's response + desc_done: true - table: tabSouth Africa VAT Account description: '' fields: - name: name - description: '' + description: Descriptive label for the South Africa VAT account type used when + identifying or filtering VAT-related transactions and reporting requirements. - name: account - description: '' + description: General ledger account number linked to this South Africa VAT configuration + used when posting VAT amounts to the correct financial accounts. join_hint: table: tabAccount 'on': account = tabAccount.name + desc_done: true - table: tabSouth Africa VAT Settings description: '' fields: - name: name - description: '' + description: Unique identifier or label for the South Africa VAT settings configuration - name: company - description: '' + description: Company entity to which these South Africa VAT settings apply join_hint: table: tabCompany 'on': company = tabCompany.name - name: vat_accounts - description: '' + description: General ledger accounts designated for recording South Africa VAT + transactions and liabilities + desc_done: true - table: tabStock Entry description: '' fields: - name: name - description: '' + description: Unique identifier for the stock entry transaction - name: naming_series - description: '' + description: Prefix pattern used to generate stock entry document numbers options: - MAT-STE-.YYYY.- - name: stock_entry_type - description: '' + description: Category of stock movement such as material receipt, material issue, + material transfer, or manufacturing join_hint: table: tabStock Entry Type 'on': stock_entry_type = tabStock Entry Type.name - name: outgoing_stock_entry - description: '' + description: Links to the original stock entry when receiving materials that were + previously sent for transfer, useful for tracking material movement between + warehouses. join_hint: table: tabStock Entry 'on': outgoing_stock_entry = tabStock Entry.name - name: purpose - description: '' + description: Defines the transaction type such as Material Receipt, Material Issue, + Material Transfer, Manufacture, or Repack to categorize the stock movement. options: - Material Issue - Material Receipt @@ -25662,339 +31960,435 @@ tables: - Send to Subcontractor - Disassemble - name: add_to_transit - description: '' + description: Indicates whether materials are placed in a transit warehouse during + inter-warehouse transfers rather than directly moving to the target warehouse. - name: work_order - description: '' + description: Manufacturing or production order that this stock entry fulfills + or consumes materials for. join_hint: table: tabWork Order 'on': work_order = tabWork Order.name - name: purchase_order - description: '' + description: Purchase order linked to this stock entry when receiving purchased + goods into inventory. join_hint: table: tabPurchase Order 'on': purchase_order = tabPurchase Order.name - name: subcontracting_order - description: '' + description: Subcontracting purchase order where materials are sent to a subcontractor + or finished goods are received back. join_hint: table: tabSubcontracting Order 'on': subcontracting_order = tabSubcontracting Order.name - name: delivery_note_no - description: '' + description: Reference to the delivery note document associated with this stock + movement, used when tracking shipments or goods delivered to customers. join_hint: table: tabDelivery Note 'on': delivery_note_no = tabDelivery Note.name - name: sales_invoice_no - description: '' + description: Reference to the sales invoice document linked to this stock transaction, + used when connecting inventory movements to customer billing. join_hint: table: tabSales Invoice 'on': sales_invoice_no = tabSales Invoice.name - name: pick_list - description: '' + description: Reference to the pick list document used for warehouse picking operations, + relevant when tracking which items were selected from inventory for fulfillment. join_hint: table: tabPick List 'on': pick_list = tabPick List.name - name: purchase_receipt_no - description: '' + description: Reference to the purchase receipt document when stock entry is linked + to incoming purchased goods join_hint: table: tabPurchase Receipt 'on': purchase_receipt_no = tabPurchase Receipt.name - name: asset_repair - description: '' + description: Links stock entry to a specific asset repair job when materials are + issued or consumed for fixing assets join_hint: table: tabAsset Repair 'on': asset_repair = tabAsset Repair.name - name: company - description: '' + description: The company entity that owns or records this stock movement transaction join_hint: table: tabCompany 'on': company = tabCompany.name - name: posting_date - description: '' + description: Date when the stock entry transaction is recorded in the ledger for + accounting and inventory valuation purposes. - name: posting_time - description: '' + description: Time when the stock entry transaction is recorded in the ledger for + accounting and inventory valuation purposes. - name: set_posting_time - description: '' + description: Indicates whether the posting date and time were manually specified + instead of using the current timestamp. - name: inspection_required - description: '' + description: Indicates whether incoming materials need quality inspection before + acceptance into inventory. - name: apply_putaway_rule - description: '' + description: Determines if automated warehouse location assignment rules should + be applied when receiving stock. - name: from_bom - description: '' + description: Indicates the stock entry was generated from a Bill of Materials + for manufacturing or production purposes. - name: use_multi_level_bom - description: '' + description: Indicates whether the stock entry processes materials through multiple + levels of bill of materials instead of a single-level BOM. - name: bom_no - description: '' + description: The bill of materials identifier used for this stock entry, relevant + when manufacturing or material planning is involved. join_hint: table: tabBOM 'on': bom_no = tabBOM.name - name: fg_completed_qty - description: '' + description: The quantity of finished goods completed in this stock entry, used + when tracking manufacturing output. - name: process_loss_percentage - description: '' + description: Percentage of material lost during manufacturing or processing operations, + used when analyzing production efficiency or waste rates. - name: process_loss_qty - description: '' + description: Actual quantity of material lost during manufacturing or processing + operations, used when calculating total waste or scrap amounts. - name: from_warehouse - description: '' + description: Source warehouse from which stock is being transferred or issued, + used when tracking material movement origins. join_hint: table: tabWarehouse 'on': from_warehouse = tabWarehouse.name - name: source_warehouse_address - description: '' + description: Address link of the warehouse from which stock is being transferred + or issued. join_hint: table: tabAddress 'on': source_warehouse_address = tabAddress.name - name: source_address_display - description: '' + description: Formatted full address text of the source warehouse for display and + reporting purposes. - name: to_warehouse - description: '' + description: Destination warehouse receiving stock in transfer, receipt, or manufacturing + operations. join_hint: table: tabWarehouse 'on': to_warehouse = tabWarehouse.name - name: target_warehouse_address - description: '' + description: Destination warehouse location details for material transfers or + stock movements. join_hint: table: tabAddress 'on': target_warehouse_address = tabAddress.name - name: target_address_display - description: '' + description: Formatted display version of the destination warehouse address for + stock transfers. - name: scan_barcode - description: '' + description: Barcode value scanned to quickly identify and add items to the stock + entry. - name: last_scanned_warehouse - description: '' + description: Warehouse most recently scanned during stock entry processing, relevant + for tracking scan sequence in mobile or barcode workflows. - name: items - description: '' + description: Line items in the stock entry detailing individual materials, quantities, + and warehouses being transferred or adjusted. - name: total_outgoing_value - description: '' + description: Total monetary value of inventory leaving the source warehouse in + this stock entry transaction. - name: total_incoming_value - description: '' + description: Total value of items received or transferred into stock before additional + costs are applied. - name: value_difference - description: '' + description: Difference between incoming and outgoing stock values, used to identify + gains or losses during stock transfers or revaluations. - name: additional_costs - description: '' + description: Extra costs like freight, taxes, or handling charges added to the + stock entry beyond the base item value. - name: total_additional_costs - description: '' + description: Sum of all additional costs like freight, insurance, or handling + charges added to the stock entry beyond item costs. - name: supplier - description: '' + description: Supplier ID or code from whom materials are being received in this + stock entry. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: supplier_name - description: '' + description: Full name of the supplier providing materials for this stock entry. - name: supplier_address - description: '' + description: Supplier's address when stock entry involves material received from + or returned to a supplier join_hint: table: tabAddress 'on': supplier_address = tabAddress.name - name: address_display - description: '' + description: Formatted display address for the stock entry location or party involved - name: project - description: '' + description: Project associated with this stock movement for tracking project-specific + inventory consumption or allocation join_hint: table: tabProject 'on': project = tabProject.name - name: select_print_heading - description: '' + description: Custom heading text that appears on printed stock entry documents + instead of the default title. join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: letter_head - description: '' + description: Company letterhead template applied when printing this stock entry + document. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: is_opening - description: '' + description: Indicates this stock entry records opening balances for inventory + items at the start of accounting. options: - 'No' - 'Yes' - name: remarks - description: '' + description: Additional notes or comments about the stock entry transaction - name: per_transferred - description: '' + description: Percentage of stock quantity that has been transferred to the target + location - name: total_amount - description: '' + description: Total monetary value of all items in the stock entry - name: job_card - description: '' + description: Reference to the job card or work order that this stock entry is + fulfilling or consuming materials for. join_hint: table: tabJob Card 'on': job_card = tabJob Card.name - name: amended_from - description: '' + description: Reference to the original stock entry document that this entry is + correcting or replacing after amendment. join_hint: table: tabStock Entry 'on': amended_from = tabStock Entry.name - name: credit_note - description: '' + description: Link to the credit note document when this stock entry is created + to return goods against a credit note. join_hint: table: tabJournal Entry 'on': credit_note = tabJournal Entry.name - name: is_return - description: '' + description: Indicates whether this stock entry represents a return transaction + of previously issued or transferred materials. + desc_done: true - table: tabStock Entry Detail description: '' fields: - name: name - description: '' + description: Unique identifier for the stock entry detail line item - name: barcode - description: '' + description: Barcode scanned or entered for the item in this stock entry line - name: has_item_scanned - description: '' + description: Indicates whether the item was added to this stock entry line by + scanning a barcode - name: s_warehouse - description: '' + description: Source warehouse from which stock is being transferred or issued + in the stock entry transaction. join_hint: table: tabWarehouse 'on': s_warehouse = tabWarehouse.name - name: t_warehouse - description: '' + description: Target warehouse to which stock is being received or transferred + in the stock entry transaction. join_hint: table: tabWarehouse 'on': t_warehouse = tabWarehouse.name - name: item_code - description: '' + description: Identifier of the specific item or product being moved, transferred, + or adjusted in this stock entry line. join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Name of the item being transferred, consumed, or manufactured in + the stock entry transaction. - name: is_finished_item - description: '' + description: Indicates whether this item is the final manufactured product output + in a manufacturing stock entry. - name: is_scrap_item - description: '' + description: Indicates whether this item represents waste or scrap material generated + during the manufacturing process. - name: quality_inspection - description: '' + description: References the quality inspection record linked to this stock entry + line item for tracking inspection results and compliance. join_hint: table: tabQuality Inspection 'on': quality_inspection = tabQuality Inspection.name - name: subcontracted_item - description: '' + description: Identifies the finished item code received back from a subcontractor + in subcontracting stock entries. join_hint: table: tabItem 'on': subcontracted_item = tabItem.name - name: description - description: '' + description: Contains the detailed text description or specifications of the item + being transferred, manufactured, or adjusted in this stock entry line. - name: item_group - description: '' + description: Category or classification of the item being transferred or consumed + in the stock entry. - name: image_view - description: '' + description: Visual representation or photo of the item in the stock entry line. - name: qty - description: '' + description: Quantity of the item being moved, consumed, or manufactured in this + stock entry transaction. - name: transfer_qty - description: '' + description: Quantity being transferred in the base unit of measure, used when + asking about actual stock movement amounts in standardized units. - name: retain_sample - description: '' + description: Indicates whether a sample is kept from this stock entry line, used + when filtering for quality control or sample retention requirements. - name: uom - description: '' + description: Unit of measure for the item in this stock entry line, used when + specifying or filtering by measurement units like kg, pieces, or liters. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: stock_uom - description: '' + description: Unit of measurement for inventory tracking and stock balance calculations + in the warehouse system. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert between transaction UOM and stock UOM for quantity + calculations. - name: sample_quantity - description: '' + description: Quantity of items set aside or allocated for quality testing, inspection, + or demonstration purposes. - name: basic_rate - description: '' + description: Base price per unit of the item before any additional costs or adjustments + are applied. - name: additional_cost - description: '' + description: Extra costs added per unit beyond the basic rate, such as freight, + handling, or processing charges. - name: valuation_rate - description: '' + description: Final total rate per unit used for inventory valuation, combining + basic rate and additional costs. - name: allow_zero_valuation_rate - description: '' + description: Indicates whether this stock entry line item permits items with zero + valuation, relevant when querying transfers of non-valued or sample items. - name: set_basic_rate_manually - description: '' + description: Indicates whether the basic rate was manually entered rather than + auto-calculated, useful for identifying user-overridden pricing in stock movements. - name: basic_amount - description: '' + description: The base value of the item before additional charges or taxes in + this stock entry line, used for calculating total stock movement value. - name: amount - description: '' + description: Total monetary value of the stock entry line item, used when querying + transaction values or financial impact of stock movements. - name: use_serial_batch_fields - description: '' + description: Indicates whether this stock entry line uses serial number or batch + tracking, relevant when filtering items with lot-level traceability. - name: serial_and_batch_bundle - description: '' + description: Reference to the bundled serial numbers and batch numbers for this + stock entry line, used when tracking specific lot identities in inventory movements. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: serial_no - description: '' + description: Unique identifier for individually tracked items in the stock movement, + used when querying specific serialized inventory units. - name: batch_no - description: '' + description: Identifier for items grouped by production or purchase batch, used + when tracking inventory by lot or expiration date. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: expense_account - description: '' + description: General ledger account charged for stock consumption or write-offs, + used when analyzing costs of materials issued or scrapped. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: cost_center - description: '' + description: Accounting dimension to allocate stock movement expenses for this + line item. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Links this stock movement line to a specific project for tracking + project-related inventory transactions. join_hint: table: tabProject 'on': project = tabProject.name - name: actual_qty - description: '' + description: Physical quantity of the item in the warehouse after this stock entry + transaction is completed. - name: transferred_qty - description: '' + description: Quantity of items actually transferred or moved in this stock entry + line. - name: bom_no - description: '' + description: Bill of Materials reference number linked to this stock entry detail + for manufacturing operations. join_hint: table: tabBOM 'on': bom_no = tabBOM.name - name: allow_alternative_item - description: '' + description: Indicates whether substitute or alternative items can be used in + place of the specified item. - name: material_request - description: '' + description: Links this stock entry line to the material request document that + triggered or authorized the stock movement. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: material_request_item - description: '' + description: Links to the specific line item within the material request that + this stock entry fulfills. join_hint: table: tabMaterial Request Item 'on': material_request_item = tabMaterial Request Item.name - name: original_item - description: '' + description: Stores the initial item code before any item substitution or replacement + occurred during stock entry processing. join_hint: table: tabItem 'on': original_item = tabItem.name - name: against_stock_entry - description: '' + description: References the original stock entry being reversed, returned, or + adjusted by this transaction. join_hint: table: tabStock Entry 'on': against_stock_entry = tabStock Entry.name - name: ste_detail - description: '' + description: Links to another stock entry detail line when transferring or matching + items between stock entries. - name: po_detail - description: '' + description: Links this stock receipt or material transfer to the specific purchase + order line item being fulfilled. - name: sco_rm_detail - description: '' + description: Links to subcontracting raw material details when this stock entry + transfers materials to a subcontractor. - name: putaway_rule - description: '' + description: Identifies the warehouse putaway rule applied to determine the destination + location for incoming stock. join_hint: table: tabPutaway Rule 'on': putaway_rule = tabPutaway Rule.name - name: reference_purchase_receipt - description: '' + description: Links to the original purchase receipt document when this stock entry + is created from or relates to a goods receipt. join_hint: table: tabPurchase Receipt 'on': reference_purchase_receipt = tabPurchase Receipt.name - name: job_card_item - description: '' + description: Item code or name associated with the job card for which this stock + entry is being made, used when tracking material consumption or production for + specific manufacturing jobs. + desc_done: true - table: tabStock Entry Type description: '' fields: - name: name - description: '' + description: Unique identifier for the stock entry type such as Material Issue, + Material Receipt, or Material Transfer - name: purpose - description: '' + description: Business reason or use case for this stock entry type such as manufacturing + consumption, sales return, or warehouse replenishment options: - Material Issue - Material Receipt @@ -26006,234 +32400,305 @@ tables: - Send to Subcontractor - Disassemble - name: add_to_transit - description: '' + description: Whether this stock entry type creates in-transit inventory between + source and target warehouses during material transfer - name: is_standard - description: '' + description: Indicates whether this stock entry type is a predefined system type + versus a custom user-created type. + desc_done: true - table: tabStock Ledger Entry description: '' fields: - name: name - description: '' + description: Unique identifier for the specific stock ledger entry transaction + record - name: item_code - description: '' + description: Product or material identifier for which stock movement is being + recorded join_hint: table: tabItem 'on': item_code = tabItem.name - name: warehouse - description: '' + description: Storage location where the stock movement or balance change occurred join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: posting_date - description: '' + description: Date when the stock transaction was officially recorded in the ledger + for accounting and inventory valuation purposes. - name: posting_time - description: '' + description: Time of day when the stock transaction was officially recorded, used + for precise chronological ordering within the same date. - name: posting_datetime - description: '' + description: Combined date and time timestamp of when the stock transaction was + officially recorded, used for exact chronological sequencing of all stock movements. - name: is_adjustment_entry - description: '' + description: Indicates whether this stock ledger entry was created through a stock + reconciliation or adjustment process rather than a regular transaction. - name: auto_created_serial_and_batch_bundle - description: '' + description: Indicates whether the serial number and batch bundle was automatically + generated by the system during this stock transaction. - name: voucher_type - description: '' + description: The document type that created this stock movement, such as Purchase + Receipt, Delivery Note, Stock Entry, or Sales Invoice. join_hint: table: tabDocType 'on': voucher_type = tabDocType.name - name: voucher_no - description: '' + description: Identifier of the transaction document (e.g., purchase receipt, delivery + note, stock entry) that created this stock movement. - name: voucher_detail_no - description: '' + description: Identifier of the specific line item within the voucher document + that caused this stock ledger entry. - name: serial_and_batch_bundle - description: '' + description: Reference to grouped serial numbers or batch numbers associated with + this stock transaction. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: dependant_sle_voucher_detail_no - description: '' + description: Links to the voucher detail number of a dependent stock transaction + that triggered or relies on this ledger entry. - name: recalculate_rate - description: '' + description: Indicates whether the valuation rate should be recalculated for this + stock transaction, typically used when correcting or adjusting inventory valuations. - name: actual_qty - description: '' + description: The physical quantity change in stock units for this transaction, + positive for receipts and negative for issues or consumption. - name: qty_after_transaction - description: '' + description: Remaining stock quantity after this transaction was applied, used + to check current or historical inventory levels at a point in time. - name: incoming_rate - description: '' + description: Valuation rate per unit for stock received or produced, used to calculate + the value of incoming inventory. - name: outgoing_rate - description: '' + description: Valuation rate per unit for stock issued or consumed, used to calculate + the value of outgoing inventory and cost of goods sold. - name: valuation_rate - description: '' + description: Price per unit used to calculate inventory value at the time of the + stock transaction. - name: stock_value - description: '' + description: Total monetary value of the stock quantity after this transaction. - name: stock_value_difference - description: '' + description: Change in total inventory value caused by this specific stock movement. - name: stock_queue - description: '' + description: FIFO or moving average queue tracking batch-wise stock valuation + and quantity for inventory costing calculations. - name: company - description: '' + description: Company entity that owns this stock transaction for multi-company + inventory segregation. join_hint: table: tabCompany 'on': company = tabCompany.name - name: stock_uom - description: '' + description: Base unit of measurement for the item's stock quantity as defined + in the item master. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: project - description: '' + description: Links inventory transaction to a specific project for project-based + inventory tracking and costing. join_hint: table: tabProject 'on': project = tabProject.name - name: fiscal_year - description: '' + description: The accounting fiscal year period when the inventory transaction + occurred or is recorded. - name: has_batch_no - description: '' + description: Indicates whether the item in this stock transaction is tracked using + batch numbers for lot traceability. - name: has_serial_no - description: '' + description: Indicates whether the stock item in this transaction is tracked by + serial numbers. - name: is_cancelled - description: '' + description: Indicates whether this stock ledger entry has been cancelled or reversed. - name: to_rename - description: '' + description: Indicates this entry is marked for renaming during item or warehouse + name changes. - name: serial_no - description: '' + description: Unique identifier for individually tracked items, used when querying + specific unit-level inventory movements or warranty tracking. - name: batch_no - description: '' + description: Identifier for groups of items manufactured or received together, + used when querying inventory by production lot or expiration date. + desc_done: true - table: tabStock Reconciliation description: This tool helps you to update or fix the quantity and valuation of stock in the system. It is typically used to synchronise the system values and what actually exists in your warehouses. fields: - name: name - description: '' + description: Unique identifier for the stock reconciliation transaction - name: naming_series - description: '' + description: Prefix pattern used to generate the stock reconciliation name options: - MAT-RECO-.YYYY.- - name: company - description: '' + description: Company entity for which the stock reconciliation is being performed join_hint: table: tabCompany 'on': company = tabCompany.name - name: purpose - description: '' + description: Reason or explanation for why the stock reconciliation was performed, + such as physical inventory count, damaged goods adjustment, or opening stock + entry. options: - Opening Stock - Stock Reconciliation - name: posting_date - description: '' + description: Date when the stock reconciliation transaction is recorded in the + accounting ledger and affects inventory valuation. - name: posting_time - description: '' + description: Time of day when the stock reconciliation was posted to the system. - name: set_posting_time - description: '' + description: Indicates whether the reconciliation uses a custom posting date and + time instead of the current timestamp. - name: set_warehouse - description: '' + description: Indicates whether a single warehouse is applied to all items in the + reconciliation instead of individual warehouse assignments. join_hint: table: tabWarehouse 'on': set_warehouse = tabWarehouse.name - name: scan_barcode - description: '' + description: Field for scanning item barcodes to quickly add items to the stock + reconciliation. - name: last_scanned_warehouse - description: '' + description: Warehouse location most recently scanned during the stock reconciliation + process. - name: scan_mode - description: '' + description: Method used to capture inventory data during reconciliation, such + as barcode scanning or manual entry. - name: items - description: '' + description: List of inventory items included in this stock reconciliation with + their counted quantities and variances. - name: expense_account - description: '' + description: Account where stock valuation differences or discrepancies are posted + as expenses during reconciliation. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: difference_amount - description: '' + description: Total monetary value of stock discrepancies found between system + records and physical count. - name: amended_from - description: '' + description: Reference to the original stock reconciliation document that this + record corrects or replaces. join_hint: table: tabStock Reconciliation 'on': amended_from = tabStock Reconciliation.name - name: cost_center - description: '' + description: Cost center assigned to the stock reconciliation for accounting and + expense allocation purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name + desc_done: true - table: tabStock Reconciliation Item description: '' fields: - name: name - description: '' + description: Stock reconciliation item identifier or code used to reference a + specific line item in the reconciliation process - name: barcode - description: '' + description: Barcode scanned or entered for the item being reconciled to match + physical inventory - name: has_item_scanned - description: '' + description: Indicates whether the item was added to reconciliation via barcode + scanning rather than manual entry - name: item_code - description: '' + description: Unique identifier for the inventory item being reconciled in the + stock reconciliation. join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Display name of the inventory item being reconciled, used when searching + by product name rather than code. - name: item_group - description: '' + description: Category or classification of the item being reconciled, used for + filtering reconciliations by product type or family. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: warehouse - description: '' + description: Warehouse location where the stock reconciliation adjustment is being + made join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: qty - description: '' + description: Adjusted quantity of the item after stock reconciliation - name: valuation_rate - description: '' + description: Per-unit inventory value used to calculate the total value of reconciled + stock - name: amount - description: '' + description: Total monetary value of the stock reconciliation item, used when + querying the financial impact or value of inventory adjustments. - name: allow_zero_valuation_rate - description: '' + description: Indicates whether this item can have a zero valuation rate during + reconciliation, relevant when filtering items with special valuation handling. - name: use_serial_batch_fields - description: '' + description: Indicates whether this item uses serial number or batch tracking + fields, relevant when querying items requiring lot or serial number management. - name: reconcile_all_serial_batch - description: '' + description: Indicates whether all serial numbers and batch numbers should be + reconciled for this item, used when users want to update all tracked units at + once. - name: serial_and_batch_bundle - description: '' + description: The target serial and batch bundle after reconciliation, representing + the desired final state of serial/batch inventory for this item. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: current_serial_and_batch_bundle - description: '' + description: The existing serial and batch bundle before reconciliation, representing + the current state of serial/batch inventory being adjusted. join_hint: table: tabSerial and Batch Bundle 'on': current_serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: serial_no - description: '' + description: Unique identifier for individually tracked items in stock reconciliation, + used when querying specific serialized inventory units. - name: batch_no - description: '' + description: Batch or lot number for grouped inventory items in stock reconciliation, + used when querying stock by manufacturing batch or expiry grouping. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: current_qty - description: '' + description: Existing quantity in system before reconciliation adjustment, used + when comparing actual physical count versus recorded stock levels. - name: current_amount - description: '' + description: The existing stock amount in the system before reconciliation adjustments + are applied. - name: current_valuation_rate - description: '' + description: The existing valuation rate per unit in the system before reconciliation + adjustments are applied. - name: current_serial_no - description: '' + description: The existing serial numbers assigned to items in the system before + reconciliation adjustments are applied. - name: quantity_difference - description: '' + description: Difference between actual counted quantity and system quantity for + a stock item during reconciliation. - name: amount_difference - description: '' + description: Monetary value difference between actual counted stock value and + system stock value during reconciliation. + desc_done: true - table: tabStock Reposting Settings description: '' fields: - name: name - description: '' + description: Unique identifier for the stock reposting settings configuration - name: limit_reposting_timeslot - description: '' + description: Whether stock reposting is restricted to specific time windows - name: start_time - description: '' + description: Time when the allowed stock reposting window begins - name: end_time - description: '' + description: Time when stock reposting process completed or is scheduled to end. - name: limits_dont_apply_on - description: '' + description: Transactions or document types excluded from reposting limits and + restrictions. options: - Monday - Tuesday @@ -26243,80 +32708,99 @@ tables: - Saturday - Sunday - name: item_based_reposting - description: '' + description: Whether stock reposting is performed separately for each individual + item rather than in bulk. - name: notify_reposting_error_to_role - description: '' + description: Role that receives notifications when stock reposting processes encounter + errors or failures. join_hint: table: tabRole 'on': notify_reposting_error_to_role = tabRole.name + desc_done: true - table: tabStock Reservation Entry description: '' fields: - name: name - description: '' + description: Unique identifier for the stock reservation entry - name: item_code - description: '' + description: Product or material being reserved from available stock join_hint: table: tabItem 'on': item_code = tabItem.name - name: warehouse - description: '' + description: Storage location where the reserved stock is held join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: has_serial_no - description: '' + description: Indicates whether the reserved stock item is tracked by individual + serial numbers. - name: has_batch_no - description: '' + description: Indicates whether the reserved stock item is tracked by batch numbers + for lot control. - name: voucher_type - description: '' + description: The document type that created this stock reservation, such as Sales + Order or Work Order. options: - Sales Order - name: voucher_no - description: '' + description: Identifies the specific voucher document that created or is linked + to this stock reservation. - name: voucher_detail_no - description: '' + description: Identifies the specific line item or detail row within the voucher + that this stock reservation corresponds to. - name: from_voucher_type - description: '' + description: Indicates the type of source document that originated this stock + reservation, such as Sales Order, Work Order, or Material Request. options: - Pick List - Purchase Receipt - name: from_voucher_no - description: '' + description: Source document number that created or triggered this stock reservation, + used to trace reservations back to sales orders, work orders, or other originating + transactions. - name: from_voucher_detail_no - description: '' + description: Line item number within the source document that this reservation + corresponds to, used to identify which specific product line triggered the reservation. - name: stock_uom - description: '' + description: Unit of measurement for the reserved stock quantity, used when querying + reservations in base inventory units rather than transaction units. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: available_qty - description: '' + description: Quantity available for reservation after accounting for existing + reservations and stock levels. - name: voucher_qty - description: '' + description: Quantity specified in the source document or voucher that triggered + this reservation entry. - name: reserved_qty - description: '' + description: Quantity currently reserved and allocated for this specific transaction + or order. - name: delivered_qty - description: '' + description: Quantity that has been physically delivered against this stock reservation. - name: reservation_based_on - description: '' + description: Source document type that triggered the stock reservation such as + Sales Order or Work Order. options: - Qty - Serial and Batch - name: sb_entries - description: '' + description: Serial and batch number entries linked to this stock reservation + for tracking individual units or batches. - name: company - description: '' + description: Company entity that owns or is associated with this stock reservation join_hint: table: tabCompany 'on': company = tabCompany.name - name: project - description: '' + description: Project for which inventory items are reserved or allocated join_hint: table: tabProject 'on': project = tabProject.name - name: status - description: '' + description: Current state of the stock reservation such as draft, active, delivered, + or cancelled options: - Draft - Partially Reserved @@ -26325,313 +32809,408 @@ tables: - Delivered - Cancelled - name: amended_from - description: '' + description: Links to the original stock reservation entry that this entry amends + or corrects. join_hint: table: tabStock Reservation Entry 'on': amended_from = tabStock Reservation Entry.name + desc_done: true - table: tabStock Settings description: Default settings for your stock-related transactions fields: - name: name - description: '' + description: Unique identifier for the stock settings configuration - name: item_naming_by - description: '' + description: Determines whether items are identified by item code, item name, + or naming series in stock transactions options: - Item Code - Naming Series - name: valuation_method - description: '' + description: Default inventory costing method such as FIFO, LIFO, or moving average + used for stock valuation options: - FIFO - Moving Average - LIFO - name: item_group - description: '' + description: Product category or classification used when filtering or grouping + inventory items by type join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: default_warehouse - description: '' + description: Primary storage location automatically assigned for stock transactions + when no specific warehouse is specified join_hint: table: tabWarehouse 'on': default_warehouse = tabWarehouse.name - name: sample_retention_warehouse - description: '' + description: Dedicated storage location for holding quality control or testing + samples separate from regular inventory join_hint: table: tabWarehouse 'on': sample_retention_warehouse = tabWarehouse.name - name: stock_uom - description: '' + description: Default unit of measurement for inventory items when no specific + UOM is defined join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: auto_insert_price_list_rate_if_missing - description: '' + description: Whether to automatically add item prices to price lists when they + don't exist - name: update_price_list_based_on - description: '' + description: Source basis for automatically updating price list rates such as + last purchase price or valuation rate options: - Rate - Price List Rate - name: update_existing_price_list_rate - description: '' + description: Whether price list rates are automatically updated when item prices + change in stock transactions. - name: allow_to_edit_stock_uom_qty_for_sales - description: '' + description: Whether users can manually modify stock unit of measure quantities + during sales transactions instead of using conversion factors. - name: allow_to_edit_stock_uom_qty_for_purchase - description: '' + description: Whether users can manually modify stock unit of measure quantities + during purchase transactions instead of using conversion factors. - name: allow_uom_with_conversion_rate_defined_in_item - description: '' + description: Whether units of measure with conversion rates defined at the item + level are permitted in stock transactions. - name: over_delivery_receipt_allowance - description: '' + description: Percentage threshold for accepting delivery receipts that exceed + the ordered quantity. - name: mr_qty_allowance - description: '' + description: Percentage tolerance for material request quantities to exceed or + fall short of planned amounts. - name: over_picking_allowance - description: '' + description: Percentage threshold that allows picking more items than ordered + in sales or delivery transactions. - name: role_allowed_to_over_deliver_receive - description: '' + description: User role permitted to exceed standard delivery or receipt quantities + beyond configured limits. join_hint: table: tabRole 'on': role_allowed_to_over_deliver_receive = tabRole.name - name: allow_negative_stock - description: '' + description: Whether inventory can go below zero, enabling sales or issues without + available stock. - name: show_barcode_field - description: '' + description: Controls whether barcode input fields are displayed in stock transactions + and item forms. - name: clean_description_html - description: '' + description: Removes HTML formatting from item descriptions when displaying or + printing stock documents. - name: allow_internal_transfer_at_arms_length_price - description: '' + description: Permits stock transfers between company entities to use market-rate + pricing instead of cost price for transfer pricing compliance. - name: allow_existing_serial_no - description: '' + description: Whether the system permits reusing serial numbers that already exist + in inventory transactions. - name: do_not_use_batchwise_valuation - description: '' + description: Whether inventory valuation is calculated at item level instead of + separately for each batch. - name: auto_create_serial_and_batch_bundle_for_outward - description: '' + description: Whether serial and batch bundles are automatically generated when + items leave inventory in outward transactions. - name: pick_serial_and_batch_based_on - description: '' + description: Determines the default selection criteria (FIFO, LIFO, expiry date) + for automatically picking serial numbers and batch numbers during stock transactions. options: - FIFO - LIFO - Expiry - name: disable_serial_no_and_batch_selector - description: '' + description: Controls whether the interactive selector interface for choosing + serial numbers and batches is turned off, forcing manual entry or automatic + selection. - name: use_serial_batch_fields - description: '' + description: Enables dedicated fields for serial and batch number entry in stock + transactions instead of using the selector interface. - name: do_not_update_serial_batch_on_creation_of_auto_bundle - description: '' + description: Controls whether serial numbers and batch numbers are automatically + updated when auto-bundling inventory items during transactions. - name: set_serial_and_batch_bundle_naming_based_on_naming_series - description: '' + description: Determines if serial and batch bundle identifiers follow the configured + naming series pattern instead of default naming. - name: use_naming_series - description: '' + description: Enables automatic sequential naming for stock-related documents using + predefined prefix and number patterns. - name: naming_series_prefix - description: '' + description: Prefix used when generating automatic stock transaction document + numbers - name: enable_stock_reservation - description: '' + description: Controls whether inventory can be reserved for future orders or transactions + before actual delivery - name: allow_partial_reservation - description: '' + description: Controls whether orders can reserve less inventory than requested + when full quantity is unavailable - name: auto_reserve_stock_for_sales_order_on_purchase - description: '' + description: Whether stock is automatically reserved for sales orders when purchase + orders are created or received. - name: auto_reserve_serial_and_batch - description: '' + description: Whether serialized or batched items are automatically reserved during + stock transactions. - name: action_if_quality_inspection_is_not_submitted - description: '' + description: What happens when quality inspection is required but not completed + for stock receipts or deliveries. options: - Stop - Warn - name: action_if_quality_inspection_is_rejected - description: '' + description: Defines what happens when incoming materials fail quality inspection, + such as rejecting the purchase receipt or blocking stock entry. options: - Stop - Warn - name: allow_to_make_quality_inspection_after_purchase_or_delivery - description: '' + description: Controls whether quality checks can be performed after goods have + already been received or delivered instead of requiring inspection before acceptance. - name: auto_indent - description: '' + description: Automatically creates material requests or purchase orders when stock + falls below reorder levels without manual intervention. - name: reorder_email_notify - description: '' + description: Whether email notifications are sent when stock reaches reorder level + or triggers replenishment alerts. - name: allow_from_dn - description: '' + description: Whether stock transactions can be created or sourced from delivery + notes. - name: allow_from_pr - description: '' + description: Whether stock transactions can be created or sourced from purchase + receipts. - name: stock_frozen_upto - description: '' + description: Date until which stock transactions are frozen and cannot be modified + or created, used when asking about stock freeze cutoff dates or locked periods. - name: stock_frozen_upto_days - description: '' + description: Number of days from today that stock transactions are frozen, used + when asking about the duration or length of the stock freeze period. - name: role_allowed_to_create_edit_back_dated_transactions - description: '' + description: User role permitted to create or modify stock transactions with dates + in frozen periods, used when asking about permissions for backdated entries + or overriding stock freezes. join_hint: table: tabRole 'on': role_allowed_to_create_edit_back_dated_transactions = tabRole.name - name: stock_auth_role - description: '' + description: Role required to authorize or approve stock transactions and inventory + movements. join_hint: table: tabRole 'on': stock_auth_role = tabRole.name + desc_done: true - table: tabSub Operation description: '' fields: - name: name - description: '' + description: Unique identifier or label for the sub-operation used when referencing + specific manufacturing steps or tasks. - name: operation - description: '' + description: Parent operation or process that this sub-operation belongs to, used + when analyzing hierarchical production workflows. join_hint: table: tabOperation 'on': operation = tabOperation.name - name: time_in_mins - description: '' + description: Duration in minutes required to complete this sub-operation, used + when calculating total cycle times and production capacity. - name: description - description: '' + description: Detailed explanation or notes about the sub-operation's purpose, + process, or specifications + desc_done: true - table: tabSubcontracting BOM description: '' fields: - name: name - description: '' + description: Unique identifier for the subcontracting bill of materials record - name: is_active - description: '' + description: Indicates whether this subcontracting BOM is currently enabled and + available for use in production - name: finished_good - description: '' + description: The final product item that will be manufactured through this subcontracting + process join_hint: table: tabItem 'on': finished_good = tabItem.name - name: finished_good_qty - description: '' + description: Quantity of the finished good item produced from the subcontracting + bill of materials. - name: finished_good_uom - description: '' + description: Unit of measurement for the finished good quantity in the subcontracting + BOM. join_hint: table: tabUOM 'on': finished_good_uom = tabUOM.name - name: finished_good_bom - description: '' + description: Bill of materials reference for the finished good item that will + be manufactured by the subcontractor. join_hint: table: tabBOM 'on': finished_good_bom = tabBOM.name - name: service_item - description: '' + description: The specific service item code or name that will be provided by the + subcontractor as part of the subcontracting work. join_hint: table: tabItem 'on': service_item = tabItem.name - name: service_item_qty - description: '' + description: The quantity of the service item to be delivered or performed by + the subcontractor. - name: service_item_uom - description: '' + description: The unit of measurement for the service item quantity, such as hours, + pieces, or kilograms. join_hint: table: tabUOM 'on': service_item_uom = tabUOM.name - name: conversion_factor - description: '' + description: Ratio used to convert quantities between the finished good and subcontracted + item units of measure in the subcontracting bill of materials. + desc_done: true - table: tabSubcontracting Order description: '' fields: - name: name - description: '' + description: Unique identifier for the subcontracting order used in queries to + find or reference a specific order. - name: title - description: '' + description: Human-readable label or short description of the subcontracting order + for display and quick identification. - name: naming_series - description: '' + description: Prefix pattern that determines how subcontracting order identifiers + are automatically formatted and numbered. options: - SC-ORD-.YYYY.- - name: purchase_order - description: '' + description: Purchase order number linking this subcontracting order to the procurement + document with the supplier join_hint: table: tabPurchase Order 'on': purchase_order = tabPurchase Order.name - name: supplier - description: '' + description: Supplier ID or code for the subcontractor performing the work join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: supplier_name - description: '' + description: Full business name of the subcontractor, used when searching by company + name rather than code - name: supplier_warehouse - description: '' + description: Warehouse location at the supplier's facility where subcontracted + materials or finished goods are stored or delivered from. join_hint: table: tabWarehouse 'on': supplier_warehouse = tabWarehouse.name - name: company - description: '' + description: Company entity that owns or initiated this subcontracting order. join_hint: table: tabCompany 'on': company = tabCompany.name - name: transaction_date - description: '' + description: Date when the subcontracting order transaction was recorded or executed. - name: schedule_date - description: '' + description: Date when the subcontracted items or services are scheduled to be + delivered or completed by the subcontractor. - name: amended_from - description: '' + description: Reference to the original subcontracting order document that this + order amends or replaces. join_hint: table: tabSubcontracting Order 'on': amended_from = tabSubcontracting Order.name - name: cost_center - description: '' + description: Accounting cost center to which the subcontracting expenses should + be allocated for financial tracking. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Project associated with the subcontracting order for tracking costs + and deliverables against specific project budgets. join_hint: table: tabProject 'on': project = tabProject.name - name: set_warehouse - description: '' + description: Warehouse designated to receive finished goods from the subcontractor + after completion of work. join_hint: table: tabWarehouse 'on': set_warehouse = tabWarehouse.name - name: items - description: '' + description: Line items detailing materials or components sent to the subcontractor + for processing or assembly. - name: total_qty - description: '' + description: Total quantity of items or materials being subcontracted across all + line items in the order. - name: total - description: '' + description: Total monetary value of the subcontracting order including all items, + services, and charges. - name: service_items - description: '' + description: Items or operations that represent services performed by the subcontractor + rather than finished goods supplied. - name: set_reserve_warehouse - description: '' + description: Warehouse designated to reserve raw materials or components for this + subcontracting order. join_hint: table: tabWarehouse 'on': set_reserve_warehouse = tabWarehouse.name - name: supplied_items - description: '' + description: List of materials or components provided to the subcontractor to + complete the work. - name: supplier_address - description: '' + description: Physical location or address of the subcontractor performing the + work. join_hint: table: tabAddress 'on': supplier_address = tabAddress.name - name: address_display - description: '' + description: Formatted address of the subcontractor where work or materials will + be delivered for this order. - name: contact_person - description: '' + description: Name of the individual at the subcontractor responsible for coordinating + this order. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_display - description: '' + description: Formatted contact information including phone and email for the subcontractor + on this order. - name: contact_mobile - description: '' + description: Mobile phone number of the subcontractor contact person for urgent + communication or coordination about the order. - name: contact_email - description: '' + description: Email address of the subcontractor contact person for formal correspondence + and order documentation. - name: shipping_address - description: '' + description: Delivery location where finished goods or materials from the subcontractor + should be sent. join_hint: table: tabAddress 'on': shipping_address = tabAddress.name - name: shipping_address_display - description: '' + description: Formatted shipping address where subcontracted materials or finished + goods will be delivered. - name: billing_address - description: '' + description: Address identifier for invoicing the subcontracting work. join_hint: table: tabAddress 'on': billing_address = tabAddress.name - name: billing_address_display - description: '' + description: Formatted billing address shown on subcontracting invoices and payment + documents. - name: distribute_additional_costs_based_on - description: '' + description: Method or basis used to allocate extra costs across subcontracting + order items, such as by quantity, amount, or weight. options: - Qty - Amount - name: additional_costs - description: '' + description: Individual line items or entries representing extra charges beyond + the base subcontracting cost, such as freight, handling, or customs fees. - name: total_additional_costs - description: '' + description: Aggregate sum of all extra charges added to the subcontracting order + beyond the primary service or material costs. - name: status - description: '' + description: Current state of the subcontracting order such as draft, submitted, + completed, or cancelled. options: - Draft - Open @@ -26642,324 +33221,417 @@ tables: - Cancelled - Closed - name: per_received - description: '' + description: Percentage of materials or items received from the subcontractor + against the total order quantity. - name: select_print_heading - description: '' + description: Custom heading or title to display when printing the subcontracting + order document. join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: letter_head - description: '' + description: Letterhead template used for printing or emailing the subcontracting + order document to the supplier. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name + desc_done: true - table: tabSubcontracting Order Item description: '' fields: - name: name - description: '' + description: Unique identifier for the subcontracting order item record. - name: item_code - description: '' + description: SKU or product code of the item being subcontracted for inventory + and catalog lookups. join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Descriptive name of the item being subcontracted for human-readable + identification and search. - name: bom - description: '' + description: Bill of materials defining the components and raw materials required + to manufacture the subcontracted item. join_hint: table: tabBOM 'on': bom = tabBOM.name - name: include_exploded_items - description: '' + description: Whether to expand multi-level bill of materials to show all nested + components in the subcontracting order. - name: schedule_date - description: '' + description: Target date when the subcontracted item is expected to be completed + and returned by the supplier. - name: expected_delivery_date - description: '' + description: Date when the subcontracted items are expected to be delivered back + from the subcontractor. - name: description - description: '' + description: Detailed text describing the specific item or service being subcontracted + in this order line. - name: image_view - description: '' + description: Visual representation or attachment showing the subcontracted item + specifications or requirements. - name: qty - description: '' + description: Quantity of items ordered from the subcontractor for this line item. - name: received_qty - description: '' + description: Quantity of items actually received back from the subcontractor. - name: returned_qty - description: '' + description: Quantity of items sent back to the subcontractor after initial receipt + due to defects or other issues. - name: stock_uom - description: '' + description: Unit of measurement for inventory tracking of the subcontracted item join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert between transaction unit and stock unit for + the subcontracted item - name: rate - description: '' + description: Price per unit charged for the subcontracted item or service - name: amount - description: '' + description: Total monetary value of the subcontracting order item including raw + materials and services. - name: rm_cost_per_qty - description: '' + description: Cost per unit for raw materials supplied to the subcontractor for + this item. - name: service_cost_per_qty - description: '' + description: Cost per unit charged by the subcontractor for processing or manufacturing + services on this item. - name: additional_cost_per_qty - description: '' + description: Extra cost charged per unit quantity on top of the base subcontracting + rate for this item. - name: warehouse - description: '' + description: Storage location where finished goods from this subcontracting order + item will be received or stored. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: expense_account - description: '' + description: General ledger account where subcontracting costs for this item are + recorded as expenses. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: manufacturer - description: '' + description: The company that manufactures the subcontracted item or component + being ordered. join_hint: table: tabManufacturer 'on': manufacturer = tabManufacturer.name - name: manufacturer_part_no - description: '' + description: The manufacturer's unique part number or SKU for the subcontracted + item. - name: material_request - description: '' + description: Links to the material request that triggered or required this subcontracting + order item. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: material_request_item - description: '' + description: Links to the specific material request line that triggered this subcontracting + order item, used when tracing subcontracting orders back to their originating + material requirements. - name: cost_center - description: '' + description: The cost center to which expenses for this subcontracting order item + are allocated for accounting and budgeting purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: The project to which this subcontracting order item is assigned for + project-based cost tracking and management. join_hint: table: tabProject 'on': project = tabProject.name - name: purchase_order_item - description: '' + description: Links this subcontracting order item to the corresponding purchase + order item that triggered the subcontracting requirement. - name: page_break - description: '' + description: Controls whether a page break appears before this item when printing + subcontracting order documents. - name: subcontracting_conversion_factor - description: '' + description: Conversion ratio between the finished good quantity and the raw material + quantities supplied to the subcontractor. - name: job_card - description: '' + description: References the job card document associated with this subcontracting + order item for tracking production work. join_hint: table: tabJob Card 'on': job_card = tabJob Card.name + desc_done: true - table: tabSubcontracting Order Service Item description: '' fields: - name: name - description: '' + description: Unique identifier for the subcontracting order service item record. - name: item_code - description: '' + description: Code of the service item being subcontracted, used when searching + by specific service SKU or item identifier. join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Descriptive name of the service item being subcontracted, used when + searching by service description rather than code. - name: qty - description: '' + description: Quantity of service units ordered from the subcontractor for this + specific service item. - name: rate - description: '' + description: Unit price charged by the subcontractor per service unit for this + item. - name: amount - description: '' + description: Total monetary value for this service item, calculated from quantity + and rate. - name: fg_item - description: '' + description: Finished good item code produced or assembled from this subcontracting + service operation. join_hint: table: tabItem 'on': fg_item = tabItem.name - name: fg_item_qty - description: '' + description: Quantity of finished good item expected to be produced from this + subcontracting service. - name: purchase_order_item - description: '' + description: Purchase order line item code that this subcontracting service is + linked to for procurement tracking. - name: material_request - description: '' + description: References the material request document that triggered or is linked + to this subcontracting service item for material planning purposes. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: material_request_item - description: '' + description: References the specific line item within the material request that + corresponds to this subcontracting service item. + desc_done: true - table: tabSubcontracting Order Supplied Item description: '' fields: - name: name - description: '' + description: Unique identifier for the subcontracting order supplied item record - name: main_item_code - description: '' + description: Finished or semi-finished item code that the subcontractor will produce + or assemble join_hint: table: tabItem 'on': main_item_code = tabItem.name - name: rm_item_code - description: '' + description: Raw material or component item code supplied to the subcontractor + for manufacturing the main item join_hint: table: tabItem 'on': rm_item_code = tabItem.name - name: stock_uom - description: '' + description: Unit of measurement for the supplied item in subcontracting orders, + used when querying inventory quantities or material requirements. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert between transaction unit and stock unit for + the supplied item, relevant when calculating actual stock quantities needed. - name: reserve_warehouse - description: '' + description: Warehouse location from which raw materials or components are reserved + for this subcontracting supply, used when tracking material allocation or availability. join_hint: table: tabWarehouse 'on': reserve_warehouse = tabWarehouse.name - name: bom_detail_no - description: '' + description: Identifier linking the supplied item to a specific line in the bill + of materials for the subcontracting order. - name: reference_name - description: '' + description: Name or label used to identify the supplied item in the subcontracting + context. - name: rate - description: '' + description: Price or cost per unit for the supplied item in the subcontracting + order. - name: amount - description: '' + description: Total monetary value of the supplied item in the subcontracting order. - name: required_qty - description: '' + description: Quantity of the item needed to be supplied by the main company to + the subcontractor for production. - name: supplied_qty - description: '' + description: Actual quantity of the item already delivered or transferred to the + subcontractor. - name: consumed_qty - description: '' + description: Quantity of supplied item actually consumed or used by the subcontractor + in production. - name: returned_qty - description: '' + description: Quantity of supplied item returned back by the subcontractor after + completion or cancellation. - name: total_supplied_qty - description: '' + description: Total quantity of item supplied to the subcontractor for the order. + desc_done: true - table: tabSubcontracting Receipt description: '' fields: - name: name - description: '' + description: Unique identifier for the subcontracting receipt transaction - name: title - description: '' + description: Display name or label for the subcontracting receipt - name: naming_series - description: '' + description: Prefix pattern used to generate the receipt identifier options: - MAT-SCR-.YYYY.- - MAT-SCR-RET-.YYYY.- - name: supplier - description: '' + description: Identifies which subcontracting supplier provided the materials or + components being received. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: supplier_name - description: '' + description: The display name of the subcontracting supplier for human-readable + identification and filtering. - name: supplier_delivery_note - description: '' + description: The delivery note or challan number provided by the supplier when + shipping the subcontracted items. - name: company - description: '' + description: Identifies which company entity received the subcontracted materials + or services. join_hint: table: tabCompany 'on': company = tabCompany.name - name: posting_date - description: '' + description: The date when the subcontracting receipt transaction was officially + recorded in the accounting system. - name: posting_time - description: '' + description: The time of day when the subcontracting receipt transaction was officially + recorded. - name: set_posting_time - description: '' + description: Indicates whether the posting date and time were manually specified + instead of using the current timestamp. - name: is_return - description: '' + description: Indicates whether this receipt represents returned materials being + sent back to the subcontractor. - name: return_against - description: '' + description: References the original subcontracting receipt document that this + return is being made against. join_hint: table: tabSubcontracting Receipt 'on': return_against = tabSubcontracting Receipt.name - name: cost_center - description: '' + description: Cost center to which this subcontracting receipt is allocated for + accounting and expense tracking purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Project associated with this subcontracting receipt for tracking + project-specific subcontracted work and costs. join_hint: table: tabProject 'on': project = tabProject.name - name: set_warehouse - description: '' + description: Warehouse where the finished goods from the subcontractor are received + and stored. join_hint: table: tabWarehouse 'on': set_warehouse = tabWarehouse.name - name: rejected_warehouse - description: '' + description: Warehouse where rejected or non-conforming items from the subcontracting + receipt are stored. join_hint: table: tabWarehouse 'on': rejected_warehouse = tabWarehouse.name - name: supplier_warehouse - description: '' + description: Warehouse belonging to the subcontractor supplier from which materials + or finished goods are received. join_hint: table: tabWarehouse 'on': supplier_warehouse = tabWarehouse.name - name: items - description: '' + description: Line items detailing the specific materials or finished goods received + from the subcontractor in this receipt. - name: total_qty - description: '' + description: Total quantity of items received from the subcontractor in this receipt + transaction. - name: total - description: '' + description: Total monetary value of all items received in this subcontracting + receipt. - name: supplied_items - description: '' + description: List of specific items and materials supplied by the company to the + subcontractor that are being returned or accounted for in this receipt. - name: in_words - description: '' + description: Total receipt amount expressed as text for verification when users + ask about written-out values or check printing. - name: bill_no - description: '' + description: Supplier's bill or invoice number for the subcontracting receipt + when users reference external billing documents. - name: bill_date - description: '' + description: Date on the supplier's bill or invoice when users need to match receipt + records to supplier billing dates. - name: supplier_address - description: '' + description: Specific supplier address location used when filtering or identifying + where subcontracted materials or services are being sourced from. join_hint: table: tabAddress 'on': supplier_address = tabAddress.name - name: contact_person - description: '' + description: Individual at the supplier responsible for the subcontracting receipt, + used when identifying who to communicate with regarding this transaction. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: address_display - description: '' + description: Formatted complete address text used when users need the full readable + address for display or reporting purposes. - name: contact_display - description: '' + description: Name of the contact person associated with the subcontracting receipt + for communication or coordination purposes. - name: contact_mobile - description: '' + description: Mobile phone number of the contact person for the subcontracting + receipt. - name: contact_email - description: '' + description: Email address of the contact person for the subcontracting receipt. - name: shipping_address - description: '' + description: Physical location where subcontracted materials or finished goods + are delivered from the subcontractor join_hint: table: tabAddress 'on': shipping_address = tabAddress.name - name: shipping_address_display - description: '' + description: Formatted display version of the shipping address for subcontracted + items - name: billing_address - description: '' + description: Address where invoices for subcontracting services should be sent + or associated with payment join_hint: table: tabAddress 'on': billing_address = tabAddress.name - name: billing_address_display - description: '' + description: Full formatted billing address for the subcontracting receipt, used + when users need to identify or filter by billing location details. - name: distribute_additional_costs_based_on - description: '' + description: Method used to allocate extra costs across items (e.g., by quantity, + amount), relevant when users ask how additional charges are apportioned. options: - Qty - Amount - name: additional_costs - description: '' + description: Extra charges beyond the base subcontracting cost such as freight + or handling fees, used when users query total costs or cost breakdowns. - name: total_additional_costs - description: '' + description: Total of all additional costs (freight, insurance, customs, etc.) + added to the subcontracting receipt beyond the base item costs. - name: amended_from - description: '' + description: Reference to the previous subcontracting receipt document if this + receipt was created as an amendment or correction. join_hint: table: tabSubcontracting Receipt 'on': amended_from = tabSubcontracting Receipt.name - name: range - description: '' + description: Numeric or alphanumeric series range identifier used for organizing + or grouping subcontracting receipt documents. - name: represents_company - description: '' + description: The company entity that this subcontracting receipt transaction belongs + to or is recorded under. join_hint: table: tabCompany 'on': represents_company = tabCompany.name - name: status - description: '' + description: Current state of the subcontracting receipt such as draft, submitted, + completed, or cancelled. options: - Draft - Completed @@ -26968,299 +33640,384 @@ tables: - Cancelled - Closed - name: per_returned - description: '' + description: Percentage of the received subcontracted items that have been returned + to the supplier. - name: auto_repeat - description: '' + description: Indicates if this subcontracting receipt is part of a recurring schedule + or automatically repeats at defined intervals. join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: letter_head - description: '' + description: The letterhead template used when printing or generating documents + for this subcontracting receipt. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: language - description: '' + description: The language in which this subcontracting receipt document and its + printed outputs are displayed. - name: instructions - description: '' + description: Internal operational notes or procedural guidance for processing + the subcontracting receipt. - name: select_print_heading - description: '' + description: Custom heading or title to display when printing the subcontracting + receipt document. join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: remarks - description: '' + description: Additional comments or observations about the subcontracting receipt + transaction. - name: transporter_name - description: '' + description: Name of the logistics company or carrier that transported the subcontracted + materials or finished goods. - name: lr_no - description: '' + description: Lorry receipt number or transport document reference issued by the + transporter for the shipment. - name: lr_date - description: '' + description: Date when the lorry receipt or transport document was issued by the + transporter. + desc_done: true - table: tabSubcontracting Receipt Item description: '' fields: - name: name - description: '' + description: Unique identifier for the subcontracting receipt item record. - name: item_code - description: '' + description: Code of the item received from the subcontractor, used to identify + which specific product or material was delivered. join_hint: table: tabItem 'on': item_code = tabItem.name - name: item_name - description: '' + description: Descriptive name of the item received from the subcontractor, used + when searching by product description rather than code. - name: is_scrap_item - description: '' + description: Indicates whether the received item is defective or scrap material + from the subcontractor - name: description - description: '' + description: Detailed text describing the specific subcontracting receipt item + or its condition - name: brand - description: '' + description: Brand name or manufacturer of the item received from the subcontractor join_hint: table: tabBrand 'on': brand = tabBrand.name - name: image_view - description: '' + description: Visual representation or attachment associated with the subcontracting + receipt item for verification or reference purposes. - name: received_qty - description: '' + description: Actual quantity of items physically received from the subcontractor + against the order. - name: qty - description: '' + description: Expected or ordered quantity of items to be received from the subcontractor. - name: rejected_qty - description: '' + description: Quantity of subcontracted items rejected upon receipt inspection + due to quality or specification failures. - name: returned_qty - description: '' + description: Quantity of subcontracted items returned to the subcontractor after + receipt. - name: stock_uom - description: '' + description: Unit of measurement for inventory tracking of the subcontracted item + received. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: conversion_factor - description: '' + description: Factor used when the subcontracted item is received in a different + unit of measure than originally ordered. - name: rate - description: '' + description: Unit price or cost per item for the subcontracted goods being received. - name: amount - description: '' + description: Total monetary value of the subcontracted items received, typically + rate multiplied by quantity. - name: rm_cost_per_qty - description: '' + description: Cost per quantity unit for raw materials consumed in subcontracting + production of this item. - name: service_cost_per_qty - description: '' + description: Cost per quantity unit for subcontractor service charges or labor + for processing this item. - name: additional_cost_per_qty - description: '' + description: Cost per quantity unit for miscellaneous or overhead expenses beyond + raw materials and service charges for this item. - name: scrap_cost_per_qty - description: '' + description: Cost per unit of scrapped or rejected material in this subcontracting + receipt item. - name: rm_supp_cost - description: '' + description: Cost of raw materials supplied to the subcontractor for this receipt + item. - name: warehouse - description: '' + description: Warehouse location where the subcontracted items from this receipt + are stored or received. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: subcontracting_order - description: '' + description: The source subcontracting order document that this receipt item is + linked to, used when tracing receipts back to their originating orders. join_hint: table: tabSubcontracting Order 'on': subcontracting_order = tabSubcontracting Order.name - name: subcontracting_order_item - description: '' + description: The specific line item from the subcontracting order that this receipt + corresponds to, used when matching received items to what was originally ordered. - name: subcontracting_receipt_item - description: '' + description: The unique identifier for this specific receipt line item in the + subcontracting receipt document, used when referencing individual items received + from subcontractors. - name: rejected_warehouse - description: '' + description: Warehouse where rejected or non-conforming items from subcontractor + receipt are stored or returned to. join_hint: table: tabWarehouse 'on': rejected_warehouse = tabWarehouse.name - name: bom - description: '' + description: Bill of materials reference that defines the components and materials + structure for the subcontracted item being received. join_hint: table: tabBOM 'on': bom = tabBOM.name - name: include_exploded_items - description: '' + description: Whether to show individual component-level items from the BOM structure + rather than just the parent assembly in the receipt. - name: quality_inspection - description: '' + description: Quality inspection document linked to this subcontracting receipt + item for tracking inspection results and approval status. join_hint: table: tabQuality Inspection 'on': quality_inspection = tabQuality Inspection.name - name: schedule_date - description: '' + description: Planned or expected date for receiving this subcontracted item from + the supplier. - name: reference_name - description: '' + description: Display identifier combining document type and number for this subcontracting + receipt item, used when referencing the item in queries. - name: serial_and_batch_bundle - description: '' + description: References the accepted serial numbers and batch numbers received + from the subcontractor for this item. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: use_serial_batch_fields - description: '' + description: Indicates whether this subcontracting receipt item tracks individual + serial numbers or batch numbers. - name: rejected_serial_and_batch_bundle - description: '' + description: References the rejected serial numbers and batch numbers returned + or not accepted from the subcontractor for this item. join_hint: table: tabSerial and Batch Bundle 'on': rejected_serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: serial_no - description: '' + description: Serial number of the item received from the subcontractor for tracking + individual units. - name: rejected_serial_no - description: '' + description: Serial number of the item rejected during subcontracting receipt + inspection or quality check. - name: batch_no - description: '' + description: Batch number assigned to the received subcontracted items for lot + tracking and traceability. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: manufacturer - description: '' + description: Original manufacturer of the subcontracted item received, relevant + when tracking supplier parts by brand or OEM source. join_hint: table: tabManufacturer 'on': manufacturer = tabManufacturer.name - name: manufacturer_part_no - description: '' + description: Manufacturer's part number for the subcontracted item received, used + to identify items by vendor-specific SKU rather than internal codes. - name: expense_account - description: '' + description: General ledger account charged for subcontracting receipt costs, + relevant when analyzing expense allocation or cost accounting for outsourced + work. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: service_expense_account - description: '' + description: Account where subcontracted service costs are expensed when receiving + items from the subcontractor. join_hint: table: tabAccount 'on': service_expense_account = tabAccount.name - name: cost_center - description: '' + description: Cost center to which this subcontracted receipt item's expenses are + allocated for tracking departmental or operational costs. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Project to which this subcontracted receipt item is linked for tracking + project-specific subcontracting costs and materials. join_hint: table: tabProject 'on': project = tabProject.name - name: page_break - description: '' + description: Controls whether a page break occurs before this item when printing + subcontracting receipt documents. - name: purchase_order - description: '' + description: The purchase order document from which this subcontracting receipt + item originates. join_hint: table: tabPurchase Order 'on': purchase_order = tabPurchase Order.name - name: purchase_order_item - description: '' + description: The specific line item from the purchase order that this subcontracting + receipt corresponds to. + desc_done: true - table: tabSubcontracting Receipt Supplied Item description: '' fields: - name: name - description: '' + description: Unique identifier for the subcontracting receipt supplied item record - name: main_item_code - description: '' + description: Finished or semi-finished item code that the subcontractor is manufacturing join_hint: table: tabItem 'on': main_item_code = tabItem.name - name: rm_item_code - description: '' + description: Raw material or component item code supplied to the subcontractor + for manufacturing the main item join_hint: table: tabItem 'on': rm_item_code = tabItem.name - name: item_name - description: '' + description: Raw material or component supplied to the subcontractor for manufacturing, + referenced when tracking what materials were provided for a specific subcontracting + job. - name: bom_detail_no - description: '' + description: Reference to the specific line item in the bill of materials that + corresponds to this supplied item, used to link supplied materials back to the + production BOM structure. - name: description - description: '' + description: Detailed text describing the supplied item, used when searching for + items by their characteristics or specifications rather than item code. - name: stock_uom - description: '' + description: Unit of measurement for the supplied item in inventory stock terms. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier to convert between the transaction unit and stock unit + of measurement for the supplied item. - name: reference_name - description: '' + description: Name or identifier of the supplied item being received in the subcontracting + process. - name: rate - description: '' + description: Unit price of the supplied item provided to the subcontractor for + this receipt transaction. - name: amount - description: '' + description: Total monetary value of the supplied item quantity in this subcontract + receipt. - name: available_qty_for_consumption - description: '' + description: Quantity of the supplied item remaining that can still be consumed + or used in subcontracted production. - name: required_qty - description: '' + description: Quantity of supplied item needed for the subcontracting receipt production + process. - name: consumed_qty - description: '' + description: Actual quantity of supplied item consumed during subcontracting receipt + execution. - name: current_stock - description: '' + description: Available stock quantity of the supplied item at the time of subcontracting + receipt. - name: serial_and_batch_bundle - description: '' + description: Identifier linking multiple serial or batch numbers supplied together + in this subcontracting receipt transaction. join_hint: table: tabSerial and Batch Bundle 'on': serial_and_batch_bundle = tabSerial and Batch Bundle.name - name: use_serial_batch_fields - description: '' + description: Indicates whether serial number or batch number tracking is enabled + for the supplied item in this receipt. - name: subcontracting_order - description: '' + description: Reference to the parent subcontracting order document for which these + supplied items were received. join_hint: table: tabSubcontracting Order 'on': subcontracting_order = tabSubcontracting Order.name - name: serial_no - description: '' + description: Unique identifier for tracking individual units of supplied items + received from subcontractors. - name: batch_no - description: '' + description: Batch or lot number for grouping supplied items received from subcontractors + for quality control and traceability. join_hint: table: tabBatch 'on': batch_no = tabBatch.name - name: expense_account - description: '' + description: General ledger account where costs of supplied items received from + subcontractors are recorded. join_hint: table: tabAccount 'on': expense_account = tabAccount.name - name: cost_center - description: '' + description: Cost center to which the subcontracting receipt supplied item is + allocated for accounting and expense tracking purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name + desc_done: true - table: tabSubmission Queue description: '' fields: - name: name - description: '' + description: Unique identifier or title of the submission in the queue - name: status - description: '' + description: Current state of the submission such as pending, approved, rejected, + or processing options: - Queued - Finished - Failed - name: created_at - description: '' + description: Timestamp when the submission was first added to the queue - name: enqueued_by - description: '' + description: User or process that added the submission to the queue - name: job_id - description: '' + description: Unique identifier for the queued submission job join_hint: table: tabRQ Job 'on': job_id = tabRQ Job.name - name: ended_at - description: '' + description: Timestamp when the queued submission job completed or terminated - name: ref_doctype - description: '' + description: The type of document being submitted through the queue, such as Sales + Order or Purchase Invoice. join_hint: table: tabDocType 'on': ref_doctype = tabDocType.name - name: ref_docname - description: '' + description: The specific document ID or name being submitted in the queue. - name: exception - description: '' + description: Error message or exception details when a submission fails or encounters + problems. + desc_done: true - table: tabSubscription description: '' fields: - name: name - description: '' + description: Subscription plan or service name that identifies what the customer + is subscribed to - name: party_type - description: '' + description: Type of entity holding the subscription such as Customer, Supplier, + or Employee join_hint: table: tabDocType 'on': party_type = tabDocType.name - name: party - description: '' + description: Specific entity (customer, supplier, or employee) who owns or is + associated with this subscription - name: company - description: '' + description: The company entity that owns or is billed for this subscription join_hint: table: tabCompany 'on': company = tabCompany.name - name: status - description: '' + description: Current state of the subscription such as active, cancelled, expired, + or trial options: - Trialling - Active @@ -27269,367 +34026,467 @@ tables: - Unpaid - Completed - name: start_date - description: '' + description: The date when the subscription began or becomes effective - name: end_date - description: '' + description: When a subscription's scheduled termination or renewal date occurs, + regardless of whether it was canceled early. - name: cancelation_date - description: '' + description: When a user actively canceled their subscription, which may occur + before the end_date. - name: trial_period_start - description: '' + description: When a subscription's free trial began, used to identify trial users + or calculate trial duration. - name: trial_period_end - description: '' + description: Date when the subscription trial period expires and billing begins. - name: follow_calendar_months - description: '' + description: Whether subscription billing cycles align with calendar month boundaries + rather than anniversary dates from start date. - name: generate_new_invoices_past_due_date - description: '' + description: Whether the system continues creating new invoices for subscriptions + that have overdue unpaid invoices. - name: submit_invoice - description: '' + description: Whether invoices for this subscription should be submitted or generated + automatically. - name: current_invoice_start - description: '' + description: Start date of the current billing period being invoiced for this + subscription. - name: current_invoice_end - description: '' + description: End date of the current billing period being invoiced for this subscription. - name: days_until_due - description: '' + description: Number of days after invoice generation until payment is due for + subscription invoices - name: generate_invoice_at - description: '' + description: Timing or date when the next subscription invoice will be automatically + created options: - End of the current subscription period - Beginning of the current subscription period - Days before the current subscription period - name: number_of_days - description: '' + description: Duration or length of the subscription billing period in days - name: cancel_at_period_end - description: '' + description: Indicates whether the subscription will automatically cancel when + the current billing period ends, relevant for questions about pending cancellations + or auto-renewal status. - name: plans - description: '' + description: The subscription plan or plans associated with this subscription, + used when filtering or searching by plan type, tier, or product offering. - name: sales_tax_template - description: '' + description: The tax calculation template applied to this subscription for determining + sales tax rates and rules based on jurisdiction or product type. join_hint: table: tabSales Taxes and Charges Template 'on': sales_tax_template = tabSales Taxes and Charges Template.name - name: purchase_tax_template - description: '' + description: Tax template applied to purchase transactions or invoices generated + from this subscription join_hint: table: tabPurchase Taxes and Charges Template 'on': purchase_tax_template = tabPurchase Taxes and Charges Template.name - name: apply_additional_discount - description: '' + description: Whether an extra discount beyond line-item discounts is applied to + the subscription total options: - Grand Total - Net Total - name: additional_discount_percentage - description: '' + description: Percentage value of the extra discount applied at subscription level + when additional discounts are enabled - name: additional_discount_amount - description: '' + description: Extra discount applied to subscription beyond standard pricing or + promotional discounts. - name: cost_center - description: '' + description: Accounting department or business unit charged for this subscription's + expenses. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name + desc_done: true - table: tabSubscription Invoice description: '' fields: - name: name - description: '' + description: Unique identifier or reference number for the subscription invoice - name: document_type - description: '' + description: Type of subscription invoice document such as credit note, debit + note, or standard invoice join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: invoice - description: '' + description: Reference to the related sales invoice generated from this subscription + invoice + desc_done: true - table: tabSubscription Plan description: '' fields: - name: name - description: '' + description: Unique identifier or code for the subscription plan used in technical + references and system integrations. - name: plan_name - description: '' + description: Display name of the subscription plan shown to customers and used + in business conversations about plan offerings. - name: currency - description: '' + description: Currency in which the subscription plan pricing is denominated and + billed to customers. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: item - description: '' + description: The product or service being sold under this subscription plan. join_hint: table: tabItem 'on': item = tabItem.name - name: price_determination - description: '' + description: How the subscription price is calculated, such as fixed rate, tiered + pricing, or usage-based billing. options: - Fixed Rate - Based On Price List - Monthly Rate - name: cost - description: '' + description: The internal cost to provide this subscription plan, used for profitability + analysis and margin calculations. - name: price_list - description: '' + description: Price list that defines the pricing structure and rates applied to + this subscription plan. join_hint: table: tabPrice List 'on': price_list = tabPrice List.name - name: billing_interval - description: '' + description: Unit of time between billing cycles such as day, week, month, or + year. options: - Day - Week - Month - Year - name: billing_interval_count - description: '' + description: Number of billing intervals between charges, combining with billing_interval + to determine actual billing frequency. - name: product_price_id - description: '' + description: Links to the specific pricing tier or plan variant that determines + billing amount and frequency for this subscription. - name: payment_gateway - description: '' + description: Identifies which payment processor handles transactions for this + subscription such as Stripe, PayPal, or Braintree. join_hint: table: tabPayment Gateway Account 'on': payment_gateway = tabPayment Gateway Account.name - name: cost_center - description: '' + description: Allocates subscription revenue or expenses to a specific department + or business unit for financial tracking and reporting. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name + desc_done: true - table: tabSubscription Plan Detail description: '' fields: - name: name - description: '' + description: Identifies the specific subscription plan detail line item for analyzing + plan composition and feature breakdowns. - name: plan - description: '' + description: Links to the parent subscription plan for filtering and grouping + plan-level metrics and comparisons. join_hint: table: tabSubscription Plan 'on': plan = tabSubscription Plan.name - name: qty - description: '' + description: Tracks quantity or allocation amount for the plan detail, used in + capacity analysis and usage calculations. + desc_done: true - table: tabSubscription Settings description: '' fields: - name: name - description: '' + description: Subscription plan or settings identifier that users reference when + asking about specific subscription configurations or types - name: grace_period - description: '' + description: Number of days allowed after payment failure or subscription expiration + before enforcement actions occur - name: cancel_after_grace - description: '' + description: Whether the subscription is automatically canceled when the grace + period expires without payment - name: prorate - description: '' + description: Whether subscription charges are calculated proportionally based + on partial billing periods when subscription starts, ends, or changes mid-cycle + desc_done: true - table: tabSuccess Action description: '' fields: - name: name - description: '' + description: Name or identifier of the success action configuration - name: ref_doctype - description: '' + description: Document type that triggers or is associated with this success action join_hint: table: tabDocType 'on': ref_doctype = tabDocType.name - name: first_success_message - description: '' + description: Message displayed to users the first time this success action occurs - name: message - description: '' + description: Success message or confirmation text displayed to the user after + completing an action or workflow step. - name: next_actions - description: '' + description: Available follow-up actions or workflow steps that can be taken after + the current action succeeds. - name: action_timeout - description: '' + description: Time limit or expiration period for completing the next action before + it becomes invalid or unavailable. + desc_done: true - table: tabSupplier description: Supplier of Goods or Services. fields: - name: name - description: '' + description: Unique identifier code or ID assigned to the supplier for system + reference and lookups - name: naming_series - description: '' + description: Prefix pattern used to auto-generate supplier IDs following organizational + naming conventions options: - SUP-.YYYY.- - name: supplier_name - description: '' + description: Full business name or legal name of the supplier as it appears in + contracts and invoices - name: country - description: '' + description: Geographic location where the supplier is based or operates from. join_hint: table: tabCountry 'on': country = tabCountry.name - name: supplier_group - description: '' + description: Organizational grouping or category that clusters suppliers by business + relationship, strategic importance, or management structure. join_hint: table: tabSupplier Group 'on': supplier_group = tabSupplier Group.name - name: supplier_type - description: '' + description: Classification of supplier by the nature of goods or services they + provide, such as raw materials, finished goods, or services. options: - Company - Individual - Partnership - name: is_transporter - description: '' + description: Indicates whether the supplier provides transportation or logistics + services in addition to or instead of goods. - name: default_currency - description: '' + description: The currency used for transactions and invoicing with this supplier. join_hint: table: tabCurrency 'on': default_currency = tabCurrency.name - name: default_bank_account - description: '' + description: The primary bank account for making payments to this supplier. join_hint: table: tabBank Account 'on': default_bank_account = tabBank Account.name - name: default_price_list - description: '' + description: Price list automatically applied when creating purchase transactions + with this supplier. join_hint: table: tabPrice List 'on': default_price_list = tabPrice List.name - name: is_internal_supplier - description: '' + description: Indicates the supplier is an internal company entity used for inter-company + or branch transfers. - name: represents_company - description: '' + description: The internal company that this supplier represents when is_internal_supplier + is enabled. join_hint: table: tabCompany 'on': represents_company = tabCompany.name - name: companies - description: '' + description: Comma-separated list of company codes or entities that are authorized + to transact with this supplier. - name: supplier_details - description: '' + description: Full descriptive information about the supplier including business + overview, capabilities, and qualifications. - name: website - description: '' + description: Supplier's official website URL for accessing their online presence + and product catalogs. - name: language - description: '' + description: Preferred language for communications and documents with the supplier. join_hint: table: tabLanguage 'on': language = tabLanguage.name - name: tax_id - description: '' + description: Supplier's tax identification number or VAT registration number for + tax reporting and compliance. - name: tax_category - description: '' + description: Tax classification determining which tax rates and rules apply to + purchases from this supplier. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: tax_withholding_category - description: '' + description: Classification determining which tax withholding rules apply to payments + made to this supplier join_hint: table: tabTax Withholding Category 'on': tax_withholding_category = tabTax Withholding Category.name - name: supplier_primary_address - description: '' + description: Main business address for the supplier used for official correspondence + and tax documentation join_hint: table: tabAddress 'on': supplier_primary_address = tabAddress.name - name: primary_address - description: '' + description: Default address identifier linking to the supplier's main location + record - name: supplier_primary_contact - description: '' + description: Main contact person name at the supplier organization for business + communications and inquiries join_hint: table: tabContact 'on': supplier_primary_contact = tabContact.name - name: mobile_no - description: '' + description: Mobile phone number of the supplier's primary contact person - name: email_id - description: '' + description: Email address of the supplier's primary contact person for electronic + correspondence - name: payment_terms - description: '' + description: Payment terms negotiated with the supplier such as net 30, net 60, + or immediate payment requirements. join_hint: table: tabPayment Terms Template 'on': payment_terms = tabPayment Terms Template.name - name: accounts - description: '' + description: General ledger accounts associated with this supplier for posting + transactions and expenses. - name: allow_purchase_invoice_creation_without_purchase_order - description: '' + description: Whether invoices from this supplier can be created and processed + without requiring a prior purchase order. - name: allow_purchase_invoice_creation_without_purchase_receipt - description: '' + description: Whether invoices from this supplier can be created before receiving + goods, relevant for payment processing workflows without prior receipt confirmation. - name: is_frozen - description: '' + description: Whether all transactions with this supplier are temporarily blocked, + used when querying which suppliers cannot currently be used for purchases or + payments. - name: disabled - description: '' + description: Whether this supplier is permanently deactivated and excluded from + active supplier lists, searches, and new transaction creation. - name: warn_rfqs - description: '' + description: Flag indicating whether to show warnings when creating RFQs for this + supplier due to performance or compliance issues. - name: warn_pos - description: '' + description: Flag indicating whether to show warnings when creating purchase orders + for this supplier due to performance or compliance issues. - name: prevent_rfqs - description: '' + description: Flag indicating whether to block creation of new RFQs for this supplier + entirely due to serious issues or blacklisting. - name: prevent_pos - description: '' + description: Whether this supplier is blocked from being used in point-of-sale + transactions. - name: on_hold - description: '' + description: Whether this supplier is temporarily suspended from new purchase + orders or transactions. - name: hold_type - description: '' + description: The specific reason or category for why the supplier is on hold, + such as credit issues, quality problems, or compliance violations. options: - All - Invoices - Payments - name: release_date - description: '' + description: Date when the supplier relationship or account was activated or made + available for transactions. - name: portal_users - description: '' + description: Users from the supplier organization who have access to the supplier + portal for order tracking, invoices, and collaboration. + desc_done: true - table: tabSupplier Group description: '' fields: - name: name - description: '' + description: Unique identifier code or short name for the supplier group - name: supplier_group_name - description: '' + description: Full descriptive name of the supplier group used when searching or + filtering suppliers by category or classification - name: parent_supplier_group - description: '' + description: Links this supplier group to a higher-level group for hierarchical + supplier categorization and roll-up reporting join_hint: table: tabSupplier Group 'on': parent_supplier_group = tabSupplier Group.name - name: is_group - description: '' + description: Indicates whether this supplier entry represents a group/category + of suppliers rather than an individual supplier entity. - name: payment_terms - description: '' + description: Default payment terms template applied to transactions with suppliers + in this group. join_hint: table: tabPayment Terms Template 'on': payment_terms = tabPayment Terms Template.name - name: accounts - description: '' + description: Default accounting ledger accounts used for financial postings when + transacting with suppliers in this group. - name: lft - description: '' + description: Left boundary value in nested set model for hierarchical supplier + group positioning and ancestor queries. - name: rgt - description: '' + description: Right boundary value in nested set model for hierarchical supplier + group positioning and descendant queries. - name: old_parent - description: '' + description: Previous parent supplier group before the most recent reparenting + or reorganization operation. join_hint: table: tabSupplier Group 'on': old_parent = tabSupplier Group.name + desc_done: true - table: tabSupplier Group Item description: '' fields: - name: name - description: '' + description: Name of the specific item or product associated with this supplier + group - name: supplier_group - description: '' + description: Supplier group classification that this item belongs to for procurement + or vendor management purposes join_hint: table: tabSupplier Group 'on': supplier_group = tabSupplier Group.name + desc_done: true - table: tabSupplier Item description: '' fields: - name: name - description: '' + description: supplier_item_name - name: supplier - description: '' + description: supplier_who_provides_this_item join_hint: table: tabSupplier 'on': supplier = tabSupplier.name + desc_done: true - table: tabSupplier Quotation description: '' fields: - name: name - description: '' + description: Unique identifier for the supplier quotation document - name: title - description: '' + description: Brief descriptive label or subject line summarizing what the supplier + quotation is for - name: naming_series - description: '' + description: Prefix pattern used to generate the quotation number sequence options: - PUR-SQTN-.YYYY.- - name: supplier - description: '' + description: Identifier of the vendor providing the quotation, used when searching + for quotes from a specific supplier. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: supplier_name - description: '' + description: Name of the vendor providing the quotation, used when searching by + supplier company name rather than identifier. - name: company - description: '' + description: The buying organization or entity receiving this quotation, used + when filtering quotes by which company location or subsidiary is purchasing. join_hint: table: tabCompany 'on': company = tabCompany.name - name: status - description: '' + description: Current state of the supplier quotation such as draft, submitted, + ordered, or expired. options: - Draft - Submitted @@ -27637,458 +34494,609 @@ tables: - Cancelled - Expired - name: transaction_date - description: '' + description: Date when the supplier quotation was created or issued. - name: valid_till - description: '' + description: Expiration date until which the supplier's quoted prices and terms + remain valid. - name: quotation_number - description: '' + description: Unique identifier for the supplier quotation used when referencing, + searching, or tracking a specific quote from a vendor. - name: has_unit_price_items - description: '' + description: Indicates whether the quotation includes line items with individual + unit pricing rather than bulk or total pricing only. - name: amended_from - description: '' + description: References the original quotation number that this quotation revises + or replaces when changes were made after initial submission. join_hint: table: tabSupplier Quotation 'on': amended_from = tabSupplier Quotation.name - name: cost_center - description: '' + description: Cost center to which expenses from this supplier quotation will be + allocated for budgeting and financial tracking purposes. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Specific project associated with this supplier quotation for tracking + project-related procurement and costs. join_hint: table: tabProject 'on': project = tabProject.name - name: currency - description: '' + description: Currency in which the supplier quotation prices and amounts are denominated. join_hint: table: tabCurrency 'on': currency = tabCurrency.name - name: conversion_rate - description: '' + description: Exchange rate used to convert supplier quotation amounts from price + list currency to company base currency. - name: buying_price_list - description: '' + description: Specific price list from the supplier that applies to this quotation, + determining pricing terms and conditions. join_hint: table: tabPrice List 'on': buying_price_list = tabPrice List.name - name: price_list_currency - description: '' + description: Currency in which the supplier's price list and quotation amounts + are denominated. join_hint: table: tabCurrency 'on': price_list_currency = tabCurrency.name - name: plc_conversion_rate - description: '' + description: Exchange rate used to convert price list currency to transaction + currency for this supplier quotation. - name: ignore_pricing_rule - description: '' + description: Whether automatic pricing rules are bypassed for this supplier quotation. - name: items - description: '' + description: Line items containing quoted products, quantities, rates, and amounts + from the supplier. - name: total_qty - description: '' + description: Total quantity of all items in the supplier quotation across all + line items. - name: total_net_weight - description: '' + description: Combined net weight of all items in the supplier quotation. - name: base_total - description: '' + description: Total amount of the supplier quotation in the company's base currency + before taxes and charges. - name: base_net_total - description: '' + description: Net total amount in company's base currency before taxes and after + discounts, used for multi-currency reporting and accounting consolidation. - name: total - description: '' + description: Final grand total amount including all taxes, charges, and discounts + that the supplier quoted. - name: net_total - description: '' + description: Subtotal amount in transaction currency after item-level discounts + but before taxes and additional charges. - name: tax_category - description: '' + description: Tax classification applied to the supplier quotation determining + which tax rules apply based on supplier location, product type, or transaction + nature. join_hint: table: tabTax Category 'on': tax_category = tabTax Category.name - name: taxes_and_charges - description: '' + description: Specific tax template or configuration defining the actual tax rates, + accounts, and charge calculations applied to this supplier quotation. join_hint: table: tabPurchase Taxes and Charges Template 'on': taxes_and_charges = tabPurchase Taxes and Charges Template.name - name: shipping_rule - description: '' + description: Shipping cost calculation rule applied to determine freight charges + based on order value, weight, or destination for this supplier quotation. join_hint: table: tabShipping Rule 'on': shipping_rule = tabShipping Rule.name - name: incoterm - description: '' + description: Shipping term code defining responsibility transfer point between + supplier and buyer such as FOB, CIF, or EXW. join_hint: table: tabIncoterm 'on': incoterm = tabIncoterm.name - name: named_place - description: '' + description: Specific location associated with the incoterm where responsibility + transfers, such as port name or delivery address. - name: taxes - description: '' + description: Total tax amount or tax details applied to the supplier quotation. - name: base_taxes_and_charges_added - description: '' + description: Total additional taxes and charges applied to the quotation in base + currency, used when calculating total cost increases from tax additions. - name: base_taxes_and_charges_deducted - description: '' + description: Total taxes and charges deducted or credited from the quotation in + base currency, used when calculating net reductions from tax credits or exemptions. - name: base_total_taxes_and_charges - description: '' + description: Net total of all taxes and charges (additions minus deductions) in + base currency, used when determining the complete tax impact on the quotation. - name: taxes_and_charges_added - description: '' + description: Total amount of taxes and charges that increase the quotation value, + such as VAT, sales tax, or freight charges. - name: taxes_and_charges_deducted - description: '' + description: Total amount of taxes and charges that decrease the quotation value, + such as tax credits, discounts, or rebates. - name: total_taxes_and_charges - description: '' + description: Net total of all taxes and charges applied to the supplier quotation, + combining both additions and deductions. - name: apply_discount_on - description: '' + description: Specifies whether discounts are calculated on grand total or net + total, relevant when users ask how discount calculation basis is determined. options: - Grand Total - Net Total - name: base_discount_amount - description: '' + description: Fixed monetary discount amount applied before additional percentage + discounts, used when users ask about flat discount values on the quotation. - name: additional_discount_percentage - description: '' + description: Extra percentage discount applied after base discount, relevant when + users ask about secondary or stacked discount rates. - name: discount_amount - description: '' + description: Total discount value applied to the supplier quotation in the document's + currency. - name: base_grand_total - description: '' + description: Final total amount of the supplier quotation in the company's base + currency, including all taxes, discounts, and adjustments. - name: base_rounding_adjustment - description: '' + description: Rounding correction applied to the final total in the company's base + currency to achieve a clean rounded amount. - name: base_rounded_total - description: '' + description: Total amount after rounding adjustments in base currency, used when + users ask about the final rounded quotation value before conversion. - name: base_in_words - description: '' + description: Written text representation of the quotation amount in base currency, + used when users need the spelled-out value for documents or reports. - name: grand_total - description: '' + description: Final total amount including all charges, taxes, and discounts in + transaction currency, used when users ask about the complete quotation value. - name: rounding_adjustment - description: '' + description: Amount added or subtracted to round the quotation total to a convenient + figure. - name: rounded_total - description: '' + description: Final quotation total after applying rounding adjustment to the calculated + total. - name: in_words - description: '' + description: Text representation of the quotation total amount written out in + words for formal documentation. - name: disable_rounded_total - description: '' + description: Whether quotation totals are shown with exact decimal precision instead + of rounded amounts. - name: other_charges_calculation - description: '' + description: Method or formula used to calculate additional charges beyond line + item costs in the quotation. - name: pricing_rules - description: '' + description: Special pricing conditions or discount rules applied to determine + quotation prices. - name: supplier_address - description: '' + description: Specific supplier address linked to this quotation for delivery or + billing purposes. join_hint: table: tabAddress 'on': supplier_address = tabAddress.name - name: address_display - description: '' + description: Formatted full address text of the supplier as it appears on the + quotation document. - name: contact_person - description: '' + description: Name of the individual at the supplier company who provided or is + responsible for this quotation. join_hint: table: tabContact 'on': contact_person = tabContact.name - name: contact_display - description: '' + description: Name of the supplier contact person for this quotation, used when + searching for quotes by who provided them. - name: contact_mobile - description: '' + description: Mobile phone number of the supplier contact for this quotation, used + when users need to reach the quote provider by phone. - name: contact_email - description: '' + description: Email address of the supplier contact for this quotation, used when + users need to communicate with or identify the quote provider electronically. - name: shipping_address - description: '' + description: Address where goods from this supplier quotation will be delivered + if accepted join_hint: table: tabAddress 'on': shipping_address = tabAddress.name - name: shipping_address_display - description: '' + description: Formatted display version of the shipping address for presentation + and reports - name: billing_address - description: '' + description: Address where invoices and payment-related documents for this supplier + quotation should be sent join_hint: table: tabAddress 'on': billing_address = tabAddress.name - name: billing_address_display - description: '' + description: Formatted billing address of the supplier for this quotation, used + when searching by supplier location or billing details. - name: tc_name - description: '' + description: Name of the terms and conditions template applied to this supplier + quotation. join_hint: table: tabTerms and Conditions 'on': tc_name = tabTerms and Conditions.name - name: terms - description: '' + description: Full text of the terms and conditions or special agreements included + in this supplier quotation. - name: letter_head - description: '' + description: Letterhead template used when printing or emailing this supplier + quotation document. join_hint: table: tabLetter Head 'on': letter_head = tabLetter Head.name - name: group_same_items - description: '' + description: Whether identical items are consolidated into single lines when displaying + or printing the quotation. - name: select_print_heading - description: '' + description: Custom heading text that appears at the top of the printed supplier + quotation instead of the default title. join_hint: table: tabPrint Heading 'on': select_print_heading = tabPrint Heading.name - name: language - description: '' + description: Language in which the supplier quotation document is generated or + communicated. - name: auto_repeat - description: '' + description: Indicates if this supplier quotation is set to automatically recur + at scheduled intervals. join_hint: table: tabAuto Repeat 'on': auto_repeat = tabAuto Repeat.name - name: is_subcontracted - description: '' + description: Indicates whether the quoted items or services involve subcontracting + work to external parties. - name: opportunity - description: '' + description: Links the supplier quotation to a sales opportunity when the quotation + is being prepared in response to a potential customer deal. join_hint: table: tabOpportunity 'on': opportunity = tabOpportunity.name + desc_done: true - table: tabSupplier Quotation Item description: '' fields: - name: name - description: '' + description: Unique identifier for this quotation item row, typically auto-generated. - name: item_code - description: '' + description: The company's internal item/product code being quoted by the supplier. join_hint: table: tabItem 'on': item_code = tabItem.name - name: supplier_part_no - description: '' + description: The supplier's own part number or SKU for the quoted item, distinct + from the company's internal item code. - name: item_name - description: '' + description: The product or material being quoted by the supplier, used when searching + for quotations by specific items or materials. - name: lead_time_days - description: '' + description: Number of days the supplier needs to deliver the item after order + placement, used when comparing supplier response times or planning procurement + timelines. - name: expected_delivery_date - description: '' + description: The specific calendar date when the supplier commits to deliver the + item, used when checking delivery schedules or matching quotations to project + deadlines. - name: is_free_item - description: '' + description: Whether this quotation line item is offered at no charge as a promotional + or complimentary item. - name: description - description: '' + description: Detailed text describing the quoted item, its specifications, or + additional notes about what the supplier is offering. - name: item_group - description: '' + description: The product category or classification that this quoted item belongs + to for grouping similar items. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: brand - description: '' + description: Brand name of the quoted item from the supplier. join_hint: table: tabBrand 'on': brand = tabBrand.name - name: image_view - description: '' + description: Visual representation or image attachment of the quoted item. - name: qty - description: '' + description: Quantity of the item quoted by the supplier. - name: stock_uom - description: '' + description: The base inventory unit of measure for the item being quoted, used + when asking about the supplier's quoted item in its standard stock-keeping unit. join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: uom - description: '' + description: The unit of measure specified in this specific supplier quotation + line, used when asking about the quoted quantity unit which may differ from + stock UOM. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: The multiplier to convert between the quotation UOM and stock UOM, + used when asking how quoted quantities translate to base inventory units. - name: stock_qty - description: '' + description: Quantity of the item currently available in supplier's stock at time + of quotation. - name: price_list_rate - description: '' + description: Base unit price from supplier's standard price list before any discounts + or negotiations. - name: discount_percentage - description: '' + description: Percentage discount offered by supplier off the price list rate for + this quotation item. - name: discount_amount - description: '' + description: Total discount value applied to this quotation item line, used when + asking about discounts given by suppliers on specific items. - name: distributed_discount_amount - description: '' + description: Portion of document-level discount allocated to this item, used when + analyzing how header discounts are spread across line items. - name: base_price_list_rate - description: '' + description: Standard price from the supplier's price list before any discounts + or negotiations, used when comparing quoted prices to list prices. - name: rate - description: '' + description: Unit price quoted by the supplier for a single item in the quotation. - name: amount - description: '' + description: Total line amount for the quoted item after multiplying rate by quantity. - name: item_tax_template - description: '' + description: Tax template applied to calculate taxes on this specific quoted item. join_hint: table: tabItem Tax Template 'on': item_tax_template = tabItem Tax Template.name - name: base_rate - description: '' + description: Unit price quoted by supplier before applying pricing rules or discounts. - name: base_amount - description: '' + description: Total line amount before applying pricing rules or discounts, calculated + from base rate and quantity. - name: pricing_rules - description: '' + description: Specific pricing rules or discount schemes applied to this quotation + line item. - name: net_rate - description: '' + description: Price per unit after applying discounts but before taxes, used when + comparing quoted unit prices from suppliers. - name: net_amount - description: '' + description: Total line item value after discounts but before taxes, used when + analyzing total quoted costs per item. - name: base_net_rate - description: '' + description: Price per unit after discounts converted to company's base currency, + used for cross-currency supplier quote comparisons. - name: base_net_amount - description: '' + description: Net amount of the quotation item in base currency, used when comparing + supplier quotes or calculating total costs before taxes and discounts. - name: weight_per_unit - description: '' + description: Weight of a single unit of the quoted item, used when calculating + shipping costs or comparing product specifications across suppliers. - name: total_weight - description: '' + description: Total weight for the entire quantity of the quoted item, used when + estimating freight charges or logistics planning for the supplier quotation. - name: weight_uom - description: '' + description: Unit of measurement for the item's weight in the supplier quotation + line. join_hint: table: tabUOM 'on': weight_uom = tabUOM.name - name: warehouse - description: '' + description: Warehouse location where the quoted item would be received or stored + upon purchase. join_hint: table: tabWarehouse 'on': warehouse = tabWarehouse.name - name: prevdoc_doctype - description: '' + description: Document type of the preceding document that generated or is linked + to this quotation item, such as Material Request or Request for Quotation. - name: material_request - description: '' + description: Links this quotation item to the original material request that triggered + the procurement need. join_hint: table: tabMaterial Request 'on': material_request = tabMaterial Request.name - name: sales_order - description: '' + description: Links this quotation item to a customer sales order when procuring + specifically to fulfill that order. join_hint: table: tabSales Order 'on': sales_order = tabSales Order.name - name: request_for_quotation - description: '' + description: Links this quotation item to the RFQ document sent to suppliers to + solicit this quote. join_hint: table: tabRequest for Quotation 'on': request_for_quotation = tabRequest for Quotation.name - name: material_request_item - description: '' + description: Links to the specific material request line item that originated + this quotation item, used when tracing supplier quotes back to internal purchase + requisitions. - name: request_for_quotation_item - description: '' + description: Links to the specific RFQ line item that this supplier quotation + is responding to, used when comparing supplier responses to the original request + for quotation. - name: item_tax_rate - description: '' + description: Tax rate percentage or tax template applied to this quoted item, + used when calculating total quoted price including taxes or comparing tax treatment + across suppliers. - name: manufacturer - description: '' + description: Brand or company that produces the quoted item, used when filtering + or comparing quotes by product manufacturer. join_hint: table: tabManufacturer 'on': manufacturer = tabManufacturer.name - name: manufacturer_part_no - description: '' + description: Manufacturer's specific part number for the quoted item, used to + identify exact product specifications or match against manufacturer catalogs. - name: cost_center - description: '' + description: Accounting cost center to which the quoted item's expense will be + allocated, used for budget tracking and departmental cost analysis. join_hint: table: tabCost Center 'on': cost_center = tabCost Center.name - name: project - description: '' + description: Links the quotation item to a specific project for tracking project-related + supplier quotes and procurement costs. join_hint: table: tabProject 'on': project = tabProject.name - name: page_break - description: '' + description: Controls whether a page break appears before this item when printing + or generating PDF versions of the supplier quotation. + desc_done: true - table: tabSupplier Scorecard description: '' fields: - name: name - description: '' + description: Unique identifier for the supplier scorecard used to track and reference + specific supplier performance evaluations - name: supplier - description: '' + description: Links to the supplier being evaluated, used when analyzing vendor + performance or filtering scorecards by supplier join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: supplier_score - description: '' + description: Calculated performance score used to compare supplier quality and + determine if suppliers meet minimum standards - name: indicator_color - description: '' + description: Visual status indicator (red/yellow/green) used to quickly identify + at-risk or high-performing suppliers - name: status - description: '' + description: Current state of the scorecard (active/inactive/draft) used to filter + valid performance evaluations - name: period - description: '' + description: Time range for performance measurement used when analyzing supplier + trends over specific quarters or years options: - Per Week - Per Month - Per Year - name: weighting_function - description: '' + description: Calculation method for scoring used to understand how different criteria + contribute to overall supplier ratings - name: standings - description: '' + description: Current ranking or tier level used to segment suppliers into preferred, + approved, or probationary categories - name: criteria - description: '' + description: Specific performance metrics being measured (quality, delivery, cost) + used when drilling into scorecard components - name: warn_rfqs - description: '' + description: Threshold that triggers warnings when creating RFQs with underperforming + suppliers - name: warn_pos - description: '' + description: Threshold that triggers warnings when creating purchase orders with + poorly rated suppliers - name: prevent_rfqs - description: '' + description: Threshold that blocks RFQ creation with suppliers below acceptable + performance levels - name: prevent_pos - description: '' + description: Threshold that blocks purchase order creation with suppliers failing + minimum standards - name: notify_supplier - description: '' + description: Flag indicating whether supplier receives automated alerts about + their performance scores - name: notify_employee - description: '' + description: Flag indicating whether internal staff receive alerts about supplier + performance issues - name: employee - description: '' + description: Internal owner or manager responsible for the scorecard used when + routing performance review tasks join_hint: table: tabEmployee 'on': employee = tabEmployee.name + desc_done: true - table: tabSupplier Scorecard Criteria description: '' fields: - name: name - description: '' + description: Unique identifier for the supplier scorecard criteria record used + when referencing specific evaluation metrics. - name: criteria_name - description: '' + description: Descriptive label of the evaluation criterion used when analyzing + what performance aspects are being measured for suppliers. - name: max_score - description: '' + description: Maximum achievable points for this criterion used when calculating + percentage performance or normalizing supplier scores. - name: formula - description: '' + description: Calculation method or scoring logic used when determining how supplier + performance is quantified for this criterion. - name: weight - description: '' + description: Relative importance percentage of this criterion used when computing + weighted overall supplier scorecard ratings. + desc_done: true - table: tabSupplier Scorecard Period description: '' fields: - name: name - description: '' + description: Unique identifier for the supplier scorecard period record used when + referencing specific evaluation cycles. - name: supplier - description: '' + description: Links to the supplier being evaluated, used when filtering scorecards + by vendor or analyzing supplier performance. join_hint: table: tabSupplier 'on': supplier = tabSupplier.name - name: naming_series - description: '' + description: Auto-numbering prefix for scorecard period records, used when searching + by document number patterns. options: - PU-SSP-.YYYY.- - name: total_score - description: '' + description: Aggregated performance score for the period, used when comparing + supplier rankings or filtering by performance thresholds. - name: start_date - description: '' + description: Beginning date of the evaluation period, used when filtering scorecards + by time range or fiscal period. - name: end_date - description: '' + description: Closing date of the evaluation period, used when identifying active + scorecards or historical performance windows. - name: criteria - description: '' + description: Performance metrics and standards being measured, used when analyzing + what factors drive supplier scores. - name: variables - description: '' + description: Dynamic parameters or weights applied to scoring criteria, used when + understanding score calculation methodology. - name: scorecard - description: '' + description: Links to the master supplier scorecard template, used when grouping + periods by evaluation framework or scorecard type. join_hint: table: tabSupplier Scorecard 'on': scorecard = tabSupplier Scorecard.name - name: amended_from - description: '' + description: References the previous version if this scorecard was corrected, + used when tracking scorecard revisions or audit trails. join_hint: table: tabSupplier Scorecard Period 'on': amended_from = tabSupplier Scorecard Period.name + desc_done: true - table: tabSupplier Scorecard Scoring Criteria description: '' fields: - name: name - description: '' + description: Unique identifier for the supplier scorecard scoring criteria record. - name: criteria_name - description: '' + description: Name of the evaluation criterion used to assess supplier performance + such as quality, delivery, or cost. join_hint: table: tabSupplier Scorecard Criteria 'on': criteria_name = tabSupplier Scorecard Criteria.name - name: score - description: '' + description: Actual points earned by the supplier for this specific criterion + during the evaluation period. - name: weight - description: '' + description: Percentage or multiplier indicating the relative importance of this + criterion in the overall supplier scorecard calculation. - name: max_score - description: '' + description: Maximum possible points achievable for this criterion, used to calculate + percentage performance. - name: formula - description: '' + description: Calculation method or expression used to derive the score for this + criterion from underlying metrics or data. + desc_done: true - table: tabSupplier Scorecard Scoring Standing description: '' fields: - name: name - description: '' + description: Unique identifier for the scoring standing configuration used to + categorize supplier performance levels. - name: standing_name - description: '' + description: Display name of the performance standing (e.g., Preferred, Approved, + Poor) used when reporting supplier evaluation results. join_hint: table: tabSupplier Scorecard Standing 'on': standing_name = tabSupplier Scorecard Standing.name - name: standing_color - description: '' + description: Visual indicator color assigned to this standing for dashboard displays + and supplier scorecards. options: - Blue - Purple @@ -28097,53 +35105,75 @@ tables: - Orange - Red - name: min_grade - description: '' + description: Minimum score threshold that qualifies a supplier for this performance + standing level. - name: max_grade - description: '' + description: Maximum score threshold that defines the upper boundary for this + performance standing level. - name: warn_rfqs - description: '' + description: Flag indicating whether to display warnings when creating RFQs with + suppliers in this standing. - name: warn_pos - description: '' + description: Flag indicating whether to display warnings when creating purchase + orders with suppliers in this standing. - name: prevent_rfqs - description: '' + description: Flag that blocks RFQ creation with suppliers in this standing due + to poor performance. - name: prevent_pos - description: '' + description: Flag that blocks purchase order creation with suppliers in this standing + due to poor performance. - name: notify_supplier - description: '' + description: Flag indicating whether suppliers are automatically notified when + their scorecard reaches this standing. - name: notify_employee - description: '' + description: Flag indicating whether internal employees are alerted when a supplier + falls into this standing. - name: employee_link - description: '' + description: Reference to the employee or role who should be notified about suppliers + in this performance standing. join_hint: table: tabEmployee 'on': employee_link = tabEmployee.name + desc_done: true - table: tabSupplier Scorecard Scoring Variable description: '' fields: - name: name - description: '' + description: Unique identifier for the scoring variable used to track and reference + specific performance metrics in supplier scorecards. - name: variable_label - description: '' + description: Display label for the scoring variable shown to users when configuring + or viewing supplier performance criteria. join_hint: table: tabSupplier Scorecard Variable 'on': variable_label = tabSupplier Scorecard Variable.name - name: description - description: '' + description: Detailed explanation of what the scoring variable measures, used + when users need to understand the business meaning of a supplier performance + metric. - name: value - description: '' + description: Numeric or text value assigned to the scoring variable, used when + calculating supplier scores or evaluating performance thresholds. - name: param_name - description: '' + description: Technical parameter name used in system calculations and integrations + when processing supplier scorecard formulas. - name: path - description: '' + description: Hierarchical location or category path of the scoring variable, used + when organizing or filtering performance metrics by business area or evaluation + dimension. + desc_done: true - table: tabSupplier Scorecard Standing description: '' fields: - name: name - description: '' + description: Unique identifier for the supplier scorecard standing record used + to reference specific performance tier configurations. - name: standing_name - description: '' + description: Display name of the performance tier (e.g., Preferred, Approved, + Probation) used when categorizing suppliers by their scorecard results. - name: standing_color - description: '' + description: Visual indicator color assigned to this standing level used in dashboards + and reports to quickly identify supplier performance status. options: - Blue - Purple @@ -28152,133 +35182,185 @@ tables: - Orange - Red - name: min_grade - description: '' + description: Minimum scorecard grade threshold that qualifies a supplier for this + standing level, used to automatically assign performance tiers. - name: max_grade - description: '' + description: Maximum scorecard grade threshold for this standing level, used to + define the upper boundary of this performance tier. - name: warn_rfqs - description: '' + description: Flag indicating whether to display warnings when creating RFQs with + suppliers in this standing, used to alert buyers about performance concerns. - name: warn_pos - description: '' + description: Flag indicating whether to display warnings when creating purchase + orders with suppliers in this standing, used to prevent procurement from poor + performers. - name: prevent_rfqs - description: '' + description: Flag that blocks creation of new RFQs with suppliers in this standing, + used to enforce hard stops for unacceptable supplier performance. - name: prevent_pos - description: '' + description: Flag that blocks creation of new purchase orders with suppliers in + this standing, used to completely restrict purchasing from failing suppliers. - name: notify_supplier - description: '' + description: Flag indicating whether to automatically send notifications to suppliers + when they are assigned this standing, used for supplier performance communication. - name: notify_employee - description: '' + description: Flag indicating whether to send alerts to internal employees when + a supplier reaches this standing level, used for escalation and awareness. - name: employee_link - description: '' + description: Reference to the employee or role to notify when suppliers fall into + this standing, used to route performance alerts to responsible procurement managers. join_hint: table: tabEmployee 'on': employee_link = tabEmployee.name + desc_done: true - table: tabSupplier Scorecard Variable description: '' fields: - name: name - description: '' + description: Unique identifier for the supplier scorecard variable used to track + specific performance metrics. - name: variable_label - description: '' + description: Display name shown to users when viewing or filtering supplier performance + metrics in scorecards. - name: is_custom - description: '' + description: Indicates whether this scorecard variable was custom-created by the + organization versus being a standard system metric. - name: param_name - description: '' + description: Technical parameter name used in calculations and integrations when + evaluating supplier performance. - name: path - description: '' + description: Hierarchical location or category path showing where this variable + fits within the scorecard structure. - name: description - description: '' + description: Detailed explanation of what this scorecard variable measures and + how it evaluates supplier performance. + desc_done: true - table: tabSupport Search Source description: '' fields: - name: name - description: '' + description: Unique identifier for the support search source configuration record. - name: source_name - description: '' + description: Display name of the external search source used when presenting search + options to support users. - name: source_type - description: '' + description: Classification of the search source system type used to determine + integration method and data handling. options: - API - Link - name: base_url - description: '' + description: Root API endpoint URL used when connecting to the external search + source system. - name: query_route - description: '' + description: API path appended to base URL for executing search queries against + the source. - name: search_term_param_name - description: '' + description: Query parameter name used to pass user search keywords to the external + API. - name: response_result_key_path - description: '' + description: JSON path to extract search result array from the API response payload. - name: post_route - description: '' + description: API endpoint path used to retrieve full article or post details after + initial search. - name: post_route_key_list - description: '' + description: List of JSON keys used to construct the detailed post retrieval request. - name: post_title_key - description: '' + description: JSON field name containing the article title in search results for + display. - name: post_description_key - description: '' + description: JSON field name containing the article summary or preview text in + search results. - name: source_doctype - description: '' + description: ERP DocType name mapped to this search source for linking and reference + purposes. join_hint: table: tabDocType 'on': source_doctype = tabDocType.name - name: result_title_field - description: '' + description: Field mapping for displaying search result titles in the support + interface. - name: result_preview_field - description: '' + description: Field mapping for displaying search result preview snippets in the + support interface. - name: result_route_field - description: '' + description: Field mapping containing the navigation path or URL to access the + full search result. + desc_done: true - table: tabSupport Settings description: '' fields: - name: name - description: '' + description: Unique identifier for the support settings configuration record - name: track_service_level_agreement - description: '' + description: Used when determining if SLA tracking and monitoring is enabled for + support tickets - name: allow_resetting_service_level_agreement - description: '' + description: Used when checking if users have permission to manually reset SLA + timers on support cases - name: close_issue_after_days - description: '' + description: Used when calculating automatic ticket closure dates based on inactivity + period - name: get_started_sections - description: '' + description: Used when displaying onboarding or help sections to new support portal + users - name: show_latest_forum_posts - description: '' + description: Used when determining if recent community forum posts should appear + in the support interface - name: forum_url - description: '' + description: Used when redirecting users to the external or internal community + forum location - name: get_latest_query - description: '' + description: Used when fetching the most recent forum posts or support content + via API query - name: response_key_list - description: '' + description: Used when parsing API responses to extract specific data fields from + forum or support content - name: post_title_key - description: '' + description: Used when mapping the title field from forum post API responses - name: post_description_key - description: '' + description: Used when mapping the description or body content field from forum + post API responses - name: post_route_key - description: '' + description: Used when identifying the routing parameter name for forum post URLs - name: post_route_string - description: '' + description: Used when constructing direct links to individual forum posts or + support articles - name: greeting_title - description: '' + description: Used when displaying the main welcome message on the support portal + homepage - name: greeting_subtitle - description: '' + description: Used when displaying the secondary welcome message or tagline on + the support portal - name: search_apis - description: '' + description: Used when configuring which external or internal APIs to query for + support content search + desc_done: true - table: tabSystem Console description: '' fields: - name: name - description: '' + description: Unique identifier for the system console entry, used when referencing + specific console configurations or logs. - name: type - description: '' + description: Categorizes the console type (e.g., SQL, command, debug), used when + filtering console operations by execution context. options: - Python - SQL - name: console - description: '' + description: Contains the actual console command or script text, used when searching + for specific operations or troubleshooting executed commands. - name: commit - description: '' + description: Indicates whether the console operation was committed to the database, + used when verifying transaction completion or rollback status. - name: output - description: '' + description: Stores the execution result or error message from the console operation, + used when analyzing outcomes or debugging failed commands. - name: show_processlist - description: '' + description: Flag indicating if the process list was displayed during execution, + used when tracking active database connections or performance monitoring activities. + desc_done: true - table: tabSystem Settings description: '' fields: @@ -28506,52 +35588,67 @@ tables: description: '' fields: - name: name - description: '' + description: Unique identifier or label for the tag used to categorize and filter + records across the system - name: description - description: '' + description: Detailed explanation of the tag's purpose, usage context, or business + meaning for classification + desc_done: true - table: tabTag Link description: '' fields: - name: name - description: '' + description: Unique identifier for the tag link record connecting a tag to a document. - name: document_type - description: '' + description: Specifies the type of document being tagged, used to filter tags + by module or entity type. join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: document_name - description: '' + description: References the specific document instance that has been tagged, used + to find all tags applied to a particular record. - name: tag - description: '' + description: The actual tag value applied to the document, used to search and + group documents by common labels or categories. join_hint: table: tabTag 'on': tag = tabTag.name - name: title - description: '' + description: Display name or label for the tag link, used for presenting tag associations + in user interfaces. + desc_done: true - table: tabTarget Detail description: '' fields: - name: name - description: '' + description: Unique identifier for the target detail record used when referencing + specific sales or performance targets. - name: item_group - description: '' + description: Product category or classification used when analyzing targets by + product line or merchandise grouping. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name - name: fiscal_year - description: '' + description: Financial year period for the target used when comparing performance + across different annual planning cycles. join_hint: table: tabFiscal Year 'on': fiscal_year = tabFiscal Year.name - name: target_qty - description: '' + description: Planned quantity goal used when measuring volume-based sales performance + against objectives. - name: target_amount - description: '' + description: Planned revenue or value goal used when measuring financial performance + against budget expectations. - name: distribution_id - description: '' + description: Reference to territory or channel assignment used when analyzing + targets by sales region or distribution network. join_hint: table: tabMonthly Distribution 'on': distribution_id = tabMonthly Distribution.name + desc_done: true - table: tabTask description: '' fields: @@ -28634,67 +35731,91 @@ tables: - name: act_start_date description: '' - name: actual_time - description: '' + description: Used to track the real hours spent on a task for labor cost analysis + and productivity reporting. - name: act_end_date - description: '' + description: Used to determine when a task was actually completed for schedule + variance and performance tracking. - name: total_costing_amount - description: '' + description: Used to analyze the total internal cost of a task for profitability + and budget variance reporting. - name: total_billing_amount - description: '' + description: Used to calculate revenue from a task for invoicing and project profitability + analysis. - name: review_date - description: '' + description: Used to identify when a task is scheduled for quality review or approval + checkpoint. - name: closing_date - description: '' + description: Used to determine when a task was officially closed for completion + reporting and audit trails. - name: department - description: '' + description: Used to filter and analyze tasks by organizational unit for departmental + performance and resource allocation. join_hint: table: tabDepartment 'on': department = tabDepartment.name - name: company - description: '' + description: Used to segment tasks by business entity for multi-company reporting + and consolidation. join_hint: table: tabCompany 'on': company = tabCompany.name - name: lft - description: '' + description: Used for hierarchical task tree queries to efficiently retrieve task + structures and parent-child relationships. - name: rgt - description: '' + description: Used for hierarchical task tree queries to efficiently retrieve task + structures and subtask boundaries. - name: old_parent - description: '' + description: Used to track task reparenting history for audit trails and organizational + change analysis. - name: template_task - description: '' + description: Used to identify if a task is a reusable template for standardizing + project creation and task duplication. + desc_done: false - table: tabTask Depends On description: '' fields: - name: name - description: '' + description: Unique identifier for the task dependency relationship record. - name: task - description: '' + description: The dependent task that cannot start or finish until another task + is completed. join_hint: table: tabTask 'on': task = tabTask.name - name: subject - description: '' + description: The predecessor task that must be completed before the dependent + task can proceed. - name: project - description: '' + description: The project context in which the task dependency relationship exists. + desc_done: true - table: tabTask Type description: '' fields: - name: name - description: '' + description: Identifies the specific task type category used when filtering, grouping, + or reporting on tasks by their classification. - name: weight - description: '' + description: Determines task priority or resource allocation weighting used when + calculating workload distribution or scheduling priorities. - name: description - description: '' + description: Provides detailed explanation of the task type used when users need + to understand task categorization rules or selection criteria. + desc_done: true - table: tabTax Category description: '' fields: - name: name - description: '' + description: Unique identifier for the tax category used to classify tax types + and link tax rules to transactions. - name: title - description: '' + description: Display label for the tax category shown to users when selecting + applicable tax classifications for items or transactions. - name: disabled - description: '' + description: Indicates whether this tax category is currently inactive and should + be excluded from selection in new transactions or configurations. + desc_done: true - table: tabTax Rule description: '' fields: @@ -28785,136 +35906,190 @@ tables: - name: priority description: '' - name: company - description: '' + description: Used to filter tax rules by specific company entity when analyzing + tax configurations or determining which tax rates apply to transactions for + a particular legal entity. join_hint: table: tabCompany 'on': company = tabCompany.name + desc_done: false - table: tabTax Withheld Vouchers description: '' fields: - name: name - description: '' + description: Unique identifier for the tax withheld voucher record used when referencing + specific withholding transactions. - name: voucher_type - description: '' + description: Classification of the voucher indicating the type of tax withholding + transaction being processed. - name: voucher_name - description: '' + description: Descriptive label for the voucher used when searching or reporting + on specific tax withholding events. - name: taxable_amount - description: '' + description: The base amount subject to tax withholding used when calculating + withholding obligations or analyzing taxable income. + desc_done: true - table: tabTax Withholding Account description: '' fields: - name: name - description: '' + description: Unique identifier for the tax withholding account configuration used + when referencing specific withholding setups in payroll or vendor payment scenarios. - name: company - description: '' + description: Company entity associated with this tax withholding account, used + when filtering withholding configurations by legal entity or organizational + unit. join_hint: table: tabCompany 'on': company = tabCompany.name - name: account - description: '' + description: General ledger account where tax withholding amounts are posted, + used when tracking liabilities or reconciling withheld taxes for remittance + to authorities. join_hint: table: tabAccount 'on': account = tabAccount.name + desc_done: true - table: tabTax Withholding Category description: '' fields: - name: name - description: '' + description: Unique identifier for the tax withholding category used when referencing + specific withholding rules in transactions and reports. - name: category_name - description: '' + description: Descriptive label for the withholding category used when classifying + and filtering tax deduction types across vendors or customers. - name: round_off_tax_amount - description: '' + description: Indicates whether calculated withholding tax should be rounded to + nearest whole number, used when precise tax amounts are required for compliance. - name: consider_party_ledger_amount - description: '' + description: Determines if cumulative transaction amounts with the party should + be evaluated for threshold-based withholding, used when tax applies only after + spending limits. - name: tax_on_excess_amount - description: '' + description: Specifies whether withholding tax applies only to amounts exceeding + a threshold rather than the total, used for progressive tax calculations. - name: rates - description: '' + description: Defines applicable tax percentage rates and threshold slabs for this + withholding category, used when calculating deduction amounts based on transaction + values. - name: accounts - description: '' + description: Lists the general ledger accounts where withheld tax amounts are + posted, used when recording tax liabilities and generating tax payable reports. + desc_done: true - table: tabTax Withholding Rate description: '' fields: - name: name - description: '' + description: Identifies the specific tax withholding rate configuration or rule + being applied for payroll tax calculations. - name: from_date - description: '' + description: Used to determine when a tax withholding rate becomes effective for + payroll processing within a date range. - name: to_date - description: '' + description: Used to determine when a tax withholding rate expires or is no longer + applicable for payroll calculations. - name: tax_withholding_rate - description: '' + description: Specifies the percentage rate applied to calculate tax withholding + amounts from employee compensation. - name: single_threshold - description: '' + description: Defines the income threshold for applying tax withholding rates to + individual payment transactions. - name: cumulative_threshold - description: '' + description: Defines the year-to-date income threshold for applying progressive + tax withholding rates across multiple pay periods. + desc_done: true - table: tabTelephony Call Type description: '' fields: - name: name - description: '' + description: Unique identifier for the telephony call type used when filtering + or reporting on specific call categories. - name: call_type - description: '' + description: Classification of the call (inbound, outbound, internal) used when + analyzing call direction patterns or routing rules. - name: amended_from - description: '' + description: Reference to the original call type record if this was modified, + used when tracking call type configuration changes or audit history. join_hint: table: tabTelephony Call Type 'on': amended_from = tabTelephony Call Type.name + desc_done: true - table: tabTerms and Conditions description: 'Standard Terms and Conditions that can be added to Sales and Purchases. Examples: Validity of the offer, Payment Terms, Safety and Usage, etc.' fields: - name: name - description: '' + description: Unique identifier for the terms and conditions record, used when + referencing specific T&C agreements in transactions or queries. - name: title - description: '' + description: Display name of the terms and conditions, used when searching for + or selecting applicable T&C in sales or purchase documents. - name: disabled - description: '' + description: Indicates if these terms are inactive and should be excluded from + selection in active transactions. - name: selling - description: '' + description: Flag showing if these terms apply to sales transactions, used when + filtering T&C for customer-facing documents. - name: buying - description: '' + description: Flag showing if these terms apply to purchase transactions, used + when filtering T&C for supplier-facing documents. - name: terms - description: '' + description: Full text of the terms and conditions content, searched when looking + for specific clauses or legal language in agreements. + desc_done: true - table: tabTerritory description: Classification of Customers by region fields: - name: name - description: '' + description: Unique identifier for the territory record used in lookups and references. - name: territory_name - description: '' + description: Display name of the sales territory used when filtering or grouping + sales data by region. - name: parent_territory - description: '' + description: Links to the parent territory in hierarchical reporting structures + for roll-up analysis. join_hint: table: tabTerritory 'on': parent_territory = tabTerritory.name - name: is_group - description: '' + description: Indicates if this territory contains sub-territories, used when analyzing + regional vs. district-level performance. - name: territory_manager - description: '' + description: Assigned manager responsible for the territory, used in sales performance + and accountability reports. join_hint: table: tabSales Person 'on': territory_manager = tabSales Person.name - name: lft - description: '' + description: Left boundary value in nested set model for efficient territory hierarchy + queries. - name: rgt - description: '' + description: Right boundary value in nested set model for efficient territory + hierarchy queries. - name: old_parent - description: '' + description: Previous parent territory before reorganization, used for historical + territory assignment tracking. join_hint: table: tabTerritory 'on': old_parent = tabTerritory.name - name: targets - description: '' + description: Sales or revenue targets assigned to the territory for performance + measurement and goal tracking. + desc_done: true - table: tabTerritory Item description: '' fields: - name: name - description: '' + description: Unique identifier for the territory-item relationship record, used + when querying specific territory and item combinations. - name: territory - description: '' + description: Links to the specific sales territory where this item is available + or authorized for sale, used when filtering products by geographic sales region. join_hint: table: tabTerritory 'on': territory = tabTerritory.name + desc_done: true - table: tabTimesheet description: '' fields: @@ -29002,16 +36177,21 @@ tables: - name: total_billed_amount description: '' - name: total_costing_amount - description: '' + description: Used to analyze actual labor costs incurred for timesheet entries + when calculating project profitability or employee cost allocation. - name: per_billed - description: '' + description: Used to determine what percentage of timesheet hours are billable + to clients versus internal or non-billable work. - name: note - description: '' + description: Used when searching for additional context or comments explaining + timesheet entries, delays, or special circumstances. - name: amended_from - description: '' + description: Used to track timesheet correction history when auditing changes + or identifying which original timesheet was modified. join_hint: table: tabTimesheet 'on': amended_from = tabTimesheet.name + desc_done: false - table: tabTimesheet Detail description: '' fields: @@ -29075,114 +36255,151 @@ tables: description: '' fields: - name: name - description: '' + description: Unique identifier or title of the to-do task used when searching + for specific tasks or filtering task lists. - name: status - description: '' + description: Current state of the to-do item (open, closed, cancelled) used when + filtering tasks by completion status or tracking progress. options: - Open - Closed - Cancelled - name: priority - description: '' + description: Urgency level of the task (low, medium, high) used when prioritizing + workload or filtering critical tasks. options: - High - Medium - Low - name: color - description: '' + description: Visual indicator for task categorization used when organizing or + quickly identifying task types in dashboards. - name: date - description: '' + description: Due date or creation date of the task used when filtering overdue + items or scheduling work by timeline. - name: allocated_to - description: '' + description: User assigned to complete the task used when filtering tasks by owner + or checking individual workloads. join_hint: table: tabUser 'on': allocated_to = tabUser.name - name: description - description: '' + description: Detailed explanation of the task requirements used when searching + for tasks by content or understanding task scope. - name: reference_type - description: '' + description: Type of linked document (Sales Order, Project, Issue) used when filtering + tasks by related business process or module. join_hint: table: tabDocType 'on': reference_type = tabDocType.name - name: reference_name - description: '' + description: Specific document ID linked to this task used when tracing tasks + back to originating transactions or projects. - name: role - description: '' + description: User role assigned to handle the task used when routing tasks by + department or filtering by functional responsibility. join_hint: table: tabRole 'on': role = tabRole.name - name: assigned_by - description: '' + description: User ID who created or delegated the task used when tracking task + origin or filtering by task creator. join_hint: table: tabUser 'on': assigned_by = tabUser.name - name: assigned_by_full_name - description: '' + description: Full name of the user who assigned the task used when displaying + task assignment history in reports. - name: sender - description: '' + description: Original requestor or initiator of the task used when identifying + task source or filtering by external stakeholders. - name: assignment_rule - description: '' + description: Automated rule that created the task used when analyzing task distribution + logic or troubleshooting auto-assignments. join_hint: table: tabAssignment Rule 'on': assignment_rule = tabAssignment Rule.name + desc_done: true - table: tabToken Cache description: '' fields: - name: name - description: '' + description: Unique identifier for the token cache record, used when searching + for specific token instances. - name: user - description: '' + description: Links the token to a specific user, used when filtering tokens by + user ownership or access rights. join_hint: table: tabUser 'on': user = tabUser.name - name: connected_app - description: '' + description: Identifies which application the token authorizes, used when querying + tokens for specific app integrations. join_hint: table: tabConnected App 'on': connected_app = tabConnected App.name - name: provider_name - description: '' + description: Specifies the OAuth provider (e.g., Google, Salesforce), used when + filtering tokens by authentication service. - name: access_token - description: '' + description: The actual authorization credential, used when validating or troubleshooting + active API connections. - name: refresh_token - description: '' + description: Token used to obtain new access tokens, queried when investigating + token renewal or expiration issues. - name: expires_in - description: '' + description: Duration until token expiration in seconds, used when identifying + expired or soon-to-expire tokens. - name: state - description: '' + description: Current status of the token (active, expired, revoked), used when + filtering valid or problematic tokens. - name: scopes - description: '' + description: Permissions granted by the token, used when auditing access levels + or troubleshooting authorization failures. - name: success_uri - description: '' + description: Redirect URL after successful authentication, used when debugging + OAuth flow completion issues. - name: token_type - description: '' + description: Type of token (Bearer, etc.), used when filtering tokens by authentication + mechanism. + desc_done: true - table: tabTop Bar Item description: '' fields: - name: name - description: '' + description: Unique identifier for the top bar menu item used in system configuration + and navigation setup. - name: label - description: '' + description: Display text shown to users in the top navigation bar for this menu + item. - name: url - description: '' + description: Target destination or route when users click this top bar item for + navigation. - name: open_in_new_tab - description: '' + description: Flag indicating whether clicking this item opens the destination + in a new browser tab or current window. - name: right - description: '' + description: Boolean determining if this menu item appears on the right side of + the top bar instead of left. - name: parent_label - description: '' + description: Reference to parent menu item label for creating hierarchical dropdown + menus in the top navigation. + desc_done: true - table: tabTransaction Deletion Record description: '' fields: - name: name - description: '' + description: Unique identifier for the transaction deletion record, used when + referencing or tracking specific deletion operations. - name: company - description: '' + description: Specifies which company's data is being deleted, used when filtering + deletion records by organizational entity. join_hint: table: tabCompany 'on': company = tabCompany.name - name: status - description: '' + description: Indicates current state of the deletion process (pending, completed, + failed), used when monitoring deletion job progress. options: - Queued - Running @@ -29190,641 +36407,861 @@ tables: - Completed - Cancelled - name: error_log - description: '' + description: Contains failure details when deletion encounters issues, used when + troubleshooting failed deletion operations. - name: delete_bin_data - description: '' + description: Flag indicating whether to remove recycled/bin items, used when determining + if soft-deleted records should be permanently purged. - name: delete_leads_and_addresses - description: '' + description: Controls removal of lead and address records, used when deciding + if CRM and contact data should be included in deletion. - name: reset_company_default_values - description: '' + description: Flag for restoring company settings to defaults, used when cleaning + up customized configurations during deletion. - name: clear_notifications - description: '' + description: Indicates whether to remove notification records, used when determining + if alert history should be purged. - name: initialize_doctypes_table - description: '' + description: Controls resetting of document type configurations, used when preparing + system for fresh doctype setup after deletion. - name: delete_transactions - description: '' + description: Master flag enabling transaction data removal, used when confirming + if transactional records should be deleted. - name: doctypes - description: '' + description: List of document types to be deleted, used when specifying which + record types are included in the deletion scope. - name: doctypes_to_be_ignored - description: '' + description: Document types excluded from deletion, used when protecting specific + record types from removal. - name: amended_from - description: '' + description: References the original deletion record if this is an amendment, + used when tracking deletion record revisions. join_hint: table: tabTransaction Deletion Record 'on': amended_from = tabTransaction Deletion Record.name - name: process_in_single_transaction - description: '' + description: Controls whether deletion executes atomically, used when ensuring + all-or-nothing deletion behavior for data integrity. + desc_done: true - table: tabTransaction Deletion Record Details description: '' fields: - name: name - description: '' + description: Unique identifier for the transaction deletion record, used when + tracking or referencing specific deletion operations. - name: doctype_name - description: '' + description: The document type being deleted, used when filtering deletion records + by module or entity type. join_hint: table: tabDocType 'on': doctype_name = tabDocType.name - name: docfield_name - description: '' + description: The specific field within the document type being deleted, used when + analyzing deletion scope at field level. - name: no_of_docs - description: '' + description: Total count of documents affected by this deletion operation, used + when assessing deletion impact or volume. - name: done - description: '' + description: Completion status of the deletion process, used when checking if + deletion has finished or is still in progress. + desc_done: true - table: tabTransaction Deletion Record Item description: '' fields: - name: name - description: '' + description: Unique identifier for each transaction deletion record item, used + when tracking or auditing specific deleted transaction line items. - name: doctype_name - description: '' + description: Specifies the document type of the deleted transaction item, used + when filtering or reporting on deletions by transaction category such as invoices, + payments, or journal entries. join_hint: table: tabDocType 'on': doctype_name = tabDocType.name + desc_done: true - table: tabTransaction Log description: '' fields: - name: name - description: '' + description: Unique identifier for the transaction log entry, used when referencing + specific audit trail records. - name: row_index - description: '' + description: Sequential position of this transaction in the log, used to track + chronological order and detect missing entries. - name: reference_doctype - description: '' + description: Type of document being tracked, used to filter audit logs by module + or transaction category. - name: document_name - description: '' + description: Specific document identifier being audited, used to retrieve complete + change history for a particular record. - name: timestamp - description: '' + description: Exact date and time of the transaction, used for temporal analysis + and compliance reporting of when changes occurred. - name: checksum_version - description: '' + description: Version of the hashing algorithm used, relevant for validating data + integrity across system upgrades. - name: previous_hash - description: '' + description: Hash of the preceding transaction, used to verify unbroken audit + chain and detect tampering. - name: transaction_hash - description: '' + description: Cryptographic hash of this transaction's data, used to verify individual + record integrity and detect unauthorized modifications. - name: chaining_hash - description: '' + description: Combined hash linking this transaction to the chain, used for blockchain-style + audit trail validation. - name: data - description: '' + description: JSON payload containing the actual transaction details, used to examine + what specific changes were made to the document. - name: amended_from - description: '' + description: Reference to the original document if this is an amendment, used + to track correction history and amendment trails. join_hint: table: tabTransaction Log 'on': amended_from = tabTransaction Log.name + desc_done: true - table: tabTranslation description: '' fields: - name: name - description: '' + description: Unique identifier for the translation record, used when referencing + specific translation entries. - name: contributed - description: '' + description: Indicates whether the translation was user-contributed, used to filter + community vs official translations. - name: language - description: '' + description: Target language code for the translation, used when filtering or + searching translations by language. join_hint: table: tabLanguage 'on': language = tabLanguage.name - name: source_text - description: '' + description: Original text to be translated, used when searching for translations + of specific phrases or content. - name: context - description: '' + description: Contextual information about where the source text appears, used + to disambiguate translations for the same text in different scenarios. - name: translated_text - description: '' + description: The actual translated content in the target language, used when retrieving + or validating translation output. - name: contribution_status - description: '' + description: Approval status of contributed translations, used to filter verified + vs pending translations. options: - Pending - Verified - Rejected - name: contribution_docname - description: '' + description: Reference to the document or module where the translation applies, + used to scope translations to specific areas of the system. + desc_done: true - table: tabUAE VAT Account description: '' fields: - name: name - description: '' + description: name - name: account - description: '' + description: account join_hint: table: tabAccount 'on': account = tabAccount.name + desc_done: true - table: tabUAE VAT Settings description: '' fields: - name: name - description: '' + description: Unique identifier for the UAE VAT settings configuration record. - name: company - description: '' + description: Specifies which company entity this UAE VAT configuration applies + to for multi-company VAT compliance. join_hint: table: tabCompany 'on': company = tabCompany.name - name: uae_vat_accounts - description: '' + description: Links to the chart of accounts used for UAE VAT posting and reporting + requirements. + desc_done: true - table: tabUOM description: '' fields: - name: name - description: '' + description: Unique identifier for the unit of measure record, used when referencing + specific UOMs in queries about inventory or transactions. - name: enabled - description: '' + description: Indicates whether this unit of measure is currently active for use + in transactions, relevant when filtering available UOMs for item setup or order + entry. - name: uom_name - description: '' + description: Display name of the unit of measure (e.g., 'Each', 'Box', 'Kilogram'), + used when searching for or reporting on specific measurement units. - name: must_be_whole_number - description: '' + description: Determines if quantities in this UOM require integer values only, + relevant when validating transaction quantities or identifying UOMs that allow + fractional amounts. + desc_done: true - table: tabUOM Category description: '' fields: - name: name - description: '' + description: Unique identifier for the unit of measure category used when searching + or filtering UOM groupings by their system name. - name: category_name - description: '' + description: Display name of the UOM category used when users need to identify + or report on groups of related units like weight, volume, or length. + desc_done: true - table: tabUOM Conversion Detail description: '' fields: - name: name - description: '' + description: Unique identifier for this unit of measure conversion record, used + when referencing specific conversion rules between units. - name: uom - description: '' + description: Target unit of measure being converted to, used when finding how + to convert quantities from base units to alternative units like cases, pallets, + or dozens. join_hint: table: tabUOM 'on': uom = tabUOM.name - name: conversion_factor - description: '' + description: Multiplier that converts from base unit to target unit, used when + calculating equivalent quantities across different units of measure in inventory + or sales. + desc_done: true - table: tabUOM Conversion Factor description: '' fields: - name: name - description: '' + description: Unique identifier for this specific unit of measure conversion rule - name: category - description: '' + description: Item category or group this UOM conversion applies to for category-specific + conversion rates join_hint: table: tabUOM Category 'on': category = tabUOM Category.name - name: from_uom - description: '' + description: Source unit of measure being converted from when calculating quantity + equivalents join_hint: table: tabUOM 'on': from_uom = tabUOM.name - name: to_uom - description: '' + description: Target unit of measure being converted to when calculating quantity + equivalents join_hint: table: tabUOM 'on': to_uom = tabUOM.name - name: value - description: '' + description: Multiplication factor applied to convert quantities from the source + UOM to the target UOM + desc_done: true - table: tabUnhandled Email description: '' fields: - name: name - description: '' + description: Unique identifier for the unhandled email record used when referencing + specific failed email processing instances - name: email_account - description: '' + description: Links to the email account that received the unhandled message, used + when investigating email processing issues by account join_hint: table: tabEmail Account 'on': email_account = tabEmail Account.name - name: uid - description: '' + description: External unique identifier from the email server used when tracking + or reconciling emails with source systems - name: reason - description: '' + description: Explains why the email could not be processed, used when analyzing + email handling failures and troubleshooting patterns - name: message_id - description: '' + description: Standard email Message-ID header used when searching for specific + emails or tracking email threads - name: raw - description: '' + description: Complete raw email content including headers and body, used when + manual review or reprocessing of failed emails is needed + desc_done: true - table: tabUnreconcile Payment description: '' fields: - name: name - description: '' + description: Unique identifier for the unreconcile payment transaction record - name: company - description: '' + description: Company entity for which the payment unreconciliation is being processed join_hint: table: tabCompany 'on': company = tabCompany.name - name: voucher_type - description: '' + description: Document type of the original payment voucher being unreconciled, + such as Payment Entry or Journal Entry join_hint: table: tabDocType 'on': voucher_type = tabDocType.name - name: voucher_no - description: '' + description: Reference number of the specific payment voucher being unreconciled + from invoices or bills - name: allocations - description: '' + description: List of invoice or bill allocations that are being reversed or removed + from the original payment - name: amended_from - description: '' + description: Reference to the previous unreconcile payment record if this transaction + is an amendment or correction join_hint: table: tabUnreconcile Payment 'on': amended_from = tabUnreconcile Payment.name + desc_done: true - table: tabUnreconcile Payment Entries description: '' fields: - name: name - description: '' + description: Unique identifier for the unreconciled payment entry record used + to track reversal transactions. - name: account - description: '' + description: The ledger account from which the payment allocation is being reversed + or unreconciled. - name: party_type - description: '' + description: Specifies whether the unreconciled payment involves a Customer, Supplier, + or other entity type. - name: party - description: '' + description: The specific customer or supplier whose payment allocation is being + unreconciled. - name: reference_doctype - description: '' + description: The document type (e.g., Sales Invoice, Purchase Invoice) that was + originally linked to the payment being unreconciled. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_name - description: '' + description: The specific document number or ID of the invoice or transaction + being unlinked from the payment. - name: allocated_amount - description: '' + description: The monetary value of the payment allocation that is being reversed + or unreconciled. - name: account_currency - description: '' + description: The currency in which the unreconciled payment and account are denominated. join_hint: table: tabCurrency 'on': account_currency = tabCurrency.name - name: unlinked - description: '' + description: Indicates whether the payment entry has been successfully unlinked + from its original reference document. + desc_done: true - table: tabUser Document Type description: '' fields: - name: name - description: '' + description: Unique identifier for the user document type permission record. - name: document_type - description: '' + description: The DocType for which this user has specific permissions assigned. join_hint: table: tabDocType 'on': document_type = tabDocType.name - name: is_custom - description: '' + description: Indicates whether this document type permission was custom-created + versus system-default. - name: read - description: '' + description: Grants user permission to view records of this document type. - name: write - description: '' + description: Grants user permission to edit existing records of this document + type. - name: create - description: '' + description: Grants user permission to create new records of this document type. - name: submit - description: '' + description: Grants user permission to submit records of this document type for + approval or finalization. - name: cancel - description: '' + description: Grants user permission to cancel submitted records of this document + type. - name: amend - description: '' + description: Grants user permission to amend cancelled records of this document + type. - name: delete - description: '' + description: Grants user permission to permanently delete records of this document + type. - name: email - description: '' + description: Grants user permission to send email notifications related to this + document type. - name: share - description: '' + description: Grants user permission to share records of this document type with + other users. - name: print - description: '' + description: Grants user permission to print records of this document type. + desc_done: true - table: tabUser Email description: '' fields: - name: name - description: '' + description: Identifies the email account configuration name for filtering and + reporting on specific email setups. - name: email_account - description: '' + description: References the associated email account used when querying which + users have specific email providers or domains configured. join_hint: table: tabEmail Account 'on': email_account = tabEmail Account.name - name: email_id - description: '' + description: Unique identifier for the email record used when joining to email + transaction or audit tables. - name: awaiting_password - description: '' + description: Indicates whether email setup is incomplete due to pending password + entry, used to identify blocked or incomplete configurations. - name: used_oauth - description: '' + description: Flags whether OAuth authentication is enabled, used when analyzing + security methods or troubleshooting authentication issues. - name: enable_outgoing - description: '' + description: Determines if outbound email is active for this account, used when + diagnosing why emails are not being sent or filtering active sending accounts. + desc_done: true - table: tabUser Group description: '' fields: - name: name - description: '' + description: Identifies the user group for access control, permissions assignment, + and filtering users by role or department in security and reporting queries. - name: user_group_members - description: '' + description: Lists users belonging to this group for analyzing group membership, + auditing access rights, and determining who has specific permissions or roles. + desc_done: true - table: tabUser Group Member description: '' fields: - name: name - description: '' + description: Unique identifier for the user group member record, used when querying + specific group membership assignments or tracking individual member entries. - name: user - description: '' + description: Links to the specific user who is a member of the group, used when + finding which users belong to a group or checking a user's group memberships. join_hint: table: tabUser 'on': user = tabUser.name + desc_done: true - table: tabUser Invitation description: '' fields: - name: name - description: '' + description: Name of the person being invited to access the ERP system. - name: email - description: '' + description: Email address where the invitation is sent and used for user account + creation. - name: app_name - description: '' + description: Specific ERP application or module the invitation grants access to. - name: redirect_to_path - description: '' + description: URL path where the user is redirected after accepting the invitation. - name: roles - description: '' + description: Permission roles or access levels assigned to the invited user upon + acceptance. - name: status - description: '' + description: Current state of the invitation such as pending, accepted, expired, + or cancelled. options: - Pending - Accepted - Expired - Cancelled - name: invited_by - description: '' + description: User who created and sent this invitation, used for tracking invitation + sources. join_hint: table: tabUser 'on': invited_by = tabUser.name - name: key - description: '' + description: Unique token or identifier used to validate and process the invitation + acceptance. - name: user - description: '' + description: Reference to the user account created or linked after invitation + acceptance. join_hint: table: tabUser 'on': user = tabUser.name - name: email_sent_at - description: '' + description: Timestamp when the invitation email was delivered, used for tracking + communication timing. - name: accepted_at - description: '' + description: Timestamp when the invitee accepted the invitation and completed + registration. + desc_done: true - table: tabUser Role description: '' fields: - name: name - description: '' + description: The name or title of the user role, used to identify and filter access + permissions and user groups. - name: role - description: '' + description: The role identifier or type assigned to users, used to determine + authorization levels and filter users by their functional responsibilities. join_hint: table: tabRole 'on': role = tabRole.name + desc_done: true - table: tabUser Select Document Type description: '' fields: - name: name - description: '' + description: Unique identifier or label for the document type selection record. - name: document_type - description: '' + description: Specifies which type of document the user is selecting or working + with, used when filtering or categorizing documents by their classification. join_hint: table: tabDocType 'on': document_type = tabDocType.name + desc_done: true - table: tabUser Social Login description: '' fields: - name: name - description: '' + description: Full name of the user retrieved from the social login provider, used + when identifying or displaying user information from external authentication + sources. - name: provider - description: '' + description: Social authentication platform (e.g., Google, Facebook, LinkedIn) + used for login, queried when analyzing login methods or filtering users by authentication + source. - name: username - description: '' + description: User's account identifier on the social platform, referenced when + matching or reconciling user accounts across systems. - name: userid - description: '' + description: Unique identifier linking the social login to the internal user record, + used when joining user authentication data with core user profiles or tracking + login history. + desc_done: true - table: tabUser Type description: '' fields: - name: name - description: '' + description: Unique identifier for the user type, used when filtering or referencing + specific user access configurations. - name: is_standard - description: '' + description: Indicates if this is a system-defined user type that cannot be deleted, + relevant when determining which user types can be modified. - name: role - description: '' + description: The role assigned to users of this type, used when analyzing permissions + and access control by user category. join_hint: table: tabRole 'on': role = tabRole.name - name: apply_user_permission_on - description: '' + description: Specifies the DocType on which user permissions are enforced, relevant + when restricting data visibility based on user type. join_hint: table: tabDocType 'on': apply_user_permission_on = tabDocType.name - name: user_id_field - description: '' + description: The field name used to link records to specific users, critical when + implementing row-level security and data ownership rules. - name: user_doctypes - description: '' + description: List of DocTypes accessible to this user type, used when determining + which modules and documents users can interact with. - name: custom_select_doctypes - description: '' + description: Custom-defined DocTypes available for selection, relevant when extending + user type access beyond standard configurations. - name: select_doctypes - description: '' + description: Standard DocTypes that can be selected for user permissions, used + when configuring which document types are subject to user-level restrictions. - name: user_type_modules - description: '' + description: Modules accessible to this user type, critical when analyzing feature + access and license allocation by user category. + desc_done: true - table: tabUser Type Module description: '' fields: - name: name - description: '' + description: The unique identifier or label of the user type, used when filtering + or searching for specific user classifications or roles in the system. - name: module - description: '' + description: The functional module or application area this user type belongs + to, used when analyzing user access patterns or segmenting users by business + domain. join_hint: table: tabModule Def 'on': module = tabModule Def.name + desc_done: true - table: tabVariant Field description: '' fields: - name: name - description: '' + description: The display label or title of the variant field used when users need + to identify or reference specific product variant attributes in reports and + configurations. - name: field_name - description: '' + description: The technical identifier or system name of the variant field used + when querying or filtering product variations by specific attribute types like + size, color, or material. + desc_done: true - table: tabVehicle description: '' fields: - name: name - description: '' + description: Unique identifier or label for the vehicle used in reports and tracking - name: license_plate - description: '' + description: Registration number used to identify vehicles in compliance and operational + queries - name: make - description: '' + description: Vehicle manufacturer brand used when filtering or analyzing fleet + composition by brand - name: model - description: '' + description: Specific vehicle model used for maintenance planning and fleet standardization + analysis - name: last_odometer - description: '' + description: Most recent mileage reading used to track usage, schedule maintenance, + and calculate depreciation - name: acquisition_date - description: '' + description: Date vehicle was purchased or acquired used for age analysis and + depreciation calculations - name: location - description: '' + description: Current physical location or assignment of vehicle used for allocation + and availability tracking - name: chassis_no - description: '' + description: Vehicle identification number used for warranty claims, recalls, + and unique identification - name: vehicle_value - description: '' + description: Current or acquisition value used for asset reporting, insurance, + and financial analysis - name: employee - description: '' + description: Person assigned or responsible for the vehicle used in allocation + and accountability tracking join_hint: table: tabEmployee 'on': employee = tabEmployee.name - name: insurance_company - description: '' + description: Provider of vehicle insurance used when reviewing coverage and filing + claims - name: policy_no - description: '' + description: Insurance policy identifier used to verify coverage and process insurance-related + transactions - name: start_date - description: '' + description: Insurance or lease coverage start date used to validate active coverage + periods - name: end_date - description: '' + description: Insurance or lease coverage end date used to identify expiring policies + requiring renewal - name: fuel_type - description: '' + description: Type of fuel the vehicle uses for cost analysis and environmental + reporting options: - Petrol - Diesel - Natural Gas - Electric - name: uom - description: '' + description: Unit of measure for fuel consumption used in efficiency calculations + and reporting join_hint: table: tabUOM 'on': uom = tabUOM.name - name: carbon_check_date - description: '' + description: Date of last emissions or environmental inspection used for compliance + tracking - name: color - description: '' + description: Vehicle exterior color used for identification and matching in incident + reports - name: wheels - description: '' + description: Number of wheels used for vehicle classification and maintenance + specifications - name: doors - description: '' + description: Number of doors used for vehicle type classification and capacity + planning - name: amended_from - description: '' + description: Reference to previous version if record was modified used for audit + trail and change tracking join_hint: table: tabVehicle 'on': amended_from = tabVehicle.name + desc_done: true - table: tabVideo description: '' fields: - name: name - description: '' + description: Unique identifier for the video record used when referencing specific + videos in queries or reports. - name: title - description: '' + description: Video title used when searching for content by name or analyzing + video performance by topic. - name: provider - description: '' + description: Platform or source of the video used when filtering or comparing + performance across different video hosting services. options: - YouTube - Vimeo - name: url - description: '' + description: Direct link to the video used when accessing the original content + or verifying video availability. - name: youtube_video_id - description: '' + description: YouTube-specific identifier used when integrating with YouTube API + or tracking YouTube-hosted content. - name: publish_date - description: '' + description: Date the video was published used when analyzing trends over time + or filtering videos by recency. - name: duration - description: '' + description: Length of the video in seconds used when analyzing engagement by + video length or filtering by content duration. - name: like_count - description: '' + description: Number of likes received used when measuring positive audience engagement + and content popularity. - name: view_count - description: '' + description: Total number of views used when measuring reach, popularity, and + overall video performance. - name: dislike_count - description: '' + description: Number of dislikes received used when assessing negative feedback + and calculating engagement ratios. - name: comment_count - description: '' + description: Number of comments posted used when measuring audience interaction + and discussion level. - name: description - description: '' + description: Full text description of the video used when searching content by + keywords or understanding video context. + desc_done: true - table: tabVideo Settings description: '' fields: - name: name - description: '' + description: Identifies the specific video settings configuration being referenced + in analytics or integration queries. - name: enable_youtube_tracking - description: '' + description: Used when determining whether YouTube video engagement metrics are + being captured for marketing or content performance analysis. - name: api_key - description: '' + description: Referenced when troubleshooting video platform integrations or validating + third-party service connections for data synchronization. - name: frequency - description: '' + description: Used when analyzing how often video tracking data is refreshed or + synchronized for reporting purposes. options: - 30 mins - 1 hr - 6 hrs - Daily + desc_done: true - table: tabView Log description: '' fields: - name: name - description: '' + description: Unique identifier for each view log entry, used when tracking specific + view events or auditing individual access records. - name: viewed_by - description: '' + description: User who accessed the document, used when analyzing who viewed specific + records or tracking user activity patterns. - name: reference_doctype - description: '' + description: Type of document that was viewed (e.g., Sales Order, Customer), used + when filtering view logs by document category or analyzing access patterns by + module. join_hint: table: tabDocType 'on': reference_doctype = tabDocType.name - name: reference_name - description: '' + description: Specific document identifier that was accessed, used when tracking + views of particular records or investigating access history for individual transactions. + desc_done: true - table: tabVoice Call Settings description: '' fields: - name: name - description: '' + description: Unique identifier for the voice call configuration record used when + referencing specific call settings. - name: user - description: '' + description: Links call settings to a specific user account for routing and personalizing + their voice call experience. join_hint: table: tabUser 'on': user = tabUser.name - name: call_receiving_device - description: '' + description: Specifies which device or endpoint receives incoming calls for this + user's configuration. options: - Computer - Phone - name: greeting_message - description: '' + description: Defines the initial message played to callers when they connect, + used for customizing caller experience. - name: agent_busy_message - description: '' + description: Message played to callers when the assigned agent is currently on + another call or unavailable due to busy status. - name: agent_unavailable_message - description: '' + description: Message played to callers when the agent is offline, logged out, + or otherwise not reachable for calls. + desc_done: true - table: tabWarehouse description: A logical Warehouse against which stock entries are made. fields: - name: name - description: '' + description: Unique identifier for the warehouse record used in lookups and references. - name: disabled - description: '' + description: Indicates if warehouse is inactive and excluded from transactions. - name: warehouse_name - description: '' + description: Display name of the warehouse used in stock queries and inventory + reports. - name: is_group - description: '' + description: Flags if this is a parent warehouse grouping multiple child warehouses + for hierarchical reporting. - name: parent_warehouse - description: '' + description: Links to parent warehouse for nested warehouse structures and consolidated + inventory views. join_hint: table: tabWarehouse 'on': parent_warehouse = tabWarehouse.name - name: is_rejected_warehouse - description: '' + description: Marks warehouse designated for storing rejected or non-conforming + inventory. - name: account - description: '' + description: General ledger account linked to warehouse for inventory valuation + and accounting integration. join_hint: table: tabAccount 'on': account = tabAccount.name - name: company - description: '' + description: Company entity owning this warehouse for multi-company inventory + segregation. join_hint: table: tabCompany 'on': company = tabCompany.name - name: email_id - description: '' + description: Contact email for warehouse communications and automated notifications. - name: phone_no - description: '' + description: Primary phone contact for warehouse operations and coordination. - name: mobile_no - description: '' + description: Mobile contact for urgent warehouse matters and field communications. - name: address_line_1 - description: '' + description: Primary street address for shipping, receiving, and warehouse location + queries. - name: address_line_2 - description: '' + description: Secondary address details for precise warehouse location identification. - name: city - description: '' + description: City location used in regional inventory distribution and logistics + planning. - name: state - description: '' + description: State or province for tax calculations and regional stock analysis. - name: pin - description: '' + description: Postal code for shipping calculations and delivery zone determination. - name: warehouse_type - description: '' + description: Classification of warehouse function such as storage, transit, or + retail for operational filtering. join_hint: table: tabWarehouse Type 'on': warehouse_type = tabWarehouse Type.name - name: default_in_transit_warehouse - description: '' + description: Designated warehouse for goods in transit between locations during + stock transfers. join_hint: table: tabWarehouse 'on': default_in_transit_warehouse = tabWarehouse.name - name: lft - description: '' + description: Left boundary in nested set model for warehouse hierarchy traversal. - name: rgt - description: '' + description: Right boundary in nested set model for warehouse hierarchy queries. - name: old_parent - description: '' + description: Previous parent warehouse tracked during hierarchy restructuring + and audit trails. join_hint: table: tabWarehouse 'on': old_parent = tabWarehouse.name + desc_done: true - table: tabWarehouse Type description: '' fields: - name: name - description: '' + description: Unique identifier or label for the warehouse type used to categorize + and differentiate warehouse facilities by their operational purpose or characteristics. - name: description - description: '' + description: Detailed explanation of the warehouse type's purpose, operational + characteristics, or business function used when analyzing warehouse capabilities + or filtering by facility classification. + desc_done: true - table: tabWarranty Claim description: '' fields: @@ -29915,21 +37352,27 @@ tables: - name: address_display description: '' - name: service_address - description: '' + description: Location where warranty service was performed or product is installed, + used to analyze claims by geographic region or service territory. - name: company - description: '' + description: Company entity that owns or processes the warranty claim, used to + filter claims by business unit or legal entity. join_hint: table: tabCompany 'on': company = tabCompany.name - name: complaint_raised_by - description: '' + description: Customer or contact who initiated the warranty claim, used to track + claim originators and analyze customer complaint patterns. - name: from_company - description: '' + description: Originating company when warranty claim involves inter-company transactions + or transfers between subsidiaries. - name: amended_from - description: '' + description: Reference to original warranty claim that was modified or corrected, + used to track claim revision history and amendments. join_hint: table: tabWarranty Claim 'on': amended_from = tabWarranty Claim.name + desc_done: false - table: tabWeb Form description: '' fields: @@ -29993,41 +37436,57 @@ tables: - name: list_title description: '' - name: list_columns - description: '' + description: Defines which data columns appear in the web form's list view for + users browsing submitted entries. - name: show_sidebar - description: '' + description: Controls whether a sidebar navigation panel displays alongside the + web form for additional context or links. - name: website_sidebar - description: '' + description: Specifies which predefined sidebar template renders with the form + for consistent site navigation. join_hint: table: tabWebsite Sidebar 'on': website_sidebar = tabWebsite Sidebar.name - name: button_label - description: '' + description: Customizes the submit button text to match business terminology or + encourage specific user actions. - name: breadcrumbs - description: '' + description: Enables breadcrumb navigation trail display to show users their location + within the website hierarchy. - name: success_title - description: '' + description: Sets the heading text shown on the confirmation page after successful + form submission. - name: success_url - description: '' + description: Redirects users to a specific page after form submission instead + of showing the default success message. - name: success_message - description: '' + description: Displays a custom confirmation message to users immediately after + they successfully submit the form. - name: meta_title - description: '' + description: Defines the browser tab and search engine title for the web form + page for SEO optimization. - name: meta_description - description: '' + description: Provides the search engine description snippet that appears in search + results for the web form page. - name: client_script - description: '' + description: Injects custom JavaScript to add dynamic validation, field behavior, + or user interaction logic to the form. - name: custom_css - description: '' + description: Applies custom styling rules to override default form appearance + for brand consistency or visual requirements. + desc_done: false - table: tabWeb Form Field description: '' fields: - name: name - description: '' + description: Unique identifier for the web form field record used when referencing + or linking this specific field configuration. - name: fieldname - description: '' + description: Internal field name used in database queries and when filtering or + grouping form submissions by this field. - name: fieldtype - description: '' + description: Defines the input type (text, number, date, select, etc.) used when + analyzing what data types are collected. options: - Attach - Attach Image @@ -30056,25 +37515,35 @@ tables: - Column Break - Page Break - name: label - description: '' + description: Display name shown to users, relevant when searching for fields by + their visible form labels. - name: allow_read_on_all_link_options - description: '' + description: Controls read permissions across linked records, used when determining + field-level access rules. - name: reqd - description: '' + description: Indicates if field is mandatory for submission, used when analyzing + form completion requirements and validation rules. - name: read_only - description: '' + description: Specifies if field is non-editable, relevant when identifying display-only + or system-populated fields. - name: show_in_filter - description: '' + description: Determines if field appears in filter options, used when configuring + searchable or filterable form data. - name: hidden - description: '' + description: Indicates if field is invisible to users, used when identifying backend-only + or conditionally displayed fields. - name: options - description: '' + description: Contains dropdown values or link references, used when analyzing + available choices or related document types. - name: max_length - description: '' + description: Character limit for text inputs, relevant when validating data constraints + or analyzing field capacity. - name: max_value - description: '' + description: Upper bound for numeric fields, used when checking value ranges or + business rule limits. - name: precision - description: '' + description: Decimal places for numeric fields, relevant when analyzing financial + or measurement data accuracy requirements. options: - '0' - '1' @@ -30087,28 +37556,38 @@ tables: - '8' - '9' - name: depends_on - description: '' + description: Conditional logic expression controlling field visibility, used when + analyzing dynamic form behavior. - name: mandatory_depends_on - description: '' + description: Conditional logic making field required, used when identifying context-dependent + validation rules. - name: read_only_depends_on - description: '' + description: Conditional logic making field non-editable, used when analyzing + state-based field permissions. - name: description - description: '' + description: Help text or instructions for the field, used when searching for + field purpose or user guidance. - name: default - description: '' + description: Pre-populated value for the field, relevant when analyzing standard + values or auto-fill behavior. + desc_done: true - table: tabWeb Form List Column description: '' fields: - name: name - description: '' + description: Unique identifier for the web form list column configuration record. - name: fieldname - description: '' + description: Database field name that this column maps to in the underlying DocType. - name: fieldtype - description: '' + description: Data type of the column determining how values are stored and validated + (e.g., Data, Select, Link). - name: label - description: '' + description: Display name shown to users as the column header in the web form + list view. - name: options - description: '' + description: Configuration values for the field such as linked DocType for Link + fields or dropdown choices for Select fields. + desc_done: true - table: tabWeb Page description: Page to show on the website fields: @@ -30179,107 +37658,142 @@ tables: - name: idx description: '' - name: website_sidebar - description: '' + description: Indicates which sidebar template or configuration is displayed on + the web page for navigation and supplementary content. join_hint: table: tabWebsite Sidebar 'on': website_sidebar = tabWebsite Sidebar.name - name: enable_comments - description: '' + description: Controls whether user comments are allowed on the web page, used + when analyzing engagement features or content moderation requirements. - name: breadcrumbs - description: '' + description: Defines the hierarchical navigation path displayed on the page, used + when analyzing site structure or user navigation patterns. + desc_done: false - table: tabWeb Page Block description: '' fields: - name: name - description: '' + description: Unique identifier for the web page block used when referencing or + filtering specific content sections. - name: web_template - description: '' + description: Template that defines the HTML structure and layout applied to this + block. join_hint: table: tabWeb Template 'on': web_template = tabWeb Template.name - name: web_template_values - description: '' + description: Dynamic values or parameters passed to the web template for content + customization. - name: css_class - description: '' + description: CSS styling class applied to control the visual appearance and formatting + of the block. - name: section_id - description: '' + description: Section identifier used to group or categorize blocks within a page + structure. - name: add_container - description: '' + description: Flag indicating whether to wrap the block content in a container + for layout control. - name: add_top_padding - description: '' + description: Flag to add spacing above the block for vertical layout separation. - name: add_bottom_padding - description: '' + description: Flag to add spacing below the block for vertical layout separation. - name: add_border_at_top - description: '' + description: Flag to display a border line at the top edge of the block. - name: add_border_at_bottom - description: '' + description: Flag to display a border line at the bottom edge of the block. - name: add_shade - description: '' + description: Flag to apply background shading or color overlay to the block. - name: hide_block - description: '' + description: Flag to conditionally hide or show the block based on display requirements. - name: add_background_image - description: '' + description: Flag or reference to display a background image within the block + area. + desc_done: true - table: tabWeb Page View description: '' fields: - name: name - description: '' + description: Identifies the specific web page or URL being viewed for tracking + page-level traffic and engagement. - name: path - description: '' + description: Captures the URL path of the viewed page for analyzing navigation + patterns and content performance. - name: referrer - description: '' + description: Tracks the previous page or external source that directed the visitor + for understanding traffic sources and user journey. - name: browser - description: '' + description: Records the web browser type used for analyzing browser compatibility + and user technology preferences. - name: browser_version - description: '' + description: Captures the specific browser version for troubleshooting compatibility + issues and tracking browser adoption. - name: is_unique - description: '' + description: Flags whether this is a unique visitor session for calculating distinct + visitor counts and reach metrics. - name: time_zone - description: '' + description: Stores the visitor's time zone for analyzing geographic distribution + and timing engagement by region. - name: user_agent - description: '' + description: Contains the full browser user agent string for detailed device and + browser identification in technical analysis. - name: source - description: '' + description: Identifies the marketing source or platform that drove the visit + for attribution and campaign performance analysis. - name: campaign - description: '' + description: Tracks the specific marketing campaign associated with the visit + for measuring campaign effectiveness and ROI. - name: medium - description: '' + description: Categorizes the marketing channel type (email, social, paid) for + comparing channel performance and budget allocation. - name: visitor_id - description: '' + description: Unique identifier for tracking individual visitor behavior across + sessions for user journey and retention analysis. + desc_done: true - table: tabWeb Template description: '' fields: - name: name - description: '' + description: Unique identifier for the web template used to reference and retrieve + specific template configurations. - name: type - description: '' + description: Categorizes the template by its functional purpose such as page, + component, or layout for filtering and selection. options: - Component - Section - Navbar - Footer - name: standard - description: '' + description: Indicates whether this is a default system template or custom-built, + used when determining upgrade impact or customization scope. - name: module - description: '' + description: Identifies which application module or functional area owns this + template for security and organizational queries. join_hint: table: tabModule Def 'on': module = tabModule Def.name - name: template - description: '' + description: Contains the actual HTML/code content of the web template used for + rendering and customization analysis. - name: fields - description: '' + description: Lists data fields or variables available in this template for mapping + business data to web presentation. + desc_done: true - table: tabWeb Template Field description: '' fields: - name: name - description: '' + description: Unique identifier for the web template field configuration record. - name: label - description: '' + description: Display name shown to users when this field appears on web templates + or forms. - name: fieldname - description: '' + description: Internal field name used to reference this field in code, queries, + and data storage. - name: fieldtype - description: '' + description: Defines the data type and input control for this field such as text, + select, date, or link. options: - Attach Image - Check @@ -30294,11 +37808,15 @@ tables: - Column Break - Table Break - name: reqd - description: '' + description: Indicates whether this field is mandatory and must be filled before + saving the web template. - name: options - description: '' + description: Contains available choices for select fields or configuration parameters + for the field behavior. - name: default - description: '' + description: Preset value automatically populated when creating a new web template + record with this field. + desc_done: true - table: tabWebhook description: '' fields: @@ -30362,11 +37880,15 @@ tables: description: '' fields: - name: name - description: '' + description: User-friendly label for the webhook configuration, used when searching + for or identifying specific webhook integrations by their business purpose. - name: fieldname - description: '' + description: Technical field identifier that maps webhook data to specific document + fields, used when troubleshooting data flow or configuring field-level mappings. - name: key - description: '' + description: Unique authentication or identification token for the webhook, used + when verifying webhook security settings or tracking specific webhook instances. + desc_done: true - table: tabWebhook Header description: '' fields: @@ -30380,223 +37902,290 @@ tables: description: '' fields: - name: name - description: '' + description: Unique identifier for tracking and referencing specific webhook request + log entries in troubleshooting and audit scenarios - name: webhook - description: '' + description: Links to the webhook configuration that triggered this request, used + when analyzing which webhook definitions are firing and their success rates join_hint: table: tabWebhook 'on': webhook = tabWebhook.name - name: reference_document - description: '' + description: Identifies the source document (sales order, invoice, etc.) that + triggered the webhook, critical for tracing business events to their integration + outcomes - name: headers - description: '' + description: Stores HTTP headers sent with the webhook request, used when debugging + authentication issues or API gateway problems - name: data - description: '' + description: Contains the actual payload sent to the external system, essential + for validating what data was transmitted during integration failures - name: user - description: '' + description: Records which user's action initiated the webhook, used for audit + trails and determining responsibility for triggered integrations join_hint: table: tabUser 'on': user = tabUser.name - name: url - description: '' + description: The endpoint URL where the webhook was sent, used when verifying + correct routing and diagnosing connectivity issues - name: response - description: '' + description: Captures the external system's response, critical for confirming + successful data receipt and understanding integration outcomes - name: error - description: '' + description: Logs failure messages when webhooks fail, primary field for troubleshooting + integration problems and monitoring system health + desc_done: true - table: tabWebsite Attribute description: '' fields: - name: name - description: '' + description: description - name: attribute - description: '' + description: Used to identify which specific website characteristic or property + is being tracked, such as domain, URL, or site configuration settings. join_hint: table: tabItem Attribute 'on': attribute = tabItem Attribute.name + desc_done: true - table: tabWebsite Filter Field description: '' fields: - name: name - description: '' + description: Used to identify or filter websites by their display name or title + in reports and analytics. - name: fieldname - description: '' + description: Used to filter by the technical field identifier or column name when + querying specific website data attributes. + desc_done: true - table: tabWebsite Item Group description: Cross Listing of Item in multiple groups fields: - name: name - description: '' + description: Unique identifier for the website item group configuration, used + when querying which item groups are displayed or configured for website presentation. - name: item_group - description: '' + description: The specific item group being configured for website display, used + when filtering or searching for products shown in particular categories on the + storefront. join_hint: table: tabItem Group 'on': item_group = tabItem Group.name + desc_done: true - table: tabWebsite Meta Tag description: '' fields: - name: name - description: '' + description: Identifies the specific meta tag type (e.g., description, keywords, + og:title) used when analyzing SEO configuration or social media sharing settings. - name: key - description: '' + description: Serves as a unique identifier or reference key for the meta tag record + when querying or updating specific website metadata entries. - name: value - description: '' + description: Contains the actual content of the meta tag used when searching for + specific SEO text, social sharing descriptions, or metadata values across web + pages. + desc_done: true - table: tabWebsite Route Meta description: '' fields: - name: name - description: '' + description: Unique identifier for the website route used to reference specific + pages or URLs in navigation and analytics queries. - name: meta_tags - description: '' + description: SEO and social media metadata associated with the route, queried + when analyzing page optimization, search rankings, or content discoverability. + desc_done: true - table: tabWebsite Route Redirect description: '' fields: - name: name - description: '' + description: Unique identifier for the website route redirect rule used when referencing + or managing specific redirects. - name: source - description: '' + description: Original URL path that triggers the redirect, used when identifying + which incoming URLs should be redirected. - name: target - description: '' + description: Destination URL path where users are redirected, used when determining + where traffic should be sent. - name: redirect_http_status - description: '' + description: HTTP status code for the redirect (301, 302, etc.), used when specifying + permanent vs temporary redirects for SEO and caching. options: - '301' - '302' - '307' - '308' + desc_done: true - table: tabWebsite Script description: Script to attach to all web pages. fields: - name: name - description: '' + description: Unique identifier for the website script, used when referencing or + filtering specific scripts embedded on web pages. - name: javascript - description: '' + description: Contains the actual JavaScript code content, queried when analyzing + script functionality or troubleshooting website behavior. + desc_done: true - table: tabWebsite Settings description: '' fields: - name: name - description: '' + description: Unique identifier for the website settings record. - name: home_page - description: '' + description: Defines which page users see when landing on the website. - name: title_prefix - description: '' + description: Text prepended to browser tab titles for branding consistency. - name: app_name - description: '' + description: Application name displayed across the website for brand identity. - name: disable_signup - description: '' + description: Controls whether new user registration is allowed on the website. - name: show_footer_on_login - description: '' + description: Determines if footer appears on login and authentication pages. - name: website_theme - description: '' + description: Selected theme that controls the overall visual design and styling. join_hint: table: tabWebsite Theme 'on': website_theme = tabWebsite Theme.name - name: website_theme_image - description: '' + description: Custom image file used for theme branding or background. - name: website_theme_image_link - description: '' + description: URL where the theme image links when clicked by users. - name: brand_html - description: '' + description: Custom HTML code for displaying logo or brand elements in header. - name: top_bar_items - description: '' + description: Navigation menu items displayed in the top bar of the website. - name: hide_login - description: '' + description: Controls visibility of login link in the website navigation. - name: navbar_search - description: '' + description: Enables or disables search functionality in the navigation bar. - name: show_language_picker - description: '' + description: Determines if language selection dropdown appears for multilingual + support. - name: navbar_template - description: '' + description: Custom template used to render the navigation bar layout. join_hint: table: tabWeb Template 'on': navbar_template = tabWeb Template.name - name: navbar_template_values - description: '' + description: Dynamic values passed to the navbar template for customization. - name: call_to_action - description: '' + description: Primary action button text encouraging user engagement or conversion. - name: call_to_action_url - description: '' + description: Destination URL when users click the call-to-action button. - name: banner_html - description: '' + description: Custom HTML for promotional or informational banner content. - name: footer_items - description: '' + description: Links and menu items displayed in the website footer section. - name: copyright - description: '' + description: Copyright notice text displayed in the footer for legal protection. - name: hide_footer_signup - description: '' + description: Controls whether signup form appears in the footer area. - name: address - description: '' + description: Physical business address displayed in the footer for contact information. - name: footer_powered - description: '' + description: Attribution text showing platform or technology powering the website. - name: footer_template - description: '' + description: Custom template used to render the footer layout and content. join_hint: table: tabWeb Template 'on': footer_template = tabWeb Template.name - name: footer_template_values - description: '' + description: Stores custom values for dynamic footer content when configuring + website footer templates. - name: enable_view_tracking - description: '' + description: Controls whether page view analytics are tracked for website traffic + analysis. - name: enable_google_indexing - description: '' + description: Determines if the website is submitted to Google for search engine + indexing. - name: indexing_refresh_token - description: '' + description: Stores OAuth refresh token for automated Google Search Console indexing + API access. - name: indexing_authorization_code - description: '' + description: Contains authorization code for initial Google indexing API authentication + setup. - name: google_analytics_id - description: '' + description: Holds the Google Analytics tracking ID for connecting website to + analytics reporting. - name: google_analytics_anonymize_ip - description: '' + description: Controls whether visitor IP addresses are anonymized in Google Analytics + for privacy compliance. - name: auto_account_deletion - description: '' + description: Enables automatic deletion of inactive user accounts after a specified + period. - name: show_account_deletion_link - description: '' + description: Controls visibility of self-service account deletion option for website + users. - name: subdomain - description: '' + description: Defines the subdomain prefix used for accessing the website instance. - name: head_html - description: '' + description: Contains custom HTML code injected into the website head section + for scripts or meta tags. - name: robots_txt - description: '' + description: Stores robots.txt file content that controls search engine crawler + access to website pages. - name: route_redirects - description: '' + description: Defines URL redirect mappings for handling old URLs or custom routing + rules. + desc_done: true - table: tabWebsite Sidebar description: '' fields: - name: name - description: '' + description: Unique identifier for the sidebar configuration, used when filtering + or referencing specific sidebar instances across the website. - name: title - description: '' + description: Display heading of the sidebar section, used when searching for sidebar + content by visible label or when reporting on sidebar organization. - name: sidebar_items - description: '' + description: Collection of navigation links or content blocks within the sidebar, + used when analyzing sidebar composition or filtering by specific menu items. + desc_done: true - table: tabWebsite Sidebar Item description: '' fields: - name: name - description: '' + description: Unique identifier for the sidebar menu item used when referencing + or filtering specific navigation elements. - name: title - description: '' + description: Display label shown to users in the sidebar navigation menu. - name: route - description: '' + description: URL path or routing destination that the sidebar item navigates to + when clicked. - name: group - description: '' + description: Category or section grouping used to organize and filter related + sidebar items together. + desc_done: true - table: tabWebsite Slideshow description: Slideshow like display for the website fields: - name: name - description: '' + description: Unique identifier for the website slideshow record used when referencing + or filtering specific slideshows in queries. - name: slideshow_name - description: '' + description: Display name of the slideshow used when searching for or identifying + which slideshow appears on website pages. - name: slideshow_items - description: '' + description: Collection of slides within the slideshow used when analyzing slideshow + content, order, or individual slide details. + desc_done: true - table: tabWebsite Slideshow Item description: '' fields: - name: name - description: '' + description: Unique identifier for the slideshow item used when referencing or + filtering specific slides in website content queries. - name: heading - description: '' + description: Main title or headline text displayed on the slide, used when searching + for promotional messages or featured content. - name: description - description: '' + description: Detailed explanatory text shown on the slide, used when analyzing + marketing copy or slide content details. - name: url - description: '' + description: Link destination when the slide is clicked, used when tracking call-to-action + targets or navigation paths from slideshow items. + desc_done: true - table: tabWebsite Theme description: '' fields: @@ -30664,9 +38253,12 @@ tables: description: '' fields: - name: name - description: '' + description: Unique identifier for the theme ignore rule that specifies which + app should be excluded from theme processing or validation. - name: app - description: '' + description: References the specific application that is configured to bypass + or ignore website theme settings and customizations. + desc_done: true - table: tabWork Order description: '' fields: @@ -30830,51 +38422,58 @@ tables: description: '' fields: - name: name - description: '' + description: Unique identifier for this work order item line entry - name: operation - description: '' + description: Links item to specific manufacturing operation or production step + where it is consumed join_hint: table: tabOperation 'on': operation = tabOperation.name - name: item_code - description: '' + description: Material or component SKU required for manufacturing this work order join_hint: table: tabItem 'on': item_code = tabItem.name - name: source_warehouse - description: '' + description: Warehouse location from which raw material will be transferred for + production join_hint: table: tabWarehouse 'on': source_warehouse = tabWarehouse.name - name: item_name - description: '' + description: Human-readable name of the material or component being consumed - name: description - description: '' + description: Additional details about the item specification or usage in this + work order - name: allow_alternative_item - description: '' + description: Indicates whether substitute materials can be used if primary item + is unavailable - name: include_item_in_manufacturing - description: '' + description: Controls whether this item is actively required in the production + process - name: required_qty - description: '' + description: Total quantity of material needed to complete the work order - name: stock_uom - description: '' + description: Unit of measurement for tracking inventory and consumption of this + item join_hint: table: tabUOM 'on': stock_uom = tabUOM.name - name: rate - description: '' + description: Unit cost or price of the material for calculating work order valuation - name: amount - description: '' + description: Total cost calculated as required quantity multiplied by rate - name: transferred_qty - description: '' + description: Quantity of material moved from source warehouse to production floor - name: consumed_qty - description: '' + description: Actual quantity of material used or issued during manufacturing - name: returned_qty - description: '' + description: Quantity of unused material sent back to source warehouse after production - name: available_qty_at_source_warehouse - description: '' + description: Current stock level at the originating warehouse for material planning - name: available_qty_at_wip_warehouse - description: '' + description: Current stock level at work-in-progress warehouse during production + desc_done: true - table: tabWork Order Operation description: '' fields: diff --git a/changai/changai/api/v2/generate_schema.py b/changai/changai/api/v2/generate_schema.py index 93e9c47..1d5560d 100644 --- a/changai/changai/api/v2/generate_schema.py +++ b/changai/changai/api/v2/generate_schema.py @@ -1,7 +1,7 @@ import os import yaml from typing import Dict, List, Any, Optional - +from pathlib import Path import frappe @@ -10,11 +10,10 @@ "Selling", "Projects", "Buying", "CRM", "Accounts", ] -CUSTOM_BUSINESS_MODULES = ["Zatca Erpgulf"] +CUSTOM_BUSINESS_MODULES = ["Zatca Erpgulf"] -def _ensure_dir(p: str) -> None: - os.makedirs(p, exist_ok=True) +ALLOWED_OUT_BASE = "/opt/hyrin/frappe-bench/apps/changai/changai/changai/api/v2/enriched_schema_test" def _tab(dt: str) -> str: @@ -106,9 +105,19 @@ def get_doctypes_for_modules(modules: List[str]) -> List[Dict[str, Any]]: fields=["name", "module"], order_by="module asc, name asc", ) +def _ensure_dir(p: str) -> None: + os.makedirs(p, exist_ok=True) +def _assert_path_inside_base(file_path: str, base_dir: str) -> str: + base = Path(base_dir).resolve() + p = Path(file_path).resolve() + if base != p and base not in p.parents: + raise ValueError(f"Unsafe out_path (outside allowed base): {p}") + return str(p) def run_yaml(out_path: str, modules: List[str]) -> Dict[str, Any]: + out_path = _assert_path_inside_base(out_path, ALLOWED_OUT_BASE) + _ensure_dir(os.path.dirname(out_path)) doctypes = get_doctypes_for_modules(modules) @@ -133,7 +142,6 @@ def run_yaml(out_path: str, modules: List[str]) -> Dict[str, Any]: per_table_field_counts[t["table"]] = fc total_fields += fc - # YAML output only (list) with open(out_path, "w", encoding="utf-8") as f: yaml.safe_dump(tables_yaml, f, sort_keys=False, allow_unicode=True) @@ -151,9 +159,7 @@ def run_yaml(out_path: str, modules: List[str]) -> Dict[str, Any]: def main(out_path: Optional[str] = None): modules = list(dict.fromkeys(BUSINESS_MODULES + CUSTOM_BUSINESS_MODULES)) - default_path = "/opt/hyrin/frappe-bench/apps/changai/changai/changai/api/v2/enriched_schema_test/enriched_schema.yaml" + default_path = os.path.join(ALLOWED_OUT_BASE, "enriched_schema.yaml") out_path = out_path or default_path return run_yaml(out_path=out_path, modules=modules) - -# DO NOT call main() here. Use bench execute. diff --git a/changai/changai/api/v2/store_chats.py b/changai/changai/api/v2/store_chats.py index 66cc7e3..44493ae 100644 --- a/changai/changai/api/v2/store_chats.py +++ b/changai/changai/api/v2/store_chats.py @@ -1,6 +1,6 @@ import json import frappe -import requests + def save_message_doc(session_id:str,message_type:str,content:str): doc=frappe.get_doc({ @@ -10,14 +10,11 @@ def save_message_doc(session_id:str,message_type:str,content:str): "content": content or "" }) doc.insert(ignore_permissions=True) - frappe.db.commit() return doc.name -@frappe.whitelist(allow_guest=True) +@frappe.whitelist(allow_guest=False) def save_turn_2(session_id: str, user_text: str=None, bot_text: dict=None): - import json - # find existing document doc_name = frappe.db.exists("ChangAI Chat History", {"session_id": session_id}) @@ -44,7 +41,6 @@ def save_turn_2(session_id: str, user_text: str=None, bot_text: dict=None): new_content, update_modified=True ) - frappe.db.commit() return doc_name else: @@ -54,13 +50,11 @@ def save_turn_2(session_id: str, user_text: str=None, bot_text: dict=None): "content": new_content }) doc.insert(ignore_permissions=True) - frappe.db.commit() return doc.name -@frappe.whitelist(allow_guest=True) -def get_chat_history_1(session_id): - import json +@frappe.whitelist(allow_guest=False) +def get_chat_history_1(session_id: str) -> list: doc_name = frappe.db.exists("ChangAI Chat History", {"session_id": session_id}) if not doc_name: return [] @@ -128,8 +122,9 @@ def respond_from_cache(user_question:str): doc=frappe.db.get_value("ChangAI Logs",{"user_question":user_question},["sql_generated","result"],as_dict=False) return doc + @frappe.whitelist(allow_guest=False) -def inject_prompt(user_qstn,session_id): +def inject_prompt(user_qstn: str, session_id: str) -> str: rows=get_chat_history_1(session_id) prompt=PROMPT_FOLLOWUP.format(rows=rows,qstn=user_qstn) return prompt diff --git a/changai/changai/api/v2/text2sql_pipeline_v2.py b/changai/changai/api/v2/text2sql_pipeline_v2.py index 12d037f..0210c47 100644 --- a/changai/changai/api/v2/text2sql_pipeline_v2.py +++ b/changai/changai/api/v2/text2sql_pipeline_v2.py @@ -17,6 +17,7 @@ import time from werkzeug.wrappers import Response import frappe +from pathlib import Path from google import genai from google.genai import types from langchain_community.embeddings import HuggingFaceEmbeddings @@ -35,8 +36,8 @@ _SCHEMA_VS = None -@frappe.whitelist(allow_guest=True) -def get_settings(): +@frappe.whitelist(allow_guest=False) +def get_settings() -> Dict[str, Any]: settings=frappe.get_single("ChangAI Settings") langsmith_tracing = "true" if settings.langsmith_tracing else "false" config={ @@ -80,10 +81,19 @@ def get_settings(): NON_ERP_PROMPT_PATH=f"{CONFIG['ROOT_PATH']}/changai/changai/changai/prompts/non_erp_prompt.txt" TEMPLATE_PATH=f"{CONFIG['ROOT_PATH']}/changai/changai/changai/templates/conversation_template_v2.j2" BUSINESS_KEYWORDS_PATH = f"{CONFIG['ROOT_PATH']}/changai/changai/changai/api/v2/business_keywords_v1.json" +ALLOWED_BASE = CONFIG["ROOT_PATH"] + + +def _assert_file_inside_base(file_path: str, base_dir: str) -> str: + base = Path(base_dir).resolve() + p = Path(file_path).resolve() + if base != p and base not in p.parents: + raise ValueError(f"Unsafe path: {p}") + return str(p) @frappe.whitelist(allow_guest=False) -def get_backend_server_settings(*keys): +def get_backend_server_settings(*keys: str) -> Dict[str, Any]: """ Fetch multiple settings from the BACKEND_SERVER_SETTINGS. """ @@ -93,7 +103,7 @@ def get_backend_server_settings(*keys): @frappe.whitelist(allow_guest=True) -def generate_token_secure(api_key, api_secret, app_key): +def generate_token_secure(api_key: str, api_secret: str, app_key: str): try: try: @@ -178,8 +188,8 @@ def generate_token_secure(api_key, api_secret, app_key): #api for user token -@frappe.whitelist(allow_guest=False) -def generate_token_secure_for_users(username, password, app_key): +@frappe.whitelist(allow_guest=True) +def generate_token_secure_for_users(username: str, password: str, app_key: str) -> Dict[str, Any]: """ Generate a secure token for user authentication. """ @@ -237,7 +247,7 @@ def generate_token_secure_for_users(username, password, app_key): # Api for checking user name using token @frappe.whitelist(allow_guest=False) -def whoami(): +def whoami() -> Dict[str, Any]: """This function returns the current session user""" try: response_content = { @@ -261,7 +271,7 @@ def call_model(prompt: str, task: str = "llm") -> Any: return local_llm_request(prompt) -def call_embedder(question): +def call_embedder(question: str) -> Any: return remote_embedder_request(question) if CONFIG["REMOTE"] else local_embedder_request(question) @@ -292,7 +302,7 @@ def local_llm_request(prompt: str) -> str: return (text or "").strip() or "Error: Empty response from local LLM." -def return_headers(): +def return_headers() -> Dict[str, str]: return { "Content-Type": "application/json", "Authorization": f"Bearer {CONFIG['API_TOKEN']}", @@ -300,7 +310,7 @@ def return_headers(): @frappe.whitelist(allow_guest=False) -def create_llm_prediction(prompt: str): +def create_llm_prediction(prompt: str) -> Dict[str, Any]: payload = { "version": CONFIG["LLM_VERSION_ID"], "input": {"user_input": prompt}, @@ -334,7 +344,7 @@ def create_llm_prediction(prompt: str): return {"ok": True, "pred_id": pred_id, "status": status} -def get_llm_prediction(pred_id:str): +def get_llm_prediction(pred_id: str) -> Dict[str, Any]: try: poll_url=f"{CONFIG['URL']}/{pred_id}" resp=requests.get(poll_url,headers=return_headers(),timeout=120) @@ -359,7 +369,7 @@ def get_llm_prediction(pred_id:str): @frappe.whitelist(allow_guest=False) -def remote_llm_request(prompt: str): +def remote_llm_request(prompt: str) -> Any: payload = { "version": CONFIG["LLM_VERSION_ID"], "input": {"user_input": prompt}, @@ -412,7 +422,7 @@ def remote_llm_request(prompt: str): @frappe.whitelist(allow_guest=False) -def call_gemini(prompt): +def call_gemini(prompt: str) -> Union[str, Dict[str, Any]]: try: # Authenticate once creds = service_account.Credentials.from_service_account_file( @@ -534,7 +544,7 @@ def remote_llm_request_deploy_test( @frappe.whitelist(allow_guest=False) -def remote_embedder_request(formatted_q: str) -> Union[list, str]: +def remote_embedder_request(formatted_q: str) -> Union[List[Any], str]: payload = {"version": CONFIG["EMBED_VERSION_ID"], "input": {"user_input": formatted_q}} headers = { "Content-Type": "application/json", @@ -551,7 +561,7 @@ def remote_embedder_request(formatted_q: str) -> Union[list, str]: return "Error: " + str(e) -def local_embedder_request(question: str): +def local_embedder_request(question: str) -> List[Any]: global __vector_store if not os.path.exists(INDEX_PATH): return [] @@ -561,13 +571,15 @@ def local_embedder_request(question: str): return __vector_store.similarity_search(question, k=15) -def read_json(path): - with open(path, "r", encoding="utf-8") as f: +def read_json(path: str) -> Dict[str, Any]: + safe_path = _assert_file_inside_base(path, ALLOWED_BASE) + with open(safe_path, "r", encoding="utf-8") as f: return json.load(f) -def read_text(path): - with open(path,"r",encoding="utf-8") as f: +def read_text(path: str) -> str: + safe_path = _assert_file_inside_base(path, ALLOWED_BASE) + with open(safe_path, "r", encoding="utf-8") as f: return f.read() @@ -614,12 +626,14 @@ def fill_sql_prompt(question: str, context: str) -> str: def guardrail_router(state: SQLState) -> SQLState: raw_q = state.get("formatted_q") or state.get("question") or "" q = str(raw_q).lower().strip() + safe_keywords: List[str] = [] for kw in BUSINESS_KEYWORDS: try: safe_keywords.append(str(kw).lower()) except Exception: continue + is_erp = any(kw in q for kw in safe_keywords) return {**state, "query_type": "ERP" if is_erp else "NON_ERP"} @@ -655,21 +669,15 @@ def rewrite_question(state: SQLState) -> SQLState: obj = None standalone = s else: - # e.g., list outputs or other types standalone = str(raw).strip() - # If JSON parsed to dict, extract fields if isinstance(obj, dict): standalone = (obj.get("standalone_question") or "").strip() or standalone contains_values = bool(obj.get("contains_values")) else: - # If JSON parsed to list, fallback to string if isinstance(obj, list) and not standalone: standalone = json.dumps(obj) - - # Final fallback standalone = standalone or user_qstn.strip() - return { **state, "formatted_q": standalone, @@ -686,6 +694,7 @@ def rewrite_question(state: SQLState) -> SQLState: "contains_values": False, "formatting_prompt": prompt, } + emb=HuggingFaceEmbeddings(model_name="hyrinmansoor/changAI-nomic-embed-text-v1.5-finetuned") vs = FAISS.load_local( @@ -694,7 +703,7 @@ def rewrite_question(state: SQLState) -> SQLState: allow_dangerous_deserialization=True ) -def call_fvs_table_search(q): +def call_fvs_table_search(q: str) -> List[str]: hits = vs.similarity_search(q, k=15) out, seen = [], set() for h in hits: @@ -704,7 +713,7 @@ def call_fvs_table_search(q): out.append(t) return out -def _parse_json_list(raw: str): +def _parse_json_list(raw: str) -> List[Any]: try: data = json.loads(raw) return data if isinstance(data, list) else [] @@ -712,8 +721,8 @@ def _parse_json_list(raw: str): return [] -@frappe.whitelist(allow_guest=True) -def call_retriev_multi_line(user_question): +@frappe.whitelist(allow_guest=False) +def call_retriev_multi_line(user_question: str) -> Dict[str, Any]: top_tables = call_fvs_table_search(user_question) table_prompt = FILTER_TABLES.replace("{user_question}", user_question) table_prompt = table_prompt.replace("{table_list}", json.dumps(top_tables, ensure_ascii=False)) @@ -769,7 +778,7 @@ def get_full_fields_vs(): return _FULL_FIELDS_VS -def get_sub_vs(selected_tables: list): +def get_sub_vs(selected_tables: List[str]) -> Optional[FAISS]: """Build sub-index ONCE per unique selected_tables set (cached).""" key = tuple(sorted([t for t in selected_tables if isinstance(t, str)])) if not key: @@ -935,7 +944,7 @@ def remote_entity_embedder(q: str) -> Union[list, str]: @frappe.whitelist(allow_guest=False) -def call_entity_retriever(qstn: str): +def call_entity_retriever(qstn: str) -> Dict[str, Any]: response = remote_entity_embedder(qstn) if not response.get("ok"): @@ -1006,13 +1015,15 @@ def route_after_entities(state: SQLState) -> str: return "DIRECT" if CONFIG.get("retriever_structure") == "multi line" else "CONTEXT" -def route_guardrail(state:SQLState): - return "ERP" if state.get("query_type")=="ERP" else "NON_ERP" -def clean_sql(s): +def route_guardrail(state: SQLState) -> str: + return "ERP" if state.get("query_type") == "ERP" else "NON_ERP" + + +def clean_sql(s: Any) -> str: if isinstance(s, dict): s = s.get("output") or s.get("sql") or s.get("text") or json.dumps(s, ensure_ascii=False, default=str) elif isinstance(s, list): - s = "\n".join(map(str, s)) + s = "\n".join([str(x) for x in s]) # no map() else: s = str(s) if s is not None else "" @@ -1020,7 +1031,6 @@ def clean_sql(s): s = re.sub(r"^\s*```(?:sql)?\s*", "", s, flags=re.I) s = re.sub(r"\s*```\s*$", "", s) s = re.sub(r"^\s*sql\s*\n", "", s, flags=re.I) - return s.strip() @@ -1192,68 +1202,65 @@ def validate_sql_against_mapping( app=workflow.compile(checkpointer=checkpointer) -#to execute the sql returned inside frappe @frappe.whitelist(allow_guest=False) -def execute_query(sql:str,orm:str): +def execute_query(sql: str, orm: str) -> Any: + """ + Execute only SELECT SQL when sql is provided. + (Your old code checked orm but executed sql.) + """ try: - if orm: - result=frappe.db.sql(sql,as_dict=True) - return result + if sql: + if not str(sql).lower().strip().startswith("select"): + frappe.throw(_("Only SELECT queries are allowed.")) + return frappe.db.sql(sql, as_dict=True) + return [] except Exception as e: - return {"error":f"SQL Execution Failed : {e}"} + return {"error": f"SQL Execution Failed: {e}"} + @frappe.whitelist(allow_guest=False) -def execute_query_1(mode: str, sql,orm): +def execute_query_1(mode: str, sql: str, orm: Optional[Dict[str, Any]]) -> Any: try: mode = (mode or "").lower().strip() if mode == "sql": - if not sql.lower().strip().startswith("select"): - frappe.throw("Only SELECT queries are allowed.") - + if not (sql or "").lower().strip().startswith("select"): + frappe.throw(_("Only SELECT queries are allowed.")) return frappe.db.sql(sql, as_dict=True) - elif mode == "orm": + if mode == "orm": if not isinstance(orm, dict): - frappe.throw("ORM query must be JSON object.") + frappe.throw(_("ORM query must be JSON object.")) - return frappe.get_all( - query.get("doctype"), - filters=query.get("filters"), - fields=query.get("fields"), - ) + doctype = orm.get("doctype") + filters = orm.get("filters") + fields = orm.get("fields") - else: - frappe.throw("Mode must be 'sql' or 'orm'.") + return frappe.get_all(doctype, filters=filters, fields=fields) + + frappe.throw(_("Mode must be 'sql' or 'orm'.")) except Exception as e: frappe.log_error(frappe.get_traceback(), "Query Execution Failed") return {"error": str(e)} - @frappe.whitelist(allow_guest=False) -def send_support_message(message): +def send_support_message(message: str) -> Any: url = CONFIG["support_api_url"] - - res = requests.post(url, json={ - "message": message - }) - + res = requests.post(url, json={"message": message}, timeout=15) return res.json() + @frappe.whitelist(allow_guest=False) -def get_ticket_details(tid): +def get_ticket_details(tid: Union[int, str]) -> Any: url = CONFIG["get_ticket_details_url"] - res = requests.post(url, json={ - "ticket_id": tid - }) - + res = requests.post(url, json={"ticket_id": tid}, timeout=15) return res.json() @frappe.whitelist(allow_guest=False) -def support_bot(message): +def support_bot(message: str) -> Dict[str, Any]: output = remote_llm_request_deploy_test( task="helpdesk_task", prompt="", @@ -1299,64 +1306,56 @@ def support_bot(message): def save_logs( - user_question=None, - formatted_q=None, - context=None, - sql=None, - val=None, - result=None, - tries=None, - err=None, - formatted_result=None, -): - def to_json_if_needed(v): + user_question: Optional[str] = None, + formatted_q: Optional[str] = None, + context: Optional[str] = None, + sql: Optional[str] = None, + val: Any = None, + result: Any = None, + tries: Optional[int] = None, + err: Any = None, + formatted_result: Any = None, +) -> str: + def to_json_if_needed(v: Any) -> Any: if isinstance(v, (dict, list)): - return json.dumps(v, default=str) + return json.dumps(v, default=str, ensure_ascii=False) return v - val = to_json_if_needed(val) - result = to_json_if_needed(result) - err = to_json_if_needed(err) - context = to_json_if_needed(context) - formatted_result = to_json_if_needed(formatted_result) + doc = frappe.new_doc("ChangAI Logs") doc.user_question = user_question doc.rewritten_question = formatted_q - doc.schema_retrieved = context - doc.sql_generated = sql - doc.validation = val + doc.schema_retrieved = to_json_if_needed(context) + doc.sql_generated = to_json_if_needed(sql) + doc.validation = to_json_if_needed(val) doc.tries = tries - doc.error = err - doc.result = result - doc.formatted_result = formatted_result + doc.error = to_json_if_needed(err) + doc.result = to_json_if_needed(result) + doc.formatted_result = to_json_if_needed(formatted_result) doc.insert(ignore_permissions=True) - frappe.db.commit() + # frappe.db.commit() removed return doc.name @frappe.whitelist(allow_guest=False) -def format_data_conversationally(user_data): - """ - Formats user data using the single, powerful conversational Jinja2 template. - """ +def format_data_conversationally(user_data: Any) -> str: env = jinja2.Environment( - autoescape=True, - trim_blocks=True, - lstrip_blocks=True, - extensions=["jinja2.ext.do"] -) - + autoescape=True, + trim_blocks=True, + lstrip_blocks=True, + extensions=["jinja2.ext.do"], + ) template = env.from_string(CONVERSATION_TEMPLATE) return template.render(data=user_data) - @frappe.whitelist(allow_guest=False) -def format_data(qstn, sql_data): +def format_data(qstn: str, sql_data: Any) -> Dict[str, str]: if isinstance(sql_data, (dict, list)): db_result_json = json.dumps(sql_data, ensure_ascii=False, default=str) else: db_result_json = str(sql_data) if sql_data is not None else "{}" - prompt=f""" + + prompt = f""" INSTRUCTIONS: - Convert raw database results into a short, friendly, human-readable answer. - You may use BOTH: (1) the user question and (2) the DB result JSON to form the answer. @@ -1368,19 +1367,16 @@ def format_data(qstn, sql_data): {qstn} DATABASE_RESULT_JSON: -{json.dumps(db_result_json, ensure_ascii=False, default=str)} +{db_result_json} OUTPUT: Write a clear final answer for the user based strictly on the JSON above. """ - output = call_model( - prompt=prompt - ) + output = call_model(prompt=prompt) answer = str(output) return {"answer": answer} - def hits_to_schema_context( hits: Union[List[Any], Dict, str], title: str = "SCHEMA CONTEXT", @@ -1588,7 +1584,7 @@ def _add_field(tbl: str, fld: str): for ent, filt in entities: if show_entity_filters_yaml and isinstance(filt, dict) and filt: lines.append(f" - Entity: {ent}") - lines.append(f" Filters:",{filt}) + lines.append(" Filters:") for k, v in filt.items(): vv = ", ".join(map(str, v)) if isinstance(v, (list, tuple)) else str(v) lines.append(f" {k}: {vv}") @@ -1716,38 +1712,24 @@ def run_text2sql_pipeline(user_question: str, chat_id: str): } - @frappe.whitelist(allow_guest=False) -def call_gemini_1(prompt): - # Authenticate once - creds = service_account.Credentials.from_service_account_file( - KEY_PATH, - scopes=['https://www.googleapis.com/auth/cloud-platform'] - ) - # prompt=FILTER_TABLES.format(user_question=user_question, table_list=table_list) - client = genai.Client( - vertexai=True, - project=PROJECT_ID, - location=CONFIG["location"], - credentials=creds - ) - config = types.GenerateContentConfig( - system_instruction="You are an ERPNext assistant.Follow the task instructions exactly.", - ) - contents = [ - { - "role": "user", - "parts": [{"text": str(prompt)}] - } - ] - - response = client.models.generate_content( - model=MODEL_ID, - config=config, - contents=contents - ) - text = (response.text or "").strip() - if text.startswith("```"): - text = text.replace("```json", "").replace("```", "").strip() - - return text \ No newline at end of file +def call_gemini_1(prompt: str) -> Union[str, Dict[str, Any]]: + creds = service_account.Credentials.from_service_account_file( + KEY_PATH, + scopes=["https://www.googleapis.com/auth/cloud-platform"], + ) + client = genai.Client( + vertexai=True, + project=PROJECT_ID, + location=CONFIG["location"], + credentials=creds, + ) + cfg = types.GenerateContentConfig( + system_instruction="You are an ERPNext assistant. Follow the task instructions exactly.", + ) + contents = [{"role": "user", "parts": [{"text": str(prompt)}]}] + response = client.models.generate_content(model=MODEL_ID, config=cfg, contents=contents) + text = (response.text or "").strip() + if text.startswith("```"): + text = text.replace("```json", "").replace("```", "").strip() + return text \ No newline at end of file diff --git a/changai/changai/data/tables.json b/changai/changai/data/tables.json deleted file mode 100644 index df83599..0000000 --- a/changai/changai/data/tables.json +++ /dev/null @@ -1,6 +0,0 @@ -[ - "tabCurrency", - "tabCustomer", - "tabItem", - "tabSupplier" -] \ No newline at end of file diff --git a/changai/changai/scripts.py b/changai/changai/scripts.py index 06af8de..6036e90 100644 --- a/changai/changai/scripts.py +++ b/changai/changai/scripts.py @@ -1,11 +1,17 @@ import frappe import json -import os -import json +from pathlib import Path + +def _assert_path_inside_base(file_path: str, base_dir: str) -> str: + base = Path(base_dir).resolve() + p = Path(file_path).resolve() + if base != p and base not in p.parents: + raise ValueError(f"Unsafe path: {p}") + return str(p) + def export_meta(): meta_data = {} - # Only fetch doctypes where custom = 0 (standard) doctypes = frappe.get_all("DocType", filters={"custom": 0}, fields=["name", "module"]) for dt in doctypes: @@ -13,19 +19,14 @@ def export_meta(): meta = frappe.get_meta(dt["name"]) fields = [f.fieldname for f in meta.fields if f.fieldname] description = meta.get("description") or f"Standard ERPNext doctype for {dt['name']}" + meta_data[dt["name"]] = {"module": dt["module"], "description": description, "fields": fields} + except Exception: + frappe.log_error(frappe.get_traceback(), f"export_meta skipped {dt['name']}") - meta_data[dt["name"]] = { - "module": dt["module"], - "description": description, - "fields": fields - } - - except Exception as e: - print(f"⚠️ Skipped {dt['name']}: {e}") + path = frappe.get_site_path("private", "files", "meta.json") + safe_path = _assert_path_inside_base(path, frappe.get_site_path()) - # Save to file - path = "/opt/hyrin/frappe-bench/apps/changai/changai/public/json/meta.json" - with open(path, "w") as f: - json.dump(meta_data, f, indent=2) + with open(safe_path, "w", encoding="utf-8") as f: + json.dump(meta_data, f, indent=2, ensure_ascii=False) - print(f"✅ meta.json written to {path} with {len(meta_data)} doctypes.") + return {"ok": True, "path": path, "doctype_count": len(meta_data)}