diff --git a/foundation/templates/includes/footer/footer.html b/foundation/templates/includes/footer/footer.html index e6cc6f8f..234218ff 100644 --- a/foundation/templates/includes/footer/footer.html +++ b/foundation/templates/includes/footer/footer.html @@ -95,9 +95,6 @@
- - - erpnext.accounts.email_alert.notification_for_new_fiscal_year.notification_for_new_fiscal_year.get_context - (context) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.accounts.general_ledger.check_if_in_list - (gle, gl_map) -
-No docs
-- - - erpnext.accounts.general_ledger.delete_gl_entries - (gl_entries=None, voucher_type=None, voucher_no=None, adv_adj=False, update_outstanding=Yes) -
-No docs
-- - - erpnext.accounts.general_ledger.get_round_off_account_and_cost_center - (company) -
-No docs
-- - - erpnext.accounts.general_ledger.make_entry - (args, adv_adj, update_outstanding, from_repost=False) -
-No docs
-- - - erpnext.accounts.general_ledger.make_gl_entries - (gl_map, cancel=False, adv_adj=False, merge_entries=True, update_outstanding=Yes, from_repost=False) -
-No docs
-- - - erpnext.accounts.general_ledger.make_round_off_gle - (gl_map, debit_credit_diff) -
-No docs
-- - - erpnext.accounts.general_ledger.merge_similar_entries - (gl_map) -
-No docs
-- - - erpnext.accounts.general_ledger.process_gl_map - (gl_map, merge_entries=True) -
-No docs
-- - - erpnext.accounts.general_ledger.round_off_debit_credit - (gl_map) -
-No docs
-- - - erpnext.accounts.general_ledger.save_entries - (gl_map, adv_adj, update_outstanding, from_repost=False) -
-No docs
-- - - erpnext.accounts.general_ledger.validate_account_for_perpetual_inventory - (gl_map) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.accounts.party._get_party_details - (party=None, account=None, party_type=Customer, company=None, posting_date=None, bill_date=None, price_list=None, currency=None, doctype=None, ignore_permissions=False) -
-No docs
-- - - erpnext.accounts.party.get_dashboard_info - (party_type, party) -
-No docs
-- - - erpnext.accounts.party.get_default_price_list - (party) -
-Return default price list for party (Document object)
-Public API
- /api/method/erpnext.accounts.party.get_due_date
-
- - - erpnext.accounts.party.get_due_date - (posting_date, party_type, party, company=None, bill_date=None) -
-Get due date from Payment Terms Template
- - - erpnext.accounts.party.get_due_date_from_template - (template_name, posting_date, bill_date) -
-Inspects all `Payment Term`s from the a `Payment Terms Template` and returns the due
-date after considering all the `Payment Term`s requirements.
-
-
-Parameters:
- -template_name - Name of the Payment Terms Template
:return: String representing the calculated due date
Public API
- /api/method/erpnext.accounts.party.get_party_account
-
- - - erpnext.accounts.party.get_party_account - (party_type, party, company) -
-Returns the account for the given party.
- Will first search in party (Customer / Supplier) record, if not found,
- will search in group (Customer Group / Supplier Group),
- finally will return default.
- - - erpnext.accounts.party.get_party_account_currency - (party_type, party, company) -
-No docs
-Public API
- /api/method/erpnext.accounts.party.get_party_details
-
- - - erpnext.accounts.party.get_party_details - (party=None, account=None, party_type=Customer, company=None, posting_date=None, bill_date=None, price_list=None, currency=None, doctype=None, ignore_permissions=False) -
-No docs
-- - - erpnext.accounts.party.get_party_gle_account - (party_type, party, company) -
-No docs
-- - - erpnext.accounts.party.get_party_gle_currency - (party_type, party, company) -
-No docs
-- - - erpnext.accounts.party.get_party_shipping_address - (doctype, name) -
-Returns an Address name (best guess) for the given doctype and name for which `address_type == 'Shipping'` is true.
-and/or `is_shipping_address = 1`.
-
-It returns an empty string if there is no matching record.
-
-
-Parameters:
- -doctype - Party Doctypename - Party name
:return: String
- - - erpnext.accounts.party.get_patry_tax_withholding_details - (ref_doc) -
-No docs
-Public API
- /api/method/erpnext.accounts.party.get_pyt_term_template
-
- - - erpnext.accounts.party.get_pyt_term_template - (party_name, party_type, company=None) -
-No docs
-- - - erpnext.accounts.party.get_tax_mapper - () -
-No docs
-- - - erpnext.accounts.party.get_timeline_data - (doctype, name) -
-returns timeline data for the past one year
-- - - erpnext.accounts.party.prepare_tax_withholding_details - (tax_mapper, tax_withholding_details) -
-No docs
-- - - erpnext.accounts.party.set_account_and_due_date - (party, account, party_type, company, posting_date, bill_date, doctype) -
-No docs
-- - - erpnext.accounts.party.set_address_details - (out, party, party_type, doctype=None, company=None) -
-No docs
-- - - erpnext.accounts.party.set_contact_details - (out, party, party_type) -
-No docs
-- - - erpnext.accounts.party.set_other_values - (out, party, party_type) -
-No docs
-- - - erpnext.accounts.party.set_price_list - (out, party, party_type, given_price_list) -
-No docs
-- - - erpnext.accounts.party.set_tax_withholding_details - (tax_mapper, ref_doc, tax_withholding_category=None, use_default=0) -
-No docs
-Public API
- /api/method/erpnext.accounts.party.set_taxes
-
- - - erpnext.accounts.party.set_taxes - (party, party_type, posting_date, company, customer_group=None, supplier_group=None, billing_address=None, shipping_address=None, use_for_shopping_cart=None) -
-No docs
-- - - erpnext.accounts.party.validate_due_date - (posting_date, due_date, party_type, party, company=None, bill_date=None) -
-No docs
-- - - erpnext.accounts.party.validate_party_accounts - (doc) -
-No docs
-- - - erpnext.accounts.party.validate_party_frozen_disabled - (party_type, party_name) -
-No docs
-- - - erpnext.accounts.party.validate_party_gle_currency - (party_type, party, company, party_account_currency=None) -
-Validate party account currency with existing GL Entry's currency
-Inherits from frappe.exceptions.ValidationError - -
Public API
- /api/method/erpnext.accounts.utils.add_ac
-
- - - erpnext.accounts.utils.add_ac - (args=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.utils.add_cc
-
- - - erpnext.accounts.utils.add_cc - (args=None) -
-No docs
-- - - erpnext.accounts.utils.check_if_advance_entry_modified - (args) -
- check if there is already a voucher reference
- check if amount is same
- check if jv is submitted
-
-- - - erpnext.accounts.utils.create_payment_gateway_account - (gateway) -
-No docs
-- - - erpnext.accounts.utils.fix_total_debit_credit - () -
-No docs
-- - - erpnext.accounts.utils.get_account_name - (account_type=None, root_type=None, is_group=None, account_currency=None, company=None) -
-return account based on matching conditions
-Public API
- /api/method/erpnext.accounts.utils.get_balance_on
-
- - - erpnext.accounts.utils.get_balance_on - (account=None, date=None, party_type=None, party=None, company=None, in_account_currency=True) -
-No docs
-Public API
- /api/method/erpnext.accounts.utils.get_children
-
- - - erpnext.accounts.utils.get_children - (doctype, parent, company, is_root=False) -
-No docs
-Public API
- /api/method/erpnext.accounts.utils.get_companies
-
- - - erpnext.accounts.utils.get_companies - () -
-get a list of companies based on permission
-Public API
- /api/method/erpnext.accounts.utils.get_company_default
-
- - - erpnext.accounts.utils.get_company_default - (company, fieldname) -
-No docs
-- - - erpnext.accounts.utils.get_count_on - (account, fieldname, date) -
-No docs
-- - - erpnext.accounts.utils.get_currency_precision - () -
-No docs
-- - - erpnext.accounts.utils.get_doc_name_autoname - (field_value, doc_title, name, company) -
-append title with prefix as number and suffix as company's abbreviation separated by '-'
-Public API
- /api/method/erpnext.accounts.utils.get_fiscal_year
-
- - - erpnext.accounts.utils.get_fiscal_year - (date=None, fiscal_year=None, label=Date, verbose=1, company=None, as_dict=False) -
-No docs
-- - - erpnext.accounts.utils.get_fiscal_years - (transaction_date=None, fiscal_year=None, label=Date, verbose=1, company=None, as_dict=False) -
-No docs
-- - - erpnext.accounts.utils.get_held_invoices - (party_type, party) -
-Returns a list of names Purchase Invoices for the given party that are on hold
-
-- - - erpnext.accounts.utils.get_outstanding_invoices - (party_type, party, account, condition=None) -
-No docs
-- - - erpnext.accounts.utils.get_stock_and_account_difference - (account_list=None, posting_date=None) -
-No docs
-- - - erpnext.accounts.utils.get_stock_rbnb_difference - (posting_date, company) -
-No docs
-- - - erpnext.accounts.utils.reconcile_against_document - (args) -
- Cancel JV, Update aginst document, split if required and resubmit jv
-
-- - - erpnext.accounts.utils.remove_ref_doc_link_from_jv - (ref_type, ref_no) -
-No docs
-- - - erpnext.accounts.utils.remove_ref_doc_link_from_pe - (ref_type, ref_no) -
-No docs
-- - - erpnext.accounts.utils.unlink_ref_doc_from_payment_entries - (ref_doc) -
-No docs
-Public API
- /api/method/erpnext.accounts.utils.update_number_field
-
- - - erpnext.accounts.utils.update_number_field - (doctype_name, name, field_name, field_value, company) -
- doctype_name = Name of the DocType
- name = Docname being referred
- field_name = Name of the field thats holding the 'number' attribute
- field_value = Numeric value entered in field_name
-
- Stores the number entered in the dialog to the DocType's field.
-
- Renames the document by adding the number as a prefix to the current name and updates
- all transaction where it was present.
-
-- - - erpnext.accounts.utils.update_reference_in_journal_entry - (d, jv_obj) -
- Updates against document, if partial amount splits into rows
-
-- - - erpnext.accounts.utils.update_reference_in_payment_entry - (d, payment_entry) -
-No docs
-- - - erpnext.accounts.utils.validate_allocated_amount - (args) -
-No docs
-- - - erpnext.accounts.utils.validate_field_number - (doctype_name, name, field_value, company, field_name) -
-Validate if the number entered isn't already assigned to some other document.
-- - - erpnext.accounts.utils.validate_fiscal_year - (date, fiscal_year, company, label=Date, doc=None) -
-No docs
-Inherits from unittest.case.TestCase - -
- - - setUpClass - (cls) -
-No docs
-- - - test_get_party_shipping_address - (self) -
-No docs
-- - - test_get_party_shipping_address2 - (self) -
-No docs
-- - - erpnext.agriculture.setup.create_agriculture_data - () -
-No docs
-- - - erpnext.agriculture.setup.setup_agriculture - () -
-No docs
-- - - erpnext.buying.utils.check_for_closed_status - (doctype, docname) -
-No docs
-Public API
- /api/method/erpnext.buying.utils.get_linked_material_requests
-
- - - erpnext.buying.utils.get_linked_material_requests - (items) -
-No docs
-- - - erpnext.buying.utils.update_last_purchase_rate - (doc, is_submit) -
-updates lastpurchaserate in item table for each item
-- - - erpnext.buying.utils.validate_for_items - (doc) -
-No docs
-- - - erpnext.commands.call_command - (cmd, context) -
-No docs
-- - - erpnext.config.accounts.get_data - () -
-No docs
-- - - erpnext.config.agriculture.get_data - () -
-No docs
-- - - erpnext.config.assets.get_data - () -
-No docs
-- - - erpnext.config.buying.get_data - () -
-No docs
-- - - erpnext.config.crm.get_data - () -
-No docs
-- - - erpnext.config.desktop.get_data - () -
-No docs
-- - - erpnext.config.education.get_data - () -
-No docs
-- - - erpnext.config.erpnext_integrations.get_data - () -
-No docs
-- - - erpnext.config.healthcare.get_data - () -
-No docs
-- - - erpnext.config.hr.get_data - () -
-No docs
-- - - erpnext.config.hub_node.get_data - () -
-No docs
-- - - erpnext.config.learn.get_data - () -
-No docs
-- - - erpnext.config.maintenance.get_data - () -
-No docs
-- - - erpnext.config.manufacturing.get_data - () -
-No docs
-- - - erpnext.config.non_profit.get_data - () -
-No docs
-- - - erpnext.config.projects.get_data - () -
-No docs
-- - - erpnext.config.selling.get_data - () -
-No docs
-- - - erpnext.config.setup.get_data - () -
-No docs
-- - - erpnext.config.stock.get_data - () -
-No docs
-- - - erpnext.config.support.get_data - () -
-No docs
-- - - erpnext.config.website.get_data - () -
-No docs
-Inherits from erpnext.utilities.transaction_base.TransactionBase - -
- - - __init__ - (self) -
-No docs
-- - - append_taxes_from_master - (self, tax_master_doctype=None) -
-No docs
-- - - apply_shipping_rule - (self) -
-No docs
-- - - before_print - (self) -
-No docs
-- - - calculate_taxes_and_totals - (self) -
-No docs
-- - - clear_unallocated_advances - (self, childtype, parentfield) -
-No docs
-- - - delink_advance_entries - (self, linked_doc_name) -
-No docs
-- - - ensure_supplier_is_not_blocked - (self) -
-No docs
-- - - get_advance_entries - (self, include_unallocated=True) -
-No docs
-- - - get_company_default - (self, fieldname) -
-No docs
-- - - get_gl_dict - (self, args, account_currency=None) -
-this method populates the common properties of a gl entry record
-- - - get_party - (self) -
-No docs
-- - - get_shipping_address - (self) -
-Returns Address object from shipping address fields if present
-- - - get_stock_items - (self) -
-No docs
-- - - group_similar_items - (self) -
-No docs
-- - - is_inclusive_tax - (self) -
-No docs
-- - - is_pos_profile_changed - (self) -
-No docs
-- - - is_rounded_total_disabled - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - set_advances - (self) -
-Returns list of advances against Account, Party, Reference
-- - - set_due_date - (self) -
-No docs
-- - - set_missing_item_details - (self, for_validate=False) -
-set missing item values
-- - - set_missing_values - (self, for_validate=False) -
-No docs
-- - - set_other_charges - (self) -
-No docs
-- - - set_payment_schedule - (self) -
-No docs
-- - - set_price_list_currency - (self, buying_or_selling) -
-No docs
-- - - set_taxes - (self) -
-No docs
-- - - set_total_advance_paid - (self) -
-No docs
-- - - update_against_document_in_jv - (self) -
- Links invoice and advance voucher:
- 1. cancel advance voucher
- 2. split into multiple rows if partially adjusted, assign against voucher
- 3. submit advance voucher
-
-- - - validate - (self) -
-No docs
-- - - validate_account_currency - (self, account, account_currency=None) -
-No docs
-- - - validate_advance_entries - (self) -
-No docs
-- - - validate_all_documents_schedule - (self) -
-No docs
-- - - validate_currency - (self) -
-No docs
-- - - validate_date_with_fiscal_year - (self) -
-No docs
-- - - validate_due_date - (self) -
-No docs
-- - - validate_enabled_taxes_and_charges - (self) -
-No docs
-- - - validate_fixed_asset - (self) -
-No docs
-- - - validate_invoice_documents_schedule - (self) -
-No docs
-- - - validate_multiple_billing - (self, ref_dt, item_ref_dn, based_on, parentfield) -
-No docs
-- - - validate_non_invoice_documents_schedule - (self) -
-No docs
-- - - validate_paid_amount - (self) -
-No docs
-- - - validate_party - (self) -
-No docs
-- - - validate_payment_schedule_amount - (self) -
-No docs
-- - - validate_payment_schedule_dates - (self) -
-No docs
-- - - validate_tax_account_company - (self) -
-No docs
-- - - erpnext.controllers.accounts_controller.get_advance_journal_entries - (party_type, party, party_account, amount_field, order_doctype, order_list, include_unallocated=True) -
-No docs
-- - - erpnext.controllers.accounts_controller.get_advance_payment_entries - (party_type, party, party_account, order_doctype, order_list=None, include_unallocated=True, against_all_orders=False) -
-No docs
-Public API
- /api/method/erpnext.controllers.accounts_controller.get_default_taxes_and_charges
-
- - - erpnext.controllers.accounts_controller.get_default_taxes_and_charges - (master_doctype, tax_template=None, company=None) -
-No docs
-- - - erpnext.controllers.accounts_controller.get_due_date - (term, posting_date=None, bill_date=None) -
-No docs
-Public API
- /api/method/erpnext.controllers.accounts_controller.get_payment_term_details
-
- - - erpnext.controllers.accounts_controller.get_payment_term_details - (term, posting_date=None, grand_total=None, bill_date=None) -
-No docs
-Public API
- /api/method/erpnext.controllers.accounts_controller.get_payment_terms
-
- - - erpnext.controllers.accounts_controller.get_payment_terms - (terms_template, posting_date=None, grand_total=None, bill_date=None) -
-No docs
-- - - erpnext.controllers.accounts_controller.get_supplier_block_status - (party_name) -
-Returns a dict containing the values of `on_hold`, `release_date` and `hold_type` of
-a `Supplier`
-
-Public API
- /api/method/erpnext.controllers.accounts_controller.get_tax_rate
-
- - - erpnext.controllers.accounts_controller.get_tax_rate - (account_head) -
-No docs
-Public API
- /api/method/erpnext.controllers.accounts_controller.get_taxes_and_charges
-
- - - erpnext.controllers.accounts_controller.get_taxes_and_charges - (master_doctype, master_name) -
-No docs
-- - - erpnext.controllers.accounts_controller.set_balance_in_account_currency - (gl_dict, account_currency=None, conversion_rate=None, company_currency=None) -
-No docs
-- - - erpnext.controllers.accounts_controller.update_invoice_status - () -
-No docs
-- - - erpnext.controllers.accounts_controller.validate_conversion_rate - (currency, conversion_rate, conversion_rate_label, company) -
-common validation for currency and price list currency
-- - - erpnext.controllers.accounts_controller.validate_inclusive_tax - (tax, doc) -
-No docs
-- - - erpnext.controllers.accounts_controller.validate_taxes_and_charges - (tax) -
-No docs
-Inherits from erpnext.controllers.stock_controller.StockController - -
- - - __setup__ - (self) -
-No docs
-- - - cleanup_raw_materials_supplied - (self, parent_items, raw_material_table) -
-Remove all those child items which are no longer present in main item table
-- - - create_raw_materials_supplied - (self, raw_material_table) -
-No docs
-- - - delete_linked_asset - (self) -
-No docs
-- - - get_asset_items - (self) -
-No docs
-- - - get_feed - (self) -
-No docs
-- - - make_asset - (self, row) -
-No docs
-- - - make_asset_movement - (self, row) -
-No docs
-- - - make_serial_nos_for_asset - (self, asset_items) -
-No docs
-- - - make_sl_entries_for_supplier_warehouse - (self, sl_entries) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - process_fixed_asset - (self) -
-No docs
-- - - set_landed_cost_voucher_amount - (self) -
-No docs
-- - - set_missing_values - (self, for_validate=False) -
-No docs
-- - - set_qty_as_per_stock_uom - (self) -
-No docs
-- - - set_supplier_from_item_default - (self) -
-No docs
-- - - set_total_in_words - (self) -
-No docs
-- - - update_fixed_asset - (self, field, delete_asset=False) -
-No docs
-- - - update_ordered_and_reserved_qty - (self) -
-No docs
-- - - update_raw_materials_supplied_based_on_bom - (self, item, raw_material_table) -
-No docs
-- - - update_raw_materials_supplied_based_on_stock_entries - (self, raw_material_table) -
-No docs
-- - - update_stock_ledger - (self, allow_negative_stock=False, via_landed_cost_voucher=False) -
-No docs
-- - - update_valuation_rate - (self, parentfield) -
- item_tax_amount is the total tax amount applied on that item
- stored for valuation
-
- TODO: rename item_tax_amount to valuation_tax_amount
-
-- - - validate - (self) -
-No docs
-- - - validate_accepted_rejected_qty - (self) -
-No docs
-- - - validate_budget - (self) -
-No docs
-- - - validate_for_subcontracting - (self) -
-No docs
-- - - validate_items - (self) -
-No docs
-- - - validate_negative_quantity - (self, item_row, field_list) -
-No docs
-- - - validate_purchase_return - (self) -
-No docs
-- - - validate_rejected_warehouse - (self) -
-No docs
-- - - validate_schedule_date - (self) -
-No docs
-- - - validate_stock_or_nonstock_items - (self) -
-No docs
-- - - erpnext.controllers.buying_controller.get_asset_item_details - (asset_items) -
-No docs
-- - - erpnext.controllers.buying_controller.get_backflushed_subcontracted_raw_materials_from_se - (purchase_orders, purchase_receipt) -
-No docs
-- - - erpnext.controllers.buying_controller.get_items_from_bom - (item_code, bom, exploded_item=1) -
-No docs
-- - - erpnext.controllers.buying_controller.get_subcontracted_raw_materials_from_se - (purchase_orders) -
-No docs
-- - - erpnext.controllers.buying_controller.validate_item_type - (doc, fieldname, message) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.controllers.item_variant.copy_attributes_to_variant - (item, variant) -
-No docs
-- - - erpnext.controllers.item_variant.create_multiple_variants - (item, args) -
-No docs
-Public API
- /api/method/erpnext.controllers.item_variant.create_variant
-
- - - erpnext.controllers.item_variant.create_variant - (item, args) -
-No docs
-Public API
- /api/method/erpnext.controllers.item_variant.create_variant_doc_for_quick_entry
-
- - - erpnext.controllers.item_variant.create_variant_doc_for_quick_entry - (template, args) -
-No docs
-Public API
- /api/method/erpnext.controllers.item_variant.enqueue_multiple_variant_creation
-
- - - erpnext.controllers.item_variant.enqueue_multiple_variant_creation - (item, args) -
-No docs
-- - - erpnext.controllers.item_variant.find_variant - (template, args, variant_item_code=None) -
-No docs
-- - - erpnext.controllers.item_variant.generate_keyed_value_combinations - (args) -
-From this:
-
- args = {"attr1": ["a", "b", "c"], "attr2": ["1", "2"], "attr3": ["A"]}
-
-To this:
-
- [
- {u'attr1': u'a', u'attr2': u'1', u'attr3': u'A'},
- {u'attr1': u'b', u'attr2': u'1', u'attr3': u'A'},
- {u'attr1': u'c', u'attr2': u'1', u'attr3': u'A'},
- {u'attr1': u'a', u'attr2': u'2', u'attr3': u'A'},
- {u'attr1': u'b', u'attr2': u'2', u'attr3': u'A'},
- {u'attr1': u'c', u'attr2': u'2', u'attr3': u'A'}
- ]
-
-- - - erpnext.controllers.item_variant.get_attribute_values - (item) -
-No docs
-Public API
- /api/method/erpnext.controllers.item_variant.get_variant
-
- - - erpnext.controllers.item_variant.get_variant - (template, args=None, variant=None, manufacturer=None, manufacturer_part_no=None) -
-Validates Attributes and their Values, then looks for an exactly - matching Item Variant
- -Parameters:
- -item - Template Itemargs - A dictionary with "Attribute" as key and "Attribute Value" as value- - - erpnext.controllers.item_variant.make_variant_based_on_manufacturer - (template, manufacturer, manufacturer_part_no) -
-Make and return a new variant based on manufacturer and - manufacturer part no
-- - - erpnext.controllers.item_variant.make_variant_item_code - (template_item_code, template_item_name, variant) -
-Uses template's item code and abbreviations to make variant's item code
-- - - erpnext.controllers.item_variant.validate_is_incremental - (numeric_attribute, attribute, value, item) -
-No docs
-- - - erpnext.controllers.item_variant.validate_item_attribute_value - (attributes_list, attribute, attribute_value, item) -
-No docs
-- - - erpnext.controllers.item_variant.validate_item_variant_attributes - (item, args=None) -
-No docs
-- - - erpnext.controllers.print_settings.format_columns - (display_columns, compact_fields) -
-No docs
-- - - erpnext.controllers.print_settings.print_settings_for_item_table - (doc) -
-No docs
-- - - erpnext.controllers.queries.bom - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.controllers.queries.customer_query - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.controllers.queries.employee_query - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.controllers.queries.get_account_list - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.controllers.queries.get_batch_no - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Public API
- /api/method/erpnext.controllers.queries.get_batch_numbers
-
- - - erpnext.controllers.queries.get_batch_numbers - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.controllers.queries.get_delivery_notes_to_be_billed - (doctype, txt, searchfield, start, page_len, filters, as_dict) -
-No docs
-- - - erpnext.controllers.queries.get_doctype_wise_filters - (filters) -
-No docs
-Public API
- /api/method/erpnext.controllers.queries.get_expense_account
-
- - - erpnext.controllers.queries.get_expense_account - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Public API
- /api/method/erpnext.controllers.queries.get_income_account
-
- - - erpnext.controllers.queries.get_income_account - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.controllers.queries.get_project_name - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.controllers.queries.item_query - (doctype, txt, searchfield, start, page_len, filters, as_dict=False) -
-No docs
-- - - erpnext.controllers.queries.lead_query - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.controllers.queries.supplier_query - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.controllers.queries.tax_account_query - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Public API
- /api/method/erpnext.controllers.queries.warehouse_query
-
- - - erpnext.controllers.queries.warehouse_query - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.controllers.sales_and_purchase_return.get_already_returned_items - (doc) -
-No docs
-- - - erpnext.controllers.sales_and_purchase_return.get_ref_item_dict - (valid_items, ref_item_row) -
-No docs
-- - - erpnext.controllers.sales_and_purchase_return.make_return_doc - (doctype, source_name, target_doc=None) -
-No docs
-- - - erpnext.controllers.sales_and_purchase_return.validate_quantity - (doc, args, ref, valid_items, already_returned_items) -
-No docs
-- - - erpnext.controllers.sales_and_purchase_return.validate_return - (doc) -
-No docs
-- - - erpnext.controllers.sales_and_purchase_return.validate_return_against - (doc) -
-No docs
-- - - erpnext.controllers.sales_and_purchase_return.validate_returned_items - (doc) -
-No docs
-Inherits from erpnext.controllers.stock_controller.StockController - -
- - - __setup__ - (self) -
-No docs
-- - - calculate_commission - (self) -
-No docs
-- - - calculate_contribution - (self) -
-No docs
-- - - check_close_sales_order - (self, ref_fieldname) -
-No docs
-- - - get_already_delivered_qty - (self, current_docname, so, so_detail) -
-No docs
-- - - get_feed - (self) -
-No docs
-- - - get_item_list - (self) -
-No docs
-- - - get_so_qty_and_warehouse - (self, so_detail) -
-No docs
-- - - has_product_bundle - (self, item_code) -
-No docs
-- - - onload - (self) -
-No docs
-- - - remove_shipping_charge - (self) -
-No docs
-- - - set_missing_lead_customer_details - (self) -
-No docs
-- - - set_missing_values - (self, for_validate=False) -
-No docs
-- - - set_po_nos - (self) -
-No docs
-- - - set_price_list_and_item_details - (self, for_validate=False) -
-No docs
-- - - set_qty_as_per_stock_uom - (self) -
-No docs
-- - - set_total_in_words - (self) -
-No docs
-- - - update_reserved_qty - (self) -
-No docs
-- - - update_stock_ledger - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_items - (self) -
-No docs
-- - - validate_max_discount - (self) -
-No docs
-- - - validate_order_type - (self) -
-No docs
-- - - validate_selling_price - (self) -
-No docs
-- - - erpnext.controllers.selling_controller.check_active_sales_items - (obj) -
-No docs
-Inherits from frappe.model.document.Document - -
Updates the status of the calling records
- Delivery Note: Update Delivered Qty, Update Percent and Validate over delivery
- Sales Invoice: Update Billed Amt, Update Percent and Validate over billing
- Installation Note: Update Installed Qty, Update Percent Qty and Validate over installation
-
-- - - _update_children - (self, args, update_modified) -
-Update quantities or amount in child table
-- - - _update_modified - (self, args, update_modified) -
-No docs
-- - - _update_percent_field - (self, args, update_modified=True) -
-Update percent field in parent transaction
-- - - _update_percent_field_in_targets - (self, args, update_modified=True) -
-Update percent field in parent transaction
-- - - check_overflow_with_tolerance - (self, item, args) -
- Checks if there is overflow condering a relaxation tolerance
-
-- - - limits_crossed_error - (self, args, item) -
-Raise exception for limits crossed
-- - - set_status - (self, update=False, status=None, update_modified=True) -
-No docs
-- - - update_billing_status - (self, zero_amount_refdoc, ref_dt, ref_fieldname) -
-No docs
-- - - update_billing_status_for_zero_amount_refdoc - (self, ref_dt) -
-No docs
-- - - update_prevdoc_status - (self) -
-No docs
-- - - update_qty - (self, update_modified=True) -
-Updates qty or amount at row level
- -Parameters:
- -update_modified - If true, updates modified and modified_by for target parent doc- - - validate_qty - (self) -
-Validates qty at row level
-- - - erpnext.controllers.status_updater.get_tolerance_for - (item_code, item_tolerance={}, global_tolerance=None) -
- Returns the tolerance for the item, if not set, returns global tolerance
-
-- - - erpnext.controllers.status_updater.validate_status - (status, options) -
-No docs
-Inherits from erpnext.controllers.accounts_controller.AccountsController - -
- - - check_expense_account - (self, item) -
-No docs
-- - - get_gl_entries - (self, warehouse_account=None, default_expense_account=None, default_cost_center=None) -
-No docs
-- - - get_incoming_rate_for_sales_return - (self, item_code, against_document) -
-No docs
-- - - get_items_and_warehouses - (self) -
-No docs
-- - - get_serialized_items - (self) -
-No docs
-- - - get_sl_entries - (self, d, args) -
-No docs
-- - - get_stock_ledger_details - (self) -
-No docs
-- - - get_voucher_details - (self, default_expense_account, default_cost_center, sle_map) -
-No docs
-- - - make_adjustment_entry - (self, expected_gle, voucher_obj) -
-No docs
-- - - make_batches - (self, warehouse_field) -
-Create batches if required. Called before submit
-- - - make_gl_entries - (self, gl_entries=None, repost_future_gle=True, from_repost=False) -
-No docs
-- - - make_gl_entries_on_cancel - (self, repost_future_gle=True) -
-No docs
-- - - make_sl_entries - (self, sl_entries, is_amended=None, allow_negative_stock=False, via_landed_cost_voucher=False) -
-No docs
-- - - update_billing_percentage - (self, update_modified=True) -
-No docs
-- - - update_stock_ledger_entries - (self, sle) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_inspection - (self) -
-Checks if quality inspection is set for Items that require inspection. - On submit, throw an exception
-- - - validate_warehouse - (self) -
-No docs
-- - - erpnext.controllers.stock_controller.compare_existing_and_expected_gle - (existing_gle, expected_gle) -
-No docs
-- - - erpnext.controllers.stock_controller.get_future_stock_vouchers - (posting_date, posting_time, for_warehouses=None, for_items=None) -
-No docs
-- - - erpnext.controllers.stock_controller.get_voucherwise_gl_entries - (future_stock_vouchers, posting_date) -
-No docs
-- - - erpnext.controllers.stock_controller.update_gl_entries_after - (posting_date, posting_time, for_warehouses=None, for_items=None, warehouse_account=None) -
-No docs
-Inherits from __builtin__.object - -
- - - __init__ - (self, doc) -
-No docs
-- - - _calculate - (self) -
-No docs
-- - - _cleanup - (self) -
-No docs
-- - - _get_tax_rate - (self, tax, item_tax_map) -
-No docs
-- - - _load_item_tax_rate - (self, item_tax_rate) -
-No docs
-- - - _set_in_company_currency - (self, doc, fields) -
-set values in base currency
-- - - apply_discount_amount - (self) -
-No docs
-- - - calculate - (self) -
-No docs
-- - - calculate_change_amount - (self) -
-No docs
-- - - calculate_item_values - (self) -
-No docs
-- - - calculate_margin - (self, item) -
-No docs
-- - - calculate_net_total - (self) -
-No docs
-- - - calculate_outstanding_amount - (self) -
-No docs
-- - - calculate_paid_amount - (self) -
-No docs
-- - - calculate_taxes - (self) -
-No docs
-- - - calculate_total_advance - (self) -
-No docs
-- - - calculate_total_net_weight - (self) -
-No docs
-- - - calculate_totals - (self) -
-No docs
-- - - calculate_write_off_amount - (self) -
-No docs
-- - - determine_exclusive_rate - (self) -
-No docs
-- - - get_current_tax_amount - (self, item, tax, item_tax_map) -
-No docs
-- - - get_current_tax_fraction - (self, tax, item_tax_map) -
- Get tax fraction for calculating tax exclusive amount
- from tax inclusive amount
-
-- - - get_tax_amount_if_for_valuation_or_deduction - (self, tax_amount, tax) -
-No docs
-- - - get_total_for_discount_amount - (self) -
-No docs
-- - - initialize_taxes - (self) -
-No docs
-- - - manipulate_grand_total_for_inclusive_tax - (self) -
-No docs
-- - - round_off_totals - (self, tax) -
-No docs
-- - - set_cumulative_total - (self, row_idx, tax) -
-No docs
-- - - set_discount_amount - (self) -
-No docs
-- - - set_item_wise_tax - (self, item, tax, tax_rate, current_tax_amount) -
-No docs
-- - - set_item_wise_tax_breakup - (self) -
-No docs
-- - - set_rounded_total - (self) -
-No docs
-- - - validate_conversion_rate - (self) -
-No docs
-- - - erpnext.controllers.taxes_and_totals.get_itemised_tax - (taxes) -
-No docs
-- - - erpnext.controllers.taxes_and_totals.get_itemised_tax_breakup_html - (doc) -
-No docs
-- - - erpnext.controllers.taxes_and_totals.get_itemised_taxable_amount - (items) -
-No docs
-- - - erpnext.controllers.taxes_and_totals.get_rounded_tax_amount - (itemised_tax, precision) -
-No docs
-- - - erpnext.controllers.trends.based_wise_columns_query - (based_on, trans) -
-No docs
-- - - erpnext.controllers.trends.get_columns - (filters, trans) -
-No docs
-- - - erpnext.controllers.trends.get_data - (filters, conditions) -
-No docs
-- - - erpnext.controllers.trends.get_mon - (dt) -
-No docs
-Public API
- /api/method/erpnext.controllers.trends.get_period_date_ranges
-
- - - erpnext.controllers.trends.get_period_date_ranges - (period, fiscal_year=None, year_start_date=None) -
-No docs
-- - - erpnext.controllers.trends.get_period_month_ranges - (period, fiscal_year) -
-No docs
-- - - erpnext.controllers.trends.get_period_wise_columns - (bet_dates, period, pwc) -
-No docs
-- - - erpnext.controllers.trends.get_period_wise_query - (bet_dates, trans_date, query_details) -
-No docs
-- - - erpnext.controllers.trends.group_wise_column - (group_by) -
-No docs
-- - - erpnext.controllers.trends.period_wise_columns_query - (filters, trans) -
-No docs
-- - - erpnext.controllers.trends.validate_filters - (filters) -
-No docs
-- - - erpnext.controllers.website_list_for_contact.get_customers_suppliers - (doctype, user) -
-No docs
-- - - erpnext.controllers.website_list_for_contact.get_list_context - (context=None) -
-No docs
-- - - erpnext.controllers.website_list_for_contact.get_list_for_transactions - (doctype, txt, filters, limit_start, limit_page_length=20, ignore_permissions=False, fields=None, order_by=None) -
-Get List of transactions like Invoices, Orders
-- - - erpnext.controllers.website_list_for_contact.get_party_details - (customers, suppliers) -
-No docs
-- - - erpnext.controllers.website_list_for_contact.get_transaction_list - (doctype, txt=None, filters=None, limit_start=0, limit_page_length=20, order_by=modified) -
-No docs
-- - - erpnext.controllers.website_list_for_contact.has_website_permission - (doc, ptype, user, verbose=False) -
-No docs
-- - - erpnext.controllers.website_list_for_contact.post_process - (doctype, data) -
-No docs
-- - - erpnext.controllers.website_list_for_contact.rfq_transaction_list - (parties_doctype, doctype, parties, limit_start, limit_page_length) -
-No docs
-- - - erpnext.demo.demo.make - (domain=Manufacturing, days=100) -
-No docs
-- - - erpnext.demo.demo.simulate - (domain=Manufacturing, days=100) -
-No docs
-- - - erpnext.demo.setup.education.get_json_path - (doctype) -
-No docs
-- - - erpnext.demo.setup.education.make_assessment_groups - () -
-No docs
-- - - erpnext.demo.setup.education.make_fees_category - () -
-No docs
-- - - erpnext.demo.setup.education.make_fees_structure - () -
-No docs
-- - - erpnext.demo.setup.education.make_masters - () -
-No docs
-- - - erpnext.demo.setup.education.make_student_applicants - () -
-No docs
-- - - erpnext.demo.setup.education.make_student_group - () -
-No docs
-- - - erpnext.demo.setup.education.setup_data - () -
-No docs
-- - - erpnext.demo.setup.education.setup_item - () -
-No docs
-- - - erpnext.demo.setup.education.weighted_choice - (weights) -
-No docs
-- - - erpnext.demo.setup.healthcare.append_drug_rx - (consultation) -
-No docs
-- - - erpnext.demo.setup.healthcare.append_test_rx - (consultation) -
-No docs
-- - - erpnext.demo.setup.healthcare.consulation_on_appointment - () -
-No docs
-- - - erpnext.demo.setup.healthcare.get_json_path - (doctype) -
-No docs
-- - - erpnext.demo.setup.healthcare.import_drug - () -
-No docs
-- - - erpnext.demo.setup.healthcare.lab_test_on_consultation - () -
-No docs
-- - - erpnext.demo.setup.healthcare.make_appointment - () -
-No docs
-- - - erpnext.demo.setup.healthcare.make_consulation - () -
-No docs
-- - - erpnext.demo.setup.healthcare.make_lab_test - () -
-No docs
-- - - erpnext.demo.setup.healthcare.make_masters - () -
-No docs
-- - - erpnext.demo.setup.healthcare.make_patient - () -
-No docs
-- - - erpnext.demo.setup.healthcare.random_date - (start, l) -
-No docs
-- - - erpnext.demo.setup.healthcare.set_consultation - (patient, patient_sex, physician, department, consultation_date, i) -
-No docs
-- - - erpnext.demo.setup.healthcare.set_lab_test - (patient, patient_sex, physician, template, rx=None) -
-No docs
-- - - erpnext.demo.setup.healthcare.setup_data - () -
-No docs
-- - - erpnext.demo.setup.manufacture.setup_asset - () -
-No docs
-- - - erpnext.demo.setup.manufacture.setup_data - () -
-No docs
-- - - erpnext.demo.setup.manufacture.setup_item - () -
-No docs
-- - - erpnext.demo.setup.manufacture.setup_item_price - () -
-No docs
-- - - erpnext.demo.setup.manufacture.setup_product_bundle - () -
-No docs
-- - - erpnext.demo.setup.manufacture.setup_workstation - () -
-No docs
-- - - erpnext.demo.setup.manufacture.show_item_groups_in_website - () -
-set showinwebsite=1 for Item Groups
-- - - erpnext.demo.setup.setup_data.complete_setup - (domain=Manufacturing) -
-No docs
-- - - erpnext.demo.setup.setup_data.import_json - (doctype, submit=False, values=None) -
-No docs
-- - - erpnext.demo.setup.setup_data.setup - (domain) -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_account - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_account_to_expense_type - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_budget - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_currency_exchange - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_customer - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_demo_page - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_employee - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_fiscal_year - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_holiday_list - () -
-Setup Holiday List for the current year
-- - - erpnext.demo.setup.setup_data.setup_leave_allocation - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_mode_of_payment - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_pos_profile - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_role_permissions - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_salary_structure - (employees, salary_slip_based_on_timesheet=0) -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_supplier - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_user - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_user_roles - () -
-No docs
-- - - erpnext.demo.setup.setup_data.setup_warehouse - () -
-No docs
-- - - erpnext.demo.user.accounts.make_payment_entries - (ref_doctype, report) -
-No docs
-- - - erpnext.demo.user.accounts.make_payment_entries_for_pos_invoice - (si) -
-No docs
-- - - erpnext.demo.user.accounts.make_pos_invoice - () -
-No docs
-- - - erpnext.demo.user.accounts.work - () -
-No docs
-- - - erpnext.demo.user.education.approve_random_student_applicant - () -
-No docs
-- - - erpnext.demo.user.education.assign_student_group - (student, student_name, program, courses, batch) -
-No docs
-- - - erpnext.demo.user.education.enroll_random_student - (current_date) -
-No docs
-- - - erpnext.demo.user.education.make_assessment_plan - (date) -
-No docs
-- - - erpnext.demo.user.education.make_course_schedule - (start_date, end_date) -
-No docs
-- - - erpnext.demo.user.education.make_fees - () -
-No docs
-- - - erpnext.demo.user.education.mark_student_attendance - (current_date) -
-No docs
-- - - erpnext.demo.user.education.weighted_choice - (weights) -
-No docs
-- - - erpnext.demo.user.education.work - () -
-No docs
-- - - erpnext.demo.user.fixed_asset.get_random_asset - () -
-No docs
-- - - erpnext.demo.user.fixed_asset.make_asset_purchase_entry - () -
-No docs
-- - - erpnext.demo.user.fixed_asset.sell_an_asset - () -
-No docs
-- - - erpnext.demo.user.fixed_asset.work - () -
-No docs
-- - - erpnext.demo.user.hr.get_expenses - () -
-No docs
-- - - erpnext.demo.user.hr.get_timesheet_based_salary_slip_employee - () -
-No docs
-- - - erpnext.demo.user.hr.make_leave_application - () -
-No docs
-- - - erpnext.demo.user.hr.make_salary_slip_for_timesheet - (name) -
-No docs
-- - - erpnext.demo.user.hr.make_sales_invoice_for_timesheet - (name) -
-No docs
-- - - erpnext.demo.user.hr.make_timesheet_records - () -
-No docs
-- - - erpnext.demo.user.hr.mark_attendance - () -
-No docs
-- - - erpnext.demo.user.hr.update_sanctioned_amount - (expense_claim) -
-No docs
-- - - erpnext.demo.user.hr.work - () -
-No docs
-- - - erpnext.demo.user.manufacturing.make_stock_entry_from_pro - (pro_id, purpose) -
-No docs
-- - - erpnext.demo.user.manufacturing.work - () -
-No docs
-- - - erpnext.demo.user.projects.close_tasks - (current_date) -
-No docs
-- - - erpnext.demo.user.projects.make_project - (current_date) -
-No docs
-- - - erpnext.demo.user.projects.make_timesheet_for_projects - (current_date) -
-No docs
-- - - erpnext.demo.user.projects.run_projects - (current_date) -
-No docs
-- - - erpnext.demo.user.purchase.add_suppliers - (rfq) -
-No docs
-- - - erpnext.demo.user.purchase.make_material_request - (item_code, qty) -
-No docs
-- - - erpnext.demo.user.purchase.make_subcontract - () -
-No docs
-- - - erpnext.demo.user.purchase.work - () -
-No docs
-- - - erpnext.demo.user.sales.make_opportunity - () -
-No docs
-- - - erpnext.demo.user.sales.make_quotation - () -
-No docs
-- - - erpnext.demo.user.sales.make_sales_order - () -
-No docs
-- - - erpnext.demo.user.sales.work - () -
-No docs
-- - - erpnext.demo.user.stock.make_delivery_note - () -
-No docs
-- - - erpnext.demo.user.stock.make_purchase_receipt - () -
-No docs
-- - - erpnext.demo.user.stock.make_purchase_return_records - () -
-No docs
-- - - erpnext.demo.user.stock.make_sales_return_records - () -
-No docs
-- - - erpnext.demo.user.stock.make_stock_reconciliation - () -
-No docs
-- - - erpnext.demo.user.stock.submit_draft_stock_entries - () -
-No docs
-- - - erpnext.demo.user.stock.work - () -
-No docs
-Public API
- /api/method/erpnext.education.api.check_attendance_records_exist
-
- - - erpnext.education.api.check_attendance_records_exist - (course_schedule=None, student_group=None, date=None) -
-Check if Attendance Records are made against the specified Course Schedule or Student Group for given date.
- -Parameters:
- -course_schedule - Course Schedule.student_group - Student Group.date - Date.Public API
- /api/method/erpnext.education.api.collect_fees
-
- - - erpnext.education.api.collect_fees - (fees, amt) -
-No docs
-Public API
- /api/method/erpnext.education.api.enroll_student
-
- - - erpnext.education.api.enroll_student - (source_name) -
-Creates a Student Record and returns a Program Enrollment.
- -Parameters:
- -source_name - Student Applicant.Public API
- /api/method/erpnext.education.api.get_assessment_criteria
-
- - - erpnext.education.api.get_assessment_criteria - (course) -
-Returns Assessmemt Criteria and their Weightage from Course Master.
- -Parameters:
- -Course - CoursePublic API
- /api/method/erpnext.education.api.get_assessment_details
-
- - - erpnext.education.api.get_assessment_details - (assessment_plan) -
-Returns Assessment Criteria and Maximum Score from Assessment Plan Master.
- -Parameters:
- -Assessment Plan - Assessment Plan- - - erpnext.education.api.get_assessment_result_doc - (student, assessment_plan) -
-No docs
-Public API
- /api/method/erpnext.education.api.get_assessment_students
-
- - - erpnext.education.api.get_assessment_students - (assessment_plan, student_group) -
-No docs
-- - - erpnext.education.api.get_course - (program) -
-Return list of courses for a particular program
- -Parameters:
- -program - ProgramPublic API
- /api/method/erpnext.education.api.get_course_schedule_events
-
- - - erpnext.education.api.get_course_schedule_events - (start, end, filters=None) -
-Returns events for Course Schedule Calendar view rendering.
- -Parameters:
- -start - Start date-time.end - End date-time.filters - Filters (JSON).Public API
- /api/method/erpnext.education.api.get_current_enrollment
-
- - - erpnext.education.api.get_current_enrollment - (student, academic_year=None) -
-No docs
-Public API
- /api/method/erpnext.education.api.get_fee_components
-
- - - erpnext.education.api.get_fee_components - (fee_structure) -
-Returns Fee Components.
- -Parameters:
- -fee_structure - Fee Structure.Public API
- /api/method/erpnext.education.api.get_fee_schedule
-
- - - erpnext.education.api.get_fee_schedule - (program, student_category=None) -
-Returns Fee Schedule.
- -Parameters:
- -program - Program.student_category - Student CategoryPublic API
- /api/method/erpnext.education.api.get_fee_structure
-
- - - erpnext.education.api.get_fee_structure - (program, academic_term=None) -
-Returns Fee Structure.
- -Parameters:
- -program - Program.academic_term - Academic Term.Public API
- /api/method/erpnext.education.api.get_grade
-
- - - erpnext.education.api.get_grade - (grading_scale, percentage) -
-Returns Grade based on the Grading Scale and Score.
- -Parameters:
- -Grading Scale - Grading ScalePercentage - Score Percentage PercentagePublic API
- /api/method/erpnext.education.api.get_result
-
- - - erpnext.education.api.get_result - (student, assessment_plan) -
-Returns Submitted Result of given student for specified Assessment Plan
- -Parameters:
- -Student - StudentAssessment Plan - Assessment PlanPublic API
- /api/method/erpnext.education.api.get_student_group_students
-
- - - erpnext.education.api.get_student_group_students - (student_group, include_inactive=0) -
-Returns List of student, student_name in Student Group.
- -Parameters:
- -student_group - Student Group.Public API
- /api/method/erpnext.education.api.get_student_guardians
-
- - - erpnext.education.api.get_student_guardians - (student) -
-Returns List of Guardians of a Student.
- -Parameters:
- -student - Student.- - - erpnext.education.api.make_attendance_records - (student, student_name, status, course_schedule=None, student_group=None, date=None) -
-Creates/Update Attendance Record.
- -Parameters:
- -student - Student.student_name - Student Name.course_schedule - Course Schedule.status - Status (Present/Absent)Public API
- /api/method/erpnext.education.api.mark_assessment_result
-
- - - erpnext.education.api.mark_assessment_result - (assessment_plan, scores) -
-No docs
-Public API
- /api/method/erpnext.education.api.mark_attendance
-
- - - erpnext.education.api.mark_attendance - (students_present, students_absent, course_schedule=None, student_group=None, date=None) -
-Creates Multiple Attendance Records.
- -Parameters:
- -students_present - Students Present JSON.students_absent - Students Absent JSON.course_schedule - Course Schedule.student_group - Student Group.date - Date.Public API
- /api/method/erpnext.education.api.submit_assessment_results
-
- - - erpnext.education.api.submit_assessment_results - (assessment_plan, student_group) -
-No docs
-Public API
- /api/method/erpnext.education.api.update_email_group
-
- - - erpnext.education.api.update_email_group - (doctype, name) -
-No docs
-- - - erpnext.education.setup.create_academic_sessions - () -
-No docs
-- - - erpnext.education.setup.setup_education - () -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.education.utils.get_overlap_for - (doc, doctype, fieldname, value=None) -
-Returns overlaping document for specified field.
- -Parameters:
- -fieldname - Checks Overlap for this field - - - erpnext.education.utils.validate_duplicate_student - (students) -
-No docs
-- - - erpnext.education.utils.validate_overlap_for - (doc, doctype, fieldname, value=None) -
-Checks overlap for specified field.
- -Parameters:
- -fieldname - Checks Overlap for this field - - - erpnext.education.web_form.student_applicant.student_applicant.get_context - (context) -
-No docs
-- - - erpnext.allow_regional - (fn) -
-Decorator to make a function regionally overridable
- -Example:
-@erpnext.allow_regional
-def myfunction():
- pass
-
-- - - erpnext.encode_company_abbr - (name, company) -
-Returns name encoded with company abbreviation
-- - - erpnext.get_company_currency - (company) -
-Returns the default company currency
-- - - erpnext.get_default_company - (user=None) -
-Get default company for user
-- - - erpnext.get_default_cost_center - (company) -
-Returns the default cost center of the company
-- - - erpnext.get_default_currency - () -
-Returns the currency of the default company
-- - - erpnext.get_default_finance_book - (company=None) -
-No docs
-- - - erpnext.get_last_membership - () -
-Returns last membership if exists
-- - - erpnext.get_party_account_type - (party_type) -
-No docs
-- - - erpnext.get_region - (company=None) -
-Return the default country based on flag, company or global settings
- -You can also set global company flag in `frappe.flags.company`
-
-- - - erpnext.is_member - () -
-Returns true if the user is still a member
-- - - erpnext.is_perpetual_inventory_enabled - (company) -
-No docs
-- - - erpnext.set_perpetual_inventory - (enable=1, company=None) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.data_migration.doctype.data_migration_connector.connectors.base.BaseConnection - -
- - - __init__ - (self, connector) -
-No docs
-- - - delete - (self, doctype, migration_id) -
-No docs
-- - - get - (self, remote_objectname, fields=None, filters=None, start=0, page_length=10) -
-No docs
-- - - get_issues - (self, repo, start=0, page_length=10) -
-No docs
-- - - get_milestones - (self, repo, start=0, page_length=10) -
-No docs
-- - - insert - (self, doctype, doc) -
-No docs
-- - - update - (self, doctype, doc, migration_id) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.create_delivery_note - (shopify_order, shopify_settings, so) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.create_order - (order, shopify_settings, company=None) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.create_sales_invoice - (shopify_order, shopify_settings, so) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.create_sales_order - (shopify_order, shopify_settings, company=None) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.get_discounted_amount - (order) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.get_fulfillment_items - (dn_items, fulfillment_items, shopify_settings) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.get_item_code - (shopify_item) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.get_order_items - (order_items, shopify_settings) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.get_order_taxes - (shopify_order, shopify_settings) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.get_sales_order - (shopify_order_id) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.get_tax_account_head - (tax) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.make_payament_entry_against_sales_invoice - (doc, shopify_settings) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.prepare_delivery_note - (order, request_id=None) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.prepare_sales_invoice - (order, request_id=None) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.set_cost_center - (items, cost_center) -
-No docs
-Public API
- /api/method/erpnext.erpnext_integrations.connectors.shopify_connection.store_request_data
-
- - - erpnext.erpnext_integrations.connectors.shopify_connection.store_request_data - (order=None, event=None) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.sync_sales_order - (order, request_id=None) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.update_taxes_with_shipping_lines - (taxes, shipping_lines, shopify_settings) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.validate_customer - (order, shopify_settings) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.shopify_connection.validate_item - (order, shopify_settings) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.woocommerce_connection.add_tax_details - (sales_order, price, desc, status) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.woocommerce_connection.link_customer_and_address - (raw_billing_data, customer_status) -
-No docs
-- - - erpnext.erpnext_integrations.connectors.woocommerce_connection.link_item - (item_data, item_status) -
-No docs
-Public API
- /api/method/erpnext.erpnext_integrations.connectors.woocommerce_connection.order
-
- - - erpnext.erpnext_integrations.connectors.woocommerce_connection.order - () -
-No docs
-- - - erpnext.erpnext_integrations.connectors.woocommerce_connection.verify_request - () -
-No docs
-- - - erpnext.erpnext_integrations.data_migration_mapping.issue_to_task.pre_process - (issue) -
-No docs
-- - - erpnext.erpnext_integrations.data_migration_mapping.milestone_to_project.pre_process - (milestone) -
-No docs
-- - - erpnext.erpnext_integrations.utils.get_webhook_address - (connector_name, method, exclude_uri=False) -
-No docs
-- - - erpnext.erpnext_integrations.utils.validate_webhooks_request - (doctype, hmac_key, secret_key=secret) -
-No docs
-- - - erpnext.healthcare.setup.add_healthcare_service_unit_tree_root - () -
-No docs
-- - - erpnext.healthcare.setup.create_antibiotics - () -
-No docs
-- - - erpnext.healthcare.setup.create_dosage - () -
-No docs
-- - - erpnext.healthcare.setup.create_duration - () -
-No docs
-- - - erpnext.healthcare.setup.create_healthcare_item_groups - () -
-No docs
-- - - erpnext.healthcare.setup.create_lab_test_items - () -
-No docs
-- - - erpnext.healthcare.setup.create_lab_test_template - () -
-No docs
-- - - erpnext.healthcare.setup.create_medical_departments - () -
-No docs
-- - - erpnext.healthcare.setup.create_sensitivity - () -
-No docs
-- - - erpnext.healthcare.setup.create_test_uom - () -
-No docs
-- - - erpnext.healthcare.setup.setup_healthcare - () -
-No docs
-- - - erpnext.healthcare.web_form.lab_test.lab_test.get_context - (context) -
-No docs
-- - - erpnext.healthcare.web_form.lab_test.lab_test.get_lab_test_list - (doctype, txt, filters, limit_start, limit_page_length=20, order_by=modified desc) -
-No docs
-- - - erpnext.healthcare.web_form.lab_test.lab_test.get_list_context - (context) -
-No docs
-- - - erpnext.healthcare.web_form.lab_test.lab_test.get_patient - () -
-No docs
-- - - erpnext.healthcare.web_form.lab_test.lab_test.has_website_permission - (doc, ptype, user, verbose=False) -
-No docs
-- - - erpnext.healthcare.web_form.patient_appointments.patient_appointments.get_appointment_list - (doctype, txt, filters, limit_start, limit_page_length=20, order_by=modified desc) -
-No docs
-- - - erpnext.healthcare.web_form.patient_appointments.patient_appointments.get_context - (context) -
-No docs
-- - - erpnext.healthcare.web_form.patient_appointments.patient_appointments.get_list_context - (context) -
-No docs
-- - - erpnext.healthcare.web_form.patient_appointments.patient_appointments.get_patient - () -
-No docs
-- - - erpnext.healthcare.web_form.patient_appointments.patient_appointments.has_website_permission - (doc, ptype, user, verbose=False) -
-No docs
-- - - erpnext.healthcare.web_form.prescription.prescription.get_consultation_list - (doctype, txt, filters, limit_start, limit_page_length=20, order_by=modified desc) -
-No docs
-- - - erpnext.healthcare.web_form.prescription.prescription.get_context - (context) -
-No docs
-- - - erpnext.healthcare.web_form.prescription.prescription.get_list_context - (context) -
-No docs
-- - - erpnext.healthcare.web_form.prescription.prescription.get_patient - () -
-No docs
-- - - erpnext.healthcare.web_form.prescription.prescription.has_website_permission - (doc, ptype, user, verbose=False) -
-No docs
-- - - erpnext.hr.email_alert.retention_bonus.retention_bonus.get_context - (context) -
-No docs
-- - - erpnext.hr.email_alert.training_feedback.training_feedback.get_context - (context) -
-No docs
-- - - erpnext.hr.email_alert.training_scheduled.training_scheduled.get_context - (context) -
-No docs
-Inherits from frappe.model.document.Document - -
Create the project and the task for the boarding process
- Assign to the concerned person and roles as per the onboarding/separation template
-
-- - - assign_task_to_users - (self, task, users) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.hr.utils.allocate_earned_leaves - () -
-Allocate earned leaves to Employees
-- - - erpnext.hr.utils.calculate_eligible_hra_exemption - (company, employee, monthly_house_rent, rented_in_metro_city) -
-No docs
-- - - erpnext.hr.utils.calculate_hra_exemption - (salary_structure, base, monthly_hra, monthly_house_rent, rented_in_metro_city) -
-No docs
-- - - erpnext.hr.utils.check_frequency_hit - (from_date, to_date, frequency) -
-Return True if current date matches frequency
-- - - erpnext.hr.utils.get_annual_component_pay - (frequency, amount) -
-No docs
-- - - erpnext.hr.utils.get_doc_condition - (doctype) -
-No docs
-Public API
- /api/method/erpnext.hr.utils.get_employee_field_property
-
- - - erpnext.hr.utils.get_employee_field_property - (employee, fieldname) -
-No docs
-Public API
- /api/method/erpnext.hr.utils.get_employee_fields_label
-
- - - erpnext.hr.utils.get_employee_fields_label - () -
-No docs
-- - - erpnext.hr.utils.get_employee_leave_policy - (employee) -
-No docs
-- - - erpnext.hr.utils.get_holidays_for_employee - (employee, start_date, end_date) -
-No docs
-- - - erpnext.hr.utils.get_hra_from_salary_slip - (employee, salary_structure, hra_component) -
-No docs
-- - - erpnext.hr.utils.get_leave_period - (from_date, to_date, company) -
-No docs
-Public API
- /api/method/erpnext.hr.utils.get_onboarding_details
-
- - - erpnext.hr.utils.get_onboarding_details - (parent, parenttype) -
-No docs
-- - - erpnext.hr.utils.get_payroll_period - (from_date, to_date, company) -
-No docs
-- - - erpnext.hr.utils.get_sal_slip_total_benefit_given - (employee, payroll_period, component=False) -
-No docs
-- - - erpnext.hr.utils.get_salary_assignment - (employee, date) -
-No docs
-- - - erpnext.hr.utils.set_employee_name - (doc) -
-No docs
-- - - erpnext.hr.utils.throw_overlap_error - (doc, exists_for, overlap_doc, from_date, to_date) -
-No docs
-- - - erpnext.hr.utils.update_employee - (employee, details, date=None, cancel=False) -
-No docs
-- - - erpnext.hr.utils.validate_dates - (doc, from_date, to_date) -
-No docs
-- - - erpnext.hr.utils.validate_overlap - (doc, from_date, to_date, company=None) -
-No docs
-- - - erpnext.hr.utils.validate_tax_declaration - (declarations) -
-No docs
-- - - erpnext.hr.web_form.job_application.job_application.get_context - (context) -
-No docs
-- - - erpnext.hub_node.data_migration_mapping.hub_message_to_lead.post_process - (remote_doc=None, local_doc=None) -
-No docs
-- - - erpnext.hub_node.data_migration_mapping.hub_message_to_lead.pre_process - (doc) -
-No docs
-Public API
- /api/method/erpnext.hub_node.enable_hub
-
- - - erpnext.hub_node.enable_hub - () -
-No docs
-Public API
- /api/method/erpnext.hub_node.get_categories
-
- - - erpnext.hub_node.get_categories - (parent=All Categories) -
-No docs
-- - - erpnext.hub_node.get_client_connection - () -
-No docs
-Public API
- /api/method/erpnext.hub_node.get_details
-
- - - erpnext.hub_node.get_details - (hub_sync_id=None, doctype=Hub Item) -
-No docs
-- - - erpnext.hub_node.get_hub_connection - () -
-No docs
-Public API
- /api/method/erpnext.hub_node.get_item_favourites
-
- - - erpnext.hub_node.get_item_favourites - (start=0, limit=20, fields=[u'*'], order_by=None) -
-No docs
-Public API
- /api/method/erpnext.hub_node.get_list
-
- - - erpnext.hub_node.get_list - (doctype, start=0, limit=20, fields=[u'*'], filters={}, order_by=None) -
-No docs
-Public API
- /api/method/erpnext.hub_node.get_meta
-
- - - erpnext.hub_node.get_meta - (doctype) -
-No docs
-- - - erpnext.hub_node.make_contact - (supplier) -
-No docs
-- - - erpnext.hub_node.make_item - (item) -
-No docs
-- - - erpnext.hub_node.make_opportunity - (buyer_name, email_id) -
-No docs
-- - - erpnext.hub_node.make_rfq - (item, supplier, contact) -
-No docs
-Public API
- /api/method/erpnext.hub_node.make_rfq_and_send_opportunity
-
- - - erpnext.hub_node.make_rfq_and_send_opportunity - (item, supplier) -
-No docs
-- - - erpnext.hub_node.make_supplier - (supplier) -
-No docs
-- - - erpnext.hub_node.send_opportunity - (contact) -
-No docs
-Public API
- /api/method/erpnext.hub_node.send_review
-
- - - erpnext.hub_node.send_review - (hub_item_code, review) -
-No docs
-Public API
- /api/method/erpnext.hub_node.update_category
-
- - - erpnext.hub_node.update_category - (hub_item_code, category) -
-No docs
-Public API
- /api/method/erpnext.hub_node.update_wishlist_item
-
- - - erpnext.hub_node.update_wishlist_item - (item_name, remove=0) -
-No docs
-- - - erpnext.non_profit.web_form.grant_application.grant_application.get_context - (context) -
-No docs
-- - - erpnext.portal.utils.set_default_role - (doc, method) -
-Set customer, supplier, student, guardian based on email
-Public API
- /api/method/erpnext.projects.utils.query_task
-
- - - erpnext.projects.utils.query_task - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.projects.web_form.tasks.tasks.get_context - (context) -
-No docs
-- - - erpnext.regional.check_deletion_permission - (doc, method) -
-No docs
-- - - erpnext.regional.france.setup.add_custom_roles_for_reports - () -
-No docs
-- - - erpnext.regional.france.setup.make_custom_fields - () -
-No docs
-- - - erpnext.regional.france.setup.setup - (company=None, patch=True) -
-No docs
-- - - erpnext.regional.france.utils.create_transaction_log - (doc, method) -
-No docs
-- - - erpnext.regional.france.utils.test_method - () -
-test function
-- - - erpnext.regional.india.setup.add_custom_roles_for_reports - () -
-No docs
-- - - erpnext.regional.india.setup.add_hsn_sac_codes - () -
-No docs
-- - - erpnext.regional.india.setup.add_permissions - () -
-No docs
-- - - erpnext.regional.india.setup.add_print_formats - () -
-No docs
-- - - erpnext.regional.india.setup.create_hsn_codes - (data, code_field) -
-No docs
-- - - erpnext.regional.india.setup.make_custom_fields - () -
-No docs
-- - - erpnext.regional.india.setup.make_fixtures - (company=None) -
-No docs
-- - - erpnext.regional.india.setup.set_salary_components - (docs) -
-No docs
-- - - erpnext.regional.india.setup.set_tax_withholding_category - (docs, company) -
-No docs
-- - - erpnext.regional.india.setup.set_tds_account - (docs, company) -
-No docs
-- - - erpnext.regional.india.setup.setup - (company=None, patch=True) -
-No docs
-- - - erpnext.regional.india.setup.update_address_template - () -
-No docs
-- - - erpnext.regional.india.utils.get_itemised_tax_breakup_data - (doc) -
-No docs
-- - - erpnext.regional.india.utils.get_itemised_tax_breakup_header - (item_doctype, tax_accounts) -
-No docs
-- - - erpnext.regional.india.utils.get_place_of_supply - (out, doctype) -
-No docs
-- - - erpnext.regional.india.utils.get_regional_address_details - (out, doctype, company) -
-No docs
-- - - erpnext.regional.india.utils.set_place_of_supply - (doc, method=None) -
-No docs
-- - - erpnext.regional.india.utils.test_method - () -
-test function
-- - - erpnext.regional.india.utils.validate_gstin_for_india - (doc, method) -
-No docs
-- - - erpnext.regional.saudi_arabia.setup.setup - (company=None, patch=True) -
-No docs
-- - - erpnext.regional.united_arab_emirates.setup.add_print_formats - () -
-No docs
-- - - erpnext.regional.united_arab_emirates.setup.make_custom_fields - () -
-No docs
-- - - erpnext.regional.united_arab_emirates.setup.setup - (company=None, patch=True) -
-No docs
-- - - erpnext.regional.united_arab_emirates.utils.update_itemised_tax_data - (doc) -
-No docs
-- - - erpnext.setup.default_success_action.get_default_success_action - () -
-No docs
-- - - erpnext.setup.default_success_action.get_first_success_message - (doctype) -
-No docs
-- - - erpnext.setup.default_success_action.get_message - (doctype) -
-No docs
-- - - erpnext.setup.install.after_install - () -
-No docs
-- - - erpnext.setup.install.check_setup_wizard_not_completed - () -
-No docs
-- - - erpnext.setup.install.create_compact_item_print_custom_field - () -
-No docs
-- - - erpnext.setup.install.create_default_cash_flow_mapper_templates - () -
-No docs
-- - - erpnext.setup.install.create_default_success_action - () -
-No docs
-- - - erpnext.setup.install.create_print_zero_amount_taxes_custom_field - () -
-No docs
-- - - erpnext.setup.install.set_single_defaults - () -
-No docs
-- - - erpnext.setup.utils.before_tests - () -
-No docs
-- - - erpnext.setup.utils.enable_all_roles_and_domains - () -
-enable all roles and domain for testing
-- - - erpnext.setup.utils.get_ancestors_of - (doctype, name) -
-Get ancestor elements of a DocType with a tree structure
-Public API
- /api/method/erpnext.setup.utils.get_exchange_rate
-
- - - erpnext.setup.utils.get_exchange_rate - (from_currency, to_currency, transaction_date=None, args=None) -
-No docs
-- - - erpnext.setup.utils.get_root_of - (doctype) -
-Get root element of a DocType with a tree structure
-- - - erpnext.setup.utils.insert_record - (records) -
-No docs
-- - - erpnext.setup.setup_wizard.data.industry_type.get_industry_types - () -
-No docs
-- - - erpnext.setup.setup_wizard.setup_wizard.fin - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.setup_wizard.get_setup_stages - (args=None) -
-No docs
-- - - erpnext.setup.setup_wizard.setup_wizard.login_as_first_user - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.setup_wizard.make_sample_data - (domains) -
-No docs
-- - - erpnext.setup.setup_wizard.setup_wizard.setup_company - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.setup_wizard.setup_complete - (args=None) -
-No docs
-- - - erpnext.setup.setup_wizard.setup_wizard.setup_post_company_fixtures - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.setup_wizard.setup_taxes - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.setup_wizard.stage_fixtures - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.setup_wizard.stage_four - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.setup_wizard.stage_three - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.test_setup_wizard.run_setup_wizard_test - () -
-No docs
-- - - erpnext.setup.setup_wizard.utils.complete - () -
-No docs
-- - - erpnext.setup.setup_wizard.operations.company_setup.create_bank_account - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.company_setup.create_email_digest - () -
-No docs
-- - - erpnext.setup.setup_wizard.operations.company_setup.create_fiscal_year_and_company - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.company_setup.create_logo - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.company_setup.create_website - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.company_setup.enable_shopping_cart - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.company_setup.get_fy_details - (fy_start_date, fy_end_date) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.default_website.test - () -
-No docs
-Inherits from __builtin__.object - -
- - - __init__ - (self, args) -
-No docs
-- - - make_blog - (self) -
-No docs
-- - - make_web_page - (self) -
-No docs
-- - - make_website_settings - (self) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.defaults_setup.create_employee_for_self - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.defaults_setup.create_feed_and_todo - () -
-update Activity feed and create todo for creation of item, customer, vendor
-- - - erpnext.setup.setup_wizard.operations.defaults_setup.create_price_lists - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.defaults_setup.create_territories - () -
-create two default territories, one for home country and one named Rest of the World
-- - - erpnext.setup.setup_wizard.operations.defaults_setup.get_fy_details - (fy_start_date, fy_end_date) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.defaults_setup.set_default_settings - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.defaults_setup.set_no_copy_fields_in_variant_settings - () -
-No docs
-- - - erpnext.setup.setup_wizard.operations.install_fixtures.add_uom_data - () -
-No docs
-- - - erpnext.setup.setup_wizard.operations.install_fixtures.install - (country=None) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.install_fixtures.install_post_company_fixtures - (company=None) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.install_fixtures.make_fixture_records - (records) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.sample_data.import_email_alert - () -
-Import email alert for task start
-- - - erpnext.setup.setup_wizard.operations.sample_data.make_issue - () -
-No docs
-- - - erpnext.setup.setup_wizard.operations.sample_data.make_material_request - (items) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.sample_data.make_opportunity - (items, customer) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.sample_data.make_projects - (domains) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.sample_data.make_quote - (items, customer) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.sample_data.make_sample_data - (domains, make_dependent=False) -
-Create a few opportunities, quotes, material requests, issues, todos, projects - to help the user get started
-- - - erpnext.setup.setup_wizard.operations.sample_data.test_sample - () -
-No docs
-- - - erpnext.setup.setup_wizard.operations.taxes_setup.create_sales_tax - (args) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.taxes_setup.get_country_wise_tax - (country) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.taxes_setup.get_tax_account_group - (company) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.taxes_setup.make_sales_and_purchase_tax_templates - (accounts, template_name=None) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.taxes_setup.make_tax_account - (company, account_name, tax_rate) -
-No docs
-- - - erpnext.setup.setup_wizard.operations.taxes_setup.make_tax_account_and_template - (company, account_name, tax_rate, template_name=None) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.shopping_cart.cart._apply_shipping_rule - (party=None, quotation=None, cart_settings=None) -
-No docs
-- - - erpnext.shopping_cart.cart._get_cart_quotation - (party=None) -
-Return the open Quotation of type "Shopping Cart" or make a new one
-- - - erpnext.shopping_cart.cart._set_price_list - (quotation, cart_settings) -
-Set price list based on customer or shopping cart default
-- - - erpnext.shopping_cart.cart.apply_cart_settings - (party=None, quotation=None) -
-No docs
-Public API
- /api/method/erpnext.shopping_cart.cart.apply_shipping_rule
-
- - - erpnext.shopping_cart.cart.apply_shipping_rule - (shipping_rule) -
-No docs
-- - - erpnext.shopping_cart.cart.decorate_quotation_doc - (doc) -
-No docs
-- - - erpnext.shopping_cart.cart.get_address_docs - (doctype=None, txt=None, filters=None, limit_start=0, limit_page_length=20, party=None) -
-No docs
-- - - erpnext.shopping_cart.cart.get_address_territory - (address_name) -
-Tries to match city, state and country of address to existing territory
-- - - erpnext.shopping_cart.cart.get_applicable_shipping_rules - (party=None, quotation=None) -
-No docs
-Public API
- /api/method/erpnext.shopping_cart.cart.get_cart_quotation
-
- - - erpnext.shopping_cart.cart.get_cart_quotation - (doc=None) -
-No docs
-- - - erpnext.shopping_cart.cart.get_debtors_account - (cart_settings) -
-No docs
-- - - erpnext.shopping_cart.cart.get_party - (user=None) -
-No docs
-- - - erpnext.shopping_cart.cart.get_shipping_rules - (quotation=None, cart_settings=None) -
-No docs
-Public API
- /api/method/erpnext.shopping_cart.cart.get_shopping_cart_menu
-
- - - erpnext.shopping_cart.cart.get_shopping_cart_menu - (context=None) -
-No docs
-- - - erpnext.shopping_cart.cart.guess_territory - () -
-No docs
-Public API
- /api/method/erpnext.shopping_cart.cart.place_order
-
- - - erpnext.shopping_cart.cart.place_order - () -
-No docs
-- - - erpnext.shopping_cart.cart.set_cart_count - (quotation=None) -
-No docs
-- - - erpnext.shopping_cart.cart.set_price_list_and_rate - (quotation, cart_settings) -
-set price list based on billing territory
-- - - erpnext.shopping_cart.cart.set_taxes - (quotation, cart_settings) -
-set taxes based on billing territory
-- - - erpnext.shopping_cart.cart.show_terms - (doc) -
-No docs
-Public API
- /api/method/erpnext.shopping_cart.cart.update_cart
-
- - - erpnext.shopping_cart.cart.update_cart - (item_code, qty, with_items=False) -
-No docs
-Public API
- /api/method/erpnext.shopping_cart.cart.update_cart_address
-
- - - erpnext.shopping_cart.cart.update_cart_address - (address_fieldname, address_name) -
-No docs
-- - - erpnext.shopping_cart.cart.update_party - (fullname, company_name=None, mobile_no=None, phone=None) -
-No docs
-Public API
- /api/method/erpnext.shopping_cart.product_info.get_product_info_for_website
-
- - - erpnext.shopping_cart.product_info.get_product_info_for_website - (item_code) -
-get product price / stock info for website
-- - - erpnext.shopping_cart.product_info.set_product_info_for_website - (item) -
-set product price uom for website
-Inherits from unittest.case.TestCase - -
Note:
- Shopping Cart == Quotation
-
-- - - create_quotation - (self) -
-No docs
-- - - create_user_if_not_exists - (self, email, first_name=None) -
-No docs
-- - - disable_shopping_cart - (self) -
-No docs
-- - - enable_shopping_cart - (self) -
-No docs
-- - - login_as_customer - (self) -
-No docs
-- - - login_as_new_user - (self) -
-No docs
-- - - remove_all_items_from_cart - (self) -
-No docs
-- - - remove_test_quotation - (self, quotation) -
-No docs
-- - - setUp - (self) -
-No docs
-- - - tearDown - (self) -
-No docs
-- - - test_add_to_cart - (self) -
-No docs
-- - - test_get_cart_customer - (self) -
-No docs
-- - - test_get_cart_new_user - (self) -
-No docs
-- - - test_remove_from_cart - (self) -
-No docs
-- - - test_tax_rule - (self) -
-No docs
-- - - test_update_cart - (self) -
-No docs
-- - - erpnext.shopping_cart.utils.check_customer_or_supplier - () -
-No docs
-- - - erpnext.shopping_cart.utils.clear_cart_count - (login_manager) -
-No docs
-- - - erpnext.shopping_cart.utils.set_cart_count - (login_manager) -
-No docs
-- - - erpnext.shopping_cart.utils.show_cart_count - () -
-No docs
-- - - erpnext.shopping_cart.utils.update_website_context - (context) -
-No docs
-- - - erpnext.startup.boot.boot_session - (bootinfo) -
-boot session - send website info if guest
-- - - erpnext.startup.boot.load_country_and_currency - (bootinfo) -
-No docs
-- - - erpnext.startup.boot.update_page_info - (bootinfo) -
-No docs
-- - - erpnext.startup.notifications.get_notification_config - () -
-No docs
-Public API
- /api/method/erpnext.stock.dashboard.item_dashboard.get_data
-
- - - erpnext.stock.dashboard.item_dashboard.get_data - (item_code=None, warehouse=None, item_group=None, start=0, sort_by=actual_qty, sort_order=desc) -
-Return data to render the item dashboard
-Public API
- /api/method/erpnext.stock.get_item_details.apply_price_list
-
- - - erpnext.stock.get_item_details.apply_price_list - (args, as_doc=False) -
-Apply pricelist on a document-like dict object and return as - {'parent': dict, 'children': list}
- -Parameters:
- -args - See belowas_doc - Updates value in the passed dict
args = {
- "doctype": "",
- "name": "",
- "items": [{"doctype": "", "name": "", "item_code": "", "brand": "", "item_group": ""}, ...],
- "conversion_rate": 1.0,
- "selling_price_list": None,
- "price_list_currency": None,
- "price_list_uom_dependant": None,
- "plc_conversion_rate": 1.0,
- "doctype": "",
- "name": "",
- "supplier": None,
- "transaction_date": None,
- "conversion_rate": 1.0,
- "buying_price_list": None,
- "ignore_pricing_rule": 0/1
-}
-- - - erpnext.stock.get_item_details.apply_price_list_on_item - (args) -
-No docs
-- - - erpnext.stock.get_item_details.get_basic_details - (args, item) -
-Parameters:
- -args - {
"item_code": "",
- "warehouse": None,
- "customer": "",
- "conversion_rate": 1.0,
- "selling_price_list": None,
- "price_list_currency": None,
- "price_list_uom_dependant": None,
- "plc_conversion_rate": 1.0,
- "doctype": "",
- "name": "",
- "supplier": None,
- "transaction_date": None,
- "conversion_rate": 1.0,
- "buying_price_list": None,
- "is_subcontracted": "Yes" / "No",
- "ignore_pricing_rule": 0/1
- "project": "",
- barcode: "",
- serial_no: "",
- warehouse: "",
- currency: "",
- update_stock: "",
- price_list: "",
- company: "",
- order_type: "",
- is_pos: "",
- ignore_pricing_rule: "",
- project: "",
- qty: "",
- stock_qty: "",
- conversion_factor: ""
-}
-Parameters:
- -item - item_code of Item object
:return: frappe._dict
Public API
- /api/method/erpnext.stock.get_item_details.get_batch_qty
-
- - - erpnext.stock.get_item_details.get_batch_qty - (batch_no, warehouse, item_code) -
-No docs
-Public API
- /api/method/erpnext.stock.get_item_details.get_batch_qty_and_serial_no
-
- - - erpnext.stock.get_item_details.get_batch_qty_and_serial_no - (batch_no, stock_qty, warehouse, item_code, has_serial_no) -
-No docs
-Public API
- /api/method/erpnext.stock.get_item_details.get_bin_details
-
- - - erpnext.stock.get_item_details.get_bin_details - (item_code, warehouse) -
-No docs
-Public API
- /api/method/erpnext.stock.get_item_details.get_bin_details_and_serial_nos
-
- - - erpnext.stock.get_item_details.get_bin_details_and_serial_nos - (item_code, warehouse, has_batch_no, stock_qty=None, serial_no=None) -
-No docs
-Public API
- /api/method/erpnext.stock.get_item_details.get_conversion_factor
-
- - - erpnext.stock.get_item_details.get_conversion_factor - (item_code, uom) -
-No docs
-Public API
- /api/method/erpnext.stock.get_item_details.get_default_bom
-
- - - erpnext.stock.get_item_details.get_default_bom - (item_code=None) -
-No docs
-- - - erpnext.stock.get_item_details.get_default_cost_center - (args, item) -
-No docs
-- - - erpnext.stock.get_item_details.get_default_deferred_revenue_account - (args, item) -
-No docs
-- - - erpnext.stock.get_item_details.get_default_expense_account - (args, item) -
-No docs
-- - - erpnext.stock.get_item_details.get_default_income_account - (args, item) -
-No docs
-- - - erpnext.stock.get_item_details.get_gross_profit - (out) -
-No docs
-Public API
- /api/method/erpnext.stock.get_item_details.get_item_code
-
- - - erpnext.stock.get_item_details.get_item_code - (barcode=None, serial_no=None) -
-No docs
-Public API
- /api/method/erpnext.stock.get_item_details.get_item_details
-
- - - erpnext.stock.get_item_details.get_item_details - (args) -
- args = {
- "item_code": "",
- "warehouse": None,
- "customer": "",
- "conversion_rate": 1.0,
- "selling_price_list": None,
- "price_list_currency": None,
- "plc_conversion_rate": 1.0,
- "doctype": "",
- "name": "",
- "supplier": None,
- "transaction_date": None,
- "conversion_rate": 1.0,
- "buying_price_list": None,
- "is_subcontracted": "Yes" / "No",
- "ignore_pricing_rule": 0/1
- "project": ""
- }
-
-- - - erpnext.stock.get_item_details.get_party_item_code - (args, item_doc, out) -
-No docs
-Public API
- /api/method/erpnext.stock.get_item_details.get_pos_profile
-
- - - erpnext.stock.get_item_details.get_pos_profile - (company, pos_profile=None, user=None) -
-No docs
-- - - erpnext.stock.get_item_details.get_pos_profile_item_details - (company, args, pos_profile=None, update_data=False) -
-No docs
-- - - erpnext.stock.get_item_details.get_price_list_currency - (price_list) -
-No docs
-- - - erpnext.stock.get_item_details.get_price_list_currency_and_exchange_rate - (args) -
-No docs
-- - - erpnext.stock.get_item_details.get_price_list_rate - (args, item_doc, out) -
-No docs
-- - - erpnext.stock.get_item_details.get_price_list_rate_for - (price_list, item_code) -
-No docs
-- - - erpnext.stock.get_item_details.get_price_list_uom_dependant - (price_list) -
-No docs
-Public API
- /api/method/erpnext.stock.get_item_details.get_projected_qty
-
- - - erpnext.stock.get_item_details.get_projected_qty - (item_code, warehouse) -
-No docs
-Public API
- /api/method/erpnext.stock.get_item_details.get_serial_no
-
- - - erpnext.stock.get_item_details.get_serial_no - (args, serial_nos=None) -
-No docs
-- - - erpnext.stock.get_item_details.get_serial_no_batchwise - (args) -
-No docs
-Public API
- /api/method/erpnext.stock.get_item_details.get_serial_no_details
-
- - - erpnext.stock.get_item_details.get_serial_no_details - (item_code, warehouse, stock_qty, serial_no) -
-No docs
-- - - erpnext.stock.get_item_details.get_serial_nos_by_fifo - (args) -
-No docs
-- - - erpnext.stock.get_item_details.get_valuation_rate - (item_code, company, warehouse=None) -
-No docs
-- - - erpnext.stock.get_item_details.insert_item_price - (args) -
-Insert Item Price if Price List and Price List Rate are specified and currency is the same
-- - - erpnext.stock.get_item_details.process_args - (args) -
-No docs
-- - - erpnext.stock.get_item_details.validate_conversion_rate - (args, meta) -
-No docs
-- - - erpnext.stock.get_item_details.validate_item_details - (args, item) -
-No docs
-- - - erpnext.stock.get_item_details.validate_price_list - (args) -
-No docs
-- - - erpnext.stock.get_company_default_inventory_account - (company) -
-No docs
-- - - erpnext.stock.get_warehouse_account - (warehouse, warehouse_account=None) -
-No docs
-- - - erpnext.stock.get_warehouse_account_map - () -
-No docs
-- - - erpnext.stock.reorder_item._reorder_item - () -
-No docs
-- - - erpnext.stock.reorder_item.create_material_request - (material_requests) -
-Create indent on reaching reorder level
-
-- - - erpnext.stock.reorder_item.get_item_warehouse_projected_qty - (items_to_consider) -
-No docs
-- - - erpnext.stock.reorder_item.notify_errors - (exceptions_list) -
-No docs
-- - - erpnext.stock.reorder_item.reorder_item - () -
-Reorder item if stock reaches reorder level
-- - - erpnext.stock.reorder_item.send_email_notification - (mr_list) -
-Notify user about auto creation of indent
-- - - erpnext.stock.stock_balance.get_balance_qty_from_sle - (item_code, warehouse) -
-No docs
-- - - erpnext.stock.stock_balance.get_indented_qty - (item_code, warehouse) -
-No docs
-- - - erpnext.stock.stock_balance.get_ordered_qty - (item_code, warehouse) -
-No docs
-- - - erpnext.stock.stock_balance.get_planned_qty - (item_code, warehouse) -
-No docs
-- - - erpnext.stock.stock_balance.get_reserved_qty - (item_code, warehouse) -
-No docs
-- - - erpnext.stock.stock_balance.repost - (only_actual=False, allow_negative_stock=False, allow_zero_rate=False, only_bin=False) -
-Repost everything!
-
-- - - erpnext.stock.stock_balance.repost_actual_qty - (item_code, warehouse, allow_zero_rate=False) -
-No docs
-- - - erpnext.stock.stock_balance.repost_all_stock_vouchers - () -
-No docs
-- - - erpnext.stock.stock_balance.repost_stock - (item_code, warehouse, allow_zero_rate=False, only_actual=False, only_bin=False) -
-No docs
-- - - erpnext.stock.stock_balance.reset_serial_no_status_and_warehouse - (serial_nos=None) -
-No docs
-- - - erpnext.stock.stock_balance.set_stock_balance_as_per_serial_no - (item_code=None, posting_date=None, posting_time=None, fiscal_year=None) -
-No docs
-- - - erpnext.stock.stock_balance.update_bin_qty - (item_code, warehouse, qty_dict=None) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.stock.stock_ledger.delete_cancelled_entry - (voucher_type, voucher_no) -
-No docs
-- - - erpnext.stock.stock_ledger.get_previous_sle - (args, for_update=False) -
- get the last sle on or before the current time-bucket,
- to get actual qty before transaction, this function
- is called from various transaction like stock entry, reco etc
-
- args = {
- "item_code": "ABC",
- "warehouse": "XYZ",
- "posting_date": "2012-12-12",
- "posting_time": "12:00",
- "sle": "name of reference Stock Ledger Entry"
- }
-
-- - - erpnext.stock.stock_ledger.get_stock_ledger_entries - (previous_sle, operator=None, order=desc, limit=None, for_update=False, debug=False) -
-get stock ledger entries filtered by specific posting datetime conditions
-- - - erpnext.stock.stock_ledger.get_valuation_rate - (item_code, warehouse, voucher_type, voucher_no, allow_zero_rate=False, currency=None, company=None, raise_error_if_no_rate=True) -
-No docs
-- - - erpnext.stock.stock_ledger.make_entry - (args, allow_negative_stock=False, via_landed_cost_voucher=False) -
-No docs
-- - - erpnext.stock.stock_ledger.make_sl_entries - (sl_entries, is_amended=None, allow_negative_stock=False, via_landed_cost_voucher=False) -
-No docs
-- - - erpnext.stock.stock_ledger.set_as_cancel - (voucher_type, voucher_no) -
-No docs
-Inherits from __builtin__.object - -
update valution rate and qty after transaction
- from the current time-bucket onwards
-
-
-Parameters:
- -args - args as dict
args = {
- "item_code": "ABC",
- "warehouse": "XYZ",
- "posting_date": "2012-12-12",
- "posting_time": "12:00"
- }
-- - - __init__ - (self, args, allow_zero_rate=False, allow_negative_stock=None, via_landed_cost_voucher=False, verbose=1) -
-No docs
-- - - build - (self) -
-No docs
-- - - check_if_allow_zero_valuation_rate - (self, voucher_type, voucher_detail_no) -
-No docs
-- - - get_fifo_values - (self, sle) -
-No docs
-- - - get_moving_average_values - (self, sle) -
-No docs
-- - - get_serialized_values - (self, sle) -
-No docs
-- - - get_sle_after_datetime - (self) -
-get Stock Ledger Entries after a particular datetime, for reposting
-- - - get_sle_before_datetime - (self) -
-get previous stock ledger entry before current time-bucket
-- - - process_sle - (self, sle) -
-No docs
-- - - raise_exceptions - (self) -
-No docs
-- - - update_bin - (self) -
-No docs
-- - - validate_negative_stock - (self, sle) -
- validate negative stock for entries current datetime onwards
- will not consider cancelled entries
-
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.stock.utils.get_avg_purchase_rate - (serial_nos) -
-get average value of serial numbers
-- - - erpnext.stock.utils.get_bin - (item_code, warehouse) -
-No docs
-- - - erpnext.stock.utils.get_fifo_rate - (previous_stock_queue, qty) -
-get FIFO (average) Rate from Queue
-Public API
- /api/method/erpnext.stock.utils.get_incoming_rate
-
- - - erpnext.stock.utils.get_incoming_rate - (args, raise_error_if_no_rate=True) -
-Get Incoming Rate based on valuation method
-- - - erpnext.stock.utils.get_latest_stock_balance - () -
-No docs
-Public API
- /api/method/erpnext.stock.utils.get_latest_stock_qty
-
- - - erpnext.stock.utils.get_latest_stock_qty - (item_code, warehouse=None) -
-No docs
-Public API
- /api/method/erpnext.stock.utils.get_stock_balance
-
- - - erpnext.stock.utils.get_stock_balance - (item_code, warehouse, posting_date=None, posting_time=None, with_valuation_rate=False) -
-Returns stock balance quantity at given warehouse on given posting date or current date.
- -If `with_valuation_rate` is True, will return tuple (qty, rate)
-
-- - - erpnext.stock.utils.get_stock_value_on - (warehouse=None, posting_date=None, item_code=None) -
-No docs
-- - - erpnext.stock.utils.get_valid_serial_nos - (sr_nos, qty=0, item_code=) -
-split serial nos, validate and return list of valid serial nos
-- - - erpnext.stock.utils.get_valuation_method - (item_code) -
-get valuation method from item or default
-- - - erpnext.stock.utils.is_group_warehouse - (warehouse) -
-No docs
-- - - erpnext.stock.utils.update_bin - (args, allow_negative_stock=False, via_landed_cost_voucher=False) -
-No docs
-- - - erpnext.stock.utils.validate_warehouse_company - (warehouse, company) -
-No docs
-- - - erpnext.support.web_form.issues.issues.get_context - (context) -
-No docs
-- - - erpnext.utilities.activation.get_help_messages - () -
-Returns help messages to be shown on Desktop
-- - - erpnext.utilities.activation.get_level - () -
-No docs
-Inherits from frappe.utils.bot.BotParser - -
- - - erpnext.utilities.get_site_info - (site_info) -
-No docs
-- - - erpnext.utilities.update_doctypes - () -
-No docs
-- - - erpnext.utilities.product.adjust_qty_for_expired_items - (item_code, stock_qty, warehouse) -
-No docs
-- - - erpnext.utilities.product.get_expired_batches - (batches) -
-Parameters:
- -batches - A list of dict in the form [{'expirydate': datetime.date(20XX, 1, 1), 'name': 'batchid'}, ...]- - - erpnext.utilities.product.get_price - (item_code, price_list, customer_group, company, qty=1) -
-No docs
-- - - erpnext.utilities.product.get_qty_in_stock - (item_code, item_warehouse_field, warehouse=None) -
-No docs
-- - - erpnext.utilities.product.qty_from_all_warehouses - (batch_info) -
-Parameters:
- -batch_info - A list of dict in the form [{u'warehouse': u'Stores - I', u'qty': 0.8}, ...]Inherits from erpnext.controllers.status_updater.StatusUpdater - -
- - - _add_calendar_event - (self, opts) -
-No docs
-- - - add_calendar_event - (self, opts, force=False) -
-No docs
-- - - compare_values - (self, ref_doc, fields, doc=None) -
-No docs
-- - - delete_events - (self) -
-No docs
-- - - get_link_filters - (self, for_doctype) -
-No docs
-- - - validate_posting_time - (self) -
-No docs
-- - - validate_rate_with_reference_doc - (self, ref_details) -
-No docs
-- - - validate_uom_is_integer - (self, uom_field, qty_fields) -
-No docs
-- - - validate_with_previous_doc - (self, ref) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.utilities.transaction_base.delete_events - (ref_type, ref_name) -
-No docs
-- - - erpnext.utilities.transaction_base.validate_uom_is_integer - (doc, uom_field, qty_fields, child_dt=None) -
-No docs
-- - - erpnext.utilities.user_progress.get_slide_settings - () -
-No docs
-- - - erpnext.utilities.user_progress.get_user_progress_slides - () -
-No docs
-- - - erpnext.utilities.user_progress_utils.create_contact - (contact, party_type, party) -
-Create contact based on given contact name
-Public API
- /api/method/erpnext.utilities.user_progress_utils.create_course
-
- - - erpnext.utilities.user_progress_utils.create_course - (args_data) -
-No docs
-Public API
- /api/method/erpnext.utilities.user_progress_utils.create_customers
-
- - - erpnext.utilities.user_progress_utils.create_customers - (args_data) -
-No docs
-Public API
- /api/method/erpnext.utilities.user_progress_utils.create_instructor
-
- - - erpnext.utilities.user_progress_utils.create_instructor - (args_data) -
-No docs
-Public API
- /api/method/erpnext.utilities.user_progress_utils.create_items
-
- - - erpnext.utilities.user_progress_utils.create_items - (args_data) -
-No docs
-Public API
- /api/method/erpnext.utilities.user_progress_utils.create_letterhead
-
- - - erpnext.utilities.user_progress_utils.create_letterhead - (args_data) -
-No docs
-Public API
- /api/method/erpnext.utilities.user_progress_utils.create_program
-
- - - erpnext.utilities.user_progress_utils.create_program - (args_data) -
-No docs
-Public API
- /api/method/erpnext.utilities.user_progress_utils.create_room
-
- - - erpnext.utilities.user_progress_utils.create_room - (args_data) -
-No docs
-Public API
- /api/method/erpnext.utilities.user_progress_utils.create_suppliers
-
- - - erpnext.utilities.user_progress_utils.create_suppliers - (args_data) -
-No docs
-Public API
- /api/method/erpnext.utilities.user_progress_utils.create_users
-
- - - erpnext.utilities.user_progress_utils.create_users - (args_data) -
-No docs
-- - - erpnext.utilities.user_progress_utils.make_item_price - (item, price_list_name, item_price) -
-No docs
-Public API
- /api/method/erpnext.utilities.user_progress_utils.set_sales_target
-
- - - erpnext.utilities.user_progress_utils.set_sales_target - (args_data) -
-No docs
-Public API
- /api/method/erpnext.utilities.user_progress_utils.update_default_domain_actions_and_get_state
-
- - - erpnext.utilities.user_progress_utils.update_default_domain_actions_and_get_state - () -
-No docs
-- - - erpnext.utilities.web_form.addresses.addresses.get_context - (context) -
-No docs
-| - App Name - | -
- erpnext
- |
-
| - Publisher - | -
- Frappe Technologies Pvt. Ltd.
- |
-
| - Version - | -
- 10.1.37
- |
-
Table Name: tabAccount
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -properties |
- - Section Break | -- - - | -- |
| 2 | -column_break0 |
- - Column Break | -- - - | -- |
| 3 | -account_name |
- - Data | -- Account Name - - | -- |
| 4 | -account_number |
- - Data | -- Account Number - - | -- |
| 5 | -is_group |
- - Check | -- Is Group - - | -- |
| 6 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 7 | -root_type |
- - Select | -- Root Type - - | -
- -Asset -Liability -Income -Expense -Equity- |
-
| 8 | -report_type |
- - Select | -- Report Type - - | -
- -Balance Sheet -Profit and Loss- |
-
| 9 | -account_currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 10 | -inter_company_account |
- - Check | -- Inter Company Account - - | -- |
| 11 | -column_break1 |
- - Column Break | -- - - | -- |
| 12 | -parent_account |
- - Link | -- Parent Account - - | -- - - - -Account - - - - | -
| 13 | -account_type |
- - Select | -
- Account Type
- - Setting Account Type helps in selecting this Account in transactions. - |
-
- -Accumulated Depreciation -Asset Received But Not Billed -Bank -Cash -Chargeable -Capital Work in Progress -Cost of Goods Sold -Depreciation -Equity -Expense Account -Expenses Included In Asset Valuation -Expenses Included In Valuation -Fixed Asset -Income Account -Payable -Receivable -Round Off -Stock -Stock Adjustment -Stock Received But Not Billed -Tax -Temporary- |
-
| 14 | -tax_rate |
- - Float | -
- Rate
- - Rate at which this tax is applied - |
- - |
| 15 | -freeze_account |
- - Select | -
- Frozen
- - If the account is frozen, entries are allowed to restricted users. - |
-
- No -Yes- |
-
| 16 | -balance_must_be |
- - Select | -- Balance must be - - | -
- -Debit -Credit- |
-
| 17 | -lft |
- - Int | -- Lft - - | -- |
| 18 | -rgt |
- - Int | -- Rgt - - | -- |
| 19 | -old_parent |
- - Data | -- Old Parent - - | -- |
Inherits from frappe.utils.nestedset.NestedSet - -
- - - after_rename - (self, old, new, merge=False) -
-No docs
-- - - autoname - (self) -
-No docs
-- - - before_rename - (self, old, new, merge=False) -
-No docs
-- - - check_gle_exists - (self) -
-No docs
-- - - check_if_child_exists - (self) -
-No docs
-- - - convert_group_to_ledger - (self) -
-No docs
-- - - convert_ledger_to_group - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - set_root_and_report_type - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_account_currency - (self) -
-No docs
-- - - validate_balance_must_be_debit_or_credit - (self) -
-No docs
-- - - validate_frozen_accounts_modifier - (self) -
-No docs
-- - - validate_group_or_ledger - (self) -
-No docs
-- - - validate_mandatory - (self) -
-No docs
-- - - validate_parent - (self) -
-Fetch Parent Details and validate parent account
-- - - validate_root_details - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.accounts.doctype.account.account.get_account_currency - (account) -
-Helper function to get account currency
-- - - erpnext.accounts.doctype.account.account.get_name_with_number - (new_account, account_number) -
-No docs
-- - - erpnext.accounts.doctype.account.account.get_parent_account - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.accounts.doctype.account.account.on_doctype_update - () -
-No docs
-Table Name: tabAccounting Period
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -period_name |
- - Data | -- Period Name - - | -- |
| 2 | -start_date |
- - Date | -- Start Date - - | -- |
| 3 | -end_date |
- - Date | -- End Date - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 6 | -status |
- - Select | -- Status - - | -
- Open -Closed- |
-
| 7 | -section_break_7 |
- - Section Break | -- - - | -- |
| 8 | -closed_documents |
- - Table | -- Closed Documents - - | -- - - - -Closed Document - - - - | -
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - before_insert - (self) -
-No docs
-- - - bootstrap_doctypes_for_closing - (self) -
-No docs
-- - - get_doctypes_for_closing - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_overlap - (self) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -auto_accounting_for_stock |
- - Check | -
- Make Accounting Entry For Every Stock Movement
- - If enabled, the system will post accounting entries for inventory automatically. - |
- - |
| 2 | -acc_frozen_upto |
- - Date | -
- Accounts Frozen Upto
- - Accounting entry frozen up to this date, nobody can do / modify entry except role specified below. - |
- - |
| 3 | -frozen_accounts_modifier |
- - Link | -
- Role Allowed to Set Frozen Accounts & Edit Frozen Entries
- - Users with this role are allowed to set frozen accounts and create / modify accounting entries against frozen accounts - |
- - - - - -Role - - - - | -
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -credit_controller |
- - Link | -
- Credit Controller
- - Role that is allowed to submit transactions that exceed credit limits set. - |
- - - - - -Role - - - - | -
| 6 | -check_supplier_invoice_uniqueness |
- - Check | -- Check Supplier Invoice Number Uniqueness - - | -- |
| 7 | -make_payment_via_journal_entry |
- - Check | -- Make Payment via Journal Entry - - | -- |
| 8 | -unlink_payment_on_cancellation_of_invoice |
- - Check | -- Unlink Payment on Cancellation of Invoice - - | -- |
| 9 | -book_asset_depreciation_entry_automatically |
- - Check | -- Book Asset Depreciation Entry Automatically - - | -- |
| 10 | -print_settings |
- - Section Break | -- Print Settings - - | -- |
| 11 | -show_inclusive_tax_in_print |
- - Check | -- Show Inclusive Tax In Print - - | -- |
| 12 | -column_break_12 |
- - Column Break | -- - - | -- |
| 13 | -show_payment_schedule_in_print |
- - Check | -- Show Payment Schedule in Print - - | -- |
| 14 | -currency_exchange_section |
- - Section Break | -- Currency Exchange Settings - - | -- |
| 15 | -allow_stale |
- - Check | -- Allow Stale Exchange Rates - - | -- |
| 16 | -stale_days |
- - Int | -- Stale Days - - | -- |
| 17 | -report_settings_sb |
- - Section Break | -- Report Settings - - | -- |
| 18 | -use_custom_cash_flow |
- - Check | -
- Use Custom Cash Flow Format
- - Only select if you have setup Cash Flow Mapper documents - |
- - |
Inherits from frappe.model.document.Document - -
- - - enable_payment_schedule_in_print - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_stale_days - (self) -
-No docs
-Table Name: tabAllowed To Transact With
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
Table Name: tabBank
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -bank_name |
- - Data | -- Bank Name - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabBank Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -account_name |
- - Data | -- Account Name - - | -- |
| 2 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
| 3 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 4 | -bank |
- - Link | -- Bank - - | -- - - - -Bank - - - - | -
| 5 | -column_break_7 |
- - Column Break | -- - - | -- |
| 6 | -bank_account_no |
- - Data | -- Bank Account No - - | -- |
| 7 | -iban |
- - Data | -- IBAN - - | -- |
| 8 | -branch_code |
- - Data | -- Branch Code - - | -- |
| 9 | -swift_number |
- - Data | -- SWIFT number - - | -- |
| 10 | -address_and_contact |
- - Section Break | -- Address and Contact - - | -
- fa fa-map-marker- |
-
| 11 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 12 | -website |
- - Data | -- Website - - | -- |
| 13 | -column_break_12 |
- - Column Break | -- - - | -- |
| 14 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
Inherits from frappe.model.document.Document - -
- - - on_trash - (self) -
-No docs
-- - - onload - (self) -
-Load address and contacts in __onload
Table Name: tabBank Guarantee
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -bg_type |
- - Select | -- Bank Guarantee Type - - | -
- -Receiving -Providing- |
-
| 2 | -reference_doctype |
- - Link | -- Reference Document Type - - | -- - - - -DocType - - - - | -
| 3 | -reference_docname |
- - Dynamic Link | -- Reference Document Name - - | -
- reference_doctype- |
-
| 4 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 5 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 6 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 7 | -column_break_6 |
- - Column Break | -- - - | -- |
| 8 | -amount |
- - Currency | -- Amount - - | -- |
| 9 | -start_date |
- - Date | -- Start Date - - | -- |
| 10 | -validity |
- - Int | -- Validity in Days - - | -- |
| 11 | -end_date |
- - Date | -- End Date - - | -- |
| 12 | -bank_account_info |
- - Section Break | -- Bank Account Info - - | -- |
| 13 | -bank |
- - Link | -- Bank - - | -- - - - -Bank - - - - | -
| 14 | -bank_account |
- - Link | -- Bank Account - - | -- - - - -Bank Account - - - - | -
| 15 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
| 16 | -bank_account_no |
- - Data | -- Bank Account No - - | -- |
| 17 | -column_break_17 |
- - Column Break | -- - - | -- |
| 18 | -iban |
- - Data | -- IBAN - - | -- |
| 19 | -branch_code |
- - Data | -- Branch Code - - | -- |
| 20 | -swift_number |
- - Data | -- SWIFT number - - | -- |
| 21 | -section_break_14 |
- - Section Break | -- - - | -- |
| 22 | -more_information |
- - Text Editor | -- Clauses and Conditions - - | -- |
| 23 | -margin_details |
- - Section Break | -- Other Details - - | -- |
| 24 | -bank_guarantee_number |
- - Data | -- Bank Guarantee Number - - | -- |
| 25 | -name_of_beneficiary |
- - Data | -- Name of Beneficiary - - | -- |
| 26 | -column_break_19 |
- - Column Break | -- - - | -- |
| 27 | -margin_money |
- - Currency | -- Margin Money - - | -- |
| 28 | -charges |
- - Currency | -- Charges Incurred - - | -- |
| 29 | -fixed_deposit_number |
- - Data | -- Fixed Deposit Number - - | -- |
| 30 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Bank Guarantee - - - - | -
Inherits from frappe.model.document.Document - -
- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.bank_guarantee.bank_guarantee.get_vouchar_detials
-
- - - erpnext.accounts.doctype.bank_guarantee.bank_guarantee.get_vouchar_detials - (column_list, doctype, docname) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -bank_account |
- - Link | -
- Bank Account
- - Select account head of the bank where cheque was deposited. - |
- - - - - -Account - - - - | -
| 2 | -account_currency |
- - Link | -- Account Currency - - | -- - - - -Currency - - - - | -
| 3 | -from_date |
- - Date | -- From Date - - | -- |
| 4 | -to_date |
- - Date | -- To Date - - | -- |
| 5 | -include_reconciled_entries |
- - Check | -- Include Reconciled Entries - - | -- |
| 6 | -include_pos_transactions |
- - Check | -- Include POS Transactions - - | -- |
| 7 | -get_payment_entries |
- - Button | -- Get Payment Entries - - | -- |
| 8 | -payment_entries |
- - Table | -- Payment Entries - - | -- - - - -Bank Reconciliation Detail - - - - | -
| 9 | -update_clearance_date |
- - Button | -- Update Clearance Date - - | -- |
| 10 | -total_amount |
- - Currency | -- Total Amount - - | -
- account_currency- |
-
Inherits from frappe.model.document.Document - -
- - - get_payment_entries - (self) -
-No docs
-- - - update_clearance_date - (self) -
-No docs
-Table Name: tabBank Reconciliation Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -payment_document |
- - Link | -- Payment Document - - | -- - - - -DocType - - - - | -
| 2 | -payment_entry |
- - Dynamic Link | -- Payment Entry - - | -
- payment_document- |
-
| 3 | -against_account |
- - Data | -- Against Account - - | -- |
| 4 | -amount |
- - Data | -- Amount - - | -- |
| 5 | -column_break_5 |
- - Column Break | -- - - | -- |
| 6 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 7 | -cheque_number |
- - Data | -- Cheque Number - - | -- |
| 8 | -cheque_date |
- - Date | -- Cheque Date - - | -- |
| 9 | -clearance_date |
- - Date | -- Clearance Date - - | -- |
Table Name: tabBank Statement Settings
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -bank_account |
- - Link | -- Bank Account - - | -- - - - -Account - - - - | -
| 2 | -date_format |
- - Data | -- Date Format - - | -- |
| 3 | -statement_header_mapping |
- - Section Break | -- Statement Header Mapping - - | -- |
| 4 | -header_items |
- - Table | -- Statement Headers - - | -- - - - -Bank Statement Settings Item - - - - | -
| 5 | -transaction_data_mapping |
- - Section Break | -- Transaction Data Mapping - - | -- |
| 6 | -mapped_items |
- - Table | -- Mapped Items - - | -- - - - -Bank Statement Transaction Settings Item - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabBank Statement Settings Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -mapped_header |
- - Data | -- Mapped Header - - | -- |
| 2 | -stmt_header |
- - Data | -- Bank Header - - | -- |
Table Name: tabBank Statement Transaction Entry
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -bank_account |
- - Link | -- Bank Account - - | -- - - - -Account - - - - | -
| 2 | -from_date |
- - Date | -- From Date - - | -- |
| 3 | -to_date |
- - Date | -- To Date - - | -- |
| 4 | -bank_settings |
- - Link | -- Bank Statement Settings - - | -- - - - -Bank Statement Settings - - - - | -
| 5 | -column_break_3 |
- - Column Break | -- - - | -- |
| 6 | -bank |
- - Link | -- Bank - - | -- - - - -Bank - - - - | -
| 7 | -receivable_account |
- - Link | -- Receivable Account - - | -- - - - -Account - - - - | -
| 8 | -payable_account |
- - Link | -- Payable Account - - | -- - - - -Account - - - - | -
| 9 | -bank_statement |
- - Attach | -- Bank Statement - - | -- |
| 10 | -section_break_6 |
- - Section Break | -- Bank Transaction Entries - - | -- |
| 11 | -new_transaction_items |
- - Table | -- New Transactions - - | -- - - - -Bank Statement Transaction Payment Item - - - - | -
| 12 | -section_break_9 |
- - Section Break | -- - - | -- |
| 13 | -match_invoices |
- - Button | -- Match Transaction to Invoices - - | -- |
| 14 | -column_break_14 |
- - Column Break | -- - - | -- |
| 15 | -create_payments |
- - Button | -- Create New Payment/Journal Entry - - | -- |
| 16 | -column_break_16 |
- - Column Break | -- - - | -- |
| 17 | -submit_payments |
- - Button | -- Submit/Reconcile Payments - - | -- |
| 18 | -section_break_18 |
- - Section Break | -- Matching Invoices - - | -- |
| 19 | -payment_invoice_items |
- - Table | -- Payment Invoice Items - - | -- - - - -Bank Statement Transaction Invoice Item - - - - | -
| 20 | -reconciled_transactions |
- - Section Break | -- Reconciled Transactions - - | -- |
| 21 | -reconciled_transaction_items |
- - Table | -- Reconciled Transactions - - | -- - - - -Bank Statement Transaction Payment Item - - - - | -
| 22 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Bank Statement Transaction Entry - - - - | -
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - create_journal_entry - (self, pe) -
-No docs
-- - - create_payment_entries - (self) -
-No docs
-- - - create_payment_entry - (self, pe) -
-No docs
-- - - create_settings - (self, bank) -
-No docs
-- - - get_matching_payments - (self, party, amount, pay_date) -
-No docs
-- - - get_statement_headers - (self) -
-No docs
-- - - map_transactions_on_journal_entry - (self) -
-No docs
-- - - map_unknown_transactions - (self) -
-No docs
-- - - match_invoice_to_payment - (self) -
-No docs
-- - - move_reconciled_entries - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - populate_matching_invoices - (self) -
-No docs
-- - - populate_matching_vouchers - (self) -
-No docs
-- - - populate_payment_entries - (self) -
-No docs
-- - - submit_payment_entries - (self) -
-No docs
-- - - update_payment_entry - (self, payment) -
-No docs
-- - - erpnext.accounts.doctype.bank_statement_transaction_entry.bank_statement_transaction_entry.get_header_index - (headers, row) -
-No docs
-- - - erpnext.accounts.doctype.bank_statement_transaction_entry.bank_statement_transaction_entry.get_matching_journal_entries - (from_date, to_date, account, against, amount) -
-No docs
-- - - erpnext.accounts.doctype.bank_statement_transaction_entry.bank_statement_transaction_entry.get_payments_matching_invoice - (invoice, amount, pay_date) -
-No docs
-- - - erpnext.accounts.doctype.bank_statement_transaction_entry.bank_statement_transaction_entry.get_rows_from_xls_file - (filename) -
-No docs
-- - - erpnext.accounts.doctype.bank_statement_transaction_entry.bank_statement_transaction_entry.get_transaction_entries - (filename, headers) -
-No docs
-- - - erpnext.accounts.doctype.bank_statement_transaction_entry.bank_statement_transaction_entry.get_transaction_info - (headers, header_index, row) -
-No docs
-- - - erpnext.accounts.doctype.bank_statement_transaction_entry.bank_statement_transaction_entry.is_headers_present - (headers, row) -
-No docs
-Table Name: tabBank Statement Transaction Invoice Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -transaction_date |
- - Date | -- Transaction Date - - | -- |
| 2 | -payment_description |
- - Data | -- Payment Description - - | -- |
| 3 | -party_type |
- - Select | -- Party Type - - | -
- Customer -Supplier -Account- |
-
| 4 | -party |
- - Dynamic Link | -- Party - - | -
- party_type- |
-
| 5 | -column_break_4 |
- - Column Break | -- - - | -- |
| 6 | -invoice_date |
- - Date | -- Invoice Date - - | -- |
| 7 | -invoice_type |
- - Select | -- Invoice Type - - | -
- Purchase Invoice -Sales Invoice -Journal Entry- |
-
| 8 | -invoice |
- - Dynamic Link | -- invoice - - | -
- invoice_type- |
-
| 9 | -outstanding_amount |
- - Data | -- Outstanding Amount - - | -- |
| 10 | -allocated_amount |
- - Data | -- Allocated Amount - - | -- |
Table Name: tabBank Statement Transaction Payment Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -transaction_date |
- - Date | -- Transaction Date - - | -- |
| 2 | -description |
- - Data | -- Description - - | -- |
| 3 | -amount |
- - Currency | -- Amount - - | -- |
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -party_type |
- - Select | -- Party Type - - | -
- Customer -Supplier -Account- |
-
| 6 | -party |
- - Dynamic Link | -- Party - - | -
- party_type- |
-
| 7 | -section_break_6 |
- - Section Break | -- - - | -- |
| 8 | -reference_type |
- - Select | -- Reference Type - - | -
- Payment Entry -Journal Entry- |
-
| 9 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
| 10 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
| 11 | -outstanding_amount |
- - Currency | -- outstanding_amount - - | -- |
| 12 | -column_break_10 |
- - Column Break | -- - - | -- |
| 13 | -reference_name |
- - Dynamic Link | -- Reference Name - - | -
- reference_type- |
-
| 14 | -payment_reference |
- - Data | -- Payment Reference - - | -- |
| 15 | -invoices |
- - Text | -- Invoices - - | -- |
Table Name: tabBank Statement Settings
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -bank_account |
- - Link | -- Bank Account - - | -- - - - -Account - - - - | -
| 2 | -date_format |
- - Data | -- Date Format - - | -- |
| 3 | -statement_header_mapping |
- - Section Break | -- Statement Header Mapping - - | -- |
| 4 | -header_items |
- - Table | -- Statement Headers - - | -- - - - -Bank Statement Settings Item - - - - | -
| 5 | -transaction_data_mapping |
- - Section Break | -- Transaction Data Mapping - - | -- |
| 6 | -mapped_items |
- - Table | -- Mapped Items - - | -- - - - -Bank Statement Transaction Settings Item - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabBank Statement Transaction Settings Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -mapping_type |
- - Select | -- Mapping Type - - | -
- Transaction- |
-
| 2 | -bank_data |
- - Data | -- Bank Data - - | -- |
| 3 | -mapped_data_type |
- - Select | -- Mapped Data Type - - | -
- Account -Customer -Supplier -Account- |
-
| 4 | -mapped_data |
- - Dynamic Link | -- Mapped Data - - | -
- mapped_data_type- |
-
Table Name: tabBudget
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -budget_against |
- - Select | -- Budget Against - - | -
- -Cost Center -Project- |
-
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 4 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 5 | -fiscal_year |
- - Link | -- Fiscal Year - - | -- - - - -Fiscal Year - - - - | -
| 6 | -column_break_3 |
- - Column Break | -- - - | -- |
| 7 | -monthly_distribution |
- - Link | -- Monthly Distribution - - | -- - - - -Monthly Distribution - - - - | -
| 8 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Budget - - - - | -
| 9 | -section_break_6 |
- - Section Break | -- Control Section - - | -- |
| 10 | -applicable_on_material_request |
- - Check | -- Applicable on Material Request - - | -- |
| 11 | -action_if_annual_budget_exceeded_on_mr |
- - Select | -- Action if Annual Budget Exceeded on MR - - | -
- -Stop -Warn -Ignore- |
-
| 12 | -action_if_accumulated_monthly_budget_exceeded_on_mr |
- - Select | -- Action if Accumulated Monthly Budget Exceeded on MR - - | -
- -Stop -Warn -Ignore- |
-
| 13 | -column_break_13 |
- - Column Break | -- - - | -- |
| 14 | -applicable_on_purchase_order |
- - Check | -- Applicable on Purchase Order - - | -- |
| 15 | -action_if_annual_budget_exceeded_on_po |
- - Select | -- Action if Annual Budget Exceeded on PO - - | -
- -Stop -Warn -Ignore- |
-
| 16 | -action_if_accumulated_monthly_budget_exceeded_on_po |
- - Select | -- Action if Accumulated Monthly Budget Exceeded on PO - - | -
- -Stop -Warn -Ignore- |
-
| 17 | -section_break_16 |
- - Section Break | -- - - | -- |
| 18 | -applicable_on_booking_actual_expenses |
- - Check | -- Applicable on booking actual expenses - - | -- |
| 19 | -action_if_annual_budget_exceeded |
- - Select | -- Action if Annual Budget Exceeded on Actual - - | -
- -Stop -Warn -Ignore- |
-
| 20 | -action_if_accumulated_monthly_budget_exceeded |
- - Select | -- Action if Accumulated Monthly Budget Exceeded on Actual - - | -
- -Stop -Warn -Ignore- |
-
| 21 | -accounts |
- - Table | -- Budget Accounts - - | -- - - - -Budget Account - - - - | -
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - set_null_value - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_accounts - (self) -
-No docs
-- - - validate_applicable_for - (self) -
-No docs
-- - - validate_duplicate - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.accounts.doctype.budget.budget.compare_expense_with_budget - (args, budget_amount, action_for, action, budget_against, amount=0) -
-No docs
-- - - erpnext.accounts.doctype.budget.budget.get_accumulated_monthly_budget - (monthly_distribution, posting_date, fiscal_year, annual_budget) -
-No docs
-- - - erpnext.accounts.doctype.budget.budget.get_actions - (args, budget) -
-No docs
-- - - erpnext.accounts.doctype.budget.budget.get_actual_expense - (args) -
-No docs
-- - - erpnext.accounts.doctype.budget.budget.get_amount - (args, budget) -
-No docs
-- - - erpnext.accounts.doctype.budget.budget.get_expense_cost_center - (doctype, value) -
-No docs
-- - - erpnext.accounts.doctype.budget.budget.get_item_details - (args) -
-No docs
-- - - erpnext.accounts.doctype.budget.budget.get_ordered_amount - (args) -
-No docs
-- - - erpnext.accounts.doctype.budget.budget.get_project_condiion - (args) -
-No docs
-- - - erpnext.accounts.doctype.budget.budget.get_requested_amount - (args) -
-No docs
-- - - erpnext.accounts.doctype.budget.budget.validate_budget_records - (args, budget_records) -
-No docs
-- - - erpnext.accounts.doctype.budget.budget.validate_expense_against_budget - (args, company=None) -
-No docs
-Table Name: tabBudget Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
| 2 | -budget_amount |
- - Currency | -- Budget Amount - - | -
- Company:company:default_currency- |
-
Table Name: tabC-Form
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- C-FORM-- |
-
| 2 | -c_form_no |
- - Data | -- C-Form No - - | -- |
| 3 | -received_date |
- - Date | -- Received Date - - | -- |
| 4 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 5 | -column_break1 |
- - Column Break | -- - - | -- |
| 6 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 7 | -quarter |
- - Select | -- Quarter - - | -
- -I -II -III -IV- |
-
| 8 | -total_amount |
- - Currency | -- Total Amount - - | -
- Company:company:default_currency- |
-
| 9 | -state |
- - Data | -- State - - | -- |
| 10 | -section_break0 |
- - Section Break | -- - - | -- |
| 11 | -invoices |
- - Table | -- Invoices - - | -- - - - -C-Form Invoice Detail - - - - | -
| 12 | -total_invoiced_amount |
- - Currency | -- Total Invoiced Amount - - | -
- Company:company:default_currency- |
-
| 13 | -amended_from |
- - Link | -- Amended From - - | -- - - - -C-Form - - - - | -
Inherits from frappe.model.document.Document - -
- - - before_cancel - (self) -
-No docs
-- - - get_invoice_details - (self, invoice_no) -
-Pull details from invoices for referrence
-
-- - - on_submit - (self) -
-No docs
-- - - on_update - (self) -
-Update C-Form No on invoices
-
-- - - set_cform_in_sales_invoices - (self) -
-No docs
-- - - set_total_invoiced_amount - (self) -
-No docs
-- - - validate - (self) -
-Validate invoice that c-form is applicable - and no other c-form is received for that
-Table Name: tabC-Form Invoice Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -invoice_no |
- - Link | -- Invoice No - - | -- - - - -Sales Invoice - - - - | -
| 2 | -invoice_date |
- - Date | -- Invoice Date - - | -- |
| 3 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 4 | -net_total |
- - Currency | -- Net Total - - | -
- Company:company:default_currency- |
-
| 5 | -grand_total |
- - Currency | -- Grand Total - - | -
- Company:company:default_currency- |
-
Table Name: tabCash Flow Mapper
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -section_name |
- - Data | -- Section Name - - | -- |
| 2 | -section_header |
- - Data | -- Section Header - - | -- |
| 3 | -section_leader |
- - Data | -
- Section Leader
- - e.g Adjustments for: - |
- - |
| 4 | -section_subtotal |
- - Data | -- Section Subtotal - - | -- |
| 5 | -section_footer |
- - Data | -- Section Footer - - | -- |
| 6 | -accounts |
- - Table | -- Accounts - - | -- - - - -Cash Flow Mapping Template Details - - - - | -
| 7 | -position |
- - Int | -- Position - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabCash Flow Mapping
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -mapping_name |
- - Data | -- Name - - | -- |
| 2 | -label |
- - Data | -- Label - - | -- |
| 3 | -accounts |
- - Table | -- Accounts - - | -- - - - -Cash Flow Mapping Accounts - - - - | -
| 4 | -sb_1 |
- - Section Break | -- Select Maximum Of 1 - - | -- |
| 5 | -is_finance_cost |
- - Check | -- Is Finance Cost - - | -- |
| 6 | -is_working_capital |
- - Check | -- Is Working Capital - - | -- |
| 7 | -is_finance_cost_adjustment |
- - Check | -- Is Finance Cost Adjustment - - | -- |
| 8 | -is_income_tax_liability |
- - Check | -- Is Income Tax Liability - - | -- |
| 9 | -is_income_tax_expense |
- - Check | -- Is Income Tax Expense - - | -- |
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_checked_options - (self) -
-No docs
-Table Name: tabCash Flow Mapping Accounts
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -account |
- - Link | -- account - - | -- - - - -Account - - - - | -
Table Name: tabCash Flow Mapping Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -template_name |
- - Data | -- Template Name - - | -- |
| 2 | -mapping |
- - Table | -- Cash Flow Mapping - - | -- - - - -Cash Flow Mapping Template Details - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabCash Flow Mapping Template Details
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -mapping |
- - Link | -- Mapping - - | -- - - - -Cash Flow Mapping - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabCheque Print Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -settings |
- - HTML | -- - - | -- |
| 2 | -has_print_format |
- - Check | -- Has Print Format - - | -- |
| 3 | -primary_settings |
- - Section Break | -- Primary Settings - - | -- |
| 4 | -bank_name |
- - Data | -- Bank Name - - | -- |
| 5 | -cheque_size |
- - Select | -- Cheque Size - - | -
- -Regular -A4- |
-
| 6 | -starting_position_from_top_edge |
- - Float | -- Starting position from top edge - - | -- |
| 7 | -cheque_width |
- - Float | -- Cheque Width - - | -- |
| 8 | -cheque_height |
- - Float | -- Cheque Height - - | -- |
| 9 | -scanned_cheque |
- - Attach | -- Scanned Cheque - - | -- |
| 10 | -column_break_5 |
- - Column Break | -- - - | -- |
| 11 | -is_account_payable |
- - Check | -- Is Account Payable - - | -- |
| 12 | -acc_pay_dist_from_top_edge |
- - Float | -- Distance from top edge - - | -- |
| 13 | -acc_pay_dist_from_left_edge |
- - Float | -- Distance from left edge - - | -- |
| 14 | -message_to_show |
- - Data | -- Message to show - - | -- |
| 15 | -date_and_payer_settings |
- - Section Break | -- - - | -- |
| 16 | -date_settings |
- - HTML | -- Date Settings - - | -- |
| 17 | -date_dist_from_top_edge |
- - Float | -- Distance from top edge - - | -- |
| 18 | -date_dist_from_left_edge |
- - Float | -- Starting location from left edge - - | -- |
| 19 | -payer_settings |
- - Column Break | -- Payer Settings - - | -- |
| 20 | -payer_name_from_top_edge |
- - Float | -- Distance from top edge - - | -- |
| 21 | -payer_name_from_left_edge |
- - Float | -- Starting location from left edge - - | -- |
| 22 | -amount_in_words_and_figure_settings |
- - Section Break | -- - - | -- |
| 23 | -html_19 |
- - HTML | -- - - | -- |
| 24 | -amt_in_words_from_top_edge |
- - Float | -- Distance from top edge - - | -- |
| 25 | -amt_in_words_from_left_edge |
- - Float | -- Starting location from left edge - - | -- |
| 26 | -amt_in_word_width |
- - Float | -- Width of amount in word - - | -- |
| 27 | -amt_in_words_line_spacing |
- - Float | -- Line spacing for amount in words - - | -- |
| 28 | -amount_in_figure |
- - Column Break | -- Amount In Figure - - | -- |
| 29 | -amt_in_figures_from_top_edge |
- - Float | -- Distance from top edge - - | -- |
| 30 | -amt_in_figures_from_left_edge |
- - Float | -- Starting location from left edge - - | -- |
| 31 | -account_number_and_signatory_settings |
- - Section Break | -- - - | -- |
| 32 | -account_no_settings |
- - HTML | -- - - | -- |
| 33 | -acc_no_dist_from_top_edge |
- - Float | -- Distance from top edge - - | -- |
| 34 | -acc_no_dist_from_left_edge |
- - Float | -- Starting location from left edge - - | -- |
| 35 | -signatory_position |
- - Column Break | -- Signatory Position - - | -- |
| 36 | -signatory_from_top_edge |
- - Float | -- Distance from top edge - - | -- |
| 37 | -signatory_from_left_edge |
- - Float | -- Starting location from left edge - - | -- |
| 38 | -preview |
- - Section Break | -- Preview - - | -- |
| 39 | -cheque_print_preview |
- - HTML | -- - - | -- |
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.accounts.doctype.cheque_print_template.cheque_print_template.create_or_update_cheque_print_format
-
- - - erpnext.accounts.doctype.cheque_print_template.cheque_print_template.create_or_update_cheque_print_format - (template_name) -
-No docs
-Table Name: tabClosed Document
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -document_type |
- - Link | -- Document Type - - | -- - - - -DocType - - - - | -
| 2 | -closed |
- - Check | -- Closed - - | -- |
Table Name: tabCost Center
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -sb0 |
- - Section Break | -- - - | -- |
| 2 | -cost_center_name |
- - Data | -- Cost Center Name - - | -- |
| 3 | -cost_center_number |
- - Data | -- Cost Center Number - - | -- |
| 4 | -parent_cost_center |
- - Link | -- Parent Cost Center - - | -- - - - -Cost Center - - - - | -
| 5 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 6 | -cb0 |
- - Column Break | -- - - | -- |
| 7 | -is_group |
- - Check | -- Is Group - - | -- |
| 8 | -lft |
- - Int | -- lft - - | -- |
| 9 | -rgt |
- - Int | -- rgt - - | -- |
| 10 | -old_parent |
- - Link | -- old_parent - - | -- - - - -Cost Center - - - - | -
Inherits from frappe.utils.nestedset.NestedSet - -
- - - after_rename - (self, olddn, newdn, merge=False) -
-No docs
-- - - autoname - (self) -
-No docs
-- - - before_rename - (self, olddn, newdn, merge=False) -
-No docs
-- - - check_gle_exists - (self) -
-No docs
-- - - check_if_child_exists - (self) -
-No docs
-- - - convert_group_to_ledger - (self) -
-No docs
-- - - convert_ledger_to_group - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_mandatory - (self) -
-No docs
-- - - erpnext.accounts.doctype.cost_center.cost_center.on_doctype_update - () -
-No docs
-Table Name: tabExchange Rate Revaluation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 4 | -section_break_4 |
- - Section Break | -- - - | -- |
| 5 | -get_entries |
- - Button | -- Get Entries - - | -- |
| 6 | -accounts |
- - Table | -- Exchange Rate Revaluation Account - - | -- - - - -Exchange Rate Revaluation Account - - - - | -
| 7 | -section_break_6 |
- - Section Break | -- - - | -- |
| 8 | -total_gain_loss |
- - Currency | -- Total Gain/Loss - - | -- |
| 9 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Exchange Rate Revaluation - - - - | -
Inherits from frappe.model.document.Document - -
- - - get_accounts_data - (self, account=None) -
-No docs
-- - - get_accounts_from_gle - (self) -
-No docs
-- - - make_jv_entry - (self) -
-No docs
-- - - set_total_gain_loss - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_mandatory - (self) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.exchange_rate_revaluation.exchange_rate_revaluation.get_account_details
-
- - - erpnext.accounts.doctype.exchange_rate_revaluation.exchange_rate_revaluation.get_account_details - (account, company, posting_date, party_type=None, party=None) -
-No docs
-Table Name: tabExchange Rate Revaluation Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
| 2 | -party_type |
- - Link | -- Party Type - - | -- - - - -DocType - - - - | -
| 3 | -party |
- - Dynamic Link | -- Party - - | -
- party_type- |
-
| 4 | -column_break_2 |
- - Column Break | -- - - | -- |
| 5 | -account_currency |
- - Link | -- Account Currency - - | -- - - - -Currency - - - - | -
| 6 | -balance_in_account_currency |
- - Currency | -- Balance In Account Currency - - | -- |
| 7 | -balances |
- - Section Break | -- - - | -- |
| 8 | -current_exchange_rate |
- - Float | -- Current Exchange Rate - - | -- |
| 9 | -balance_in_base_currency |
- - Currency | -- Balance In Base Currency - - | -- |
| 10 | -column_break_9 |
- - Column Break | -- - - | -- |
| 11 | -new_exchange_rate |
- - Float | -- New Exchange Rate - - | -- |
| 12 | -new_balance_in_base_currency |
- - Currency | -- New Balance In Base Currency - - | -- |
| 13 | -gain_loss |
- - Currency | -- Gain/Loss - - | -- |
Table Name: tabFinance Book
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -finance_book_name |
- - Data | -- Name - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabFiscal Year
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -year |
- - Data | -
- Year Name
- - For e.g. 2012, 2012-13 - |
- - |
| 2 | -disabled |
- - Check | -- Disabled - - | -- |
| 3 | -year_start_date |
- - Date | -- Year Start Date - - | -- |
| 4 | -year_end_date |
- - Date | -- Year End Date - - | -- |
| 5 | -companies |
- - Table | -- Companies - - | -- - - - -Fiscal Year Company - - - - | -
| 6 | -auto_created |
- - Check | -- Auto Created - - | -- |
Inherits from frappe.model.document.Document - -
- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - set_as_default - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_dates - (self) -
-No docs
-- - - validate_overlap - (self) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.fiscal_year.fiscal_year.auto_create_fiscal_year
-
- - - erpnext.accounts.doctype.fiscal_year.fiscal_year.auto_create_fiscal_year - () -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.fiscal_year.fiscal_year.check_duplicate_fiscal_year
-
- - - erpnext.accounts.doctype.fiscal_year.fiscal_year.check_duplicate_fiscal_year - (doc) -
-No docs
-Table Name: tabFiscal Year Company
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
Table Name: tabGL Entry
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 2 | -transaction_date |
- - Date | -- Transaction Date - - | -- |
| 3 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
| 4 | -party_type |
- - Link | -- Party Type - - | -- - - - -DocType - - - - | -
| 5 | -party |
- - Dynamic Link | -- Party - - | -
- party_type- |
-
| 6 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 7 | -debit |
- - Currency | -- Debit Amount - - | -
- Company:company:default_currency- |
-
| 8 | -credit |
- - Currency | -- Credit Amount - - | -
- Company:company:default_currency- |
-
| 9 | -account_currency |
- - Link | -- Account Currency - - | -- - - - -Currency - - - - | -
| 10 | -debit_in_account_currency |
- - Currency | -- Debit Amount in Account Currency - - | -
- currency- |
-
| 11 | -credit_in_account_currency |
- - Currency | -- Credit Amount in Account Currency - - | -
- currency- |
-
| 12 | -against |
- - Text | -- Against - - | -- |
| 13 | -against_voucher_type |
- - Link | -- Against Voucher Type - - | -- - - - -DocType - - - - | -
| 14 | -against_voucher |
- - Dynamic Link | -- Against Voucher - - | -
- against_voucher_type- |
-
| 15 | -voucher_type |
- - Link | -- Voucher Type - - | -- - - - -DocType - - - - | -
| 16 | -voucher_no |
- - Dynamic Link | -- Voucher No - - | -
- voucher_type- |
-
| 17 | -voucher_detail_no |
- - Data | -- Voucher Detail No - - | -- |
| 18 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 19 | -remarks |
- - Text | -- Remarks - - | -- |
| 20 | -is_opening |
- - Select | -- Is Opening - - | -
- No -Yes- |
-
| 21 | -is_advance |
- - Select | -- Is Advance - - | -
- No -Yes- |
-
| 22 | -fiscal_year |
- - Link | -- Fiscal Year - - | -- - - - -Fiscal Year - - - - | -
| 23 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 24 | -finance_book |
- - Link | -- Finance Book - - | -- - - - -Finance Book - - - - | -
Inherits from frappe.model.document.Document - -
- - - check_mandatory - (self) -
-No docs
-- - - check_pl_account - (self) -
-No docs
-- - - on_update_with_args - (self, adv_adj, update_outstanding=Yes, from_repost=False) -
-No docs
-- - - pl_must_have_cost_center - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_account_details - (self, adv_adj) -
-Account must be ledger, active and not freezed
-- - - validate_and_set_fiscal_year - (self) -
-No docs
-- - - validate_cost_center - (self) -
-No docs
-- - - validate_currency - (self) -
-No docs
-- - - validate_party - (self) -
-No docs
-- - - erpnext.accounts.doctype.gl_entry.gl_entry.check_freezing_date - (posting_date, adv_adj=False) -
- Nobody can do GL Entries where posting date is before freezing date
- except authorized person
-
-- - - erpnext.accounts.doctype.gl_entry.gl_entry.update_against_account - (voucher_type, voucher_no) -
-No docs
-- - - erpnext.accounts.doctype.gl_entry.gl_entry.update_outstanding_amt - (account, party_type, party, against_voucher_type, against_voucher, on_cancel=False) -
-No docs
-- - - erpnext.accounts.doctype.gl_entry.gl_entry.validate_balance_type - (account, adv_adj=False) -
-No docs
-- - - erpnext.accounts.doctype.gl_entry.gl_entry.validate_frozen_account - (account, adv_adj=None) -
-No docs
-Table Name: tabGST Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -cgst_account |
- - Link | -- CGST Account - - | -- - - - -Account - - - - | -
| 3 | -sgst_account |
- - Link | -- SGST Account - - | -- - - - -Account - - - - | -
| 4 | -igst_account |
- - Link | -- IGST Account - - | -- - - - -Account - - - - | -
| 5 | -cess_account |
- - Link | -- CESS Account - - | -- - - - -Account - - - - | -
Table Name: tabJournal Entry
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -entry_type_and_date |
- - Section Break | -- - - | -
- fa fa-flag- |
-
| 2 | -title |
- - Data | -- Title - - | -- |
| 3 | -voucher_type |
- - Select | -- Entry Type - - | -
- Journal Entry -Inter Company Journal Entry -Bank Entry -Cash Entry -Credit Card Entry -Debit Note -Credit Note -Contra Entry -Excise Entry -Write Off Entry -Opening Entry -Depreciation Entry -Exchange Rate Revaluation- |
-
| 4 | -naming_series |
- - Select | -- Series - - | -
- JV- -JV-RET-- |
-
| 5 | -column_break1 |
- - Column Break | -- - - | -- |
| 6 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 7 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 8 | -finance_book |
- - Link | -- Finance Book - - | -- - - - -Finance Book - - - - | -
| 9 | -2_add_edit_gl_entries |
- - Section Break | -- - - | -
- fa fa-table- |
-
| 10 | -accounts |
- - Table | -- Accounting Entries - - | -- - - - -Journal Entry Account - - - - | -
| 11 | -section_break99 |
- - Section Break | -- - - | -- |
| 12 | -cheque_no |
- - Data | -- Reference Number - - | -- |
| 13 | -cheque_date |
- - Date | -- Reference Date - - | -- |
| 14 | -user_remark |
- - Small Text | -- User Remark - - | -- |
| 15 | -column_break99 |
- - Column Break | -- - - | -- |
| 16 | -total_debit |
- - Currency | -- Total Debit - - | -
- Company:company:default_currency- |
-
| 17 | -total_credit |
- - Currency | -- Total Credit - - | -
- Company:company:default_currency- |
-
| 18 | -difference |
- - Currency | -- Difference (Dr - Cr) - - | -
- Company:company:default_currency- |
-
| 19 | -get_balance |
- - Button | -- Make Difference Entry - - | -- |
| 20 | -multi_currency |
- - Check | -- Multi Currency - - | -- |
| 21 | -total_amount_currency |
- - Link | -- Total Amount Currency - - | -- - - - -Currency - - - - | -
| 22 | -total_amount |
- - Currency | -- Total Amount - - | -
- total_amount_currency- |
-
| 23 | -total_amount_in_words |
- - Data | -- Total Amount in Words - - | -- |
| 24 | -reference |
- - Section Break | -- Reference - - | -
- fa fa-pushpin- |
-
| 25 | -clearance_date |
- - Date | -- Clearance Date - - | -- |
| 26 | -remark |
- - Small Text | -- Remark - - | -- |
| 27 | -paid_loan |
- - Data | -- Paid Loan - - | -- |
| 28 | -inter_company_journal_entry_reference |
- - Link | -- Inter Company Journal Entry Reference - - | -- - - - -Journal Entry - - - - | -
| 29 | -column_break98 |
- - Column Break | -- - - | -- |
| 30 | -bill_no |
- - Data | -- Bill No - - | -- |
| 31 | -bill_date |
- - Date | -- Bill Date - - | -- |
| 32 | -due_date |
- - Date | -- Due Date - - | -- |
| 33 | -write_off |
- - Section Break | -- Write Off - - | -- |
| 34 | -write_off_based_on |
- - Select | -- Write Off Based On - - | -
- Accounts Receivable -Accounts Payable- |
-
| 35 | -get_outstanding_invoices |
- - Button | -- Get Outstanding Invoices - - | -
- get_outstanding_invoices- |
-
| 36 | -column_break_30 |
- - Column Break | -- - - | -- |
| 37 | -write_off_amount |
- - Currency | -- Write Off Amount - - | -
- Company:company:default_currency- |
-
| 38 | -printing_settings |
- - Section Break | -- Printing Settings - - | -- |
| 39 | -pay_to_recd_from |
- - Data | -- Pay To / Recd From - - | -- |
| 40 | -column_break_35 |
- - Column Break | -- - - | -- |
| 41 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 42 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 43 | -addtional_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 44 | -column_break3 |
- - Column Break | -- - - | -- |
| 45 | -is_opening |
- - Select | -- Is Opening - - | -
- No -Yes- |
-
| 46 | -stock_entry |
- - Link | -- Stock Entry - - | -- - - - -Stock Entry - - - - | -
| 47 | -subscription_section |
- - Section Break | -- Subscription Section - - | -- |
| 48 | -auto_repeat |
- - Link | -- Auto Repeat - - | -- - - - -Auto Repeat - - - - | -
| 49 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Journal Entry - - - - | -
Inherits from erpnext.controllers.accounts_controller.AccountsController - -
- - - __init__ - (self) -
-No docs
-- - - check_credit_limit - (self) -
-No docs
-- - - create_remarks - (self) -
-No docs
-- - - get_balance - (self) -
-No docs
-- - - get_feed - (self) -
-No docs
-- - - get_outstanding_invoices - (self) -
-No docs
-- - - get_title - (self) -
-No docs
-- - - get_values - (self) -
-No docs
-- - - make_gl_entries - (self, cancel=0, adv_adj=0) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - set_account_and_party_balance - (self) -
-No docs
-- - - set_against_account - (self) -
-No docs
-- - - set_amounts_in_company_currency - (self) -
-No docs
-- - - set_exchange_rate - (self) -
-No docs
-- - - set_print_format_fields - (self) -
-No docs
-- - - set_total_amount - (self, amt, currency) -
-No docs
-- - - set_total_debit_credit - (self) -
-No docs
-- - - unlink_advance_entry_reference - (self) -
-No docs
-- - - unlink_asset_adjustment_entry - (self) -
-No docs
-- - - unlink_asset_reference - (self) -
-No docs
-- - - unlink_inter_company_jv - (self) -
-No docs
-- - - update_advance_paid - (self) -
-No docs
-- - - update_expense_claim - (self) -
-No docs
-- - - update_inter_company_jv - (self) -
-No docs
-- - - update_loan - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_against_jv - (self) -
-No docs
-- - - validate_cheque_info - (self) -
-No docs
-- - - validate_credit_debit_note - (self) -
-No docs
-- - - validate_empty_accounts_table - (self) -
-No docs
-- - - validate_entries_for_advance - (self) -
-No docs
-- - - validate_expense_claim - (self) -
-No docs
-- - - validate_inter_company_accounts - (self) -
-No docs
-- - - validate_invoices - (self) -
-Validate totals and docstatus for invoices
-- - - validate_multi_currency - (self) -
-No docs
-- - - validate_orders - (self) -
-Validate totals, closed and docstatus for orders
-- - - validate_party - (self) -
-No docs
-- - - validate_reference_doc - (self) -
-Validates reference document
-- - - validate_total_debit_and_credit - (self) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.journal_entry.journal_entry.get_account_balance_and_party_type
-
- - - erpnext.accounts.doctype.journal_entry.journal_entry.get_account_balance_and_party_type - (account, date, company, debit=None, credit=None, exchange_rate=None) -
-Returns dict of account balance and party type to be set in Journal Entry on selection of account.
-- - - erpnext.accounts.doctype.journal_entry.journal_entry.get_against_jv - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.journal_entry.journal_entry.get_average_exchange_rate
-
- - - erpnext.accounts.doctype.journal_entry.journal_entry.get_average_exchange_rate - (account) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.journal_entry.journal_entry.get_default_bank_cash_account
-
- - - erpnext.accounts.doctype.journal_entry.journal_entry.get_default_bank_cash_account - (company, account_type=None, mode_of_payment=None, account=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.journal_entry.journal_entry.get_exchange_rate
-
- - - erpnext.accounts.doctype.journal_entry.journal_entry.get_exchange_rate - (posting_date, account=None, account_currency=None, company=None, reference_type=None, reference_name=None, debit=None, credit=None, exchange_rate=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.journal_entry.journal_entry.get_opening_accounts
-
- - - erpnext.accounts.doctype.journal_entry.journal_entry.get_opening_accounts - (company) -
-get all balance sheet accounts for opening entry
-Public API
- /api/method/erpnext.accounts.doctype.journal_entry.journal_entry.get_outstanding
-
- - - erpnext.accounts.doctype.journal_entry.journal_entry.get_outstanding - (args) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.journal_entry.journal_entry.get_party_account_and_balance
-
- - - erpnext.accounts.doctype.journal_entry.journal_entry.get_party_account_and_balance - (company, party_type, party) -
-No docs
-- - - erpnext.accounts.doctype.journal_entry.journal_entry.get_payment_entry - (ref_doc, args) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.journal_entry.journal_entry.get_payment_entry_against_invoice
-
- - - erpnext.accounts.doctype.journal_entry.journal_entry.get_payment_entry_against_invoice - (dt, dn, amount=None, debit_in_account_currency=None, journal_entry=False, bank_account=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.journal_entry.journal_entry.get_payment_entry_against_order
-
- - - erpnext.accounts.doctype.journal_entry.journal_entry.get_payment_entry_against_order - (dt, dn, amount=None, debit_in_account_currency=None, journal_entry=False, bank_account=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.journal_entry.journal_entry.make_inter_company_journal_entry
-
- - - erpnext.accounts.doctype.journal_entry.journal_entry.make_inter_company_journal_entry - (name, voucher_type, company) -
-No docs
-Table Name: tabJournal Entry Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
| 2 | -account_type |
- - Data | -- Account Type - - | -- |
| 3 | -balance |
- - Currency | -- Account Balance - - | -
- account_currency- |
-
| 4 | -cost_center |
- - Link | -
- Cost Center
- - If Income or Expense - |
- - - - - -Cost Center - - - - | -
| 5 | -col_break1 |
- - Column Break | -- - - | -- |
| 6 | -party_type |
- - Link | -- Party Type - - | -- - - - -DocType - - - - | -
| 7 | -party |
- - Dynamic Link | -- Party - - | -
- party_type- |
-
| 8 | -party_balance |
- - Currency | -- Party Balance - - | -
- account_currency- |
-
| 9 | -currency_section |
- - Section Break | -- Currency - - | -- |
| 10 | -account_currency |
- - Link | -- Account Currency - - | -- - - - -Currency - - - - | -
| 11 | -column_break_10 |
- - Column Break | -- - - | -- |
| 12 | -exchange_rate |
- - Float | -- Exchange Rate - - | -- |
| 13 | -sec_break1 |
- - Section Break | -- Amount - - | -- |
| 14 | -debit_in_account_currency |
- - Currency | -- Debit - - | -
- account_currency- |
-
| 15 | -debit |
- - Currency | -- Debit in Company Currency - - | -
- Company:company:default_currency- |
-
| 16 | -col_break2 |
- - Column Break | -- - - | -- |
| 17 | -credit_in_account_currency |
- - Currency | -- Credit - - | -
- account_currency- |
-
| 18 | -credit |
- - Currency | -- Credit in Company Currency - - | -
- Company:company:default_currency- |
-
| 19 | -reference |
- - Section Break | -- Reference - - | -- |
| 20 | -reference_type |
- - Select | -- Reference Type - - | -
- -Sales Invoice -Purchase Invoice -Journal Entry -Sales Order -Purchase Order -Expense Claim -Asset -Loan -Payroll Entry -Employee Advance -Exchange Rate Revaluation- |
-
| 21 | -reference_name |
- - Dynamic Link | -- Reference Name - - | -
- reference_type- |
-
| 22 | -reference_due_date |
- - Select | -- Reference Due Date - - | -- |
| 23 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 24 | -col_break3 |
- - Column Break | -- - - | -- |
| 25 | -is_advance |
- - Select | -- Is Advance - - | -
- No -Yes- |
-
| 26 | -against_account |
- - Text | -- Against Account - - | -- |
Table Name: tabMode of Payment
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -mode_of_payment |
- - Data | -- Mode of Payment - - | -- |
| 2 | -type |
- - Select | -- Type - - | -
- Cash -Bank -General- |
-
| 3 | -accounts |
- - Table | -- Accounts - - | -- - - - -Mode of Payment Account - - - - | -
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_accounts - (self) -
-No docs
-- - - validate_repeating_companies - (self) -
-Error when Same Company is entered multiple times in accounts
-Table Name: tabMode of Payment Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -default_account |
- - Link | -
- Default Account
- - Default account will be automatically updated in POS Invoice when this mode is selected. - |
- - - - - -Account - - - - | -
Table Name: tabMonthly Distribution
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -distribution_id |
- - Data | -
- Distribution Name
- - Name of the Monthly Distribution - |
- - |
| 2 | -fiscal_year |
- - Link | -- Fiscal Year - - | -- - - - -Fiscal Year - - - - | -
| 3 | -percentages |
- - Table | -- Monthly Distribution Percentages - - | -- - - - -Monthly Distribution Percentage - - - - | -
Inherits from frappe.model.document.Document - -
- - - get_months - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabMonthly Distribution Percentage
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -month |
- - Data | -- Month - - | -- |
| 2 | -percentage_allocation |
- - Float | -- Percentage Allocation - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -create_missing_party |
- - Check | -
- Create Missing Party
- - Create missing customer or supplier. - |
- - |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -invoice_type |
- - Select | -- Invoice Type - - | -
- Sales -Purchase- |
-
| 5 | -section_break_4 |
- - Section Break | -- Invoices - - | -- |
| 6 | -invoices |
- - Table | -- - - | -- - - - -Opening Invoice Creation Tool Item - - - - | -
Inherits from frappe.model.document.Document - -
- - - add_party - (self, party_type, party) -
-No docs
-- - - get_invoice_dict - (self, row=None) -
-No docs
-- - - get_opening_invoice_summary - (self) -
-No docs
-- - - make_invoices - (self) -
-No docs
-- - - onload - (self) -
-Load the Opening Invoice summary
-Public API
- /api/method/erpnext.accounts.doctype.opening_invoice_creation_tool.opening_invoice_creation_tool.get_temporary_opening_account
-
- - - erpnext.accounts.doctype.opening_invoice_creation_tool.opening_invoice_creation_tool.get_temporary_opening_account - (company=None) -
-No docs
-Table Name: tabOpening Invoice Creation Tool Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -party_type |
- - Link | -- Party Type - - | -- - - - -DocType - - - - | -
| 2 | -party |
- - Dynamic Link | -- Party - - | -
- party_type- |
-
| 3 | -temporary_opening_account |
- - Link | -- Temporary Opening Account - - | -- - - - -Account - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 6 | -due_date |
- - Date | -- Due Date - - | -- |
| 7 | -section_break_5 |
- - Section Break | -- - - | -- |
| 8 | -item_name |
- - Data | -- Item Name - - | -- |
| 9 | -outstanding_amount |
- - Currency | -- Outstanding Amount - - | -- |
| 10 | -column_break_4 |
- - Column Break | -- - - | -- |
| 11 | -qty |
- - Data | -- Quantity - - | -- |
Table Name: tabParty Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
Table Name: tabPayment Entry
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -type_of_payment |
- - Section Break | -- Type of Payment - - | -- |
| 2 | -naming_series |
- - Select | -- Series - - | -
- PE-- |
-
| 3 | -payment_type |
- - Select | -- Payment Type - - | -
- Receive -Pay -Internal Transfer- |
-
| 4 | -column_break_5 |
- - Column Break | -- - - | -- |
| 5 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 6 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 7 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
| 8 | -party_section |
- - Section Break | -- Payment From / To - - | -- |
| 9 | -party_type |
- - Link | -- Party Type - - | -- - - - -DocType - - - - | -
| 10 | -party |
- - Dynamic Link | -- Party - - | -
- party_type- |
-
| 11 | -column_break_11 |
- - Column Break | -- - - | -- |
| 12 | -party_name |
- - Data | -- Party Name - - | -- |
| 13 | -payment_accounts_section |
- - Section Break | -- Accounts - - | -- |
| 14 | -party_balance |
- - Currency | -- Party Balance - - | -- |
| 15 | -paid_from |
- - Link | -- Account Paid From - - | -- - - - -Account - - - - | -
| 16 | -paid_from_account_currency |
- - Link | -- Account Currency - - | -- - - - -Currency - - - - | -
| 17 | -paid_from_account_balance |
- - Currency | -- Account Balance - - | -
- paid_from_account_currency- |
-
| 18 | -column_break_18 |
- - Column Break | -- - - | -- |
| 19 | -paid_to |
- - Link | -- Account Paid To - - | -- - - - -Account - - - - | -
| 20 | -paid_to_account_currency |
- - Link | -- Account Currency - - | -- - - - -Currency - - - - | -
| 21 | -paid_to_account_balance |
- - Currency | -- Account Balance - - | -
- paid_to_account_currency- |
-
| 22 | -payment_amounts_section |
- - Section Break | -- Amount - - | -- |
| 23 | -paid_amount |
- - Currency | -- Paid Amount - - | -
- paid_from_account_currency- |
-
| 24 | -source_exchange_rate |
- - Float | -- Exchange Rate - - | -- |
| 25 | -base_paid_amount |
- - Currency | -- Paid Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 26 | -column_break_21 |
- - Column Break | -- - - | -- |
| 27 | -received_amount |
- - Currency | -- Received Amount - - | -
- paid_to_account_currency- |
-
| 28 | -target_exchange_rate |
- - Float | -- Exchange Rate - - | -- |
| 29 | -base_received_amount |
- - Currency | -- Received Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 30 | -section_break_14 |
- - Section Break | -- Reference - - | -- |
| 31 | -allocate_payment_amount |
- - Check | -- Allocate Payment Amount - - | -- |
| 32 | -references |
- - Table | -- Payment References - - | -- - - - -Payment Entry Reference - - - - | -
| 33 | -section_break_34 |
- - Section Break | -- Writeoff - - | -- |
| 34 | -total_allocated_amount |
- - Currency | -- Total Allocated Amount - - | -- |
| 35 | -base_total_allocated_amount |
- - Currency | -- Total Allocated Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 36 | -set_exchange_gain_loss |
- - Button | -- Set Exchange Gain / Loss - - | -- |
| 37 | -column_break_36 |
- - Column Break | -- - - | -- |
| 38 | -unallocated_amount |
- - Currency | -- Unallocated Amount - - | -- |
| 39 | -difference_amount |
- - Currency | -- Difference Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 40 | -write_off_difference_amount |
- - Button | -- Write Off Difference Amount - - | -- |
| 41 | -deductions_or_loss_section |
- - Section Break | -- Deductions or Loss - - | -- |
| 42 | -deductions |
- - Table | -- Payment Deductions or Loss - - | -- - - - -Payment Entry Deduction - - - - | -
| 43 | -transaction_references |
- - Section Break | -- Transaction ID - - | -- |
| 44 | -reference_no |
- - Data | -- Cheque/Reference No - - | -- |
| 45 | -column_break_23 |
- - Column Break | -- - - | -- |
| 46 | -reference_date |
- - Date | -- Cheque/Reference Date - - | -- |
| 47 | -clearance_date |
- - Date | -- Clearance Date - - | -- |
| 48 | -section_break_12 |
- - Section Break | -- More Information - - | -- |
| 49 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 50 | -remarks |
- - Small Text | -- Remarks - - | -- |
| 51 | -column_break_16 |
- - Column Break | -- - - | -- |
| 52 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 53 | -print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 54 | -subscription_section |
- - Section Break | -- Subscription Section - - | -- |
| 55 | -auto_repeat |
- - Link | -- Auto Repeat - - | -- - - - -Auto Repeat - - - - | -
| 56 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Payment Entry - - - - | -
| 57 | -title |
- - Data | -- Title - - | -- |
Inherits from frappe.exceptions.ValidationError - -
Inherits from erpnext.controllers.accounts_controller.AccountsController - -
- - - __init__ - (self) -
-No docs
-- - - add_bank_gl_entries - (self, gl_entries) -
-No docs
-- - - add_deductions_gl_entries - (self, gl_entries) -
-No docs
-- - - add_party_gl_entries - (self, gl_entries) -
-No docs
-- - - calculate_deductions - (self, tax_details) -
-No docs
-- - - clear_unallocated_reference_document_rows - (self) -
-No docs
-- - - delink_advance_entry_references - (self) -
-No docs
-- - - make_gl_entries - (self, cancel=0, adv_adj=0) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_recurring - (self, reference_doc, auto_repeat_doc) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - set_amounts - (self) -
-No docs
-- - - set_amounts_in_company_currency - (self) -
-No docs
-- - - set_difference_amount - (self) -
-No docs
-- - - set_exchange_rate - (self) -
-No docs
-- - - set_missing_ref_details - (self, force=False) -
-No docs
-- - - set_missing_values - (self) -
-No docs
-- - - set_remarks - (self) -
-No docs
-- - - set_title - (self) -
-No docs
-- - - set_total_allocated_amount - (self) -
-No docs
-- - - set_unallocated_amount - (self) -
-No docs
-- - - setup_party_account_field - (self) -
-No docs
-- - - update_advance_paid - (self) -
-No docs
-- - - update_expense_claim - (self) -
-No docs
-- - - update_outstanding_amounts - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_account_type - (self, account, account_types) -
-No docs
-- - - validate_allocated_amount - (self) -
-No docs
-- - - validate_bank_accounts - (self) -
-No docs
-- - - validate_duplicate_entry - (self) -
-No docs
-- - - validate_journal_entry - (self) -
-No docs
-- - - validate_mandatory - (self) -
-No docs
-- - - validate_party_details - (self) -
-No docs
-- - - validate_payment_against_negative_invoice - (self) -
-No docs
-- - - validate_payment_type - (self) -
-No docs
-- - - validate_reference_documents - (self) -
-No docs
-- - - validate_transaction_reference - (self) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.payment_entry.payment_entry.get_account_details
-
- - - erpnext.accounts.doctype.payment_entry.payment_entry.get_account_details - (account, date) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.payment_entry.payment_entry.get_company_defaults
-
- - - erpnext.accounts.doctype.payment_entry.payment_entry.get_company_defaults - (company) -
-No docs
-- - - erpnext.accounts.doctype.payment_entry.payment_entry.get_negative_outstanding_invoices - (party_type, party, party_account, party_account_currency, company_currency) -
-No docs
-- - - erpnext.accounts.doctype.payment_entry.payment_entry.get_orders_to_be_billed - (posting_date, party_type, party, party_account_currency, company_currency) -
-No docs
-- - - erpnext.accounts.doctype.payment_entry.payment_entry.get_outstanding_on_journal_entry - (name) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.payment_entry.payment_entry.get_outstanding_reference_documents
-
- - - erpnext.accounts.doctype.payment_entry.payment_entry.get_outstanding_reference_documents - (args) -
-No docs
-- - - erpnext.accounts.doctype.payment_entry.payment_entry.get_paid_amount - (dt, dn, party_type, party, account, due_date) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.payment_entry.payment_entry.get_party_details
-
- - - erpnext.accounts.doctype.payment_entry.payment_entry.get_party_details - (company, party_type, party, date) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.payment_entry.payment_entry.get_payment_entry
-
- - - erpnext.accounts.doctype.payment_entry.payment_entry.get_payment_entry - (dt, dn, party_amount=None, bank_account=None, bank_amount=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.payment_entry.payment_entry.get_reference_details
-
- - - erpnext.accounts.doctype.payment_entry.payment_entry.get_reference_details - (reference_doctype, reference_name, party_account_currency) -
-No docs
-Table Name: tabPayment Entry Deduction
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
| 2 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 3 | -amount |
- - Currency | -- Amount - - | -- |
Table Name: tabPayment Entry Reference
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -reference_doctype |
- - Link | -- Type - - | -- - - - -DocType - - - - | -
| 2 | -reference_name |
- - Dynamic Link | -- Name - - | -
- reference_doctype- |
-
| 3 | -due_date |
- - Date | -- Due Date - - | -- |
| 4 | -bill_no |
- - Data | -- Supplier Invoice No - - | -- |
| 5 | -column_break_4 |
- - Column Break | -- - - | -- |
| 6 | -total_amount |
- - Float | -- Total Amount - - | -- |
| 7 | -outstanding_amount |
- - Float | -- Outstanding - - | -- |
| 8 | -allocated_amount |
- - Float | -- Allocated - - | -- |
| 9 | -exchange_rate |
- - Float | -- Exchange Rate - - | -- |
Table Name: tabPayment Gateway Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -payment_gateway |
- - Link | -- Payment Gateway - - | -- - - - -Payment Gateway - - - - | -
| 2 | -is_default |
- - Check | -- Is Default - - | -- |
| 3 | -column_break_4 |
- - Column Break | -- - - | -- |
| 4 | -payment_account |
- - Link | -- Payment Account - - | -- - - - -Account - - - - | -
| 5 | -currency |
- - Read Only | -- Currency - - | -- |
| 6 | -payment_request_message |
- - Section Break | -- - - | -- |
| 7 | -message |
- - Small Text | -- Default Payment Request Message - - | -- |
| 8 | -message_examples |
- - HTML | -- Message Examples - - | -- |
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - set_as_default_if_not_set - (self) -
-No docs
-- - - update_default_payment_gateway - (self) -
-No docs
-- - - validate - (self) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -party_type |
- - Link | -- Party Type - - | -- - - - -DocType - - - - | -
| 3 | -party |
- - Dynamic Link | -- Party - - | -
- party_type- |
-
| 4 | -receivable_payable_account |
- - Link | -- Receivable / Payable Account - - | -- - - - -Account - - - - | -
| 5 | -bank_cash_account |
- - Link | -- Bank / Cash Account - - | -- - - - -Account - - - - | -
| 6 | -col_break1 |
- - Column Break | -- - - | -- |
| 7 | -from_date |
- - Date | -- From Invoice Date - - | -- |
| 8 | -to_date |
- - Date | -- To Invoice Date - - | -- |
| 9 | -minimum_amount |
- - Currency | -- Minimum Invoice Amount - - | -- |
| 10 | -maximum_amount |
- - Currency | -- Maximum Invoice Amount - - | -- |
| 11 | -get_unreconciled_entries |
- - Button | -- Get Unreconciled Entries - - | -- |
| 12 | -sec_break1 |
- - Section Break | -- Unreconciled Payment Details - - | -- |
| 13 | -payments |
- - Table | -- Payments - - | -- - - - -Payment Reconciliation Payment - - - - | -
| 14 | -reconcile |
- - Button | -- Reconcile - - | -- |
| 15 | -sec_break2 |
- - Section Break | -- Invoice/Journal Entry Details - - | -- |
| 16 | -invoices |
- - Table | -- Invoices - - | -- - - - -Payment Reconciliation Invoice - - - - | -
Inherits from frappe.model.document.Document - -
- - - add_invoice_entries - (self, non_reconciled_invoices) -
-No docs
-- - - add_payment_entries - (self, entries) -
-No docs
-- - - check_condition - (self) -
-No docs
-- - - check_mandatory_to_fetch - (self) -
-No docs
-- - - get_invoice_entries - (self) -
-No docs
-- - - get_jv_entries - (self) -
-No docs
-- - - get_nonreconciled_payment_entries - (self) -
-No docs
-- - - get_payment_entries - (self) -
-No docs
-- - - get_unreconciled_entries - (self) -
-No docs
-- - - reconcile - (self, args) -
-No docs
-- - - validate_invoice - (self) -
-No docs
-Table Name: tabPayment Reconciliation Invoice
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -invoice_type |
- - Select | -- Invoice Type - - | -
- Sales Invoice -Purchase Invoice -Journal Entry- |
-
| 2 | -invoice_number |
- - Dynamic Link | -- Invoice Number - - | -
- invoice_type- |
-
| 3 | -invoice_date |
- - Date | -- Invoice Date - - | -- |
| 4 | -col_break1 |
- - Column Break | -- - - | -- |
| 5 | -amount |
- - Currency | -- Amount - - | -- |
| 6 | -outstanding_amount |
- - Currency | -- Outstanding Amount - - | -- |
Table Name: tabPayment Reconciliation Payment
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -reference_type |
- - Link | -- Reference Type - - | -- - - - -DocType - - - - | -
| 2 | -reference_name |
- - Dynamic Link | -- Reference Name - - | -
- reference_type- |
-
| 3 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 4 | -is_advance |
- - Data | -- Is Advance - - | -- |
| 5 | -reference_row |
- - Data | -- Reference Row - - | -- |
| 6 | -col_break1 |
- - Column Break | -- - - | -- |
| 7 | -invoice_number |
- - Select | -- Invoice Number - - | -- |
| 8 | -amount |
- - Currency | -- Amount - - | -- |
| 9 | -allocated_amount |
- - Currency | -- Allocated amount - - | -- |
| 10 | -sec_break1 |
- - Section Break | -- - - | -- |
| 11 | -remark |
- - Small Text | -- Remark - - | -- |
Table Name: tabPayment Request
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- PR- |
-
| 2 | -recipient_and_message |
- - Section Break | -- Recipient Message And Payment Details - - | -- |
| 3 | -print_format |
- - Select | -- Print Format - - | -- |
| 4 | -email_to |
- - Data | -- To - - | -- |
| 5 | -subject |
- - Data | -- Subject - - | -- |
| 6 | -column_break_9 |
- - Column Break | -- - - | -- |
| 7 | -payment_gateway_account |
- - Link | -- Payment Gateway Account - - | -- - - - -Payment Gateway Account - - - - | -
| 8 | -currency |
- - Link | -- Transaction Currency - - | -- - - - -Currency - - - - | -
| 9 | -grand_total |
- - Currency | -
- Amount
- - Amount in customer's currency - |
-
- currency- |
-
| 10 | -status |
- - Select | -- Status - - | -
- -Draft -Initiated -Paid -Failed -Cancelled- |
-
| 11 | -make_sales_invoice |
- - Check | -- Make Sales Invoice - - | -- |
| 12 | -section_break_10 |
- - Section Break | -- - - | -- |
| 13 | -message |
- - Text | -- Message - - | -- |
| 14 | -message_examples |
- - HTML | -- Message Examples - - | -- |
| 15 | -mute_email |
- - Check | -- Mute Email - - | -- |
| 16 | -payment_url |
- - Small Text | -- payment_url - - | -- |
| 17 | -section_break_7 |
- - Section Break | -- Payment Gateway Details - - | -- |
| 18 | -payment_gateway |
- - Read Only | -- Payment Gateway - - | -- |
| 19 | -payment_account |
- - Read Only | -- Payment Account - - | -- |
| 20 | -reference_details |
- - Section Break | -- Reference Details - - | -- |
| 21 | -reference_doctype |
- - Link | -- Reference Doctype - - | -- - - - -DocType - - - - | -
| 22 | -reference_name |
- - Dynamic Link | -- Reference Name - - | -
- reference_doctype- |
-
| 23 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Payment Request - - - - | -
Inherits from frappe.model.document.Document - -
- - - check_if_payment_entry_exists - (self) -
-No docs
-- - - create_payment_entry - (self, submit=True) -
-create entry
-- - - get_message - (self) -
-return message with payment gateway link
-- - - get_payment_success_url - (self) -
-No docs
-- - - get_payment_url - (self) -
-No docs
-- - - make_communication_entry - (self) -
-Make communication entry
-- - - make_invoice - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_payment_authorized - (self, status=None) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - payment_gateway_validation - (self) -
-No docs
-- - - send_email - (self) -
-send email with payment link
-- - - set_as_cancelled - (self) -
-No docs
-- - - set_as_paid - (self) -
-No docs
-- - - set_failed - (self) -
-No docs
-- - - set_payment_request_url - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_currency - (self) -
-No docs
-- - - validate_payment_request - (self) -
-No docs
-- - - validate_reference_document - (self) -
-No docs
-- - - erpnext.accounts.doctype.payment_request.payment_request.get_amount - (ref_doc, dt) -
-get amount based on doctype
-- - - erpnext.accounts.doctype.payment_request.payment_request.get_dummy_message - (doc) -
-No docs
-- - - erpnext.accounts.doctype.payment_request.payment_request.get_gateway_details - (args) -
-return gateway and payment account of default payment gateway
-- - - erpnext.accounts.doctype.payment_request.payment_request.get_payment_gateway_account - (args) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.payment_request.payment_request.get_print_format_list
-
- - - erpnext.accounts.doctype.payment_request.payment_request.get_print_format_list - (ref_doctype) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.payment_request.payment_request.make_payment_entry
-
- - - erpnext.accounts.doctype.payment_request.payment_request.make_payment_entry - (docname) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.payment_request.payment_request.make_payment_request
-
- - - erpnext.accounts.doctype.payment_request.payment_request.make_payment_request - () -
-Make payment request
-- - - erpnext.accounts.doctype.payment_request.payment_request.make_status_as_paid - (doc, method) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.payment_request.payment_request.resend_payment_email
-
- - - erpnext.accounts.doctype.payment_request.payment_request.resend_payment_email - (docname) -
-No docs
-Table Name: tabPayment Schedule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -payment_term |
- - Link | -- Payment Term - - | -- - - - -Payment Term - - - - | -
| 2 | -description |
- - Small Text | -- Description - - | -- |
| 3 | -due_date |
- - Date | -- Due Date - - | -- |
| 4 | -invoice_portion |
- - Percent | -- Invoice Portion - - | -- |
| 5 | -payment_amount |
- - Currency | -- Payment Amount - - | -
- currency- |
-
| 6 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
Table Name: tabPayment Term
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -payment_term_name |
- - Data | -- Payment Term Name - - | -- |
| 2 | -invoice_portion |
- - Float | -- Invoice Portion - - | -- |
| 3 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -due_date_based_on |
- - Select | -- Due Date Based On - - | -
- Day(s) after invoice date -Day(s) after the end of the invoice month -Month(s) after the end of the invoice month- |
-
| 6 | -credit_days |
- - Int | -- Credit Days - - | -- |
| 7 | -credit_months |
- - Int | -- Credit Months - - | -- |
| 8 | -section_break_6 |
- - Section Break | -- - - | -- |
| 9 | -description |
- - Small Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabPayment Terms Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -template_name |
- - Data | -- Template Name - - | -- |
| 2 | -terms |
- - Table | -- Payment Terms - - | -- - - - -Payment Terms Template Detail - - - - | -
Inherits from frappe.model.document.Document - -
- - - check_duplicate_terms - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_credit_days - (self) -
-No docs
-- - - validate_invoice_portion - (self) -
-No docs
-Table Name: tabPayment Terms Template Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -payment_term |
- - Link | -- Payment Term - - | -- - - - -Payment Term - - - - | -
| 2 | -description |
- - Small Text | -- Description - - | -- |
| 3 | -invoice_portion |
- - Percent | -- Invoice Portion - - | -- |
| 4 | -due_date_based_on |
- - Select | -- Due Date Based On - - | -
- Day(s) after invoice date -Day(s) after the end of the invoice month -Month(s) after the end of the invoice month- |
-
| 5 | -credit_days |
- - Int | -- Credit Days - - | -- |
| 6 | -credit_months |
- - Int | -- Credit Months - - | -- |
| 7 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
Table Name: tabPeriod Closing Voucher
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -transaction_date |
- - Date | -- Transaction Date - - | -- |
| 2 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 3 | -fiscal_year |
- - Link | -- Closing Fiscal Year - - | -- - - - -Fiscal Year - - - - | -
| 4 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Period Closing Voucher - - - - | -
| 5 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 6 | -column_break1 |
- - Column Break | -- - - | -- |
| 7 | -closing_account_head |
- - Link | -
- Closing Account Head
- - The account head under Liability or Equity, in which Profit/Loss will be booked - |
- - - - - -Account - - - - | -
| 8 | -remarks |
- - Small Text | -- Remarks - - | -- |
Inherits from erpnext.controllers.accounts_controller.AccountsController - -
- - - get_pl_balances - (self) -
-Get balance for pl accounts
-- - - make_gl_entries - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_account_head - (self) -
-No docs
-- - - validate_posting_date - (self) -
-No docs
-Table Name: tabPOS Customer Group
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
Table Name: tabPOS Item Group
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
Table Name: tabPOS Profile
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -disabled |
- - Check | -- Disabled - - | -- |
| 2 | -section_break_2 |
- - Section Break | -- - - | -- |
| 3 | -pos_profile_name |
- - Data | -- POS Profile Name - - | -- |
| 4 | -naming_series |
- - Select | -- Series - - | -
- [Select]- |
-
| 5 | -update_stock |
- - Check | -- Update Stock - - | -- |
| 6 | -ignore_pricing_rule |
- - Check | -- Ignore Pricing Rule - - | -- |
| 7 | -allow_delete |
- - Check | -- Allow Delete - - | -- |
| 8 | -allow_user_to_edit_rate |
- - Check | -- Allow user to edit Rate - - | -- |
| 9 | -allow_user_to_edit_discount |
- - Check | -- Allow user to edit Discount - - | -- |
| 10 | -allow_print_before_pay |
- - Check | -- Allow Print Before Pay - - | -- |
| 11 | -column_break_4 |
- - Column Break | -- - - | -- |
| 12 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 13 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 14 | -country |
- - Read Only | -- Country - - | -- |
| 15 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 16 | -campaign |
- - Link | -- Campaign - - | -- - - - -Campaign - - - - | -
| 17 | -section_break_15 |
- - Section Break | -- Applicable for Users - - | -- |
| 18 | -applicable_for_users |
- - Table | -- Applicable for Users - - | -- - - - -POS Profile User - - - - | -
| 19 | -section_break_11 |
- - Section Break | -- - - | -- |
| 20 | -payments |
- - Table | -- Sales Invoice Payment - - | -- - - - -Sales Invoice Payment - - - - | -
| 21 | -section_break_14 |
- - Section Break | -- - - | -- |
| 22 | -item_groups |
- - Table | -- Item Groups - - | -- - - - -POS Item Group - - - - | -
| 23 | -column_break_16 |
- - Column Break | -- - - | -- |
| 24 | -customer_groups |
- - Table | -- Customer Groups - - | -- - - - -POS Customer Group - - - - | -
| 25 | -section_break_16 |
- - Section Break | -- - - | -- |
| 26 | -print_format_for_online |
- - Link | -- Print Format for Online - - | -- - - - -Print Format - - - - | -
| 27 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 28 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 29 | -column_break0 |
- - Column Break | -- - - | -- |
| 30 | -selling_price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 31 | -tc_name |
- - Link | -- Terms and Conditions - - | -- - - - -Terms and Conditions - - - - | -
| 32 | -apply_discount |
- - Check | -- Apply Discount - - | -- |
| 33 | -apply_discount_on |
- - Select | -- Apply Discount On - - | -
- Grand Total -Net Total- |
-
| 34 | -offline_pos_section |
- - Section Break | -- Offline POS Section - - | -- |
| 35 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 36 | -column_break_31 |
- - Column Break | -- - - | -- |
| 37 | -print_format |
- - Link | -- Print Format - - | -- - - - -Print Format - - - - | -
| 38 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 39 | -section_break_19 |
- - Section Break | -- Accounting - - | -- |
| 40 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 41 | -write_off_account |
- - Link | -- Write Off Account - - | -- - - - -Account - - - - | -
| 42 | -write_off_cost_center |
- - Link | -- Write Off Cost Center - - | -- - - - -Cost Center - - - - | -
| 43 | -account_for_change_amount |
- - Link | -- Account for Change Amount - - | -- - - - -Account - - - - | -
| 44 | -column_break_23 |
- - Column Break | -- - - | -- |
| 45 | -income_account |
- - Link | -- Income Account - - | -- - - - -Account - - - - | -
| 46 | -expense_account |
- - Link | -- Expense Account - - | -- - - - -Account - - - - | -
| 47 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 48 | -taxes_and_charges |
- - Link | -- Taxes and Charges - - | -- - - - -Sales Taxes and Charges Template - - - - | -
Inherits from frappe.model.document.Document - -
- - - before_save - (self) -
-No docs
-- - - check_default_payment - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - set_defaults - (self, include_current_pos=True) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_all_link_fields - (self) -
-No docs
-- - - validate_customer_territory_group - (self) -
-No docs
-- - - validate_default_profile - (self) -
-No docs
-- - - validate_duplicate_groups - (self) -
-No docs
-- - - erpnext.accounts.doctype.pos_profile.pos_profile.get_item_groups - (pos_profile) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.pos_profile.pos_profile.get_series
-
- - - erpnext.accounts.doctype.pos_profile.pos_profile.get_series - () -
-No docs
-- - - erpnext.accounts.doctype.pos_profile.pos_profile.pos_profile_query - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.pos_profile.pos_profile.set_default_profile
-
- - - erpnext.accounts.doctype.pos_profile.pos_profile.set_default_profile - (pos_profile, company) -
-No docs
-Table Name: tabPOS Profile User
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -default |
- - Check | -- Default - - | -- |
| 2 | -user |
- - Link | -- User - - | -- - - - -User - - - - | -
Inherits from frappe.model.document.Document - -
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -use_pos_in_offline_mode |
- - Check | -- Use POS in Offline Mode - - | -- |
Inherits from frappe.model.document.Document - -
- - - set_link_for_pos - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabPricing Rule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -applicability_section |
- - Section Break | -- - - | -- |
| 2 | -title |
- - Data | -- Title - - | -- |
| 3 | -apply_on |
- - Select | -- Apply On - - | -
- -Item Code -Item Group -Brand- |
-
| 4 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 5 | -brand |
- - Link | -- Brand - - | -- - - - -Brand - - - - | -
| 6 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 7 | -column_break_7 |
- - Column Break | -- - - | -- |
| 8 | -priority |
- - Select | -
- Priority
- - Higher the number, higher the priority - |
-
- -1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20- |
-
| 9 | -disable |
- - Check | -- Disable - - | -- |
| 10 | -section_break_7 |
- - Section Break | -- - - | -- |
| 11 | -selling |
- - Check | -- Selling - - | -- |
| 12 | -buying |
- - Check | -- Buying - - | -- |
| 13 | -column_break_11 |
- - Column Break | -- - - | -- |
| 14 | -applicable_for |
- - Select | -- Applicable For - - | -
- -Customer -Customer Group -Territory -Sales Partner -Campaign -Supplier -Supplier Group- |
-
| 15 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 16 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 17 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 18 | -sales_partner |
- - Link | -- Sales Partner - - | -- - - - -Sales Partner - - - - | -
| 19 | -campaign |
- - Link | -- Campaign - - | -- - - - -Campaign - - - - | -
| 20 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 21 | -supplier_group |
- - Link | -- Supplier Group - - | -- - - - -Supplier Group - - - - | -
| 22 | -section_break_19 |
- - Section Break | -- - - | -- |
| 23 | -min_qty |
- - Float | -- Min Qty - - | -- |
| 24 | -column_break_21 |
- - Column Break | -- - - | -- |
| 25 | -max_qty |
- - Float | -- Max Qty - - | -- |
| 26 | -section_break_23 |
- - Section Break | -- - - | -- |
| 27 | -valid_from |
- - Date | -- Valid From - - | -- |
| 28 | -valid_upto |
- - Date | -- Valid Upto - - | -- |
| 29 | -col_break1 |
- - Column Break | -- - - | -- |
| 30 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 31 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 32 | -margin |
- - Section Break | -- Margin - - | -- |
| 33 | -margin_type |
- - Select | -- Margin Type - - | -
- -Percentage -Amount- |
-
| 34 | -column_break_33 |
- - Column Break | -- - - | -- |
| 35 | -margin_rate_or_amount |
- - Float | -- Margin Rate or Amount - - | -- |
| 36 | -price_discount_section |
- - Section Break | -- - - | -- |
| 37 | -rate_or_discount |
- - Select | -- Rate or Discount - - | -
- -Rate -Discount Percentage- |
-
| 38 | -col_break2 |
- - Column Break | -- - - | -- |
| 39 | -rate |
- - Currency | -- Rate - - | -- |
| 40 | -discount_percentage |
- - Float | -- Discount on Price List Rate (%) - - | -- |
| 41 | -for_price_list |
- - Link | -- For Price List - - | -- - - - -Price List - - - - | -
| 42 | -help_section |
- - Section Break | -- - - | -
- Simple- |
-
| 43 | -pricing_rule_help |
- - HTML | -- Pricing Rule Help - - | -- |
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - cleanup_fields_value - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_applicable_for_selling_or_buying - (self) -
-No docs
-- - - validate_mandatory - (self) -
-No docs
-- - - validate_max_discount - (self) -
-No docs
-- - - validate_min_max_qty - (self) -
-No docs
-- - - validate_price_list_with_currency - (self) -
-No docs
-- - - validate_rate_or_discount - (self) -
-No docs
-- - - erpnext.accounts.doctype.pricing_rule.pricing_rule.apply_internal_priority - (pricing_rules, field_set, args) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.pricing_rule.pricing_rule.apply_pricing_rule
-
- - - erpnext.accounts.doctype.pricing_rule.pricing_rule.apply_pricing_rule - (args) -
- args = {
- "items": [{"doctype": "", "name": "", "item_code": "", "brand": "", "item_group": ""}, ...],
- "customer": "something",
- "customer_group": "something",
- "territory": "something",
- "supplier": "something",
- "supplier_group": "something",
- "currency": "something",
- "conversion_rate": "something",
- "price_list": "something",
- "plc_conversion_rate": "something",
- "company": "something",
- "transaction_date": "something",
- "campaign": "something",
- "sales_partner": "something",
- "ignore_pricing_rule": "something"
- }
-
-- - - erpnext.accounts.doctype.pricing_rule.pricing_rule.filter_pricing_rules - (args, pricing_rules) -
-No docs
-- - - erpnext.accounts.doctype.pricing_rule.pricing_rule.get_pricing_rule_for_item - (args) -
-No docs
-- - - erpnext.accounts.doctype.pricing_rule.pricing_rule.get_pricing_rules - (args) -
-No docs
-- - - erpnext.accounts.doctype.pricing_rule.pricing_rule.get_serial_no_for_item - (args) -
-No docs
-- - - erpnext.accounts.doctype.pricing_rule.pricing_rule.if_all_rules_same - (pricing_rules, fields) -
-No docs
-- - - erpnext.accounts.doctype.pricing_rule.pricing_rule.remove_pricing_rule_for_item - (pricing_rule, item_details) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.pricing_rule.pricing_rule.remove_pricing_rules
-
- - - erpnext.accounts.doctype.pricing_rule.pricing_rule.remove_pricing_rules - (item_list) -
-No docs
-- - - erpnext.accounts.doctype.pricing_rule.pricing_rule.set_transaction_type - (args) -
-No docs
-Table Name: tabPurchase Invoice
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -naming_series |
- - Select | -- Series - - | -
- PINV- -PINV-RET-- |
-
| 3 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 4 | -supplier_name |
- - Data | -- Supplier Name - - | -- |
| 5 | -tax_id |
- - Read Only | -- Tax Id - - | -- |
| 6 | -due_date |
- - Date | -- Due Date - - | -- |
| 7 | -is_paid |
- - Check | -- Is Paid - - | -- |
| 8 | -is_return |
- - Check | -- Is Return (Debit Note) - - | -- |
| 9 | -column_break1 |
- - Column Break | -- - - | -- |
| 10 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 11 | -posting_date |
- - Date | -- Date - - | -- |
| 12 | -posting_time |
- - Time | -- Posting Time - - | -- |
| 13 | -set_posting_time |
- - Check | -- Edit Posting Date and Time - - | -- |
| 14 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Purchase Invoice - - - - | -
| 15 | -sb_14 |
- - Section Break | -- Hold Invoice - - | -- |
| 16 | -on_hold |
- - Check | -- Hold Invoice - - | -- |
| 17 | -release_date |
- - Date | -
- Release Date
- - Once set, this invoice will be on hold till the set date - |
- - |
| 18 | -cb_17 |
- - Column Break | -- - - | -- |
| 19 | -hold_comment |
- - Small Text | -- Reason For Putting On Hold - - | -- |
| 20 | -supplier_invoice_details |
- - Section Break | -- Supplier Invoice Details - - | -- |
| 21 | -bill_no |
- - Data | -- Supplier Invoice No - - | -- |
| 22 | -column_break_15 |
- - Column Break | -- - - | -- |
| 23 | -bill_date |
- - Date | -- Supplier Invoice Date - - | -- |
| 24 | -returns |
- - Section Break | -- Returns - - | -- |
| 25 | -return_against |
- - Link | -- Return Against Purchase Invoice - - | -- - - - -Purchase Invoice - - - - | -
| 26 | -section_addresses |
- - Section Break | -- Address and Contact - - | -- |
| 27 | -supplier_address |
- - Link | -- Select Supplier Address - - | -- - - - -Address - - - - | -
| 28 | -address_display |
- - Small Text | -- Address - - | -- |
| 29 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 30 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 31 | -contact_mobile |
- - Small Text | -- Mobile No - - | -- |
| 32 | -contact_email |
- - Small Text | -- Contact Email - - | -- |
| 33 | -col_break_address |
- - Column Break | -- - - | -- |
| 34 | -shipping_address |
- - Link | -- Select Shipping Address - - | -- - - - -Address - - - - | -
| 35 | -shipping_address_display |
- - Small Text | -- Shipping Address - - | -- |
| 36 | -currency_and_price_list |
- - Section Break | -- Currency and Price List - - | -
- fa fa-tag- |
-
| 37 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 38 | -conversion_rate |
- - Float | -- Exchange Rate - - | -- |
| 39 | -column_break2 |
- - Column Break | -- - - | -- |
| 40 | -buying_price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 41 | -price_list_currency |
- - Link | -- Price List Currency - - | -- - - - -Currency - - - - | -
| 42 | -plc_conversion_rate |
- - Float | -- Price List Exchange Rate - - | -- |
| 43 | -ignore_pricing_rule |
- - Check | -- Ignore Pricing Rule - - | -- |
| 44 | -items_section |
- - Section Break | -- - - | -
- fa fa-shopping-cart- |
-
| 45 | -update_stock |
- - Check | -- Update Stock - - | -- |
| 46 | -items |
- - Table | -- Items - - | -- - - - -Purchase Invoice Item - - - - | -
| 47 | -section_break_26 |
- - Section Break | -- - - | -- |
| 48 | -total_qty |
- - Float | -- Total Quantity - - | -- |
| 49 | -base_total |
- - Currency | -- Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 50 | -base_net_total |
- - Currency | -- Net Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 51 | -column_break_28 |
- - Column Break | -- - - | -- |
| 52 | -total |
- - Currency | -- Total - - | -
- currency- |
-
| 53 | -net_total |
- - Currency | -- Net Total - - | -
- currency- |
-
| 54 | -total_net_weight |
- - Float | -- Total Net Weight - - | -- |
| 55 | -taxes_section |
- - Section Break | -- - - | -
- fa fa-money- |
-
| 56 | -taxes_and_charges |
- - Link | -- Taxes and Charges - - | -- - - - -Purchase Taxes and Charges Template - - - - | -
| 57 | -column_break_49 |
- - Column Break | -- - - | -- |
| 58 | -shipping_rule |
- - Link | -- Shipping Rule - - | -- - - - -Shipping Rule - - - - | -
| 59 | -section_break_51 |
- - Section Break | -- - - | -- |
| 60 | -taxes |
- - Table | -- Purchase Taxes and Charges - - | -- - - - -Purchase Taxes and Charges - - - - | -
| 61 | -sec_tax_breakup |
- - Section Break | -- Tax Breakup - - | -- |
| 62 | -other_charges_calculation |
- - Text | -- Taxes and Charges Calculation - - | -- |
| 63 | -totals |
- - Section Break | -- - - | -
- fa fa-money- |
-
| 64 | -base_taxes_and_charges_added |
- - Currency | -- Taxes and Charges Added (Company Currency) - - | -
- Company:company:default_currency- |
-
| 65 | -base_taxes_and_charges_deducted |
- - Currency | -- Taxes and Charges Deducted (Company Currency) - - | -
- Company:company:default_currency- |
-
| 66 | -base_total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges (Company Currency) - - | -
- Company:company:default_currency- |
-
| 67 | -column_break_40 |
- - Column Break | -- - - | -- |
| 68 | -taxes_and_charges_added |
- - Currency | -- Taxes and Charges Added - - | -
- currency- |
-
| 69 | -taxes_and_charges_deducted |
- - Currency | -- Taxes and Charges Deducted - - | -
- currency- |
-
| 70 | -total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges - - | -
- currency- |
-
| 71 | -section_break_44 |
- - Section Break | -- Additional Discount - - | -- |
| 72 | -apply_discount_on |
- - Select | -- Apply Additional Discount On - - | -
- -Grand Total -Net Total- |
-
| 73 | -base_discount_amount |
- - Currency | -- Additional Discount Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 74 | -column_break_46 |
- - Column Break | -- - - | -- |
| 75 | -additional_discount_percentage |
- - Float | -- Additional Discount Percentage - - | -- |
| 76 | -discount_amount |
- - Currency | -- Additional Discount Amount - - | -
- currency- |
-
| 77 | -section_break_49 |
- - Section Break | -- - - | -- |
| 78 | -base_grand_total |
- - Currency | -- Grand Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 79 | -base_rounding_adjustment |
- - Currency | -- Rounding Adjustment (Company Currency) - - | -
- Company:company:default_currency- |
-
| 80 | -base_rounded_total |
- - Currency | -- Rounded Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 81 | -base_in_words |
- - Data | -- In Words (Company Currency) - - | -- |
| 82 | -column_break8 |
- - Column Break | -- - - | -- |
| 83 | -grand_total |
- - Currency | -- Grand Total - - | -
- currency- |
-
| 84 | -rounding_adjustment |
- - Currency | -- Rounding Adjustment - - | -
- currency- |
-
| 85 | -rounded_total |
- - Currency | -- Rounded Total - - | -
- currency- |
-
| 86 | -in_words |
- - Data | -- In Words - - | -- |
| 87 | -total_advance |
- - Currency | -- Total Advance - - | -
- party_account_currency- |
-
| 88 | -outstanding_amount |
- - Currency | -- Outstanding Amount - - | -
- party_account_currency- |
-
| 89 | -disable_rounded_total |
- - Check | -- Disable Rounded Total - - | -- |
| 90 | -payments_section |
- - Section Break | -- Payments - - | -- |
| 91 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
| 92 | -cash_bank_account |
- - Link | -- Cash/Bank Account - - | -- - - - -Account - - - - | -
| 93 | -col_br_payments |
- - Column Break | -- - - | -- |
| 94 | -paid_amount |
- - Currency | -- Paid Amount - - | -
- currency- |
-
| 95 | -base_paid_amount |
- - Currency | -- Paid Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 96 | -write_off |
- - Section Break | -- Write Off - - | -- |
| 97 | -write_off_amount |
- - Currency | -- Write Off Amount - - | -
- currency- |
-
| 98 | -base_write_off_amount |
- - Currency | -- Write Off Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 99 | -column_break_61 |
- - Column Break | -- - - | -- |
| 100 | -write_off_account |
- - Link | -- Write Off Account - - | -- - - - -Account - - - - | -
| 101 | -write_off_cost_center |
- - Link | -- Write Off Cost Center - - | -- - - - -Cost Center - - - - | -
| 102 | -advances_section |
- - Section Break | -- Advance Payments - - | -
- fa fa-money- |
-
| 103 | -get_advances |
- - Button | -- Get Advances Paid - - | -- |
| 104 | -advances |
- - Table | -- Advances - - | -- - - - -Purchase Invoice Advance - - - - | -
| 105 | -payment_schedule_section |
- - Section Break | -- Payment Terms - - | -- |
| 106 | -payment_terms_template |
- - Link | -- Payment Terms Template - - | -- - - - -Payment Terms Template - - - - | -
| 107 | -payment_schedule |
- - Table | -- Payment Schedule - - | -- - - - -Payment Schedule - - - - | -
| 108 | -terms_section_break |
- - Section Break | -- Terms and Conditions - - | -
- fa fa-legal- |
-
| 109 | -tc_name |
- - Link | -- Terms - - | -- - - - -Terms and Conditions - - - - | -
| 110 | -terms |
- - Text Editor | -- Terms and Conditions1 - - | -- |
| 111 | -raw_materials_supplied |
- - Section Break | -- Raw Materials Supplied - - | -- |
| 112 | -is_subcontracted |
- - Select | -- Raw Materials Supplied - - | -
- No -Yes- |
-
| 113 | -supplier_warehouse |
- - Link | -- Supplier Warehouse - - | -- - - - -Warehouse - - - - | -
| 114 | -supplied_items |
- - Table | -- Supplied Items - - | -- - - - -Purchase Receipt Item Supplied - - - - | -
| 115 | -printing_settings |
- - Section Break | -- Printing Settings - - | -- |
| 116 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 117 | -group_same_items |
- - Check | -- Group same items - - | -- |
| 118 | -column_break_112 |
- - Column Break | -- - - | -- |
| 119 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 120 | -language |
- - Data | -- Print Language - - | -- |
| 121 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 122 | -credit_to |
- - Link | -- Credit To - - | -- - - - -Account - - - - | -
| 123 | -party_account_currency |
- - Link | -- Party Account Currency - - | -- - - - -Currency - - - - | -
| 124 | -is_opening |
- - Select | -- Is Opening - - | -
- No -Yes- |
-
| 125 | -against_expense_account |
- - Small Text | -- Against Expense Account - - | -- |
| 126 | -column_break_63 |
- - Column Break | -- - - | -- |
| 127 | -status |
- - Select | -- Status - - | -
- -Draft -Return -Debit Note Issued -Submitted -Paid -Unpaid -Overdue -Cancelled- |
-
| 128 | -inter_company_invoice_reference |
- - Link | -- Inter Company Invoice Reference - - | -- - - - -Sales Invoice - - - - | -
| 129 | -remarks |
- - Small Text | -- Remarks - - | -- |
| 130 | -rejected_warehouse |
- - Link | -
- Rejected Warehouse
- - Warehouse where you are maintaining stock of rejected items - |
- - - - - -Warehouse - - - - | -
| 131 | -subscription_section |
- - Section Break | -- Subscription Section - - | -- |
| 132 | -from_date |
- - Date | -
- From Date
- - Start date of current invoice's period - |
- - |
| 133 | -to_date |
- - Date | -
- To Date
- - End date of current invoice's period - |
- - |
| 134 | -column_break_114 |
- - Column Break | -- - - | -- |
| 135 | -auto_repeat |
- - Link | -- Auto Repeat - - | -- - - - -Auto Repeat - - - - | -
Inherits from erpnext.controllers.buying_controller.BuyingController - -
- - - __init__ - (self) -
-No docs
-- - - before_save - (self) -
-No docs
-- - - block_invoice - (self, hold_comment=None) -
-No docs
-- - - check_conversion_rate - (self) -
-No docs
-- - - check_for_closed_status - (self) -
-No docs
-- - - check_prev_docstatus - (self) -
-No docs
-- - - create_remarks - (self) -
-No docs
-- - - get_asset_gl_entry - (self, gl_entries) -
-No docs
-- - - get_gl_entries - (self, warehouse_account=None) -
-No docs
-- - - invoice_is_blocked - (self) -
-No docs
-- - - make_gl_entries - (self, gl_entries=None, repost_future_gle=True, from_repost=False) -
-No docs
-- - - make_gle_for_rounding_adjustment - (self, gl_entries) -
-No docs
-- - - make_item_gl_entries - (self, gl_entries) -
-No docs
-- - - make_payment_gl_entries - (self, gl_entries) -
-No docs
-- - - make_supplier_gl_entry - (self, gl_entries) -
-No docs
-- - - make_tax_gl_entries - (self, gl_entries) -
-No docs
-- - - make_write_off_gl_entry - (self, gl_entries) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_recurring - (self, reference_doc, auto_repeat_doc) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - po_required - (self) -
-No docs
-- - - pr_required - (self) -
-No docs
-- - - set_against_expense_account - (self) -
-No docs
-- - - set_expense_account - (self, for_validate=False) -
-No docs
-- - - set_missing_values - (self, for_validate=False) -
-No docs
-- - - set_tax_withholding - (self) -
-No docs
-- - - unblock_invoice - (self) -
-No docs
-- - - update_billing_status_in_pr - (self, update_modified=True) -
-No docs
-- - - update_project - (self) -
-No docs
-- - - update_status_updater_args - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_cash - (self) -
-No docs
-- - - validate_credit_to_acc - (self) -
-No docs
-- - - validate_item_code - (self) -
-No docs
-- - - validate_purchase_receipt_if_update_stock - (self) -
-No docs
-- - - validate_release_date - (self) -
-No docs
-- - - validate_supplier_invoice - (self) -
-No docs
-- - - validate_warehouse - (self) -
-No docs
-- - - validate_with_previous_doc - (self) -
-No docs
-- - - validate_write_off_account - (self) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.purchase_invoice.purchase_invoice.block_invoice
-
- - - erpnext.accounts.doctype.purchase_invoice.purchase_invoice.block_invoice - (name, hold_comment) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.purchase_invoice.purchase_invoice.change_release_date
-
- - - erpnext.accounts.doctype.purchase_invoice.purchase_invoice.change_release_date - (name, release_date=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.purchase_invoice.purchase_invoice.make_debit_note
-
- - - erpnext.accounts.doctype.purchase_invoice.purchase_invoice.make_debit_note - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.purchase_invoice.purchase_invoice.make_inter_company_sales_invoice
-
- - - erpnext.accounts.doctype.purchase_invoice.purchase_invoice.make_inter_company_sales_invoice - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.purchase_invoice.purchase_invoice.make_stock_entry
-
- - - erpnext.accounts.doctype.purchase_invoice.purchase_invoice.make_stock_entry - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.purchase_invoice.purchase_invoice.unblock_invoice
-
- - - erpnext.accounts.doctype.purchase_invoice.purchase_invoice.unblock_invoice - (name) -
-No docs
-Table Name: tabPurchase Invoice Advance
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -reference_type |
- - Link | -- Reference Type - - | -- - - - -DocType - - - - | -
| 2 | -reference_name |
- - Dynamic Link | -- Reference Name - - | -
- reference_type- |
-
| 3 | -remarks |
- - Text | -- Remarks - - | -- |
| 4 | -reference_row |
- - Data | -- Reference Row - - | -- |
| 5 | -col_break1 |
- - Column Break | -- - - | -- |
| 6 | -advance_amount |
- - Currency | -- Advance Amount - - | -
- party_account_currency- |
-
| 7 | -allocated_amount |
- - Currency | -- Allocated Amount - - | -
- party_account_currency- |
-
Table Name: tabPurchase Invoice Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 2 | -col_break1 |
- - Column Break | -- - - | -- |
| 3 | -item_name |
- - Data | -- Item Name - - | -- |
| 4 | -description_section |
- - Section Break | -- Description - - | -- |
| 5 | -description |
- - Text Editor | -- Description - - | -- |
| 6 | -image |
- - Attach | -- Image - - | -- |
| 7 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 8 | -quantity_and_rate |
- - Section Break | -- Quantity and Rate - - | -- |
| 9 | -received_qty |
- - Float | -- Received Qty - - | -- |
| 10 | -qty |
- - Float | -- Qty - - | -- |
| 11 | -rejected_qty |
- - Float | -- Rejected Qty - - | -- |
| 12 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 13 | -col_break2 |
- - Column Break | -- - - | -- |
| 14 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 15 | -conversion_factor |
- - Float | -- UOM Conversion Factor - - | -- |
| 16 | -stock_qty |
- - Float | -- Stock Qty - - | -- |
| 17 | -sec_break1 |
- - Section Break | -- - - | -- |
| 18 | -price_list_rate |
- - Currency | -- Price List Rate - - | -
- currency- |
-
| 19 | -discount_percentage |
- - Percent | -- Discount on Price List Rate (%) - - | -- |
| 20 | -col_break3 |
- - Column Break | -- - - | -- |
| 21 | -base_price_list_rate |
- - Currency | -- Price List Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 22 | -sec_break2 |
- - Section Break | -- - - | -- |
| 23 | -rate |
- - Currency | -- Rate - - | -
- currency- |
-
| 24 | -amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 25 | -col_break4 |
- - Column Break | -- - - | -- |
| 26 | -base_rate |
- - Currency | -- Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 27 | -base_amount |
- - Currency | -- Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 28 | -pricing_rule |
- - Link | -- Pricing Rule - - | -- - - - -Pricing Rule - - - - | -
| 29 | -section_break_22 |
- - Section Break | -- - - | -- |
| 30 | -net_rate |
- - Currency | -- Net Rate - - | -
- currency- |
-
| 31 | -net_amount |
- - Currency | -- Net Amount - - | -
- currency- |
-
| 32 | -column_break_25 |
- - Column Break | -- - - | -- |
| 33 | -base_net_rate |
- - Currency | -- Net Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 34 | -base_net_amount |
- - Currency | -- Net Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 35 | -item_weight_details |
- - Section Break | -- Item Weight Details - - | -- |
| 36 | -weight_per_unit |
- - Float | -- Weight Per Unit - - | -- |
| 37 | -total_weight |
- - Float | -- Total Weight - - | -- |
| 38 | -column_break_38 |
- - Column Break | -- - - | -- |
| 39 | -weight_uom |
- - Link | -- Weight UOM - - | -- - - - -UOM - - - - | -
| 40 | -warehouse_section |
- - Section Break | -- Warehouse - - | -- |
| 41 | -warehouse |
- - Link | -- Accepted Warehouse - - | -- - - - -Warehouse - - - - | -
| 42 | -rejected_warehouse |
- - Link | -- Rejected Warehouse - - | -- - - - -Warehouse - - - - | -
| 43 | -quality_inspection |
- - Link | -- Quality Inspection - - | -- - - - -Quality Inspection - - - - | -
| 44 | -batch_no |
- - Link | -- Batch No - - | -- - - - -Batch - - - - | -
| 45 | -col_br_wh |
- - Column Break | -- - - | -- |
| 46 | -serial_no |
- - Text | -- Serial No - - | -- |
| 47 | -rejected_serial_no |
- - Text | -- Rejected Serial No - - | -- |
| 48 | -accounting |
- - Section Break | -- Accounting - - | -- |
| 49 | -expense_account |
- - Link | -- Expense Head - - | -- - - - -Account - - - - | -
| 50 | -col_break5 |
- - Column Break | -- - - | -- |
| 51 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 52 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 53 | -reference |
- - Section Break | -- Reference - - | -- |
| 54 | -allow_zero_valuation_rate |
- - Check | -- Allow Zero Valuation Rate - - | -- |
| 55 | -brand |
- - Data | -- Brand - - | -- |
| 56 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 57 | -item_tax_rate |
- - Code | -
- Item Tax Rate
- - Tax detail table fetched from item master as a string and stored in this field. -Used for Taxes and Charges - |
- - |
| 58 | -item_tax_amount |
- - Currency | -- Item Tax Amount - - | -
- Company:company:default_currency- |
-
| 59 | -purchase_order |
- - Link | -- Purchase Order - - | -- - - - -Purchase Order - - - - | -
| 60 | -bom |
- - Link | -- BOM - - | -- - - - -BOM - - - - | -
| 61 | -include_exploded_items |
- - Check | -- Include Exploded Items - - | -- |
| 62 | -col_break6 |
- - Column Break | -- - - | -- |
| 63 | -is_fixed_asset |
- - Check | -- Is Fixed Asset - - | -- |
| 64 | -asset |
- - Link | -- Asset - - | -- - - - -Asset - - - - | -
| 65 | -asset_location |
- - Link | -- Asset Location - - | -- - - - -Location - - - - | -
| 66 | -po_detail |
- - Data | -- Purchase Order Item - - | -- |
| 67 | -purchase_receipt |
- - Link | -- Purchase Receipt - - | -- - - - -Purchase Receipt - - - - | -
| 68 | -page_break |
- - Check | -- Page Break - - | -- |
| 69 | -pr_detail |
- - Data | -- PR Detail - - | -- |
| 70 | -valuation_rate |
- - Currency | -- Valuation Rate - - | -
- Company:company:default_currency- |
-
| 71 | -rm_supp_cost |
- - Currency | -- Raw Materials Supplied Cost - - | -
- Company:company:default_currency- |
-
| 72 | -landed_cost_voucher_amount |
- - Currency | -- Landed Cost Voucher Amount - - | -- |
Table Name: tabPurchase Taxes and Charges
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -category |
- - Select | -- Consider Tax or Charge for - - | -
- Valuation and Total -Valuation -Total- |
-
| 2 | -add_deduct_tax |
- - Select | -- Add or Deduct - - | -
- Add -Deduct- |
-
| 3 | -charge_type |
- - Select | -- Type - - | -
- -Actual -On Net Total -On Previous Row Amount -On Previous Row Total- |
-
| 4 | -row_id |
- - Data | -- Reference Row # - - | -- |
| 5 | -included_in_print_rate |
- - Check | -
- Is this Tax included in Basic Rate?
- - If checked, the tax amount will be considered as already included in the Print Rate / Print Amount - |
- - |
| 6 | -col_break1 |
- - Column Break | -- - - | -- |
| 7 | -account_head |
- - Link | -- Account Head - - | -- - - - -Account - - - - | -
| 8 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 9 | -description |
- - Small Text | -- Description - - | -- |
| 10 | -section_break_10 |
- - Section Break | -- - - | -- |
| 11 | -rate |
- - Float | -- Rate - - | -- |
| 12 | -section_break_9 |
- - Section Break | -- - - | -- |
| 13 | -tax_amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 14 | -tax_amount_after_discount_amount |
- - Currency | -- Tax Amount After Discount Amount - - | -
- currency- |
-
| 15 | -total |
- - Currency | -- Total - - | -
- currency- |
-
| 16 | -column_break_14 |
- - Column Break | -- - - | -- |
| 17 | -base_tax_amount |
- - Currency | -- Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 18 | -base_total |
- - Currency | -- Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 19 | -base_tax_amount_after_discount_amount |
- - Currency | -- Tax Amount After Discount Amount - - | -
- Company:company:default_currency- |
-
| 20 | -item_wise_tax_detail |
- - Code | -- Item Wise Tax Detail - - | -- |
| 21 | -parenttype |
- - Data | -- Parenttype - - | -- |
Table Name: tabPurchase Taxes and Charges Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -is_default |
- - Check | -- Default - - | -- |
| 3 | -disabled |
- - Check | -- Disabled - - | -- |
| 4 | -column_break4 |
- - Column Break | -- - - | -- |
| 5 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 6 | -section_break6 |
- - Section Break | -- - - | -- |
| 7 | -taxes |
- - Table | -- Purchase Taxes and Charges - - | -- - - - -Purchase Taxes and Charges - - - - | -
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabSalary Component Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -default_account |
- - Link | -
- Default Account
- - Default Bank / Cash account will be automatically updated in Salary Journal Entry when this mode is selected. - |
- - - - - -Account - - - - | -
Table Name: tabSales Invoice
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -customer_section |
- - Section Break | -- - - | -
- fa fa-user- |
-
| 2 | -title |
- - Data | -- Title - - | -- |
| 3 | -naming_series |
- - Select | -- Series - - | -
- SINV- -SINV-RET-- |
-
| 4 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 5 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 6 | -tax_id |
- - Data | -- Tax Id - - | -- |
| 7 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 8 | -is_pos |
- - Check | -- Include Payment (POS) - - | -- |
| 9 | -pos_profile |
- - Link | -- POS Profile - - | -- - - - -POS Profile - - - - | -
| 10 | -offline_pos_name |
- - Data | -- Offline POS Name - - | -- |
| 11 | -is_return |
- - Check | -- Is Return (Credit Note) - - | -- |
| 12 | -column_break1 |
- - Column Break | -- - - | -- |
| 13 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 14 | -posting_date |
- - Date | -- Date - - | -- |
| 15 | -posting_time |
- - Time | -- Posting Time - - | -- |
| 16 | -set_posting_time |
- - Check | -- Edit Posting Date and Time - - | -- |
| 17 | -due_date |
- - Date | -- Payment Due Date - - | -- |
| 18 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Sales Invoice - - - - | -
| 19 | -returns |
- - Section Break | -- Returns - - | -- |
| 20 | -return_against |
- - Link | -- Return Against Sales Invoice - - | -- - - - -Sales Invoice - - - - | -
| 21 | -customer_po_details |
- - Section Break | -- Customer PO Details - - | -- |
| 22 | -po_no |
- - Data | -- Customer's Purchase Order - - | -- |
| 23 | -column_break_23 |
- - Column Break | -- - - | -- |
| 24 | -po_date |
- - Date | -- Customer's Purchase Order Date - - | -- |
| 25 | -address_and_contact |
- - Section Break | -- Address and Contact - - | -- |
| 26 | -customer_address |
- - Link | -- Customer Address - - | -- - - - -Address - - - - | -
| 27 | -address_display |
- - Small Text | -- Address - - | -- |
| 28 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 29 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 30 | -contact_mobile |
- - Small Text | -- Mobile No - - | -- |
| 31 | -contact_email |
- - Data | -- Contact Email - - | -
- |
-
| 32 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 33 | -col_break4 |
- - Column Break | -- - - | -- |
| 34 | -shipping_address_name |
- - Link | -- Shipping Address Name - - | -- - - - -Address - - - - | -
| 35 | -shipping_address |
- - Small Text | -- Shipping Address - - | -- |
| 36 | -company_address |
- - Link | -- Company Address Name - - | -- - - - -Address - - - - | -
| 37 | -company_address_display |
- - Small Text | -- Company Address - - | -- |
| 38 | -currency_and_price_list |
- - Section Break | -- Currency and Price List - - | -- |
| 39 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 40 | -conversion_rate |
- - Float | -
- Exchange Rate
- - Rate at which Customer Currency is converted to customer's base currency - |
- - |
| 41 | -column_break2 |
- - Column Break | -- - - | -- |
| 42 | -selling_price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 43 | -price_list_currency |
- - Link | -- Price List Currency - - | -- - - - -Currency - - - - | -
| 44 | -plc_conversion_rate |
- - Float | -
- Price List Exchange Rate
- - Rate at which Price list currency is converted to customer's base currency - |
- - |
| 45 | -ignore_pricing_rule |
- - Check | -- Ignore Pricing Rule - - | -- |
| 46 | -items_section |
- - Section Break | -- - - | -
- fa fa-shopping-cart- |
-
| 47 | -update_stock |
- - Check | -- Update Stock - - | -- |
| 48 | -items |
- - Table | -- Items - - | -- - - - -Sales Invoice Item - - - - | -
| 49 | -packing_list |
- - Section Break | -- Packing List - - | -
- fa fa-suitcase- |
-
| 50 | -packed_items |
- - Table | -- Packed Items - - | -- - - - -Packed Item - - - - | -
| 51 | -product_bundle_help |
- - HTML | -- Product Bundle Help - - | -- |
| 52 | -time_sheet_list |
- - Section Break | -- Time Sheet List - - | -- |
| 53 | -timesheets |
- - Table | -- Time Sheets - - | -- - - - -Sales Invoice Timesheet - - - - | -
| 54 | -total_billing_amount |
- - Currency | -- Total Billing Amount - - | -- |
| 55 | -section_break_30 |
- - Section Break | -- - - | -- |
| 56 | -total_qty |
- - Float | -- Total Quantity - - | -- |
| 57 | -base_total |
- - Currency | -- Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 58 | -base_net_total |
- - Currency | -- Net Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 59 | -column_break_32 |
- - Column Break | -- - - | -- |
| 60 | -total |
- - Currency | -- Total - - | -
- currency- |
-
| 61 | -net_total |
- - Currency | -- Net Total - - | -
- currency- |
-
| 62 | -total_net_weight |
- - Float | -- Total Net Weight - - | -- |
| 63 | -taxes_section |
- - Section Break | -- - - | -
- fa fa-money- |
-
| 64 | -taxes_and_charges |
- - Link | -- Taxes and Charges - - | -- - - - -Sales Taxes and Charges Template - - - - | -
| 65 | -column_break_38 |
- - Column Break | -- - - | -- |
| 66 | -shipping_rule |
- - Link | -- Shipping Rule - - | -- - - - -Shipping Rule - - - - | -
| 67 | -section_break_40 |
- - Section Break | -- - - | -- |
| 68 | -taxes |
- - Table | -- Sales Taxes and Charges - - | -- - - - -Sales Taxes and Charges - - - - | -
| 69 | -sec_tax_breakup |
- - Section Break | -- Tax Breakup - - | -- |
| 70 | -other_charges_calculation |
- - Text | -- Taxes and Charges Calculation - - | -- |
| 71 | -section_break_43 |
- - Section Break | -- - - | -- |
| 72 | -base_total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges (Company Currency) - - | -
- Company:company:default_currency- |
-
| 73 | -column_break_47 |
- - Column Break | -- - - | -- |
| 74 | -total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges - - | -
- currency- |
-
| 75 | -section_break_49 |
- - Section Break | -- Additional Discount - - | -- |
| 76 | -apply_discount_on |
- - Select | -- Apply Additional Discount On - - | -
- -Grand Total -Net Total- |
-
| 77 | -base_discount_amount |
- - Currency | -- Additional Discount Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 78 | -column_break_51 |
- - Column Break | -- - - | -- |
| 79 | -additional_discount_percentage |
- - Float | -- Additional Discount Percentage - - | -- |
| 80 | -discount_amount |
- - Currency | -- Additional Discount Amount - - | -
- currency- |
-
| 81 | -totals |
- - Section Break | -- - - | -
- fa fa-money- |
-
| 82 | -base_grand_total |
- - Currency | -- Grand Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 83 | -base_rounding_adjustment |
- - Currency | -- Rounding Adjustment (Company Currency) - - | -
- Company:company:default_currency- |
-
| 84 | -base_rounded_total |
- - Currency | -- Rounded Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 85 | -base_in_words |
- - Data | -
- In Words (Company Currency)
- - In Words will be visible once you save the Sales Invoice. - |
- - |
| 86 | -column_break5 |
- - Column Break | -- - - | -- |
| 87 | -grand_total |
- - Currency | -- Grand Total - - | -
- currency- |
-
| 88 | -rounding_adjustment |
- - Currency | -- Rounding Adjustment - - | -
- currency- |
-
| 89 | -rounded_total |
- - Currency | -- Rounded Total - - | -
- currency- |
-
| 90 | -in_words |
- - Data | -- In Words - - | -- |
| 91 | -total_advance |
- - Currency | -- Total Advance - - | -
- party_account_currency- |
-
| 92 | -outstanding_amount |
- - Currency | -- Outstanding Amount - - | -
- party_account_currency- |
-
| 93 | -advances_section |
- - Section Break | -- Advance Payments - - | -
- fa fa-money- |
-
| 94 | -get_advances |
- - Button | -- Get Advances Received - - | -- |
| 95 | -advances |
- - Table | -- Advances - - | -- - - - -Sales Invoice Advance - - - - | -
| 96 | -payment_schedule_section |
- - Section Break | -- Payment Terms - - | -- |
| 97 | -payment_terms_template |
- - Link | -- Payment Terms Template - - | -- - - - -Payment Terms Template - - - - | -
| 98 | -payment_schedule |
- - Table | -- Payment Schedule - - | -- - - - -Payment Schedule - - - - | -
| 99 | -payments_section |
- - Section Break | -- Payments - - | -
- fa fa-money- |
-
| 100 | -cash_bank_account |
- - Link | -- Cash/Bank Account - - | -- - - - -Account - - - - | -
| 101 | -payments |
- - Table | -- Sales Invoice Payment - - | -- - - - -Sales Invoice Payment - - - - | -
| 102 | -section_break_84 |
- - Section Break | -- - - | -- |
| 103 | -base_paid_amount |
- - Currency | -- Paid Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 104 | -column_break_86 |
- - Column Break | -- - - | -- |
| 105 | -paid_amount |
- - Currency | -- Paid Amount - - | -
- currency- |
-
| 106 | -section_break_88 |
- - Section Break | -- - - | -- |
| 107 | -base_change_amount |
- - Currency | -- Base Change Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 108 | -column_break_90 |
- - Column Break | -- - - | -- |
| 109 | -change_amount |
- - Currency | -- Change Amount - - | -
- currency- |
-
| 110 | -account_for_change_amount |
- - Link | -- Account for Change Amount - - | -- - - - -Account - - - - | -
| 111 | -column_break4 |
- - Section Break | -- Write Off - - | -- |
| 112 | -write_off_amount |
- - Currency | -- Write Off Amount - - | -
- currency- |
-
| 113 | -base_write_off_amount |
- - Currency | -- Write Off Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 114 | -write_off_outstanding_amount_automatically |
- - Check | -- Write Off Outstanding Amount - - | -- |
| 115 | -column_break_74 |
- - Column Break | -- - - | -- |
| 116 | -write_off_account |
- - Link | -- Write Off Account - - | -- - - - -Account - - - - | -
| 117 | -write_off_cost_center |
- - Link | -- Write Off Cost Center - - | -- - - - -Cost Center - - - - | -
| 118 | -terms_section_break |
- - Section Break | -- Terms - - | -- |
| 119 | -tc_name |
- - Link | -- Terms - - | -- - - - -Terms and Conditions - - - - | -
| 120 | -terms |
- - Text Editor | -- Terms and Conditions Details - - | -- |
| 121 | -edit_printing_settings |
- - Section Break | -- Printing Settings - - | -- |
| 122 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 123 | -language |
- - Data | -- Print Language - - | -- |
| 124 | -column_break_84 |
- - Column Break | -- - - | -- |
| 125 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 126 | -more_information |
- - Section Break | -- More Information - - | -- |
| 127 | -inter_company_invoice_reference |
- - Link | -- Inter Company Invoice Reference - - | -- - - - -Purchase Invoice - - - - | -
| 128 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 129 | -campaign |
- - Link | -- Campaign - - | -- - - - -Campaign - - - - | -
| 130 | -col_break23 |
- - Column Break | -- - - | -- |
| 131 | -status |
- - Select | -- Status - - | -
- -Draft -Return -Credit Note Issued -Submitted -Paid -Unpaid -Overdue -Cancelled- |
-
| 132 | -source |
- - Link | -- Source - - | -- - - - -Lead Source - - - - | -
| 133 | -more_info |
- - Section Break | -- Accounting Details - - | -
- fa fa-file-text- |
-
| 134 | -debit_to |
- - Link | -- Debit To - - | -- - - - -Account - - - - | -
| 135 | -party_account_currency |
- - Link | -- Party Account Currency - - | -- - - - -Currency - - - - | -
| 136 | -is_opening |
- - Select | -- Is Opening Entry - - | -
- No -Yes- |
-
| 137 | -c_form_applicable |
- - Select | -- C-Form Applicable - - | -
- No -Yes- |
-
| 138 | -c_form_no |
- - Link | -- C-Form No - - | -- - - - -C-Form - - - - | -
| 139 | -column_break8 |
- - Column Break | -- - - | -- |
| 140 | -remarks |
- - Small Text | -- Remarks - - | -- |
| 141 | -sales_team_section_break |
- - Section Break | -- Commission - - | -
- fa fa-group- |
-
| 142 | -sales_partner |
- - Link | -- Sales Partner - - | -- - - - -Sales Partner - - - - | -
| 143 | -column_break10 |
- - Column Break | -- - - | -- |
| 144 | -commission_rate |
- - Float | -- Commission Rate (%) - - | -- |
| 145 | -total_commission |
- - Currency | -- Total Commission - - | -
- Company:company:default_currency- |
-
| 146 | -section_break2 |
- - Section Break | -- Sales Team - - | -- |
| 147 | -sales_team |
- - Table | -- Sales Team1 - - | -- - - - -Sales Team - - - - | -
| 148 | -subscription_section |
- - Section Break | -- Subscription Section - - | -- |
| 149 | -from_date |
- - Date | -- From Date - - | -- |
| 150 | -to_date |
- - Date | -- To Date - - | -- |
| 151 | -column_break_140 |
- - Column Break | -- - - | -- |
| 152 | -auto_repeat |
- - Link | -- Auto Repeat - - | -- - - - -Auto Repeat - - - - | -
| 153 | -against_income_account |
- - Small Text | -- Against Income Account - - | -- |
| 154 | -pos_total_qty |
- - Float | -- Total Qty - - | -- |
Inherits from erpnext.controllers.selling_controller.SellingController - -
- - - __init__ - (self) -
-No docs
-- - - add_remarks - (self) -
-No docs
-- - - add_timesheet_data - (self) -
-No docs
-- - - before_cancel - (self) -
-No docs
-- - - before_save - (self) -
-No docs
-- - - book_income_for_deferred_revenue - (self) -
-No docs
-- - - calculate_billing_amount_for_timesheet - (self) -
-No docs
-- - - check_credit_limit - (self) -
-No docs
-- - - check_prev_docstatus - (self) -
-No docs
-- - - clear_unallocated_mode_of_payments - (self) -
-No docs
-- - - get_company_abbr - (self) -
-No docs
-- - - get_gl_entries - (self, warehouse_account=None) -
-No docs
-- - - get_warehouse - (self) -
-No docs
-- - - make_customer_gl_entry - (self, gl_entries) -
-No docs
-- - - make_gl_entries - (self, gl_entries=None, repost_future_gle=True, from_repost=False) -
-No docs
-- - - make_gle_for_change_amount - (self, gl_entries) -
-No docs
-- - - make_gle_for_rounding_adjustment - (self, gl_entries) -
-No docs
-- - - make_item_gl_entries - (self, gl_entries) -
-No docs
-- - - make_pos_gl_entries - (self, gl_entries) -
-No docs
-- - - make_tax_gl_entries - (self, gl_entries) -
-No docs
-- - - make_write_off_gl_entry - (self, gl_entries) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_recurring - (self, reference_doc, auto_repeat_doc) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - set_against_income_account - (self) -
-Set against account for debit to account
-- - - set_billing_hours_and_amount - (self) -
-No docs
-- - - set_income_account_for_fixed_assets - (self) -
-No docs
-- - - set_indicator - (self) -
-Set indicator for portal
-- - - set_missing_values - (self, for_validate=False) -
-No docs
-- - - set_paid_amount - (self) -
-No docs
-- - - set_pos_fields - (self, for_validate=False) -
-Set retail related fields from POS Profiles
-- - - set_serial_no_against_delivery_note - (self) -
-No docs
-- - - so_dn_required - (self) -
-check in manage account if sales order / delivery note required or not.
-- - - update_billing_status_in_dn - (self, update_modified=True) -
-No docs
-- - - update_current_stock - (self) -
-No docs
-- - - update_packing_list - (self) -
-No docs
-- - - update_project - (self) -
-No docs
-- - - update_serial_no - (self, in_cancel=False) -
-update Sales Invoice refrence in Serial No
-- - - update_status_updater_args - (self) -
-No docs
-- - - update_time_sheet - (self, sales_invoice) -
-No docs
-- - - update_time_sheet_detail - (self, timesheet, args, sales_invoice) -
-No docs
-- - - update_timesheet_billing_for_project - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_account_for_change_amount - (self) -
-No docs
-- - - validate_auto_set_posting_time - (self) -
-No docs
-- - - validate_c_form - (self) -
-Blank C-form no if C-form applicable marked as 'No'
-- - - validate_c_form_on_cancel - (self) -
-Display message if C-Form no exists on cancellation of Sales Invoice
-- - - validate_debit_to_acc - (self) -
-No docs
-- - - validate_delivery_note - (self) -
-No docs
-- - - validate_dropship_item - (self) -
-No docs
-- - - validate_item_code - (self) -
-No docs
-- - - validate_pos - (self) -
-No docs
-- - - validate_pos_paid_amount - (self) -
-No docs
-- - - validate_proj_cust - (self) -
-check for does customer belong to same project as entered..
-- - - validate_serial_against_delivery_note - (self) -
- validate if the serial numbers in Sales Invoice Items are same as in
- Delivery Note Item
-
-- - - validate_serial_against_sales_invoice - (self) -
-check if serial number is already used in other sales invoice
-- - - validate_serial_numbers - (self) -
- validate serial number agains Delivery Note and Sales Invoice
-
-- - - validate_time_sheets_are_submitted - (self) -
-No docs
-- - - validate_warehouse - (self) -
-No docs
-- - - validate_with_previous_doc - (self) -
-No docs
-- - - validate_write_off_account - (self) -
-No docs
-- - - verify_payment_amount_is_positive - (self) -
-No docs
-- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.booked_deferred_revenue - () -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.sales_invoice.sales_invoice.get_bank_cash_account
-
- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.get_bank_cash_account - (mode_of_payment, company) -
-No docs
-- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.get_inter_company_details - (doc, doctype) -
-No docs
-- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.get_list_context - (context=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.sales_invoice.sales_invoice.make_delivery_note
-
- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.make_delivery_note - (source_name, target_doc=None) -
-No docs
-- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.make_inter_company_invoice - (doctype, source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.sales_invoice.sales_invoice.make_inter_company_purchase_invoice
-
- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.make_inter_company_purchase_invoice - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.sales_invoice.sales_invoice.make_sales_return
-
- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.make_sales_return - (source_name, target_doc=None) -
-No docs
-- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.set_account_for_mode_of_payment - (self) -
-No docs
-- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.unlink_inter_company_invoice - (doctype, name, inter_company_invoice_reference) -
-No docs
-- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.update_linked_invoice - (doctype, name, inter_company_invoice_reference) -
-No docs
-- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.validate_inter_company_invoice - (doc, doctype) -
-No docs
-- - - erpnext.accounts.doctype.sales_invoice.sales_invoice.validate_inter_company_party - (doctype, party, company, inter_company_invoice_reference) -
-No docs
-Table Name: tabSales Invoice Advance
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -reference_type |
- - Link | -- Reference Type - - | -- - - - -DocType - - - - | -
| 2 | -reference_name |
- - Dynamic Link | -- Reference Name - - | -
- reference_type- |
-
| 3 | -remarks |
- - Text | -- Remarks - - | -- |
| 4 | -reference_row |
- - Data | -- Reference Row - - | -- |
| 5 | -col_break1 |
- - Column Break | -- - - | -- |
| 6 | -advance_amount |
- - Currency | -- Advance amount - - | -
- party_account_currency- |
-
| 7 | -allocated_amount |
- - Currency | -- Allocated amount - - | -
- party_account_currency- |
-
Table Name: tabSales Invoice Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -barcode |
- - Data | -- Barcode - - | -- |
| 2 | -item_code |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 3 | -col_break1 |
- - Column Break | -- - - | -- |
| 4 | -item_name |
- - Data | -- Item Name - - | -- |
| 5 | -customer_item_code |
- - Data | -- Customer's Item Code - - | -- |
| 6 | -section_break_6 |
- - Section Break | -- Edit Description - - | -- |
| 7 | -description |
- - Text Editor | -- Description - - | -- |
| 8 | -column_break_8 |
- - Column Break | -- - - | -- |
| 9 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 10 | -image |
- - Attach | -- Image - - | -- |
| 11 | -quantity_and_rate |
- - Section Break | -- - - | -- |
| 12 | -qty |
- - Float | -- Quantity - - | -- |
| 13 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 14 | -col_break2 |
- - Column Break | -- - - | -- |
| 15 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 16 | -conversion_factor |
- - Float | -- UOM Conversion Factor - - | -- |
| 17 | -stock_qty |
- - Float | -- Qty as per Stock UOM - - | -- |
| 18 | -section_break_17 |
- - Section Break | -- - - | -- |
| 19 | -price_list_rate |
- - Currency | -- Price List Rate - - | -
- currency- |
-
| 20 | -base_price_list_rate |
- - Currency | -- Price List Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 21 | -discount_and_margin |
- - Section Break | -- Discount and Margin - - | -- |
| 22 | -margin_type |
- - Select | -- Margin Type - - | -
- -Percentage -Amount- |
-
| 23 | -margin_rate_or_amount |
- - Float | -- Margin Rate or Amount - - | -- |
| 24 | -rate_with_margin |
- - Currency | -- Rate With Margin - - | -
- currency- |
-
| 25 | -column_break_19 |
- - Column Break | -- - - | -- |
| 26 | -discount_percentage |
- - Percent | -- Discount (%) on Price List Rate with Margin - - | -- |
| 27 | -base_rate_with_margin |
- - Currency | -- Rate With Margin (Company Currency) - - | -
- Company:company:default_currency- |
-
| 28 | -section_break1 |
- - Section Break | -- - - | -- |
| 29 | -rate |
- - Currency | -- Rate - - | -
- currency- |
-
| 30 | -amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 31 | -col_break3 |
- - Column Break | -- - - | -- |
| 32 | -base_rate |
- - Currency | -- Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 33 | -base_amount |
- - Currency | -- Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 34 | -pricing_rule |
- - Link | -- Pricing Rule - - | -- - - - -Pricing Rule - - - - | -
| 35 | -section_break_21 |
- - Section Break | -- - - | -- |
| 36 | -net_rate |
- - Currency | -- Net Rate - - | -
- currency- |
-
| 37 | -net_amount |
- - Currency | -- Net Amount - - | -
- currency- |
-
| 38 | -column_break_24 |
- - Column Break | -- - - | -- |
| 39 | -base_net_rate |
- - Currency | -- Net Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 40 | -base_net_amount |
- - Currency | -- Net Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 41 | -drop_ship |
- - Section Break | -- Drop Ship - - | -- |
| 42 | -delivered_by_supplier |
- - Check | -- Delivered By Supplier - - | -- |
| 43 | -accounting |
- - Section Break | -- Accounting Details - - | -- |
| 44 | -income_account |
- - Link | -- Income Account - - | -- - - - -Account - - - - | -
| 45 | -expense_account |
- - Link | -- Expense Account - - | -- - - - -Account - - - - | -
| 46 | -col_break4 |
- - Column Break | -- - - | -- |
| 47 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 48 | -deferred_revenue |
- - Section Break | -- Deferred Revenue - - | -- |
| 49 | -enable_deferred_revenue |
- - Check | -- Enable Deferred Revenue - - | -- |
| 50 | -deferred_revenue_account |
- - Link | -- Deferred Revenue Account - - | -- - - - -Account - - - - | -
| 51 | -column_break_50 |
- - Column Break | -- - - | -- |
| 52 | -service_start_date |
- - Date | -- Service Start Date - - | -- |
| 53 | -service_end_date |
- - Date | -- Service End Date - - | -- |
| 54 | -section_break_18 |
- - Section Break | -- Item Weight Details - - | -- |
| 55 | -weight_per_unit |
- - Float | -- Weight Per Unit - - | -- |
| 56 | -total_weight |
- - Float | -- Total Weight - - | -- |
| 57 | -column_break_21 |
- - Column Break | -- - - | -- |
| 58 | -weight_uom |
- - Link | -- Weight UOM - - | -- - - - -UOM - - - - | -
| 59 | -warehouse_and_reference |
- - Section Break | -- Stock Details - - | -- |
| 60 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 61 | -target_warehouse |
- - Link | -- Customer Warehouse (Optional) - - | -- - - - -Warehouse - - - - | -
| 62 | -quality_inspection |
- - Link | -- Quality Inspection - - | -- - - - -Quality Inspection - - - - | -
| 63 | -batch_no |
- - Link | -- Batch No - - | -- - - - -Batch - - - - | -
| 64 | -col_break5 |
- - Column Break | -- - - | -- |
| 65 | -allow_zero_valuation_rate |
- - Check | -- Allow Zero Valuation Rate - - | -- |
| 66 | -serial_no |
- - Small Text | -- Serial No - - | -- |
| 67 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 68 | -brand |
- - Data | -- Brand Name - - | -- |
| 69 | -item_tax_rate |
- - Small Text | -- Item Tax Rate - - | -- |
| 70 | -actual_batch_qty |
- - Float | -- Available Batch Qty at Warehouse - - | -- |
| 71 | -actual_qty |
- - Float | -- Available Qty at Warehouse - - | -- |
| 72 | -edit_references |
- - Section Break | -- References - - | -- |
| 73 | -sales_order |
- - Link | -- Sales Order - - | -- - - - -Sales Order - - - - | -
| 74 | -so_detail |
- - Data | -- Sales Order Item - - | -- |
| 75 | -column_break_74 |
- - Column Break | -- - - | -- |
| 76 | -delivery_note |
- - Link | -- Delivery Note - - | -- - - - -Delivery Note - - - - | -
| 77 | -dn_detail |
- - Data | -- Delivery Note Item - - | -- |
| 78 | -delivered_qty |
- - Float | -- Delivered Qty - - | -- |
| 79 | -is_fixed_asset |
- - Check | -- Is Fixed Asset - - | -- |
| 80 | -asset |
- - Link | -- Asset - - | -- - - - -Asset - - - - | -
| 81 | -section_break_54 |
- - Section Break | -- - - | -- |
| 82 | -page_break |
- - Check | -- Page Break - - | -- |
Table Name: tabSales Invoice Payment
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -default |
- - Check | -- Default - - | -- |
| 2 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
| 3 | -amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
| 6 | -type |
- - Read Only | -- Type - - | -- |
| 7 | -base_amount |
- - Currency | -- Base Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 8 | -clearance_date |
- - Date | -- Clearance Date - - | -- |
Table Name: tabSales Invoice Timesheet
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -time_sheet |
- - Link | -- Time Sheet - - | -- - - - -Timesheet - - - - | -
| 2 | -billing_hours |
- - Float | -- Billing Hours - - | -- |
| 3 | -billing_amount |
- - Currency | -- Billing Amount - - | -- |
| 4 | -timesheet_detail |
- - Data | -- Timesheet Detail - - | -- |
Table Name: tabSales Taxes and Charges
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -charge_type |
- - Select | -- Type - - | -
- -Actual -On Net Total -On Previous Row Amount -On Previous Row Total- |
-
| 2 | -row_id |
- - Data | -- Reference Row # - - | -- |
| 3 | -account_head |
- - Link | -- Account Head - - | -- - - - -Account - - - - | -
| 4 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 5 | -col_break_1 |
- - Column Break | -- - - | -- |
| 6 | -description |
- - Small Text | -- Description - - | -- |
| 7 | -included_in_print_rate |
- - Check | -
- Is this Tax included in Basic Rate?
- - If checked, the tax amount will be considered as already included in the Print Rate / Print Amount - |
- - |
| 8 | -section_break_8 |
- - Section Break | -- - - | -- |
| 9 | -rate |
- - Float | -- Rate - - | -- |
| 10 | -section_break_9 |
- - Section Break | -- - - | -- |
| 11 | -tax_amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 12 | -total |
- - Currency | -- Total - - | -
- currency- |
-
| 13 | -tax_amount_after_discount_amount |
- - Currency | -- Tax Amount After Discount Amount - - | -
- currency- |
-
| 14 | -column_break_13 |
- - Column Break | -- - - | -- |
| 15 | -base_tax_amount |
- - Currency | -- Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 16 | -base_total |
- - Currency | -- Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 17 | -base_tax_amount_after_discount_amount |
- - Currency | -- Tax Amount After Discount Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 18 | -item_wise_tax_detail |
- - Code | -- Item Wise Tax Detail - - | -- |
| 19 | -parenttype |
- - Data | -- Parenttype - - | -- |
Table Name: tabSales Taxes and Charges Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -is_default |
- - Check | -- Default - - | -- |
| 3 | -disabled |
- - Check | -- Disabled - - | -- |
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 6 | -section_break_5 |
- - Section Break | -- - - | -- |
| 7 | -taxes |
- - Table | -
- Sales Taxes and Charges
- - * Will be calculated in the transaction. - |
- - - - - -Sales Taxes and Charges - - - - | -
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - set_missing_values - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.accounts.doctype.sales_taxes_and_charges_template.sales_taxes_and_charges_template.valdiate_taxes_and_charges_template - (doc) -
-No docs
-- - - erpnext.accounts.doctype.sales_taxes_and_charges_template.sales_taxes_and_charges_template.validate_disabled - (doc) -
-No docs
-Table Name: tabShare Balance
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -share_type |
- - Link | -- Share Type - - | -- - - - -Share Type - - - - | -
| 2 | -from_no |
- - Int | -- From No - - | -- |
| 3 | -rate |
- - Int | -- Rate - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -no_of_shares |
- - Int | -- No of Shares - - | -- |
| 6 | -to_no |
- - Int | -- To No - - | -- |
| 7 | -amount |
- - Int | -- Amount - - | -- |
| 8 | -section_break_8 |
- - Section Break | -- - - | -- |
| 9 | -is_company |
- - Check | -- Is Company - - | -- |
| 10 | -current_state |
- - Select | -- Current State - - | -
- -Issued -Purchased- |
-
Table Name: tabShare Transfer
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -transfer_type |
- - Select | -- Transfer Type - - | -
- -Issue -Purchase -Transfer- |
-
| 2 | -column_break_1 |
- - Column Break | -- - - | -- |
| 3 | -date |
- - Date | -- Date - - | -- |
| 4 | -section_break_1 |
- - Section Break | -- - - | -- |
| 5 | -from_shareholder |
- - Link | -- From Shareholder - - | -- - - - -Shareholder - - - - | -
| 6 | -from_folio_no |
- - Data | -- From Folio No - - | -- |
| 7 | -equity_or_liability_account |
- - Link | -- Equity/Liability Account - - | -- - - - -Account - - - - | -
| 8 | -asset_account |
- - Link | -- Asset Account - - | -- - - - -Account - - - - | -
| 9 | -column_break_3 |
- - Column Break | -- - - | -- |
| 10 | -to_shareholder |
- - Link | -- To Shareholder - - | -- - - - -Shareholder - - - - | -
| 11 | -to_folio_no |
- - Data | -- To Folio No - - | -- |
| 12 | -section_break_4 |
- - Section Break | -- - - | -- |
| 13 | -share_type |
- - Link | -- Share Type - - | -- - - - -Share Type - - - - | -
| 14 | -from_no |
- - Int | -
- From No
- - (including) - |
- - |
| 15 | -rate |
- - Currency | -- Rate - - | -- |
| 16 | -column_break_8 |
- - Column Break | -- - - | -- |
| 17 | -no_of_shares |
- - Int | -- No of Shares - - | -- |
| 18 | -to_no |
- - Int | -
- To No
- - (including) - |
- - |
| 19 | -amount |
- - Currency | -- Amount - - | -- |
| 20 | -section_break_11 |
- - Section Break | -- - - | -- |
| 21 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 22 | -section_break_6 |
- - Section Break | -- - - | -- |
| 23 | -remarks |
- - Long Text | -- Remarks - - | -- |
| 24 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Share Transfer - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - autoname_folio - (self, shareholder, is_company=False) -
-No docs
-- - - basic_validations - (self) -
-No docs
-- - - before_submit - (self) -
-No docs
-- - - folio_no_validation - (self) -
-No docs
-- - - get_shareholder_doc - (self, shareholder) -
-No docs
-- - - iterative_share_removal - (self, shareholder, share_type, query, rate, amount) -
-No docs
-- - - recursive_share_check - (self, shareholder, share_type, query) -
-No docs
-- - - remove_shares - (self, shareholder) -
-No docs
-- - - return_share_balance_entry - (self, from_no, to_no, rate) -
-No docs
-- - - share_exists - (self, shareholder) -
-No docs
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.share_transfer.share_transfer.make_jv_entry
-
- - - erpnext.accounts.doctype.share_transfer.share_transfer.make_jv_entry - (company, account, amount, payment_account, credit_applicant_type, credit_applicant, debit_applicant_type, debit_applicant) -
-No docs
-Table Name: tabShare Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -description |
- - Long Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabShareholder
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -naming_series |
- - Select | -- Series - - | -
- SH-- |
-
| 4 | -section_break_2 |
- - Section Break | -- - - | -- |
| 5 | -folio_no |
- - Data | -- Folio no. - - | -- |
| 6 | -column_break_4 |
- - Column Break | -- - - | -- |
| 7 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 8 | -is_company |
- - Check | -- Is Company - - | -- |
| 9 | -address_contacts |
- - Section Break | -- Address and Contacts - - | -
- fa fa-map-marker- |
-
| 10 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 11 | -column_break_9 |
- - Column Break | -- - - | -- |
| 12 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
| 13 | -section_break_3 |
- - Section Break | -- Share Balance - - | -- |
| 14 | -share_balance |
- - Table | -- Share Balance - - | -- - - - -Share Balance - - - - | -
| 15 | -contact_list |
- - Code | -
- Contact List
- - Hidden list maintaining the list of contacts linked to Shareholder - |
- - |
Inherits from frappe.model.document.Document - -
- - - before_save - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - onload - (self) -
-Load address and contacts in __onload
Table Name: tabShipping Rule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -label |
- - Data | -
- Shipping Rule Label
- - example: Next Day Shipping - |
- - |
| 2 | -disabled |
- - Check | -- Disabled - - | -- |
| 3 | -column_break_4 |
- - Column Break | -- - - | -- |
| 4 | -shipping_rule_type |
- - Select | -- Shipping Rule Type - - | -
- Selling -Buying- |
-
| 5 | -section_break_10 |
- - Section Break | -- Accounting - - | -- |
| 6 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 7 | -column_break_12 |
- - Column Break | -- - - | -- |
| 8 | -account |
- - Link | -- Shipping Account - - | -- - - - -Account - - - - | -
| 9 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 10 | -shipping_amount_section |
- - Section Break | -- - - | -- |
| 11 | -calculate_based_on |
- - Select | -- Calculate Based On - - | -
- Fixed -Net Total -Net Weight- |
-
| 12 | -column_break_8 |
- - Column Break | -- - - | -- |
| 13 | -shipping_amount |
- - Currency | -- Shipping Amount - - | -- |
| 14 | -rule_conditions_section |
- - Section Break | -- Shipping Rule Conditions - - | -- |
| 15 | -conditions |
- - Table | -- Shipping Rule Conditions - - | -- - - - -Shipping Rule Condition - - - - | -
| 16 | -section_break_6 |
- - Section Break | -- Restrict to Countries - - | -- |
| 17 | -countries |
- - Table | -- Valid for Countries - - | -- - - - -Shipping Rule Country - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - add_shipping_rule_to_tax_table - (self, doc, shipping_amount) -
-No docs
-- - - apply - (self, doc) -
-Apply shipping rule on given doc. Called from accounts controller
-- - - get_shipping_amount_from_rules - (self, value) -
-No docs
-- - - sort_shipping_rule_conditions - (self) -
-Sort Shipping Rule Conditions based on increasing From Value
-- - - validate - (self) -
-No docs
-- - - validate_countries - (self, doc) -
-No docs
-- - - validate_from_to_values - (self) -
-No docs
-- - - validate_overlapping_shipping_rule_conditions - (self) -
-No docs
-Table Name: tabShipping Rule Condition
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -from_value |
- - Float | -- From Value - - | -- |
| 2 | -to_value |
- - Float | -- To Value - - | -- |
| 3 | -shipping_amount |
- - Currency | -- Shipping Amount - - | -
- Company:company:default_currency- |
-
Table Name: tabShipping Rule Country
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -country |
- - Link | -- Country - - | -- - - - -Country - - - - | -
Table Name: tabSubscriber
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -subscriber_name |
- - Data | -- Subscriber Name - - | -- |
| 2 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabSubscription
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -subscriber |
- - Link | -- Subscriber - - | -- - - - -Subscriber - - - - | -
| 2 | -cancel_at_period_end |
- - Check | -- Cancel At End Of Period - - | -- |
| 3 | -start |
- - Date | -- Subscription Start Date - - | -- |
| 4 | -cancelation_date |
- - Date | -- Cancelation Date - - | -- |
| 5 | -current_invoice_start |
- - Date | -- Current Invoice Start Date - - | -- |
| 6 | -current_invoice_end |
- - Date | -- Current Invoice End Date - - | -- |
| 7 | -trial_period_start |
- - Date | -- Trial Period Start Date - - | -- |
| 8 | -trial_period_end |
- - Date | -- Trial Period End Date - - | -- |
| 9 | -cb_1 |
- - Column Break | -- - - | -- |
| 10 | -status |
- - Select | -- Status - - | -
- -Trialling -Active -Past Due Date -Cancelled -Unpaid- |
-
| 11 | -days_until_due |
- - Int | -
- Days Until Due
- - Number of days that the subscriber has to pay invoices generated by this subscription - |
- - |
| 12 | -quantity |
- - Int | -- Quantity - - | -- |
| 13 | -sb_4 |
- - Section Break | -- Plans - - | -- |
| 14 | -plans |
- - Table | -- Plans - - | -- - - - -Subscription Plan Detail - - - - | -
| 15 | -sb_1 |
- - Section Break | -- Taxes - - | -- |
| 16 | -tax_template |
- - Link | -- Sales Taxes and Charges Template - - | -- - - - -Sales Taxes and Charges Template - - - - | -
| 17 | -sb_2 |
- - Section Break | -- Discounts - - | -- |
| 18 | -apply_additional_discount |
- - Select | -- Apply Additional Discount On - - | -
- -Grand Total -Net total- |
-
| 19 | -cb_2 |
- - Column Break | -- - - | -- |
| 20 | -additional_discount_percentage |
- - Percent | -- Additional DIscount Percentage - - | -- |
| 21 | -additional_discount_amount |
- - Currency | -- Additional DIscount Amount - - | -- |
| 22 | -sb_3 |
- - Section Break | -- Invoices - - | -- |
| 23 | -invoices |
- - Table | -- Invoices - - | -- - - - -Subscription Invoice - - - - | -
Inherits from frappe.model.document.Document - -
- - - after_insert - (self) -
-No docs
-- - - before_insert - (self) -
-No docs
-- - - cancel_subscription - (self) -
- This sets the subscription as cancelled. It will stop invoices from being generated
- but it will not affect already created invoices.
-
-- - - cancel_subscription_at_period_end - (self) -
- Called when `Subscription.cancel_at_period_end` is truthy
-
-- - - create_invoice - (self, prorate) -
- Creates a `Sales Invoice`, submits it and returns it
-
-- - - current_invoice_is_past_due - (self, current_invoice=None) -
- Returns `True` if the current generated invoice is overdue
-
-- - - generate_invoice - (self, prorate=0) -
- Creates a `Sales Invoice` for the `Subscription`, updates `self.invoices` and
- saves the `Subscription`.
-
-- - - get_billing_cycle - (self) -
- Returns a dict containing billing cycle information deduced from the
- `Subscription Plan` in the `Subscription`.
-
-- - - get_billing_cycle_and_interval - (self) -
- Returns a dict representing the billing interval and cycle for this `Subscription`.
-
- You shouldn't need to call this directly. Use `get_billing_cycle` instead.
-
-- - - get_billing_cycle_data - (self) -
- Returns dict contain the billing cycle data.
-
- You shouldn't need to call this directly. Use `get_billing_cycle` instead.
-
-- - - get_current_invoice - (self) -
- Returns the most recent generated invoice.
-
-- - - get_items_from_plans - (self, plans, prorate=0) -
- Returns the `Item`s linked to `Subscription Plan`
-
-- - - get_precision - (self) -
-No docs
-- - - has_outstanding_invoice - (self) -
- Returns `True` if the most recent invoice for the `Subscription` is not paid
-
-- - - is_new_subscription - (self) -
- Returns `True` if `Subscription` has never generated an invoice
-
-- - - is_past_grace_period - (self) -
- Returns `True` if the grace period for the `Subscription` has passed
-
-- - - is_trialling - (self) -
- Returns `True` if the `Subscription` is trial period.
-
-- - - process - (self) -
- To be called by task periodically. It checks the subscription and takes appropriate action
- as need be. It calls either of these methods depending the `Subscription` status:
- 1. `process_for_active`
- 2. `process_for_past_due`
-
-- - - process_for_active - (self) -
- Called by `process` if the status of the `Subscription` is 'Active'.
-
- The possible outcomes of this method are:
- 1. Generate a new invoice
- 2. Change the `Subscription` status to 'Past Due Date'
- 3. Change the `Subscription` status to 'Cancelled'
-
-- - - process_for_past_due_date - (self) -
- Called by `process` if the status of the `Subscription` is 'Past Due Date'.
-
- The possible outcomes of this method are:
- 1. Change the `Subscription` status to 'Active'
- 2. Change the `Subscription` status to 'Cancelled'
- 3. Change the `Subscription` status to 'Unpaid'
-
-- - - restart_subscription - (self) -
- This sets the subscription as active. The subscription will be made to be like a new
- subscription and the `Subscription` will lose all the history of generated invoices
- it has.
-
-- - - set_current_invoice_end - (self) -
- This sets the date of the end of the current billing period.
-
- If the subscription is in trial period, it will be set as the end of the
- trial period.
-
- If is not in a trial period, it will be `x` days from the beginning of the
- current billing period where `x` is the billing interval from the
- `Subscription Plan` in the `Subscription`.
-
-- - - set_current_invoice_start - (self, date=None) -
- This sets the date of the beginning of the current billing period.
- If the `date` parameter is not given , it will be automatically set as today's
- date.
-
-- - - set_status_grace_period - (self) -
- Sets the `Subscription` `status` based on the preference set in `Subscription Settings`.
-
- Used when the `Subscription` needs to decide what to do after the current generated
- invoice is past it's due date and grace period.
-
-- - - set_subscription_status - (self) -
- Sets the status of the `Subscription`
-
-- - - update_subscription_period - (self, date=None) -
- Subscription period is the period to be billed. This method updates the
- beginning of the billing period and end of the billing period.
-
- The beginning of the billing period is represented in the doctype as
- `current_invoice_start` and the end of the billing period is represented
- as `current_invoice_end`.
-
-- - - validate - (self) -
-No docs
-- - - validate_trial_period - (self) -
- Runs sanity checks on trial period dates for the `Subscription`
-
-Public API
- /api/method/erpnext.accounts.doctype.subscription.subscription.cancel_subscription
-
- - - erpnext.accounts.doctype.subscription.subscription.cancel_subscription - (name) -
-Cancels a `Subscription`. This will stop the `Subscription` from further invoicing the
-`Subscriber` but all already outstanding invoices will not be affected.
-
-- - - erpnext.accounts.doctype.subscription.subscription.get_all_subscriptions - () -
-Returns all `Subscription` documents
-
-- - - erpnext.accounts.doctype.subscription.subscription.get_prorata_factor - (period_end, period_start) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.subscription.subscription.get_subscription_updates
-
- - - erpnext.accounts.doctype.subscription.subscription.get_subscription_updates - (name) -
-Use this to get the latest state of the given `Subscription`
-
-- - - erpnext.accounts.doctype.subscription.subscription.process - (data) -
-Checks a `Subscription` and updates it status as necessary
-
-- - - erpnext.accounts.doctype.subscription.subscription.process_all - () -
-Task to updates the status of all `Subscription` apart from those that are cancelled
-
-Public API
- /api/method/erpnext.accounts.doctype.subscription.subscription.restart_subscription
-
- - - erpnext.accounts.doctype.subscription.subscription.restart_subscription - (name) -
-Restarts a cancelled `Subscription`. The `Subscription` will 'forget' the history of
-all invoices it has generated
-
-Table Name: tabSubscription Invoice
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -invoice |
- - Link | -- Invoice - - | -- - - - -Sales Invoice - - - - | -
Table Name: tabSubscription Plan
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -plan_name |
- - Data | -- Plan Name - - | -- |
| 2 | -item |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 3 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 4 | -cost |
- - Currency | -- Cost - - | -- |
| 5 | -billing_interval |
- - Select | -- Billing Interval - - | -
- Day -Week -Month -Year- |
-
| 6 | -billing_interval_count |
- - Int | -
- Billing Interval Count
- - Number of intervals for the interval field e.g if Interval is 'Days' and Billing Interval Count is 3, invoices will be generated every 3 days - |
- - |
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_interval_count - (self) -
-No docs
-Table Name: tabSubscription Plan Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -plan |
- - Link | -- Plan - - | -- - - - -Subscription Plan - - - - | -
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -grace_period |
- - Int | -
- Grace Period
- - Number of days after invoice date has elapsed before canceling subscription or marking subscription as unpaid - |
- - |
| 2 | -cancel_after_grace |
- - Check | -- Cancel Invoice After Grace Period - - | -- |
| 3 | -prorate |
- - Check | -- Prorate - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabTax Rule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -tax_type |
- - Select | -- Tax Type - - | -
- Sales -Purchase- |
-
| 2 | -use_for_shopping_cart |
- - Check | -- Use for Shopping Cart - - | -- |
| 3 | -column_break_1 |
- - Column Break | -- - - | -- |
| 4 | -sales_tax_template |
- - Link | -- Sales Tax Template - - | -- - - - -Sales Taxes and Charges Template - - - - | -
| 5 | -purchase_tax_template |
- - Link | -- Purchase Tax Template - - | -- - - - -Purchase Taxes and Charges Template - - - - | -
| 6 | -filters |
- - Section Break | -- Filters - - | -- |
| 7 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 8 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 9 | -billing_city |
- - Data | -- Billing City - - | -- |
| 10 | -billing_county |
- - Data | -- Billing County - - | -- |
| 11 | -billing_state |
- - Data | -- Billing State - - | -- |
| 12 | -billing_country |
- - Link | -- Billing Country - - | -- - - - -Country - - - - | -
| 13 | -column_break_2 |
- - Column Break | -- - - | -- |
| 14 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 15 | -supplier_group |
- - Link | -- Supplier Group - - | -- - - - -Supplier Group - - - - | -
| 16 | -shipping_city |
- - Data | -- Shipping City - - | -- |
| 17 | -shipping_county |
- - Data | -- Shipping County - - | -- |
| 18 | -shipping_state |
- - Data | -- Shipping State - - | -- |
| 19 | -shipping_country |
- - Link | -- Shipping Country - - | -- - - - -Country - - - - | -
| 20 | -section_break_4 |
- - Section Break | -- Validity - - | -- |
| 21 | -from_date |
- - Date | -- From Date - - | -- |
| 22 | -column_break_7 |
- - Column Break | -- - - | -- |
| 23 | -to_date |
- - Date | -- To Date - - | -- |
| 24 | -section_break_6 |
- - Section Break | -- - - | -- |
| 25 | -priority |
- - Int | -- Priority - - | -- |
| 26 | -column_break_20 |
- - Column Break | -- - - | -- |
| 27 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - __setup__ - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_date - (self) -
-No docs
-- - - validate_filters - (self) -
-No docs
-- - - validate_tax_template - (self) -
-No docs
-- - - validate_use_for_shopping_cart - (self) -
-If shopping cart is enabled and no tax rule exists for shopping cart, enable this one
-- - - erpnext.accounts.doctype.tax_rule.tax_rule.get_customer_group_condition - (customer_group) -
-No docs
-Public API
- /api/method/erpnext.accounts.doctype.tax_rule.tax_rule.get_party_details
-
- - - erpnext.accounts.doctype.tax_rule.tax_rule.get_party_details - (party, party_type, args=None) -
-No docs
-- - - erpnext.accounts.doctype.tax_rule.tax_rule.get_tax_template - (posting_date, args) -
-Get matching tax rule
-Table Name: tabTax Withholding Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
Table Name: tabTax Withholding Category
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -percent_of_tax_withheld |
- - Float | -- Percent of Tax Withheld - - | -- |
| 2 | -threshold |
- - Currency | -- Threshold - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -book_on_invoice |
- - Check | -- Book on Invoice - - | -- |
| 5 | -withhold_cumulative_tax_amount |
- - Check | -- Withhold Cumulative Tax Amount On First Invoice After Threshold - - | -- |
| 6 | -section_break_7 |
- - Section Break | -- - - | -- |
| 7 | -accounts |
- - Table | -- Accounts - - | -- - - - -Tax Withholding Account - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabAgriculture Analysis Criteria
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -standard |
- - Check | -- Standard - - | -- |
| 3 | -linked_doctype |
- - Select | -- Linked Doctype - - | -
- -Water Analysis -Soil Analysis -Plant Analysis -Fertilizer -Soil Texture -Weather- |
-
Inherits from frappe.model.document.Document - -
Table Name: tabAgriculture Task
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -task_name |
- - Data | -- Task Name - - | -- |
| 2 | -start_day |
- - Int | -- Start Day - - | -- |
| 3 | -end_day |
- - Int | -- End Day - - | -- |
| 4 | -holiday_management |
- - Select | -- Holiday Management - - | -
- Ignore holidays -Previous Business Day -Next Business Day- |
-
| 5 | -priority |
- - Select | -- Priority - - | -
- Low -Medium -High -Urgent- |
-
Table Name: tabCrop
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -section_break_2 |
- - Section Break | -- - - | -- |
| 3 | -crop_name |
- - Data | -- Crop Name - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -scientific_name |
- - Data | -- Scientific Name - - | -- |
| 6 | -section_break_20 |
- - Section Break | -
- Tasks
- - You can define all the tasks which need to carried out for this crop here. The day field is used to mention the day on which the task needs to be carried out, 1 being the 1st day, etc.. - |
- - |
| 7 | -agriculture_task |
- - Table | -- Agriculture Task - - | -- - - - -Agriculture Task - - - - | -
| 8 | -period |
- - Int | -- Period - - | -- |
| 9 | -section_break_9 |
- - Section Break | -- - - | -- |
| 10 | -crop_spacing |
- - Float | -- Crop Spacing - - | -- |
| 11 | -crop_spacing_uom |
- - Link | -- Crop Spacing UOM - - | -- - - - -UOM - - - - | -
| 12 | -column_break_12 |
- - Column Break | -- - - | -- |
| 13 | -row_spacing |
- - Float | -- Row Spacing - - | -- |
| 14 | -row_spacing_uom |
- - Link | -- Row Spacing UOM - - | -- - - - -UOM - - - - | -
| 15 | -section_break_4 |
- - Section Break | -- - - | -- |
| 16 | -type |
- - Select | -- Type - - | -
- Annual -Perennial -Biennial- |
-
| 17 | -column_break_6 |
- - Column Break | -- - - | -- |
| 18 | -category |
- - Data | -- Category - - | -- |
| 19 | -section_break_8 |
- - Section Break | -- - - | -- |
| 20 | -target_warehouse |
- - Link | -- Target Warehouse - - | -- - - - -Warehouse - - - - | -
| 21 | -section_break_12 |
- - Section Break | -- - - | -- |
| 22 | -planting_uom |
- - Link | -- Planting UOM - - | -- - - - -UOM - - - - | -
| 23 | -planting_area |
- - Data | -- Planting Area - - | -- |
| 24 | -column_break_14 |
- - Column Break | -- - - | -- |
| 25 | -yield_uom |
- - Link | -- Yield UOM - - | -- - - - -UOM - - - - | -
| 26 | -section_break_16 |
- - Section Break | -- - - | -- |
| 27 | -section_break_17 |
- - Section Break | -- Materials Required - - | -- |
| 28 | -materials_required |
- - Table | -- Materials Required - - | -- - - - -BOM Item - - - - | -
| 29 | -section_break_19 |
- - Section Break | -- Produced Items - - | -- |
| 30 | -produce |
- - Table | -- Produce - - | -- - - - -BOM Item - - - - | -
| 31 | -section_break_18 |
- - Section Break | -- Byproducts - - | -- |
| 32 | -byproducts |
- - Table | -- Byproducts - - | -- - - - -BOM Item - - - - | -
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_crop_tasks - (self) -
-No docs
-Public API
- /api/method/erpnext.agriculture.doctype.crop.crop.get_item_details
-
- - - erpnext.agriculture.doctype.crop.crop.get_item_details - (item_code) -
-No docs
-Table Name: tabCrop Cycle
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -crop |
- - Link | -- Crop - - | -- - - - -Crop - - - - | -
| 3 | -column_break_3 |
- - Column Break | -- Linked Land Unit - - | -- |
| 4 | -linked_land_unit |
- - Table | -
- Linked Land Unit
- - A link to all the Land Units in which the Crop is growing - |
- - - - - -Linked Land Unit - - - - | -
| 5 | -section_break_3 |
- - Section Break | -- - - | -- |
| 6 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 7 | -column_break_12 |
- - Column Break | -- - - | -- |
| 8 | -start_date |
- - Date | -
- Start Date
- - This will be day 1 of the crop cycle - |
- - |
| 9 | -end_date |
- - Data | -- End Date - - | -- |
| 10 | -section_break_7 |
- - Section Break | -- - - | -- |
| 11 | -iso_8601_standard |
- - Check | -- ISO 8601 standard - - | -- |
| 12 | -column_break_5 |
- - Column Break | -- - - | -- |
| 13 | -cycle_type |
- - Select | -- Cycle Type - - | -
- Yearly -Less than a year- |
-
| 14 | -section_break_12 |
- - Section Break | -- - - | -- |
| 15 | -crop_spacing |
- - Float | -
- Crop Spacing
- - The minimum length between each plant in the field for optimum growth - |
- - |
| 16 | -crop_spacing_uom |
- - Link | -- Crop Spacing UOM - - | -- - - - -UOM - - - - | -
| 17 | -column_break_11 |
- - Column Break | -- - - | -- |
| 18 | -row_spacing |
- - Float | -
- Row Spacing
- - The minimum distance between rows of plants for optimum growth - |
- - |
| 19 | -row_spacing_uom |
- - Link | -- Row Spacing UOM - - | -- - - - -UOM - - - - | -
| 20 | -section_break_14 |
- - Section Break | -
- Detected Diseases
- - List of diseases detected on the field. When selected it'll automatically add a list of tasks to deal with the disease - |
- - |
| 21 | -detected_disease |
- - Table | -- Detected Disease - - | -- - - - -Detected Disease - - - - | -
| 22 | -section_break_22 |
- - Section Break | -- LInked Analysis - - | -- |
| 23 | -soil_texture |
- - Table | -- Soil Texture - - | -- - - - -Linked Soil Texture - - - - | -
| 24 | -soil_analysis |
- - Table | -- Soil Analysis - - | -- - - - -Linked Soil Analysis - - - - | -
| 25 | -plant_analysis |
- - Table | -- Plant Analysis - - | -- - - - -Linked Plant Analysis - - - - | -
Inherits from frappe.model.document.Document - -
- - - after_insert - (self) -
-No docs
-- - - append_to_child - (self, obj_to_append) -
-No docs
-- - - create_crop_cycle_project - (self) -
-No docs
-- - - create_project - (self, period, crop_tasks) -
-No docs
-- - - create_task - (self, crop_tasks, project_name, start_date) -
-No docs
-- - - create_tasks_for_diseases - (self) -
-No docs
-- - - import_disease_tasks - (self, disease, start_date) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - reload_linked_analysis - (self) -
-No docs
-- - - set_missing_values - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.agriculture.doctype.crop_cycle.crop_cycle.get_coordinates - (doc) -
-No docs
-- - - erpnext.agriculture.doctype.crop_cycle.crop_cycle.get_geometry_type - (doc) -
-No docs
-- - - erpnext.agriculture.doctype.crop_cycle.crop_cycle.is_in_land_unit - (point, vs) -
-No docs
-Table Name: tabDetected Disease
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -disease |
- - Link | -- Disease - - | -- - - - -Disease - - - - | -
| 2 | -start_date |
- - Date | -- Start Date - - | -- |
| 3 | -tasks_created |
- - Check | -- Tasks Created - - | -- |
Table Name: tabDisease
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -common_name |
- - Data | -- Common Name - - | -- |
| 2 | -scientific_name |
- - Data | -- Scientific Name - - | -- |
| 3 | -section_break_3 |
- - Section Break | -- - - | -- |
| 4 | -treatment_task |
- - Table | -- Treatment Task - - | -- - - - -Agriculture Task - - - - | -
| 5 | -treatment_period |
- - Int | -- Treatment Period - - | -- |
| 6 | -section_break_2 |
- - Section Break | -- Treatment Task - - | -- |
| 7 | -description |
- - Long Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabFertilizer
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -fertilizer_name |
- - Data | -- Fertilizer Name - - | -- |
| 2 | -item |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 3 | -section_break_2 |
- - Section Break | -- - - | -- |
| 4 | -density |
- - Data | -- Density (if liquid) - - | -- |
| 5 | -section_break_4 |
- - Section Break | -- - - | -- |
| 6 | -section_break_28 |
- - Section Break | -- Fertilizer Contents - - | -- |
| 7 | -fertilizer_contents |
- - Table | -- - - | -- - - - -Fertilizer Content - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabFertilizer Content
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Link | -- Title - - | -- - - - -Agriculture Analysis Criteria - - - - | -
| 2 | -value |
- - Data | -- Value - - | -- |
Table Name: tabLand Unit
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -land_unit_name |
- - Data | -- Land Unit Name - - | -- |
| 2 | -parent_land_unit |
- - Link | -- Parent Land Unit - - | -- - - - -Land Unit - - - - | -
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -is_container |
- - Check | -
- Is Container
- - Check if it is a hydroponic unit - |
- - |
| 5 | -is_group |
- - Check | -- Is Group - - | -- |
| 6 | -tree_details |
- - Section Break | -- Tree Details - - | -- |
| 7 | -lft |
- - Int | -- lft - - | -- |
| 8 | -rgt |
- - Int | -- rgt - - | -- |
| 9 | -old_parent |
- - Link | -- old_parent - - | -- - - - -Land Unit - - - - | -
| 10 | -land_unit_details |
- - Section Break | -- Land Unit Details - - | -- |
| 11 | -latitude |
- - Float | -- Latitude - - | -- |
| 12 | -longitude |
- - Float | -- Longitude - - | -- |
| 13 | -latlong |
- - Column Break | -- - - | -- |
| 14 | -area |
- - Float | -- Area - - | -- |
| 15 | -section_break_13 |
- - Section Break | -- - - | -- |
| 16 | -location |
- - Geolocation | -- Location - - | -- |
| 17 | -section_break_17 |
- - Section Break | -- Linked Analysis - - | -- |
| 18 | -linked_soil_texture |
- - Table | -- Linked Soil Texture - - | -- - - - -Linked Soil Texture - - - - | -
| 19 | -linked_soil_analysis |
- - Table | -- Linked Soil Analysis - - | -- - - - -Linked Soil Analysis - - - - | -
| 20 | -linked_plant_analysis |
- - Table | -- Linked Plant Analysis - - | -- - - - -Linked Plant Analysis - - - - | -
Inherits from frappe.utils.nestedset.NestedSet - -
- - - add_child_property - (self) -
-No docs
-- - - feature_seperator - (self, child_feature=None) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - set_location_value - (self, features) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.agriculture.doctype.land_unit.land_unit.compute_area - (features) -
-No docs
-Public API
- /api/method/erpnext.agriculture.doctype.land_unit.land_unit.get_children
-
- - - erpnext.agriculture.doctype.land_unit.land_unit.get_children - (doctype, parent, is_root=False) -
-No docs
-- - - erpnext.agriculture.doctype.land_unit.land_unit.on_doctype_update - () -
-No docs
-- - - erpnext.agriculture.doctype.land_unit.land_unit.polygon_area - (coords) -
-No docs
-- - - erpnext.agriculture.doctype.land_unit.land_unit.rad - (angle_in_degrees) -
-No docs
-- - - erpnext.agriculture.doctype.land_unit.land_unit.ring_area - (coords) -
-No docs
-Table Name: tabLinked Land Unit
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -land_unit |
- - Link | -- Land Unit - - | -- - - - -Land Unit - - - - | -
Table Name: tabLinked Plant Analysis
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -plant_analysis |
- - Link | -- Plant Analysis - - | -- - - - -Plant Analysis - - - - | -
Table Name: tabLinked Soil Analysis
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -soil_analysis |
- - Link | -- Soil Analysis - - | -- - - - -Soil Analysis - - - - | -
Table Name: tabLinked Soil Texture
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -soil_texture |
- - Link | -- Soil Texture - - | -- - - - -Soil Texture - - - - | -
Table Name: tabPlant Analysis
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -crop |
- - Link | -- Crop - - | -- - - - -Crop - - - - | -
| 2 | -section_break_1 |
- - Section Break | -- - - | -- |
| 3 | -location |
- - Geolocation | -- Location - - | -- |
| 4 | -column_break_2 |
- - Column Break | -- - - | -- |
| 5 | -collection_datetime |
- - Datetime | -- Collection Datetime - - | -- |
| 6 | -laboratory_testing_datetime |
- - Datetime | -- Laboratory Testing Datetime - - | -- |
| 7 | -result_datetime |
- - Datetime | -- Result Datetime - - | -- |
| 8 | -section_break_2 |
- - Section Break | -- Plant Analysis Criterias - - | -- |
| 9 | -plant_analysis_criteria |
- - Table | -- - - | -- - - - -Plant Analysis Criteria - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabPlant Analysis Criteria
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Link | -- Title - - | -- - - - -Agriculture Analysis Criteria - - - - | -
| 2 | -value |
- - Data | -- Value - - | -- |
| 3 | -minimum_permissible_value |
- - Data | -- Minimum Permissible Value - - | -- |
| 4 | -maximum_permissible_value |
- - Data | -- Maximum Permissible Value - - | -- |
Table Name: tabSoil Analysis
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -location |
- - Geolocation | -- Location - - | -- |
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -collection_datetime |
- - Datetime | -- Collection Datetime - - | -- |
| 4 | -laboratory_testing_datetime |
- - Datetime | -- Laboratory Testing Datetime - - | -- |
| 5 | -result_datetime |
- - Datetime | -- Result Datetime - - | -- |
| 6 | -section_break_3 |
- - Section Break | -- - - | -- |
| 7 | -ca_per_k |
- - Data | -- Ca/K - - | -- |
| 8 | -ca_per_mg |
- - Data | -- Ca/Mg - - | -- |
| 9 | -mg_per_k |
- - Data | -- Mg/K - - | -- |
| 10 | -column_break_31 |
- - Column Break | -- - - | -- |
| 11 | -ca_mg_per_k |
- - Data | -- (Ca+Mg)/K - - | -- |
| 12 | -ca_per_k_ca_mg |
- - Data | -- Ca/(K+Ca+Mg) - - | -- |
| 13 | -section_break_28 |
- - Section Break | -- - - | -- |
| 14 | -invoice_number |
- - Data | -- Invoice Number - - | -- |
| 15 | -soil_analysis_criterias |
- - Section Break | -- Soil Analysis Criterias - - | -- |
| 16 | -soil_analysis_criteria |
- - Table | -- - - | -- - - - -Soil Analysis Criteria - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabSoil Analysis Criteria
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Link | -- Title - - | -- - - - -Agriculture Analysis Criteria - - - - | -
| 2 | -value |
- - Data | -- Value - - | -- |
| 3 | -minimum_permissible_value |
- - Data | -- Minimum Permissible Value - - | -- |
| 4 | -maximum_permissible_value |
- - Data | -- Maximum Permissible Value - - | -- |
Table Name: tabSoil Texture
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -location |
- - Geolocation | -- Location - - | -- |
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -collection_datetime |
- - Datetime | -- Collection Datetime - - | -- |
| 4 | -laboratory_testing_datetime |
- - Datetime | -- Laboratory Testing Datetime - - | -- |
| 5 | -result_datetime |
- - Datetime | -- Result Datetime - - | -- |
| 6 | -section_break_4 |
- - Section Break | -- - - | -- |
| 7 | -soil_type |
- - Select | -- Soil Type - - | -
- Select -Sand -Loamy Sand -Sandy Loam -Loam -Silt Loam -Silt -Sandy Clay Loam -Clay Loam -Silty Clay Loam -Sandy Clay -Silty Clay -Clay- |
-
| 8 | -clay_composition |
- - Percent | -- Clay Composition (%) - - | -- |
| 9 | -sand_composition |
- - Percent | -- Sand Composition (%) - - | -- |
| 10 | -silt_composition |
- - Percent | -- Silt Composition (%) - - | -- |
| 11 | -column_break_6 |
- - Column Break | -- - - | -- |
| 12 | -ternary_plot |
- - HTML | -- Ternary Plot - - | -- |
| 13 | -section_break_15 |
- - Section Break | -- Soil Texture Criteria - - | -- |
| 14 | -soil_texture_criteria |
- - Table | -- - - | -- - - - -Soil Texture Criteria - - - - | -
Inherits from frappe.model.document.Document - -
- - - get_soil_type - (self) -
-No docs
-- - - load_contents - (self) -
-No docs
-- - - update_soil_edit - (self, soil_type) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabSoil Texture Criteria
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Link | -- Title - - | -- - - - -Agriculture Analysis Criteria - - - - | -
| 2 | -value |
- - Data | -- Value - - | -- |
| 3 | -minimum_permissible_value |
- - Data | -- Minimum Permissible Value - - | -- |
| 4 | -maximum_permissible_value |
- - Data | -- Maximum Permissible Value - - | -- |
Table Name: tabWater Analysis
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -location |
- - Geolocation | -- Location - - | -- |
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -collection_datetime |
- - Datetime | -- Collection Datetime - - | -- |
| 4 | -laboratory_testing_datetime |
- - Datetime | -- Laboratory Testing Datetime - - | -- |
| 5 | -result_datetime |
- - Datetime | -- Result Datetime - - | -- |
| 6 | -section_break_4 |
- - Section Break | -- - - | -- |
| 7 | -type_of_sample |
- - Data | -- Type of Sample - - | -- |
| 8 | -container |
- - Data | -- Container - - | -- |
| 9 | -origin |
- - Data | -- Origin - - | -- |
| 10 | -column_break_8 |
- - Column Break | -- - - | -- |
| 11 | -collection_temperature |
- - Data | -- Collection Temperature - - | -- |
| 12 | -storage_temperature |
- - Data | -- Storage Temperature - - | -- |
| 13 | -appearance |
- - Data | -- Appearance - - | -- |
| 14 | -person_responsible |
- - Data | -- Person Responsible - - | -- |
| 15 | -column_break_29 |
- - Section Break | -- Water Analysis Criteria - - | -- |
| 16 | -water_analysis_criteria |
- - Table | -- - - | -- - - - -Water Analysis Criteria - - - - | -
Inherits from frappe.model.document.Document - -
- - - load_contents - (self) -
-No docs
-- - - update_lab_result_date - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabWater Analysis Criteria
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Link | -- Title - - | -- - - - -Agriculture Analysis Criteria - - - - | -
| 2 | -value |
- - Data | -- Value - - | -- |
| 3 | -minimum_permissible_value |
- - Data | -- Minimum Permissible Value - - | -- |
| 4 | -maximum_permissible_value |
- - Data | -- Maximum Permissible Value - - | -- |
Table Name: tabWeather
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -source |
- - Data | -- Source - - | -- |
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -date |
- - Date | -- Date - - | -- |
| 4 | -section_break_3 |
- - Section Break | -- - - | -- |
| 5 | -section_break_9 |
- - Section Break | -- Weather Parameter - - | -- |
| 6 | -weather_parameter |
- - Table | -- - - | -- - - - -Weather Parameter - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabWeather Parameter
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Link | -- Title - - | -- - - - -Agriculture Analysis Criteria - - - - | -
| 2 | -value |
- - Data | -- Value - - | -- |
| 3 | -minimum_permissible_value |
- - Data | -- Minimum Permissible Value - - | -- |
| 4 | -maximum_permissible_value |
- - Data | -- Maximum Permissible Value - - | -- |
Table Name: tabAsset
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Naming Series - - | -
- AST -AT- |
-
| 2 | -asset_name |
- - Data | -- Asset Name - - | -- |
| 3 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 4 | -item_name |
- - Read Only | -- Item Name - - | -- |
| 5 | -asset_category |
- - Link | -- Asset Category - - | -- - - - -Asset Category - - - - | -
| 6 | -asset_owner |
- - Select | -- Asset Owner - - | -
- -Company -Supplier -Customer- |
-
| 7 | -asset_owner_company |
- - Link | -- Asset Owner Company - - | -- - - - -Company - - - - | -
| 8 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 9 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 10 | -image |
- - Attach Image | -- Image - - | -- |
| 11 | -column_break_3 |
- - Column Break | -- - - | -- |
| 12 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 13 | -location |
- - Link | -- Location - - | -- - - - -Location - - - - | -
| 14 | -custodian |
- - Link | -- Custodian - - | -- - - - -Employee - - - - | -
| 15 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 16 | -purchase_date |
- - Date | -- Purchase Date - - | -- |
| 17 | -disposal_date |
- - Date | -- Disposal Date - - | -- |
| 18 | -journal_entry_for_scrap |
- - Link | -- Journal Entry for Scrap - - | -- - - - -Journal Entry - - - - | -
| 19 | -section_break_5 |
- - Section Break | -- - - | -- |
| 20 | -gross_purchase_amount |
- - Currency | -- Gross Purchase Amount - - | -
- Company:company:default_currency- |
-
| 21 | -available_for_use_date |
- - Date | -- Available-for-use Date - - | -- |
| 22 | -column_break_18 |
- - Column Break | -- - - | -- |
| 23 | -calculate_depreciation |
- - Check | -- Calculate Depreciation - - | -- |
| 24 | -is_existing_asset |
- - Check | -- Is Existing Asset - - | -- |
| 25 | -opening_accumulated_depreciation |
- - Currency | -- Opening Accumulated Depreciation - - | -
- Company:company:default_currency- |
-
| 26 | -number_of_depreciations_booked |
- - Int | -- Number of Depreciations Booked - - | -- |
| 27 | -section_break_23 |
- - Section Break | -- Depreciation - - | -- |
| 28 | -finance_books |
- - Table | -- Finance Books - - | -- - - - -Asset Finance Book - - - - | -
| 29 | -section_break_33 |
- - Section Break | -- - - | -- |
| 30 | -depreciation_method |
- - Select | -- Depreciation Method - - | -
- -Straight Line -Double Declining Balance -Manual- |
-
| 31 | -value_after_depreciation |
- - Currency | -- Value After Depreciation - - | -
- Company:company:default_currency- |
-
| 32 | -total_number_of_depreciations |
- - Int | -- Total Number of Depreciations - - | -- |
| 33 | -column_break_24 |
- - Column Break | -- - - | -- |
| 34 | -frequency_of_depreciation |
- - Int | -- Frequency of Depreciation (Months) - - | -- |
| 35 | -next_depreciation_date |
- - Date | -- Next Depreciation Date - - | -- |
| 36 | -section_break_14 |
- - Section Break | -- Depreciation Schedule - - | -- |
| 37 | -schedules |
- - Table | -- Depreciation Schedules - - | -- - - - -Depreciation Schedule - - - - | -
| 38 | -insurance_details |
- - Section Break | -- Insurance details - - | -- |
| 39 | -policy_number |
- - Data | -- Policy number - - | -- |
| 40 | -insurer |
- - Data | -- Insurer - - | -- |
| 41 | -insured_value |
- - Data | -- Insured value - - | -- |
| 42 | -column_break_48 |
- - Column Break | -- - - | -- |
| 43 | -insurance_start_date |
- - Date | -- Insurance Start Date - - | -- |
| 44 | -insurance_end_date |
- - Date | -- Insurance End Date - - | -- |
| 45 | -comprehensive_insurance |
- - Data | -- Comprehensive Insurance - - | -- |
| 46 | -section_break_31 |
- - Section Break | -- Maintenance - - | -- |
| 47 | -maintenance_required |
- - Check | -
- Maintenance Required
- - Check if Asset requires Preventive Maintenance or Calibration - |
- - |
| 48 | -other_details |
- - Section Break | -- Other Details - - | -- |
| 49 | -status |
- - Select | -- Status - - | -
- Draft -Submitted -Partially Depreciated -Fully Depreciated -Sold -Scrapped -In Maintenance -Out of Order -Issue -Receipt- |
-
| 50 | -booked_fixed_asset |
- - Check | -- Booked Fixed Asset - - | -- |
| 51 | -column_break_51 |
- - Column Break | -- - - | -- |
| 52 | -purchase_receipt |
- - Link | -- Purchase Receipt - - | -- - - - -Purchase Receipt - - - - | -
| 53 | -purchase_receipt_amount |
- - Currency | -- Purchase Receipt Amount - - | -- |
| 54 | -purchase_invoice |
- - Link | -- Purchase Invoice - - | -- - - - -Purchase Invoice - - - - | -
| 55 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Asset - - - - | -
Inherits from erpnext.controllers.accounts_controller.AccountsController - -
- - - delete_depreciation_entries - (self) -
-No docs
-- - - get_depreciation_amount - (self, depreciable_value, total_number_of_depreciations, row) -
-No docs
-- - - get_depreciation_amount_prorata_temporis - (self, depreciable_value, row, start_date=None, end_date=None) -
-No docs
-- - - get_status - (self) -
-Returns status based on whether it is draft, submitted, scrapped or depreciated
-- - - get_value_after_depreciation - (self, idx) -
-No docs
-- - - make_depreciation_schedule - (self) -
-No docs
-- - - make_gl_entries - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - set_accumulated_depreciation - (self, ignore_booked_entry=False) -
-No docs
-- - - set_missing_values - (self) -
-No docs
-- - - set_status - (self, status=None) -
-Get and update status
-- - - update_stock_movement - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_asset_finance_books - (self, row) -
-No docs
-- - - validate_asset_values - (self) -
-No docs
-- - - validate_cancellation - (self) -
-No docs
-- - - validate_expected_value_after_useful_life - (self) -
-No docs
-- - - validate_in_use_date - (self) -
-No docs
-- - - validate_item - (self) -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset.asset.create_asset_adjustment
-
- - - erpnext.assets.doctype.asset.asset.create_asset_adjustment - (asset, asset_category, company) -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset.asset.create_asset_maintenance
-
- - - erpnext.assets.doctype.asset.asset.create_asset_maintenance - (asset, item_code, item_name, asset_category, company) -
-No docs
-- - - erpnext.assets.doctype.asset.asset.get_asset_account - (account_name, asset=None, asset_category=None, company=None) -
-No docs
-- - - erpnext.assets.doctype.asset.asset.get_asset_naming_series - () -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset.asset.get_item_details
-
- - - erpnext.assets.doctype.asset.asset.get_item_details - (item_code, asset_category=None) -
-No docs
-- - - erpnext.assets.doctype.asset.asset.make_post_gl_entry - () -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset.asset.make_purchase_invoice
-
- - - erpnext.assets.doctype.asset.asset.make_purchase_invoice - (asset, item_code, gross_purchase_amount, company, posting_date) -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset.asset.make_sales_invoice
-
- - - erpnext.assets.doctype.asset.asset.make_sales_invoice - (asset, item_code, company, serial_no=None) -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset.asset.transfer_asset
-
- - - erpnext.assets.doctype.asset.asset.transfer_asset - (args) -
-No docs
-- - - erpnext.assets.doctype.asset.asset.update_maintenance_status - () -
-No docs
-Table Name: tabAsset Adjustment
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -asset |
- - Link | -- Asset - - | -- - - - -Asset - - - - | -
| 3 | -asset_category |
- - Read Only | -- Asset Category - - | -- |
| 4 | -finance_book |
- - Link | -- Finance Book - - | -- - - - -Finance Book - - - - | -
| 5 | -journal_entry |
- - Link | -- Journal Entry - - | -- - - - -Journal Entry - - - - | -
| 6 | -column_break_4 |
- - Column Break | -- - - | -- |
| 7 | -date |
- - Date | -- Date - - | -- |
| 8 | -current_asset_value |
- - Currency | -- Current Asset Value - - | -- |
| 9 | -new_asset_value |
- - Currency | -- New Asset Value - - | -- |
| 10 | -difference_amount |
- - Currency | -- Difference Amount - - | -- |
| 11 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 12 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Asset Adjustment - - - - | -
Inherits from frappe.model.document.Document - -
- - - make_depreciation_entry - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - reschedule_depreciations - (self, asset_value) -
-No docs
-- - - set_current_asset_value - (self) -
-No docs
-- - - set_difference_amount - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset_adjustment.asset_adjustment.get_current_asset_value
-
- - - erpnext.assets.doctype.asset_adjustment.asset_adjustment.get_current_asset_value - (asset, finance_book) -
-No docs
-Table Name: tabAsset Category
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -asset_category_name |
- - Data | -- Asset Category Name - - | -- |
| 2 | -column_break_3 |
- - Column Break | -- - - | -- |
| 3 | -finance_book_detail |
- - Section Break | -- Finance Book Detail - - | -- |
| 4 | -finance_books |
- - Table | -- Finance Books - - | -- - - - -Asset Finance Book - - - - | -
| 5 | -section_break_2 |
- - Section Break | -- Accounts - - | -- |
| 6 | -accounts |
- - Table | -- Accounts - - | -- - - - -Asset Category Account - - - - | -
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.assets.doctype.asset_category.asset_category.get_asset_category_account
-
- - - erpnext.assets.doctype.asset_category.asset_category.get_asset_category_account - (asset, fieldname, account=None, asset_category=None, company=None) -
-No docs
-Table Name: tabAsset Category Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company_name |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -fixed_asset_account |
- - Link | -- Fixed Asset Account - - | -- - - - -Account - - - - | -
| 3 | -accumulated_depreciation_account |
- - Link | -- Accumulated Depreciation Account - - | -- - - - -Account - - - - | -
| 4 | -depreciation_expense_account |
- - Link | -- Depreciation Expense Account - - | -- - - - -Account - - - - | -
| 5 | -capital_work_in_progress_account |
- - Link | -- Capital Work In Progress Account - - | -- - - - -Account - - - - | -
Table Name: tabAsset Finance Book
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -finance_book |
- - Link | -- Finance Book - - | -- - - - -Finance Book - - - - | -
| 2 | -depreciation_method |
- - Select | -- Depreciation Method - - | -
- -Straight Line -Double Declining Balance -Written Down Value -Manual- |
-
| 3 | -total_number_of_depreciations |
- - Int | -- Total Number of Depreciations - - | -- |
| 4 | -column_break_5 |
- - Column Break | -- - - | -- |
| 5 | -frequency_of_depreciation |
- - Int | -- Frequency of Depreciation (Months) - - | -- |
| 6 | -depreciation_start_date |
- - Date | -- Depreciation Start Date - - | -- |
| 7 | -expected_value_after_useful_life |
- - Currency | -- Expected Value After Useful Life - - | -
- Company:company:default_currency- |
-
| 8 | -value_after_depreciation |
- - Currency | -- Value After Depreciation - - | -
- Company:company:default_currency- |
-
Table Name: tabAsset Maintenance
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -asset_name |
- - Link | -- Asset Name - - | -- - - - -Asset - - - - | -
| 2 | -asset_category |
- - Read Only | -- Asset Category - - | -- |
| 3 | -item_code |
- - Read Only | -- Item Code - - | -- |
| 4 | -item_name |
- - Read Only | -- Item Name - - | -- |
| 5 | -column_break_3 |
- - Column Break | -- - - | -- |
| 6 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 7 | -select_serial_no |
- - Link | -- Select Serial No - - | -- - - - -Serial No - - - - | -
| 8 | -serial_no |
- - Small Text | -- Serial No - - | -- |
| 9 | -section_break_6 |
- - Section Break | -- - - | -- |
| 10 | -maintenance_team |
- - Link | -- Maintenance Team - - | -- - - - -Asset Maintenance Team - - - - | -
| 11 | -column_break_9 |
- - Column Break | -- - - | -- |
| 12 | -maintenance_manager |
- - Data | -- Maintenance Manager - - | -- |
| 13 | -maintenance_manager_name |
- - Read Only | -- Maintenance Manager Name - - | -- |
| 14 | -section_break_8 |
- - Section Break | -- Tasks - - | -- |
| 15 | -asset_maintenance_tasks |
- - Table | -- Maintenance Tasks - - | -- - - - -Asset Maintenance Task - - - - | -
Inherits from frappe.model.document.Document - -
- - - on_update - (self) -
-No docs
-- - - sync_maintenance_tasks - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset_maintenance.asset_maintenance.assign_tasks
-
- - - erpnext.assets.doctype.asset_maintenance.asset_maintenance.assign_tasks - (asset_maintenance_name, assign_to_member, maintenance_task, next_due_date) -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset_maintenance.asset_maintenance.calculate_next_due_date
-
- - - erpnext.assets.doctype.asset_maintenance.asset_maintenance.calculate_next_due_date - (periodicity, start_date=None, end_date=None, last_completion_date=None, next_due_date=None) -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset_maintenance.asset_maintenance.get_maintenance_log
-
- - - erpnext.assets.doctype.asset_maintenance.asset_maintenance.get_maintenance_log - (asset_name) -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset_maintenance.asset_maintenance.get_team_members
-
- - - erpnext.assets.doctype.asset_maintenance.asset_maintenance.get_team_members - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.assets.doctype.asset_maintenance.asset_maintenance.update_maintenance_log - (asset_maintenance, item_code, item_name, task) -
-No docs
-Table Name: tabAsset Maintenance Log
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -asset_maintenance |
- - Link | -- Asset Maintenance - - | -- - - - -Asset Maintenance - - - - | -
| 2 | -naming_series |
- - Select | -- Series - - | -
- AML-- |
-
| 3 | -asset_name |
- - Read Only | -- Asset Name - - | -- |
| 4 | -column_break_2 |
- - Column Break | -- - - | -- |
| 5 | -item_code |
- - Read Only | -- Item Code - - | -- |
| 6 | -item_name |
- - Read Only | -- Item Name - - | -- |
| 7 | -section_break_5 |
- - Section Break | -- - - | -- |
| 8 | -task |
- - Link | -- Task - - | -- - - - -Asset Maintenance Task - - - - | -
| 9 | -maintenance_type |
- - Read Only | -- Maintenance Type - - | -- |
| 10 | -periodicity |
- - Data | -- Periodicity - - | -- |
| 11 | -assign_to_name |
- - Read Only | -- Assign To - - | -- |
| 12 | -column_break_6 |
- - Column Break | -- - - | -- |
| 13 | -due_date |
- - Date | -- Due Date - - | -- |
| 14 | -completion_date |
- - Date | -- Completion Date - - | -- |
| 15 | -maintenance_status |
- - Select | -- Maintenance Status - - | -
- Planned -Completed -Cancelled -Overdue- |
-
| 16 | -section_break_12 |
- - Section Break | -- - - | -- |
| 17 | -has_certificate |
- - Check | -- Has Certificate - - | -- |
| 18 | -certificate_attachement |
- - Attach | -- Certificate - - | -- |
| 19 | -section_break_6 |
- - Column Break | -- - - | -- |
| 20 | -description |
- - Read Only | -- Description - - | -- |
| 21 | -column_break_9 |
- - Section Break | -- - - | -- |
| 22 | -actions_performed |
- - Text Editor | -- Actions performed - - | -- |
| 23 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Asset Maintenance Log - - - - | -
Inherits from frappe.model.document.Document - -
- - - on_submit - (self) -
-No docs
-- - - update_maintenance_task - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.asset_maintenance_log.asset_maintenance_log.get_maintenance_tasks
-
- - - erpnext.assets.doctype.asset_maintenance_log.asset_maintenance_log.get_maintenance_tasks - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Table Name: tabAsset Maintenance Task
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -maintenance_task |
- - Data | -- Maintenance Task - - | -- |
| 2 | -maintenance_type |
- - Select | -- Maintenance Type - - | -
- Preventive Maintenance -Calibration- |
-
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -maintenance_status |
- - Select | -- Maintenance Status - - | -
- Planned -Overdue -Cancelled- |
-
| 5 | -section_break_2 |
- - Section Break | -- - - | -- |
| 6 | -start_date |
- - Date | -- Start Date - - | -- |
| 7 | -periodicity |
- - Select | -- Periodicity - - | -
- -Daily -Weekly -Monthly -Quarterly -Yearly -2 Yearly- |
-
| 8 | -column_break_4 |
- - Column Break | -- - - | -- |
| 9 | -end_date |
- - Date | -- End Date - - | -- |
| 10 | -certificate_required |
- - Check | -- Certificate Required - - | -- |
| 11 | -section_break_9 |
- - Section Break | -- - - | -- |
| 12 | -assign_to |
- - Link | -- Assign To - - | -- - - - -User - - - - | -
| 13 | -column_break_10 |
- - Column Break | -- - - | -- |
| 14 | -assign_to_name |
- - Read Only | -- Assign to Name - - | -- |
| 15 | -section_break_10 |
- - Section Break | -- - - | -- |
| 16 | -next_due_date |
- - Date | -- Next Due Date - - | -- |
| 17 | -column_break_14 |
- - Column Break | -- - - | -- |
| 18 | -last_completion_date |
- - Date | -- Last Completion Date - - | -- |
| 19 | -section_break_7 |
- - Section Break | -- - - | -- |
| 20 | -description |
- - Text Editor | -- Description - - | -- |
Table Name: tabAsset Maintenance Team
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -maintenance_team_name |
- - Data | -- Maintenance Team Name - - | -- |
| 2 | -maintenance_manager |
- - Link | -- Maintenance Manager - - | -- - - - -User - - - - | -
| 3 | -maintenance_manager_name |
- - Read Only | -- Maintenance Manager Name - - | -- |
| 4 | -column_break_2 |
- - Column Break | -- - - | -- |
| 5 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 6 | -section_break_2 |
- - Section Break | -- - - | -- |
| 7 | -maintenance_team_members |
- - Table | -- Maintenance Team Members - - | -- - - - -Maintenance Team Member - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabAsset Movement
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -purpose |
- - Select | -- Purpose - - | -
- -Issue -Receipt -Transfer- |
-
| 3 | -asset |
- - Link | -- Asset - - | -- - - - -Asset - - - - | -
| 4 | -transaction_date |
- - Datetime | -- Transaction Date - - | -- |
| 5 | -column_break_4 |
- - Column Break | -- - - | -- |
| 6 | -quantity |
- - Float | -- Quantity - - | -- |
| 7 | -serial_no |
- - Small Text | -- Serial No - - | -- |
| 8 | -section_break_7 |
- - Section Break | -- - - | -- |
| 9 | -source_location |
- - Link | -- Source Location - - | -- - - - -Location - - - - | -
| 10 | -target_location |
- - Link | -- Target Location - - | -- - - - -Location - - - - | -
| 11 | -column_break_10 |
- - Column Break | -- - - | -- |
| 12 | -from_employee |
- - Link | -- From Employee - - | -- - - - -Employee - - - - | -
| 13 | -to_employee |
- - Link | -- To Employee - - | -- - - - -Employee - - - - | -
| 14 | -reference |
- - Section Break | -- Reference - - | -- |
| 15 | -reference_doctype |
- - Link | -- Reference DocType - - | -- - - - -DocType - - - - | -
| 16 | -reference_name |
- - Dynamic Link | -- Reference Name - - | -
- reference_doctype- |
-
| 17 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Asset Movement - - - - | -
Inherits from frappe.model.document.Document - -
- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - set_latest_location_in_asset - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_asset - (self) -
-No docs
-- - - validate_warehouses - (self) -
-No docs
-Table Name: tabAsset Repair
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -asset_name |
- - Link | -- Asset Name - - | -- - - - -Asset - - - - | -
| 2 | -naming_series |
- - Select | -- Series - - | -
- ARLOG-- |
-
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -item_code |
- - Read Only | -- Item Code - - | -- |
| 5 | -item_name |
- - Read Only | -- Item Name - - | -- |
| 6 | -section_break_5 |
- - Section Break | -- - - | -- |
| 7 | -failure_date |
- - Datetime | -- Failure Date - - | -- |
| 8 | -assign_to |
- - Link | -- Assign To - - | -- - - - -User - - - - | -
| 9 | -assign_to_name |
- - Read Only | -- Assign To Name - - | -- |
| 10 | -column_break_6 |
- - Column Break | -- - - | -- |
| 11 | -completion_date |
- - Datetime | -- Completion Date - - | -- |
| 12 | -repair_status |
- - Select | -- Repair Status - - | -
- Pending -Completed -Cancelled- |
-
| 13 | -section_break_9 |
- - Section Break | -- - - | -- |
| 14 | -description |
- - Long Text | -- Error Description - - | -- |
| 15 | -column_break_9 |
- - Column Break | -- - - | -- |
| 16 | -actions_performed |
- - Long Text | -- Actions performed - - | -- |
| 17 | -section_break_17 |
- - Section Break | -- - - | -- |
| 18 | -downtime |
- - Data | -- Downtime - - | -- |
| 19 | -column_break_19 |
- - Column Break | -- - - | -- |
| 20 | -repair_cost |
- - Currency | -- Repair Cost - - | -- |
| 21 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Asset Repair - - - - | -
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.assets.doctype.asset_repair.asset_repair.get_downtime
-
- - - erpnext.assets.doctype.asset_repair.asset_repair.get_downtime - (failure_date, completion_date) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -depreciation_options |
- - Section Break | -- Depreciation Options - - | -- |
| 2 | -schedule_based_on_fiscal_year |
- - Check | -- Calculate Prorated Depreciation Schedule Based on Fiscal Year - - | -- |
| 3 | -number_of_days_in_fiscal_year |
- - Data | -
- Number of Days in Fiscal Year
- - This value is used for pro-rata temporis calculation - |
- - |
Inherits from frappe.model.document.Document - -
Table Name: tabDepreciation Schedule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -finance_book |
- - Link | -- Finance Book - - | -- - - - -Finance Book - - - - | -
| 2 | -schedule_date |
- - Date | -- Schedule Date - - | -- |
| 3 | -depreciation_amount |
- - Currency | -- Depreciation Amount - - | -
- Company:company:default_currency- |
-
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -accumulated_depreciation_amount |
- - Currency | -- Accumulated Depreciation Amount - - | -
- Company:company:default_currency- |
-
| 6 | -journal_entry |
- - Link | -- Journal Entry - - | -- - - - -Journal Entry - - - - | -
| 7 | -make_depreciation_entry |
- - Button | -- Make Depreciation Entry - - | -- |
| 8 | -finance_book_id |
- - Data | -- Finance Book Id - - | -- |
| 9 | -depreciation_method |
- - Select | -- Depreciation Method - - | -
- -Straight Line -Double Declining Balance -Written Down Value -Manual- |
-
Table Name: tabLocation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -location_name |
- - Data | -- Location Name - - | -- |
| 2 | -is_group |
- - Check | -- Is Group - - | -- |
| 3 | -parent_location |
- - Link | -- Parent Location - - | -- - - - -Location - - - - | -
| 4 | -lft |
- - Int | -- lft - - | -- |
| 5 | -rgt |
- - Int | -- rgt - - | -- |
| 6 | -old_parent |
- - Data | -- Old Parent - - | -- |
Inherits from frappe.utils.nestedset.NestedSet - -
- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.location.location.add_node
-
- - - erpnext.assets.doctype.location.location.add_node - () -
-No docs
-Public API
- /api/method/erpnext.assets.doctype.location.location.get_children
-
- - - erpnext.assets.doctype.location.location.get_children - (doctype, parent=None, location=None, is_root=False) -
-No docs
-Table Name: tabMaintenance Team Member
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -team_member |
- - Link | -- Team Member - - | -- - - - -User - - - - | -
| 2 | -full_name |
- - Data | -- Full Name - - | -- |
| 3 | -maintenance_role |
- - Link | -- Maintenance Role - - | -- - - - -Role - - - - | -
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -supp_master_name |
- - Select | -- Supplier Naming By - - | -
- Supplier Name -Naming Series- |
-
| 2 | -supplier_group |
- - Link | -- Default Supplier Group - - | -- - - - -Supplier Group - - - - | -
| 3 | -buying_price_list |
- - Link | -- Default Buying Price List - - | -- - - - -Price List - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -po_required |
- - Select | -- Purchase Order Required - - | -
- No -Yes- |
-
| 6 | -pr_required |
- - Select | -- Purchase Receipt Required - - | -
- No -Yes- |
-
| 7 | -maintain_same_rate |
- - Check | -- Maintain same rate throughout purchase cycle - - | -- |
| 8 | -allow_multiple_items |
- - Check | -- Allow Item to be added multiple times in a transaction - - | -- |
| 9 | -disable_fetch_last_purchase_rate |
- - Check | -
- Disable Fetching Last Purchase Details in Purchase Order
- - If enabled, last purchase details of items will not be fetched from previous purchase order or purchase receipt - |
- - |
| 10 | -subcontract |
- - Section Break | -- Subcontract - - | -- |
| 11 | -backflush_raw_materials_of_subcontract_based_on |
- - Select | -- Backflush Raw Materials of Subcontract Based On - - | -
- BOM -Material Transferred for Subcontract- |
-
Inherits from frappe.model.document.Document - -
Table Name: tabParty Tax Withholding Config
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -tax_withholding_category |
- - Link | -- Tax Withholding Category - - | -- - - - -Tax Withholding Category - - - - | -
| 2 | -valid_till |
- - Date | -- Valid Till - - | -- |
| 3 | -applicable_percent |
- - Float | -- Applicable Percent - - | -- |
| 4 | -certificate_received |
- - Check | -- Certificate Received - - | -- |
Table Name: tabPurchase Order
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -supplier_section |
- - Section Break | -- - - | -
- fa fa-user- |
-
| 2 | -title |
- - Data | -- Title - - | -- |
| 3 | -naming_series |
- - Select | -- Series - - | -
- PO-- |
-
| 4 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 5 | -get_items_from_open_material_requests |
- - Button | -- Get Items from Open Material Requests - - | -- |
| 6 | -is_subcontracted |
- - Select | -- Supply Raw Materials - - | -
- No -Yes- |
-
| 7 | -supplier_name |
- - Data | -- Supplier Name - - | -- |
| 8 | -supplier_warehouse |
- - Link | -- Supplier Warehouse - - | -- - - - -Warehouse - - - - | -
| 9 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 10 | -column_break1 |
- - Column Break | -- - - | -- |
| 11 | -transaction_date |
- - Date | -- Date - - | -- |
| 12 | -schedule_date |
- - Date | -- Reqd By Date - - | -- |
| 13 | -order_confirmation_no |
- - Data | -- Order Confirmation No - - | -- |
| 14 | -order_confirmation_date |
- - Date | -- Order Confirmation Date - - | -- |
| 15 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Purchase Order - - - - | -
| 16 | -drop_ship |
- - Section Break | -- Drop Ship - - | -- |
| 17 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 18 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 19 | -column_break_19 |
- - Column Break | -- - - | -- |
| 20 | -customer_contact_person |
- - Link | -- Customer Contact - - | -- - - - -Contact - - - - | -
| 21 | -customer_contact_display |
- - Small Text | -- Customer Contact - - | -- |
| 22 | -customer_contact_mobile |
- - Small Text | -- Customer Mobile No - - | -- |
| 23 | -customer_contact_email |
- - Code | -- Customer Contact Email - - | -
- |
-
| 24 | -section_addresses |
- - Section Break | -- Address and Contact - - | -- |
| 25 | -supplier_address |
- - Link | -- Select Supplier Address - - | -- - - - -Address - - - - | -
| 26 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 27 | -address_display |
- - Small Text | -- Address - - | -- |
| 28 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 29 | -contact_mobile |
- - Small Text | -- Mobile No - - | -- |
| 30 | -contact_email |
- - Small Text | -- Contact Email - - | -- |
| 31 | -col_break_address |
- - Column Break | -- - - | -- |
| 32 | -shipping_address |
- - Link | -- Select Shipping Address - - | -- - - - -Address - - - - | -
| 33 | -shipping_address_display |
- - Small Text | -- Shipping Address - - | -- |
| 34 | -currency_and_price_list |
- - Section Break | -- Currency and Price List - - | -
- fa fa-tag- |
-
| 35 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 36 | -conversion_rate |
- - Float | -- Exchange Rate - - | -- |
| 37 | -cb_price_list |
- - Column Break | -- - - | -- |
| 38 | -buying_price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 39 | -price_list_currency |
- - Link | -- Price List Currency - - | -- - - - -Currency - - - - | -
| 40 | -plc_conversion_rate |
- - Float | -- Price List Exchange Rate - - | -- |
| 41 | -ignore_pricing_rule |
- - Check | -- Ignore Pricing Rule - - | -- |
| 42 | -items_section |
- - Section Break | -- - - | -
- fa fa-shopping-cart- |
-
| 43 | -items |
- - Table | -- Items - - | -- - - - -Purchase Order Item - - - - | -
| 44 | -get_last_purchase_rate |
- - Button | -- Get last purchase rate - - | -- |
| 45 | -link_to_mrs |
- - Button | -- Link to material requests - - | -- |
| 46 | -sb_last_purchase |
- - Section Break | -- - - | -- |
| 47 | -total_qty |
- - Float | -- Total Quantity - - | -- |
| 48 | -base_total |
- - Currency | -- Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 49 | -base_net_total |
- - Currency | -- Net Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 50 | -column_break_26 |
- - Column Break | -- - - | -- |
| 51 | -total |
- - Currency | -- Total - - | -
- currency- |
-
| 52 | -net_total |
- - Currency | -- Net Total - - | -
- currency- |
-
| 53 | -total_net_weight |
- - Float | -- Total Net Weight - - | -- |
| 54 | -taxes_section |
- - Section Break | -- - - | -
- fa fa-money- |
-
| 55 | -taxes_and_charges |
- - Link | -- Taxes and Charges - - | -- - - - -Purchase Taxes and Charges Template - - - - | -
| 56 | -column_break_50 |
- - Column Break | -- - - | -- |
| 57 | -shipping_rule |
- - Link | -- Shipping Rule - - | -- - - - -Shipping Rule - - - - | -
| 58 | -section_break_52 |
- - Section Break | -- - - | -- |
| 59 | -taxes |
- - Table | -- Purchase Taxes and Charges - - | -- - - - -Purchase Taxes and Charges - - - - | -
| 60 | -sec_tax_breakup |
- - Section Break | -- Tax Breakup - - | -- |
| 61 | -other_charges_calculation |
- - Text | -- Taxes and Charges Calculation - - | -- |
| 62 | -totals |
- - Section Break | -- - - | -
- fa fa-money- |
-
| 63 | -base_taxes_and_charges_added |
- - Currency | -- Taxes and Charges Added (Company Currency) - - | -
- Company:company:default_currency- |
-
| 64 | -base_taxes_and_charges_deducted |
- - Currency | -- Taxes and Charges Deducted (Company Currency) - - | -
- Company:company:default_currency- |
-
| 65 | -base_total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges (Company Currency) - - | -
- Company:company:default_currency- |
-
| 66 | -column_break_39 |
- - Column Break | -- - - | -- |
| 67 | -taxes_and_charges_added |
- - Currency | -- Taxes and Charges Added - - | -
- currency- |
-
| 68 | -taxes_and_charges_deducted |
- - Currency | -- Taxes and Charges Deducted - - | -
- currency- |
-
| 69 | -total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges - - | -
- currency- |
-
| 70 | -discount_section |
- - Section Break | -- Additional Discount - - | -- |
| 71 | -apply_discount_on |
- - Select | -- Apply Additional Discount On - - | -
- -Grand Total -Net Total- |
-
| 72 | -base_discount_amount |
- - Currency | -- Additional Discount Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 73 | -column_break_45 |
- - Column Break | -- - - | -- |
| 74 | -additional_discount_percentage |
- - Float | -- Additional Discount Percentage - - | -- |
| 75 | -discount_amount |
- - Currency | -- Additional Discount Amount - - | -
- currency- |
-
| 76 | -totals_section |
- - Section Break | -- - - | -- |
| 77 | -base_grand_total |
- - Currency | -- Grand Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 78 | -base_rounding_adjustment |
- - Currency | -- Rounding Adjustment (Company Currency) - - | -
- Company:company:default_currency- |
-
| 79 | -base_in_words |
- - Data | -
- In Words (Company Currency)
- - In Words will be visible once you save the Purchase Order. - |
- - |
| 80 | -base_rounded_total |
- - Currency | -- Rounded Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 81 | -column_break4 |
- - Column Break | -- - - | -- |
| 82 | -grand_total |
- - Currency | -- Grand Total - - | -
- currency- |
-
| 83 | -rounding_adjustment |
- - Currency | -- Rounding Adjustment - - | -
- currency- |
-
| 84 | -in_words |
- - Data | -- In Words - - | -- |
| 85 | -advance_paid |
- - Currency | -- Advance Paid - - | -
- party_account_currency- |
-
| 86 | -payment_schedule_section |
- - Section Break | -- Payment Terms - - | -- |
| 87 | -payment_terms_template |
- - Link | -- Payment Terms Template - - | -- - - - -Payment Terms Template - - - - | -
| 88 | -payment_schedule |
- - Table | -- Payment Schedule - - | -- - - - -Payment Schedule - - - - | -
| 89 | -terms_section_break |
- - Section Break | -- Terms and Conditions - - | -
- fa fa-legal- |
-
| 90 | -tc_name |
- - Link | -- Terms - - | -- - - - -Terms and Conditions - - - - | -
| 91 | -terms |
- - Text Editor | -- Terms and Conditions - - | -- |
| 92 | -more_info |
- - Section Break | -- More Information - - | -- |
| 93 | -status |
- - Select | -- Status - - | -
- -Draft -To Receive and Bill -To Bill -To Receive -Completed -Cancelled -Closed -Delivered- |
-
| 94 | -ref_sq |
- - Data | -- Ref SQ - - | -- |
| 95 | -party_account_currency |
- - Link | -- Party Account Currency - - | -- - - - -Currency - - - - | -
| 96 | -column_break_74 |
- - Column Break | -- - - | -- |
| 97 | -per_received |
- - Percent | -- % Received - - | -- |
| 98 | -per_billed |
- - Percent | -- % Billed - - | -- |
| 99 | -column_break5 |
- - Section Break | -- Printing Settings - - | -- |
| 100 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 101 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 102 | -column_break_86 |
- - Column Break | -- - - | -- |
| 103 | -group_same_items |
- - Check | -- Group same items - - | -- |
| 104 | -language |
- - Data | -- Print Language - - | -- |
| 105 | -raw_material_details |
- - Section Break | -- Raw Materials Supplied - - | -- |
| 106 | -supplied_items_section |
- - Section Break | -- Supplied Items - - | -- |
| 107 | -supplied_items |
- - Table | -- Supplied Items - - | -- - - - -Purchase Order Item Supplied - - - - | -
| 108 | -subscription_section |
- - Section Break | -- Subscription Section - - | -- |
| 109 | -from_date |
- - Date | -- From Date - - | -- |
| 110 | -to_date |
- - Date | -- To Date - - | -- |
| 111 | -column_break_97 |
- - Column Break | -- - - | -- |
| 112 | -auto_repeat |
- - Link | -- Auto Repeat - - | -- - - - -Auto Repeat - - - - | -
Inherits from erpnext.controllers.buying_controller.BuyingController - -
- - - __init__ - (self) -
-No docs
-- - - check_for_closed_status - (self) -
-No docs
-- - - check_modified_date - (self) -
-No docs
-- - - get_last_purchase_rate - (self) -
-get last purchase rates for all items
-- - - get_schedule_dates - (self) -
-No docs
-- - - has_drop_ship_item - (self) -
-No docs
-- - - is_against_so - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - set_received_qty_for_drop_ship_items - (self) -
-No docs
-- - - update_delivered_qty_in_sales_order - (self) -
-Update delivered qty in Sales Order for drop ship
-- - - update_ordered_qty - (self, po_item_rows=None) -
-update requested qty (before ordered_qty is updated)
-- - - update_requested_qty - (self) -
-No docs
-- - - update_reserved_qty_for_subcontract - (self) -
-No docs
-- - - update_status - (self, status) -
-No docs
-- - - update_status_updater - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_bom_for_subcontracting_items - (self) -
-No docs
-- - - validate_minimum_order_qty - (self) -
-No docs
-- - - validate_supplier - (self) -
-No docs
-- - - validate_with_previous_doc - (self) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.purchase_order.purchase_order.close_or_unclose_purchase_orders
-
- - - erpnext.buying.doctype.purchase_order.purchase_order.close_or_unclose_purchase_orders - (names, status) -
-No docs
-- - - erpnext.buying.doctype.purchase_order.purchase_order.get_item_details - (items) -
-No docs
-- - - erpnext.buying.doctype.purchase_order.purchase_order.item_last_purchase_rate - (name, conversion_rate, item_code, conversion_factor=1.0) -
-get last purchase rate for an item
-Public API
- /api/method/erpnext.buying.doctype.purchase_order.purchase_order.make_purchase_invoice
-
- - - erpnext.buying.doctype.purchase_order.purchase_order.make_purchase_invoice - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.purchase_order.purchase_order.make_purchase_receipt
-
- - - erpnext.buying.doctype.purchase_order.purchase_order.make_purchase_receipt - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.purchase_order.purchase_order.make_rm_stock_entry
-
- - - erpnext.buying.doctype.purchase_order.purchase_order.make_rm_stock_entry - (purchase_order, rm_items) -
-No docs
-- - - erpnext.buying.doctype.purchase_order.purchase_order.set_missing_values - (source, target) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.purchase_order.purchase_order.update_status
-
- - - erpnext.buying.doctype.purchase_order.purchase_order.update_status - (status, name) -
-No docs
-Table Name: tabPurchase Order Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -supplier_part_no |
- - Data | -- Supplier Part Number - - | -- |
| 3 | -item_name |
- - Data | -- Item Name - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -schedule_date |
- - Date | -- Reqd By Date - - | -- |
| 6 | -expected_delivery_date |
- - Date | -- Expected Delivery Date - - | -- |
| 7 | -section_break_5 |
- - Section Break | -- Description - - | -- |
| 8 | -description |
- - Text Editor | -- Description - - | -- |
| 9 | -col_break1 |
- - Column Break | -- - - | -- |
| 10 | -image |
- - Attach | -- Image - - | -- |
| 11 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 12 | -quantity_and_rate |
- - Section Break | -- Quantity and Rate - - | -- |
| 13 | -qty |
- - Float | -- Quantity - - | -- |
| 14 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 15 | -col_break2 |
- - Column Break | -- - - | -- |
| 16 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 17 | -conversion_factor |
- - Float | -- UOM Conversion Factor - - | -- |
| 18 | -sec_break1 |
- - Section Break | -- - - | -- |
| 19 | -price_list_rate |
- - Currency | -- Price List Rate - - | -
- currency- |
-
| 20 | -discount_percentage |
- - Percent | -- Discount on Price List Rate (%) - - | -- |
| 21 | -col_break3 |
- - Column Break | -- - - | -- |
| 22 | -last_purchase_rate |
- - Currency | -- Last Purchase Rate - - | -
- currency- |
-
| 23 | -base_price_list_rate |
- - Currency | -- Price List Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 24 | -sec_break2 |
- - Section Break | -- - - | -- |
| 25 | -rate |
- - Currency | -- Rate - - | -
- currency- |
-
| 26 | -amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 27 | -col_break4 |
- - Column Break | -- - - | -- |
| 28 | -base_rate |
- - Currency | -- Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 29 | -base_amount |
- - Currency | -- Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 30 | -pricing_rule |
- - Link | -- Pricing Rule - - | -- - - - -Pricing Rule - - - - | -
| 31 | -section_break_29 |
- - Section Break | -- - - | -- |
| 32 | -net_rate |
- - Currency | -- Net Rate - - | -
- currency- |
-
| 33 | -net_amount |
- - Currency | -- Net Amount - - | -
- currency- |
-
| 34 | -column_break_32 |
- - Column Break | -- - - | -- |
| 35 | -base_net_rate |
- - Currency | -- Net Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 36 | -base_net_amount |
- - Currency | -- Net Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 37 | -item_weight_details |
- - Section Break | -- Item Weight Details - - | -- |
| 38 | -weight_per_unit |
- - Float | -- Weight Per Unit - - | -- |
| 39 | -total_weight |
- - Float | -- Total Weight - - | -- |
| 40 | -column_break_40 |
- - Column Break | -- - - | -- |
| 41 | -weight_uom |
- - Link | -- Weight UOM - - | -- - - - -UOM - - - - | -
| 42 | -warehouse_and_reference |
- - Section Break | -- Warehouse and Reference - - | -- |
| 43 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 44 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 45 | -material_request |
- - Link | -- Material Request - - | -- - - - -Material Request - - - - | -
| 46 | -material_request_item |
- - Data | -- Material Request Item - - | -- |
| 47 | -sales_order |
- - Link | -- Sales Order - - | -- - - - -Sales Order - - - - | -
| 48 | -sales_order_item |
- - Data | -- Sales Order Item - - | -- |
| 49 | -supplier_quotation |
- - Link | -- Supplier Quotation - - | -- - - - -Supplier Quotation - - - - | -
| 50 | -supplier_quotation_item |
- - Link | -- Supplier Quotation Item - - | -- - - - -Supplier Quotation Item - - - - | -
| 51 | -delivered_by_supplier |
- - Check | -- To be delivered to customer - - | -- |
| 52 | -col_break5 |
- - Column Break | -- - - | -- |
| 53 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 54 | -brand |
- - Link | -- Brand - - | -- - - - -Brand - - - - | -
| 55 | -bom |
- - Link | -- BOM - - | -- - - - -BOM - - - - | -
| 56 | -include_exploded_items |
- - Check | -- Include Exploded Items - - | -- |
| 57 | -section_break_56 |
- - Section Break | -- - - | -- |
| 58 | -stock_qty |
- - Float | -- Qty as per Stock UOM - - | -- |
| 59 | -received_qty |
- - Float | -- Received Qty - - | -- |
| 60 | -returned_qty |
- - Float | -- Returned Qty - - | -- |
| 61 | -column_break_60 |
- - Column Break | -- - - | -- |
| 62 | -billed_amt |
- - Currency | -- Billed Amt - - | -
- currency- |
-
| 63 | -item_tax_rate |
- - Code | -
- Item Tax Rate
- - Tax detail table fetched from item master as a string and stored in this field. -Used for Taxes and Charges - |
- - |
| 64 | -page_break |
- - Check | -- Page Break - - | -- |
Table Name: tabPurchase Order Item Supplied
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -main_item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -rm_item_code |
- - Link | -- Raw Material Item Code - - | -- - - - -Item - - - - | -
| 3 | -required_qty |
- - Float | -- Supplied Qty - - | -- |
| 4 | -rate |
- - Currency | -- Rate - - | -
- Company:company:default_currency- |
-
| 5 | -amount |
- - Currency | -- Amount - - | -
- Company:company:default_currency- |
-
| 6 | -column_break_6 |
- - Column Break | -- - - | -- |
| 7 | -bom_detail_no |
- - Data | -- BOM Detail No - - | -- |
| 8 | -reference_name |
- - Data | -- Reference Name - - | -- |
| 9 | -conversion_factor |
- - Float | -- Conversion Factor - - | -- |
| 10 | -stock_uom |
- - Link | -- Stock Uom - - | -- - - - -UOM - - - - | -
| 11 | -reserve_warehouse |
- - Link | -- Reserve Warehouse - - | -- - - - -Warehouse - - - - | -
Table Name: tabPurchase Receipt Item Supplied
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -main_item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -rm_item_code |
- - Link | -- Raw Material Item Code - - | -- - - - -Item - - - - | -
| 3 | -description |
- - Text Editor | -- Description - - | -- |
| 4 | -batch_no |
- - Link | -- Batch No - - | -- - - - -Batch - - - - | -
| 5 | -serial_no |
- - Text | -- Serial No - - | -- |
| 6 | -col_break1 |
- - Column Break | -- - - | -- |
| 7 | -required_qty |
- - Float | -- Required Qty - - | -- |
| 8 | -consumed_qty |
- - Float | -- Consumed Qty - - | -- |
| 9 | -stock_uom |
- - Link | -- Stock Uom - - | -- - - - -UOM - - - - | -
| 10 | -rate |
- - Currency | -- Rate - - | -
- Company:company:default_currency- |
-
| 11 | -amount |
- - Currency | -- Amount - - | -
- Company:company:default_currency- |
-
| 12 | -conversion_factor |
- - Float | -- Conversion Factor - - | -- |
| 13 | -current_stock |
- - Float | -- Current Stock - - | -- |
| 14 | -reference_name |
- - Data | -- Reference Name - - | -- |
| 15 | -bom_detail_no |
- - Data | -- BOM Detail No - - | -- |
Table Name: tabRequest for Quotation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- RFQ-- |
-
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -vendor |
- - Link | -
- Supplier
- - For individual supplier - |
- - - - - -Supplier - - - - | -
| 4 | -column_break1 |
- - Column Break | -- - - | -- |
| 5 | -transaction_date |
- - Date | -- Date - - | -- |
| 6 | -suppliers_section |
- - Section Break | -- - - | -- |
| 7 | -suppliers |
- - Table | -- Supplier Detail - - | -- - - - -Request for Quotation Supplier - - - - | -
| 8 | -get_suppliers_button |
- - Button | -- Get Suppliers - - | -- |
| 9 | -items_section |
- - Section Break | -- - - | -
- fa fa-shopping-cart- |
-
| 10 | -items |
- - Table | -- Items - - | -- - - - -Request for Quotation Item - - - - | -
| 11 | -link_to_mrs |
- - Button | -- Link to material requests - - | -- |
| 12 | -supplier_response_section |
- - Section Break | -- - - | -- |
| 13 | -email_template |
- - Link | -- Email Template - - | -- - - - -Email Template - - - - | -
| 14 | -message_for_supplier |
- - Text Editor | -- Message for Supplier - - | -- |
| 15 | -terms_section_break |
- - Section Break | -- Terms and Conditions - - | -
- fa fa-legal- |
-
| 16 | -tc_name |
- - Link | -- Terms - - | -- - - - -Terms and Conditions - - - - | -
| 17 | -terms |
- - Text Editor | -- Terms and Conditions - - | -- |
| 18 | -printing_settings |
- - Section Break | -- Printing Settings - - | -- |
| 19 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 20 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 21 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 22 | -status |
- - Select | -- Status - - | -
- -Draft -Submitted -Cancelled- |
-
| 23 | -fiscal_year |
- - Link | -- Fiscal Year - - | -- - - - -Fiscal Year - - - - | -
| 24 | -column_break3 |
- - Column Break | -- - - | -- |
| 25 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Request for Quotation - - - - | -
Inherits from erpnext.controllers.buying_controller.BuyingController - -
- - - create_user - (self, rfq_supplier, link) -
-No docs
-- - - get_attachments - (self) -
-No docs
-- - - get_link - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - send_email - (self, data, sender, subject, message, attachments) -
-No docs
-- - - send_to_supplier - (self) -
-No docs
-- - - supplier_rfq_mail - (self, data, update_password_link, rfq_link) -
-No docs
-- - - update_contact_of_supplier - (self, rfq_supplier, user) -
-No docs
-- - - update_email_id - (self) -
-No docs
-- - - update_rfq_supplier_status - (self, sup_name=None) -
-No docs
-- - - update_supplier_contact - (self, rfq_supplier, link) -
-Create a new user for the supplier if not set in contact
-- - - update_supplier_part_no - (self, args) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_duplicate_supplier - (self) -
-No docs
-- - - validate_email_id - (self, args) -
-No docs
-- - - validate_supplier_list - (self) -
-No docs
-- - - erpnext.buying.doctype.request_for_quotation.request_for_quotation.add_items - (sq_doc, supplier, items) -
-No docs
-- - - erpnext.buying.doctype.request_for_quotation.request_for_quotation.check_portal_enabled - (reference_doctype) -
-No docs
-- - - erpnext.buying.doctype.request_for_quotation.request_for_quotation.create_rfq_items - (sq_doc, supplier, data) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.request_for_quotation.request_for_quotation.create_supplier_quotation
-
- - - erpnext.buying.doctype.request_for_quotation.request_for_quotation.create_supplier_quotation - (doc) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.request_for_quotation.request_for_quotation.get_item_from_material_requests_based_on_supplier
-
- - - erpnext.buying.doctype.request_for_quotation.request_for_quotation.get_item_from_material_requests_based_on_supplier - (source_name, target_doc=None) -
-No docs
-- - - erpnext.buying.doctype.request_for_quotation.request_for_quotation.get_list_context - (context=None) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.request_for_quotation.request_for_quotation.get_pdf
-
- - - erpnext.buying.doctype.request_for_quotation.request_for_quotation.get_pdf - (doctype, name, supplier_idx) -
-No docs
-- - - erpnext.buying.doctype.request_for_quotation.request_for_quotation.get_rfq_doc - (doctype, name, supplier_idx) -
-No docs
-- - - erpnext.buying.doctype.request_for_quotation.request_for_quotation.get_supplier_contacts - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.request_for_quotation.request_for_quotation.make_supplier_quotation
-
- - - erpnext.buying.doctype.request_for_quotation.request_for_quotation.make_supplier_quotation - (source_name, for_supplier, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.request_for_quotation.request_for_quotation.send_supplier_emails
-
- - - erpnext.buying.doctype.request_for_quotation.request_for_quotation.send_supplier_emails - (rfq_name) -
-No docs
-Table Name: tabRequest for Quotation Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -supplier_part_no |
- - Data | -- Supplier Part No - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -item_name |
- - Data | -- Item Name - - | -- |
| 5 | -section_break_5 |
- - Section Break | -- Description - - | -- |
| 6 | -description |
- - Text Editor | -- Description - - | -- |
| 7 | -col_break1 |
- - Column Break | -- - - | -- |
| 8 | -image |
- - Attach | -- Image - - | -- |
| 9 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 10 | -quantity |
- - Section Break | -- Quantity - - | -- |
| 11 | -qty |
- - Float | -- Quantity - - | -- |
| 12 | -col_break2 |
- - Column Break | -- - - | -- |
| 13 | -schedule_date |
- - Date | -- Required Date - - | -- |
| 14 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 15 | -warehouse_and_reference |
- - Section Break | -- Warehouse and Reference - - | -- |
| 16 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 17 | -project_name |
- - Link | -- Project Name - - | -- - - - -Project - - - - | -
| 18 | -material_request |
- - Link | -- Material Request - - | -- - - - -Material Request - - - - | -
| 19 | -col_break4 |
- - Column Break | -- - - | -- |
| 20 | -material_request_item |
- - Data | -- Material Request Item - - | -- |
| 21 | -brand |
- - Link | -- Brand - - | -- - - - -Brand - - - - | -
| 22 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 23 | -page_break |
- - Check | -- Page Break - - | -- |
Table Name: tabRequest for Quotation Supplier
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -send_email |
- - Check | -- Send Email - - | -- |
| 2 | -email_sent |
- - Check | -- Email Sent - - | -- |
| 3 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 4 | -contact |
- - Link | -- Contact - - | -- - - - -Contact - - - - | -
| 5 | -no_quote |
- - Check | -- No Quote - - | -- |
| 6 | -quote_status |
- - Select | -- Quote Status - - | -
- Pending -Received -No Quote- |
-
| 7 | -column_break_3 |
- - Column Break | -- - - | -- |
| 8 | -supplier_name |
- - Read Only | -- Supplier Name - - | -- |
| 9 | -email_id |
- - Data | -- Email Id - - | -- |
| 10 | -download_pdf |
- - Button | -- Download PDF - - | -- |
Table Name: tabSupplier
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -basic_info |
- - Section Break | -- Name and Type - - | -
- fa fa-user- |
-
| 2 | -naming_series |
- - Select | -- Series - - | -
- SUPP-- |
-
| 3 | -supplier_name |
- - Data | -- Supplier Name - - | -- |
| 4 | -country |
- - Link | -- Country - - | -- - - - -Country - - - - | -
| 5 | -tax_id |
- - Data | -- Tax ID - - | -- |
| 6 | -is_internal_supplier |
- - Check | -- Is Internal Supplier - - | -- |
| 7 | -represents_company |
- - Link | -- Represents Company - - | -- - - - -Company - - - - | -
| 8 | -image |
- - Attach Image | -- Image - - | -- |
| 9 | -column_break0 |
- - Column Break | -- - - | -- |
| 10 | -supplier_group |
- - Link | -- Supplier Group - - | -- - - - -Supplier Group - - - - | -
| 11 | -language |
- - Link | -- Print Language - - | -- - - - -Language - - - - | -
| 12 | -disabled |
- - Check | -- Disabled - - | -- |
| 13 | -warn_rfqs |
- - Check | -- Warn RFQs - - | -- |
| 14 | -warn_pos |
- - Check | -- Warn POs - - | -- |
| 15 | -prevent_rfqs |
- - Check | -- Prevent RFQs - - | -- |
| 16 | -prevent_pos |
- - Check | -- Prevent POs - - | -- |
| 17 | -allowed_to_transact_section |
- - Section Break | -- Allowed To Transact With - - | -- |
| 18 | -companies |
- - Table | -- Allowed To Transact With - - | -- - - - -Allowed To Transact With - - - - | -
| 19 | -section_break_7 |
- - Section Break | -- Currency and Price List - - | -- |
| 20 | -default_currency |
- - Link | -- Billing Currency - - | -- - - - -Currency - - - - | -
| 21 | -column_break_10 |
- - Column Break | -- - - | -- |
| 22 | -default_price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 23 | -section_credit_limit |
- - Section Break | -- Credit Limit - - | -- |
| 24 | -payment_terms |
- - Link | -- Default Payment Terms Template - - | -- - - - -Payment Terms Template - - - - | -
| 25 | -cb_21 |
- - Column Break | -- - - | -- |
| 26 | -on_hold |
- - Check | -- Block Supplier - - | -- |
| 27 | -hold_type |
- - Select | -- Hold Type - - | -
- -All -Invoices -Payments- |
-
| 28 | -release_date |
- - Date | -
- Release Date
- - Leave blank if the Supplier is blocked indefinitely - |
- - |
| 29 | -address_contacts |
- - Section Break | -- Address and Contacts - - | -
- fa fa-map-marker- |
-
| 30 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 31 | -column_break1 |
- - Column Break | -- - - | -- |
| 32 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
| 33 | -default_payable_accounts |
- - Section Break | -- Default Payable Accounts - - | -- |
| 34 | -accounts |
- - Table | -
- Accounts
- - Mention if non-standard payable account - |
- - - - - -Party Account - - - - | -
| 35 | -default_tax_withholding_config |
- - Section Break | -- Default Tax Withholding Config - - | -- |
| 36 | -tax_withholding_config |
- - Table | -- Tax Withholding Account - - | -- - - - -Party Tax Withholding Config - - - - | -
| 37 | -column_break2 |
- - Section Break | -- More Information - - | -- |
| 38 | -website |
- - Data | -- Website - - | -- |
| 39 | -supplier_details |
- - Text | -
- Supplier Details
- - Statutory info and other general information about your Supplier - |
- - |
| 40 | -column_break_30 |
- - Column Break | -- - - | -- |
| 41 | -is_frozen |
- - Check | -- Is Frozen - - | -- |
Inherits from erpnext.utilities.transaction_base.TransactionBase - -
- - - after_rename - (self, olddn, newdn, merge=False) -
-No docs
-- - - autoname - (self) -
-No docs
-- - - before_save - (self) -
-No docs
-- - - get_feed - (self) -
-No docs
-- - - load_dashboard_info - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - onload - (self) -
-Load address and contacts in __onload
- - - validate - (self) -
-No docs
-Table Name: tabSupplier Quotation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -supplier_section |
- - Section Break | -- - - | -
- fa fa-user- |
-
| 2 | -title |
- - Data | -- Title - - | -- |
| 3 | -naming_series |
- - Select | -- Series - - | -
- SQTN-- |
-
| 4 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 5 | -supplier_name |
- - Data | -- Name - - | -- |
| 6 | -column_break1 |
- - Column Break | -- - - | -- |
| 7 | -transaction_date |
- - Date | -- Date - - | -- |
| 8 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Supplier Quotation - - - - | -
| 9 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 10 | -address_section |
- - Section Break | -- Address and Contact - - | -- |
| 11 | -supplier_address |
- - Link | -- Supplier Address - - | -- - - - -Address - - - - | -
| 12 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 13 | -address_display |
- - Small Text | -- Address - - | -- |
| 14 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 15 | -contact_mobile |
- - Small Text | -- Mobile No - - | -- |
| 16 | -contact_email |
- - Data | -- Contact Email - - | -
- |
-
| 17 | -currency_and_price_list |
- - Section Break | -- Currency and Price List - - | -
- fa fa-tag- |
-
| 18 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 19 | -conversion_rate |
- - Float | -- Exchange Rate - - | -- |
| 20 | -cb_price_list |
- - Column Break | -- - - | -- |
| 21 | -buying_price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 22 | -price_list_currency |
- - Link | -- Price List Currency - - | -- - - - -Currency - - - - | -
| 23 | -plc_conversion_rate |
- - Float | -- Price List Exchange Rate - - | -- |
| 24 | -ignore_pricing_rule |
- - Check | -- Ignore Pricing Rule - - | -- |
| 25 | -items_section |
- - Section Break | -- - - | -
- fa fa-shopping-cart- |
-
| 26 | -items |
- - Table | -- Items - - | -- - - - -Supplier Quotation Item - - - - | -
| 27 | -link_to_mrs |
- - Button | -- Link to material requests - - | -- |
| 28 | -section_break_22 |
- - Section Break | -- - - | -- |
| 29 | -total_qty |
- - Float | -- Total Quantity - - | -- |
| 30 | -base_total |
- - Currency | -- Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 31 | -base_net_total |
- - Currency | -- Net Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 32 | -column_break_24 |
- - Column Break | -- - - | -- |
| 33 | -total |
- - Currency | -- Total - - | -
- currency- |
-
| 34 | -net_total |
- - Currency | -- Net Total - - | -
- currency- |
-
| 35 | -total_net_weight |
- - Float | -- Total Net Weight - - | -- |
| 36 | -taxes_section |
- - Section Break | -- Taxes and Charges - - | -
- fa fa-money- |
-
| 37 | -taxes_and_charges |
- - Link | -- Taxes and Charges - - | -- - - - -Purchase Taxes and Charges Template - - - - | -
| 38 | -column_break_36 |
- - Column Break | -- - - | -- |
| 39 | -shipping_rule |
- - Link | -- Shipping Rule - - | -- - - - -Shipping Rule - - - - | -
| 40 | -section_break_38 |
- - Section Break | -- - - | -- |
| 41 | -taxes |
- - Table | -- Purchase Taxes and Charges - - | -- - - - -Purchase Taxes and Charges - - - - | -
| 42 | -tax_breakup |
- - Section Break | -- Tax Breakup - - | -- |
| 43 | -other_charges_calculation |
- - Text | -- Taxes and Charges Calculation - - | -- |
| 44 | -totals |
- - Section Break | -- - - | -
- fa fa-money- |
-
| 45 | -base_taxes_and_charges_added |
- - Currency | -- Taxes and Charges Added (Company Currency) - - | -
- Company:company:default_currency- |
-
| 46 | -base_taxes_and_charges_deducted |
- - Currency | -- Taxes and Charges Deducted (Company Currency) - - | -
- Company:company:default_currency- |
-
| 47 | -base_total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges (Company Currency) - - | -
- Company:company:default_currency- |
-
| 48 | -column_break_37 |
- - Column Break | -- - - | -- |
| 49 | -taxes_and_charges_added |
- - Currency | -- Taxes and Charges Added - - | -
- currency- |
-
| 50 | -taxes_and_charges_deducted |
- - Currency | -- Taxes and Charges Deducted - - | -
- currency- |
-
| 51 | -total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges - - | -
- currency- |
-
| 52 | -section_break_41 |
- - Section Break | -- Additional Discount - - | -- |
| 53 | -apply_discount_on |
- - Select | -- Apply Additional Discount On - - | -
- -Grand Total -Net Total- |
-
| 54 | -base_discount_amount |
- - Currency | -- Additional Discount Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 55 | -column_break_43 |
- - Column Break | -- - - | -- |
| 56 | -additional_discount_percentage |
- - Float | -- Additional Discount Percentage - - | -- |
| 57 | -discount_amount |
- - Currency | -- Additional Discount Amount - - | -
- currency- |
-
| 58 | -section_break_46 |
- - Section Break | -- - - | -- |
| 59 | -base_grand_total |
- - Currency | -- Grand Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 60 | -base_rounding_adjustment |
- - Currency | -- Rounding Adjustment (Company Currency - - | -
- Company:company:default_currency- |
-
| 61 | -base_in_words |
- - Data | -- In Words (Company Currency) - - | -- |
| 62 | -base_rounded_total |
- - Currency | -- Rounded Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 63 | -column_break4 |
- - Column Break | -- - - | -- |
| 64 | -grand_total |
- - Currency | -- Grand Total - - | -
- currency- |
-
| 65 | -rounding_adjustment |
- - Currency | -- Rounding Adjustment - - | -
- currency- |
-
| 66 | -in_words |
- - Data | -- In Words - - | -- |
| 67 | -terms_section_break |
- - Section Break | -- Terms and Conditions - - | -
- fa fa-legal- |
-
| 68 | -tc_name |
- - Link | -- Terms - - | -- - - - -Terms and Conditions - - - - | -
| 69 | -terms |
- - Text Editor | -- Terms and Conditions - - | -- |
| 70 | -printing_settings |
- - Section Break | -- Printing Settings - - | -- |
| 71 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 72 | -group_same_items |
- - Check | -- Group same items - - | -- |
| 73 | -column_break_72 |
- - Column Break | -- - - | -- |
| 74 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 75 | -language |
- - Data | -- Print Language - - | -- |
| 76 | -subscription_section |
- - Section Break | -- Auto Repeat Section - - | -- |
| 77 | -auto_repeat |
- - Link | -- Auto Repeat - - | -- - - - -Auto Repeat - - - - | -
| 78 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 79 | -status |
- - Select | -- Status - - | -
- -Draft -Submitted -Stopped -Cancelled- |
-
| 80 | -column_break_57 |
- - Column Break | -- - - | -- |
| 81 | -is_subcontracted |
- - Select | -- Is Subcontracted - - | -
- -Yes -No- |
-
| 82 | -reference |
- - Section Break | -- Reference - - | -- |
| 83 | -opportunity |
- - Link | -- Opportunity - - | -- - - - -Opportunity - - - - | -
Inherits from erpnext.controllers.buying_controller.BuyingController - -
- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - update_rfq_supplier_status - (self, include_me) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_with_previous_doc - (self) -
-No docs
-- - - erpnext.buying.doctype.supplier_quotation.supplier_quotation.get_list_context - (context=None) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.supplier_quotation.supplier_quotation.make_purchase_order
-
- - - erpnext.buying.doctype.supplier_quotation.supplier_quotation.make_purchase_order - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.supplier_quotation.supplier_quotation.make_quotation
-
- - - erpnext.buying.doctype.supplier_quotation.supplier_quotation.make_quotation - (source_name, target_doc=None) -
-No docs
-Table Name: tabSupplier Quotation Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -supplier_part_no |
- - Data | -- Supplier Part Number - - | -- |
| 3 | -item_name |
- - Data | -- Item Name - - | -- |
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -lead_time_days |
- - Int | -- Lead Time in days - - | -- |
| 6 | -section_break_5 |
- - Section Break | -- Description - - | -- |
| 7 | -description |
- - Text Editor | -- Description - - | -- |
| 8 | -col_break1 |
- - Column Break | -- - - | -- |
| 9 | -image |
- - Attach | -- Image - - | -- |
| 10 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 11 | -quantity_and_rate |
- - Section Break | -- Quantity and Rate - - | -- |
| 12 | -qty |
- - Float | -- Quantity - - | -- |
| 13 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 14 | -price_list_rate |
- - Currency | -- Price List Rate - - | -
- currency- |
-
| 15 | -discount_percentage |
- - Percent | -- Discount on Price List Rate (%) - - | -- |
| 16 | -col_break2 |
- - Column Break | -- - - | -- |
| 17 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 18 | -conversion_factor |
- - Float | -- UOM Conversion Factor - - | -- |
| 19 | -stock_qty |
- - Float | -- Qty as per Stock UOM - - | -- |
| 20 | -base_price_list_rate |
- - Currency | -- Price List Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 21 | -sec_break1 |
- - Section Break | -- - - | -- |
| 22 | -rate |
- - Currency | -- Rate - - | -
- currency- |
-
| 23 | -amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 24 | -col_break3 |
- - Column Break | -- - - | -- |
| 25 | -base_rate |
- - Currency | -- Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 26 | -base_amount |
- - Currency | -- Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 27 | -pricing_rule |
- - Link | -- Pricing Rule - - | -- - - - -Pricing Rule - - - - | -
| 28 | -section_break_24 |
- - Section Break | -- - - | -- |
| 29 | -net_rate |
- - Currency | -- Net Rate - - | -- |
| 30 | -net_amount |
- - Currency | -- Net Amount - - | -
- currency- |
-
| 31 | -column_break_27 |
- - Column Break | -- - - | -- |
| 32 | -base_net_rate |
- - Currency | -- Net Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 33 | -base_net_amount |
- - Currency | -- Net Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 34 | -item_weight_details |
- - Section Break | -- Item Weight Details - - | -- |
| 35 | -weight_per_unit |
- - Float | -- Weight Per Unit - - | -- |
| 36 | -total_weight |
- - Float | -- Total Weight - - | -- |
| 37 | -column_break_23 |
- - Column Break | -- - - | -- |
| 38 | -weight_uom |
- - Link | -- Weight UOM - - | -- - - - -UOM - - - - | -
| 39 | -warehouse_and_reference |
- - Section Break | -- Warehouse and Reference - - | -- |
| 40 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 41 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 42 | -prevdoc_doctype |
- - Data | -- Prevdoc DocType - - | -- |
| 43 | -material_request |
- - Link | -- Material Request - - | -- - - - -Material Request - - - - | -
| 44 | -sales_order |
- - Link | -- Sales Order - - | -- - - - -Sales Order - - - - | -
| 45 | -request_for_quotation |
- - Link | -- Request for Quotation - - | -- - - - -Request for Quotation - - - - | -
| 46 | -col_break4 |
- - Column Break | -- - - | -- |
| 47 | -material_request_item |
- - Data | -- Material Request Item - - | -- |
| 48 | -request_for_quotation_item |
- - Data | -- Request for Quotation Item - - | -- |
| 49 | -brand |
- - Link | -- Brand - - | -- - - - -Brand - - - - | -
| 50 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 51 | -item_tax_rate |
- - Code | -
- Item Tax Rate
- - Tax detail table fetched from item master as a string and stored in this field. -Used for Taxes and Charges - |
- - |
| 52 | -section_break_44 |
- - Section Break | -- - - | -- |
| 53 | -page_break |
- - Check | -- Page Break - - | -- |
Table Name: tabSupplier Scorecard
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 2 | -supplier_score |
- - Data | -- Supplier Score - - | -- |
| 3 | -indicator_color |
- - Data | -- Indicator Color - - | -- |
| 4 | -status |
- - Data | -- Status - - | -- |
| 5 | -column_break_2 |
- - Column Break | -- - - | -- |
| 6 | -period |
- - Select | -- Evaluation Period - - | -
- Per Month -Per Week -Per Year- |
-
| 7 | -scoring_setup |
- - Section Break | -- Scoring Setup - - | -- |
| 8 | -weighting_function |
- - Small Text | -
- Weighting Function
- - Scorecard variables can be used, as well as: -{total_score} (the total score from that period), -{period_number} (the number of periods to present day) - - |
- - |
| 9 | -standings |
- - Table | -- Scoring Standings - - | -- - - - -Supplier Scorecard Scoring Standing - - - - | -
| 10 | -criteria_setup |
- - Section Break | -- Criteria Setup - - | -- |
| 11 | -criteria |
- - Table | -- Scoring Criteria - - | -- - - - -Supplier Scorecard Scoring Criteria - - - - | -
| 12 | -variables |
- - Table | -- Supplier Variables - - | -- - - - -Supplier Scorecard Scoring Variable - - - - | -
| 13 | -scorecard_actions |
- - Section Break | -- Scorecard Actions - - | -- |
| 14 | -warn_rfqs |
- - Check | -- Warn for new Request for Quotations - - | -- |
| 15 | -warn_pos |
- - Check | -- Warn for new Purchase Orders - - | -- |
| 16 | -prevent_rfqs |
- - Check | -- Prevent RFQs - - | -- |
| 17 | -prevent_pos |
- - Check | -- Prevent POs - - | -- |
| 18 | -column_break_16 |
- - Column Break | -- - - | -- |
| 19 | -notify_supplier |
- - Check | -- Notify Supplier - - | -- |
| 20 | -notify_employee |
- - Check | -- Notify Employee - - | -- |
| 21 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
Inherits from frappe.model.document.Document - -
- - - calculate_total_score - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - update_standing - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_criteria_weights - (self) -
-No docs
-- - - validate_standings - (self) -
-No docs
-- - - erpnext.buying.doctype.supplier_scorecard.supplier_scorecard.daterange - (start_date, end_date) -
-No docs
-- - - erpnext.buying.doctype.supplier_scorecard.supplier_scorecard.get_scorecard_date - (period, start_date) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.supplier_scorecard.supplier_scorecard.get_timeline_data
-
- - - erpnext.buying.doctype.supplier_scorecard.supplier_scorecard.get_timeline_data - (doctype, name) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.supplier_scorecard.supplier_scorecard.make_all_scorecards
-
- - - erpnext.buying.doctype.supplier_scorecard.supplier_scorecard.make_all_scorecards - (docname) -
-No docs
-- - - erpnext.buying.doctype.supplier_scorecard.supplier_scorecard.make_default_records - () -
-No docs
-- - - erpnext.buying.doctype.supplier_scorecard.supplier_scorecard.refresh_scorecards - () -
-No docs
-Table Name: tabSupplier Scorecard Criteria
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -criteria_name |
- - Data | -- Criteria Name - - | -- |
| 2 | -weight |
- - Percent | -- Criteria Weight - - | -- |
| 3 | -max_score |
- - Float | -- Max Score - - | -- |
| 4 | -formula |
- - Small Text | -- Criteria Formula - - | -- |
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_formula - (self) -
-No docs
-- - - validate_variables - (self) -
-No docs
-- - - erpnext.buying.doctype.supplier_scorecard_criteria.supplier_scorecard_criteria._get_variables - (criteria) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.supplier_scorecard_criteria.supplier_scorecard_criteria.get_criteria_list
-
- - - erpnext.buying.doctype.supplier_scorecard_criteria.supplier_scorecard_criteria.get_criteria_list - () -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.supplier_scorecard_criteria.supplier_scorecard_criteria.get_scoring_criteria
-
- - - erpnext.buying.doctype.supplier_scorecard_criteria.supplier_scorecard_criteria.get_scoring_criteria - (criteria_name) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.supplier_scorecard_criteria.supplier_scorecard_criteria.get_variables
-
- - - erpnext.buying.doctype.supplier_scorecard_criteria.supplier_scorecard_criteria.get_variables - (criteria_name) -
-No docs
-Table Name: tabSupplier Scorecard Period
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 2 | -naming_series |
- - Select | -- Naming Series - - | -
- SSC-- |
-
| 3 | -total_score |
- - Percent | -- Period Score - - | -- |
| 4 | -column_break_2 |
- - Column Break | -- - - | -- |
| 5 | -start_date |
- - Date | -- Start Date - - | -- |
| 6 | -end_date |
- - Date | -- End Date - - | -- |
| 7 | -section_break_11 |
- - Section Break | -- Calculations - - | -- |
| 8 | -criteria |
- - Table | -- Criteria - - | -- - - - -Supplier Scorecard Scoring Criteria - - - - | -
| 9 | -variables |
- - Table | -- Variables - - | -- - - - -Supplier Scorecard Scoring Variable - - - - | -
| 10 | -sec_ref |
- - Section Break | -- Reference - - | -- |
| 11 | -scorecard |
- - Link | -- Supplier Scorecard Setup - - | -- - - - -Supplier Scorecard - - - - | -
Inherits from frappe.model.document.Document - -
- - - calculate_criteria - (self) -
-No docs
-- - - calculate_score - (self) -
-No docs
-- - - calculate_variables - (self) -
-No docs
-- - - calculate_weighted_score - (self, weighing_function) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_criteria_weights - (self) -
-No docs
-- - - erpnext.buying.doctype.supplier_scorecard_period.supplier_scorecard_period.import_string_path - (path) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.supplier_scorecard_period.supplier_scorecard_period.make_supplier_scorecard
-
- - - erpnext.buying.doctype.supplier_scorecard_period.supplier_scorecard_period.make_supplier_scorecard - (source_name, target_doc=None) -
-No docs
-- - - erpnext.buying.doctype.supplier_scorecard_period.supplier_scorecard_period.post_process - (source, target) -
-No docs
-Table Name: tabSupplier Scorecard Scoring Criteria
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -criteria_name |
- - Link | -- Criteria Name - - | -- - - - -Supplier Scorecard Criteria - - - - | -
| 2 | -section_break_2 |
- - Section Break | -- - - | -- |
| 3 | -weight |
- - Percent | -- Criteria Weight - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -max_score |
- - Float | -- Max Score - - | -- |
| 6 | -section_break_6 |
- - Section Break | -- - - | -- |
| 7 | -formula |
- - Small Text | -- Criteria Formula - - | -- |
| 8 | -score |
- - Percent | -- Score - - | -- |
Table Name: tabSupplier Scorecard Scoring Standing
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -standing_name |
- - Link | -- Standing Name - - | -- - - - -Supplier Scorecard Standing - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -standing_color |
- - Select | -- Color - - | -
- Blue -Purple -Green -Yellow -Orange -Red- |
-
| 4 | -section_break_4 |
- - Section Break | -- - - | -- |
| 5 | -min_grade |
- - Percent | -- Min Grade - - | -- |
| 6 | -max_grade |
- - Percent | -- Max Grade - - | -- |
| 7 | -actions |
- - Section Break | -- Actions - - | -- |
| 8 | -warn_rfqs |
- - Check | -- Warn RFQs - - | -- |
| 9 | -warn_pos |
- - Check | -- Warn Purchase Orders - - | -- |
| 10 | -prevent_rfqs |
- - Check | -- Prevent RFQs - - | -- |
| 11 | -prevent_pos |
- - Check | -- Prevent Purchase Orders - - | -- |
| 12 | -column_break_10 |
- - Column Break | -- - - | -- |
| 13 | -notify_supplier |
- - Check | -- Notify Supplier - - | -- |
| 14 | -notify_employee |
- - Check | -- Notify Employee - - | -- |
| 15 | -employee_link |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
Table Name: tabSupplier Scorecard Scoring Variable
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -variable_label |
- - Link | -- Variable Name - - | -- - - - -Supplier Scorecard Variable - - - - | -
| 2 | -description |
- - Small Text | -- Description - - | -- |
| 3 | -is_custom |
- - Check | -- Custom? - - | -- |
| 4 | -param_name |
- - Data | -- Parameter Name - - | -- |
| 5 | -path |
- - Data | -- Path - - | -- |
| 6 | -value |
- - Float | -- Value - - | -- |
Table Name: tabSupplier Scorecard Standing
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -standing_name |
- - Data | -- Standing Name - - | -- |
| 2 | -standing_color |
- - Select | -- Color - - | -
- Blue -Purple -Green -Yellow -Orange -Red- |
-
| 3 | -min_grade |
- - Percent | -- Min Grade - - | -- |
| 4 | -max_grade |
- - Percent | -- Max Grade - - | -- |
| 5 | -column_break_5 |
- - Column Break | -- - - | -- |
| 6 | -warn_rfqs |
- - Check | -- Warn RFQs - - | -- |
| 7 | -warn_pos |
- - Check | -- Warn Purchase Orders - - | -- |
| 8 | -prevent_rfqs |
- - Check | -- Prevent RFQs - - | -- |
| 9 | -prevent_pos |
- - Check | -- Prevent Purchase Orders - - | -- |
| 10 | -notify_supplier |
- - Check | -- Notify Supplier - - | -- |
| 11 | -notify_employee |
- - Check | -- Notify Other - - | -- |
| 12 | -employee_link |
- - Link | -- Other - - | -- - - - -Employee - - - - | -
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.buying.doctype.supplier_scorecard_standing.supplier_scorecard_standing.get_scoring_standing
-
- - - erpnext.buying.doctype.supplier_scorecard_standing.supplier_scorecard_standing.get_scoring_standing - (standing_name) -
-No docs
-Public API
- /api/method/erpnext.buying.doctype.supplier_scorecard_standing.supplier_scorecard_standing.get_standings_list
-
- - - erpnext.buying.doctype.supplier_scorecard_standing.supplier_scorecard_standing.get_standings_list - () -
-No docs
-Table Name: tabSupplier Scorecard Variable
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -variable_label |
- - Data | -- Variable Name - - | -- |
| 2 | -is_custom |
- - Check | -- Custom? - - | -- |
| 3 | -param_name |
- - Data | -- Parameter Name - - | -- |
| 4 | -path |
- - Data | -- Path - - | -- |
| 5 | -column_break_5 |
- - Column Break | -- - - | -- |
| 6 | -description |
- - Small Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_path_exists - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_cost_of_delayed_shipments - (scorecard) -
-Gets the total cost of all delayed shipments in the period (based on Purchase Receipts - POs)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_cost_of_on_time_shipments - (scorecard) -
-Gets the total cost of all on_time shipments in the period (based on Purchase Receipts)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_item_workdays - (scorecard) -
-Gets the number of days in this period
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_late_shipments - (scorecard) -
-Gets the number of late shipments (counting each item) in the period (based on Purchase Receipts vs POs)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_on_time_shipments - (scorecard) -
-Gets the number of late shipments (counting each item) in the period (based on Purchase Receipts vs POs)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_rfq_response_days - (scorecard) -
-Gets the total number of days it has taken a supplier to respond to rfqs in the period
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_rfq_total_items - (scorecard) -
-Gets the total number of RFQ items sent to supplier
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_rfq_total_number - (scorecard) -
-Gets the total number of RFQs sent to supplier
-Public API
- /api/method/erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_scoring_variable
-
- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_scoring_variable - (variable_label) -
-No docs
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_sq_total_items - (scorecard) -
-Gets the total number of RFQ items sent to supplier
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_sq_total_number - (scorecard) -
-Gets the total number of RFQ items sent to supplier
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_total_accepted_amount - (scorecard) -
-Gets the total amount (in company currency) accepted in the period (based on Purchase Receipts)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_total_accepted_items - (scorecard) -
-Gets the total number of rejected items in the period (based on Purchase Receipts)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_total_cost_of_shipments - (scorecard) -
-Gets the total cost of all shipments in the period (based on Purchase Orders)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_total_days_late - (scorecard) -
-Gets the number of item days late in the period (based on Purchase Receipts vs POs)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_total_received - (scorecard) -
-Gets the total number of received shipments in the period (based on Purchase Receipts)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_total_received_amount - (scorecard) -
-Gets the total amount (in company currency) received in the period (based on Purchase Receipts)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_total_received_items - (scorecard) -
-Gets the total number of received shipments in the period (based on Purchase Receipts)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_total_rejected_amount - (scorecard) -
-Gets the total amount (in company currency) rejected in the period (based on Purchase Receipts)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_total_rejected_items - (scorecard) -
-Gets the total number of rejected items in the period (based on Purchase Receipts)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_total_shipments - (scorecard) -
-Gets the total number of ordered shipments to arrive in the period (based on Purchase Receipts)
-- - - erpnext.buying.doctype.supplier_scorecard_variable.supplier_scorecard_variable.get_total_workdays - (scorecard) -
-Gets the number of days in this period
-Table Name: tabLead
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -organization_lead |
- - Check | -- Lead is an Organization - - | -- |
| 2 | -lead_details |
- - Section Break | -- - - | -
- fa fa-user- |
-
| 3 | -naming_series |
- - Select | -- Series - - | -
- LEAD-- |
-
| 4 | -lead_name |
- - Data | -- Person Name - - | -- |
| 5 | -company_name |
- - Data | -- Organization Name - - | -- |
| 6 | -email_id |
- - Data | -- Email Address - - | -
- |
-
| 7 | -col_break123 |
- - Column Break | -- - - | -- |
| 8 | -status |
- - Select | -- Status - - | -
- Lead -Open -Replied -Opportunity -Quotation -Lost Quotation -Interested -Converted -Do Not Contact- |
-
| 9 | -gender |
- - Link | -- Gender - - | -- - - - -Gender - - - - | -
| 10 | -source |
- - Link | -- Source - - | -- - - - -Lead Source - - - - | -
| 11 | -customer |
- - Link | -- From Customer - - | -- - - - -Customer - - - - | -
| 12 | -campaign_name |
- - Link | -- Campaign Name - - | -- - - - -Campaign - - - - | -
| 13 | -image |
- - Attach Image | -- Image - - | -- |
| 14 | -section_break_12 |
- - Section Break | -- Follow Up - - | -- |
| 15 | -lead_owner |
- - Link | -- Lead Owner - - | -- - - - -User - - - - | -
| 16 | -contact_by |
- - Link | -- Next Contact By - - | -- - - - -User - - - - | -
| 17 | -column_break_14 |
- - Column Break | -- - - | -- |
| 18 | -contact_date |
- - Datetime | -- Next Contact Date - - | -- |
| 19 | -ends_on |
- - Datetime | -- Ends On - - | -- |
| 20 | -contact_info |
- - Section Break | -- Address & Contact - - | -
- fa fa-map-marker- |
-
| 21 | -address_desc |
- - HTML | -- Address Desc - - | -- |
| 22 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 23 | -column_break2 |
- - Column Break | -- - - | -- |
| 24 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
| 25 | -phone |
- - Data | -- Phone - - | -- |
| 26 | -salutation |
- - Link | -- Salutation - - | -- - - - -Salutation - - - - | -
| 27 | -mobile_no |
- - Data | -- Mobile No. - - | -- |
| 28 | -fax |
- - Data | -- Fax - - | -- |
| 29 | -website |
- - Data | -- Website - - | -- |
| 30 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 31 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 32 | -type |
- - Select | -- Lead Type - - | -
- -Client -Channel Partner -Consultant- |
-
| 33 | -market_segment |
- - Select | -- Market Segment - - | -
- -Lower Income -Middle Income -Upper Income- |
-
| 34 | -industry |
- - Link | -- Industry - - | -- - - - -Industry Type - - - - | -
| 35 | -request_type |
- - Select | -- Request Type - - | -
- -Product Enquiry -Request for Information -Suggestions -Other- |
-
| 36 | -column_break3 |
- - Column Break | -- - - | -- |
| 37 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 38 | -unsubscribed |
- - Check | -- Unsubscribed - - | -- |
| 39 | -blog_subscriber |
- - Check | -- Blog Subscriber - - | -- |
Inherits from erpnext.controllers.selling_controller.SellingController - -
- - - add_calendar_event - (self, opts=None, force=False) -
-No docs
-- - - check_email_id_is_unique - (self) -
-No docs
-- - - get_feed - (self) -
-No docs
-- - - has_customer - (self) -
-No docs
-- - - has_lost_quotation - (self) -
-No docs
-- - - has_opportunity - (self) -
-No docs
-- - - has_quotation - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - set_lead_name - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.crm.doctype.lead.lead._make_customer - (source_name, target_doc=None, ignore_permissions=False) -
-No docs
-Public API
- /api/method/erpnext.crm.doctype.lead.lead.get_lead_details
-
- - - erpnext.crm.doctype.lead.lead.get_lead_details - (lead, posting_date=None, company=None) -
-No docs
-Public API
- /api/method/erpnext.crm.doctype.lead.lead.make_customer
-
- - - erpnext.crm.doctype.lead.lead.make_customer - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.crm.doctype.lead.lead.make_opportunity
-
- - - erpnext.crm.doctype.lead.lead.make_opportunity - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.crm.doctype.lead.lead.make_quotation
-
- - - erpnext.crm.doctype.lead.lead.make_quotation - (source_name, target_doc=None) -
-No docs
-Table Name: tabOpportunity
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -from_section |
- - Section Break | -- - - | -
- fa fa-user- |
-
| 2 | -naming_series |
- - Select | -- Series - - | -
- OPTY-- |
-
| 3 | -enquiry_from |
- - Select | -- Opportunity From - - | -
- -Lead -Customer- |
-
| 4 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 5 | -lead |
- - Link | -- Lead - - | -- - - - -Lead - - - - | -
| 6 | -customer_name |
- - Data | -- Customer / Lead Name - - | -- |
| 7 | -column_break0 |
- - Column Break | -- - - | -- |
| 8 | -title |
- - Data | -- Title - - | -- |
| 9 | -opportunity_type |
- - Link | -- Opportunity Type - - | -- - - - -Opportunity Type - - - - | -
| 10 | -status |
- - Select | -- Status - - | -
- Open -Quotation -Converted -Lost -Replied -Closed- |
-
| 11 | -order_lost_reason |
- - Small Text | -- Lost Reason - - | -- |
| 12 | -mins_to_first_response |
- - Float | -- Mins to first response - - | -- |
| 13 | -with_items |
- - Check | -- With Items - - | -- |
| 14 | -next_contact |
- - Section Break | -- Follow Up - - | -- |
| 15 | -contact_by |
- - Link | -- Next Contact By - - | -- - - - -User - - - - | -
| 16 | -contact_date |
- - Datetime | -- Next Contact Date - - | -- |
| 17 | -column_break2 |
- - Column Break | -- - - | -- |
| 18 | -to_discuss |
- - Small Text | -- To Discuss - - | -- |
| 19 | -items_section |
- - Section Break | -- Items - - | -
- fa fa-shopping-cart- |
-
| 20 | -items |
- - Table | -- Items - - | -- - - - -Opportunity Item - - - - | -
| 21 | -contact_info |
- - Section Break | -- Contact Info - - | -
- fa fa-bullhorn- |
-
| 22 | -customer_address |
- - Link | -- Customer / Lead Address - - | -- - - - -Address - - - - | -
| 23 | -address_display |
- - Small Text | -- Address - - | -- |
| 24 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 25 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 26 | -column_break3 |
- - Column Break | -- - - | -- |
| 27 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 28 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 29 | -contact_email |
- - Data | -- Contact Email - - | -- |
| 30 | -contact_mobile |
- - Small Text | -- Contact Mobile No - - | -- |
| 31 | -more_info |
- - Section Break | -- Source - - | -
- fa fa-file-text- |
-
| 32 | -source |
- - Link | -- Source - - | -- - - - -Lead Source - - - - | -
| 33 | -campaign |
- - Link | -
- Campaign
- - Enter name of campaign if source of enquiry is campaign - |
- - - - - -Campaign - - - - | -
| 34 | -column_break1 |
- - Column Break | -- - - | -- |
| 35 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 36 | -transaction_date |
- - Date | -- Opportunity Date - - | -- |
| 37 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Opportunity - - - - | -
Inherits from erpnext.utilities.transaction_base.TransactionBase - -
- - - add_calendar_event - (self, opts=None, force=False) -
-No docs
-- - - after_insert - (self) -
-No docs
-- - - declare_enquiry_lost - (self, arg) -
-No docs
-- - - has_active_quotation - (self) -
-No docs
-- - - has_lost_quotation - (self) -
-No docs
-- - - has_ordered_quotation - (self) -
-No docs
-- - - make_new_lead_if_required - (self) -
-Set lead against new opportunity
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_cust_name - (self) -
-No docs
-- - - validate_item_details - (self) -
-No docs
-- - - validate_lead_cust - (self) -
-No docs
-- - - erpnext.crm.doctype.opportunity.opportunity.auto_close_opportunity - () -
-auto close the Replied Opportunities after 7 days
Public API
- /api/method/erpnext.crm.doctype.opportunity.opportunity.get_item_details
-
- - - erpnext.crm.doctype.opportunity.opportunity.get_item_details - (item_code) -
-No docs
-Public API
- /api/method/erpnext.crm.doctype.opportunity.opportunity.make_quotation
-
- - - erpnext.crm.doctype.opportunity.opportunity.make_quotation - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.crm.doctype.opportunity.opportunity.make_request_for_quotation
-
- - - erpnext.crm.doctype.opportunity.opportunity.make_request_for_quotation - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.crm.doctype.opportunity.opportunity.make_supplier_quotation
-
- - - erpnext.crm.doctype.opportunity.opportunity.make_supplier_quotation - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.crm.doctype.opportunity.opportunity.set_multiple_status
-
- - - erpnext.crm.doctype.opportunity.opportunity.set_multiple_status - (names, status) -
-No docs
-Table Name: tabOpportunity Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -col_break1 |
- - Column Break | -- - - | -- |
| 3 | -qty |
- - Float | -- Qty - - | -- |
| 4 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 5 | -brand |
- - Link | -- Brand - - | -- - - - -Brand - - - - | -
| 6 | -section_break_6 |
- - Section Break | -- - - | -- |
| 7 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 8 | -item_name |
- - Data | -- Item Name - - | -- |
| 9 | -description |
- - Text Editor | -- Description - - | -- |
| 10 | -column_break_8 |
- - Column Break | -- - - | -- |
| 11 | -image |
- - Attach | -- Image - - | -- |
| 12 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 13 | -basic_rate |
- - Currency | -- Basic Rate - - | -
- Company:company:default_currency- |
-
Table Name: tabOpportunity Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -description |
- - Small Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabAcademic Term
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 2 | -term_name |
- - Data | -- Term Name - - | -- |
| 3 | -term_start_date |
- - Date | -- Term Start Date - - | -- |
| 4 | -term_end_date |
- - Date | -- Term End Date - - | -- |
| 5 | -title |
- - Data | -- Title - - | -- |
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.education.doctype.academic_term.academic_term.validate_duplication - (self) -
-No docs
-Table Name: tabAcademic Year
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -academic_year_name |
- - Data | -- Academic Year Name - - | -- |
| 2 | -year_start_date |
- - Date | -- Year Start Date - - | -- |
| 3 | -year_end_date |
- - Date | -- Year End Date - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabAssessment Criteria
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -assessment_criteria |
- - Data | -- Assessment Criteria - - | -- |
| 2 | -assessment_criteria_group |
- - Link | -- Assessment Criteria Group - - | -- - - - -Assessment Criteria Group - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabAssessment Criteria Group
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -assessment_criteria_group |
- - Data | -- Assessment Criteria Group - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabAssessment Group
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -assessment_group_name |
- - Data | -- Assessment Group Name - - | -- |
| 2 | -is_group |
- - Check | -- Is Group - - | -- |
| 3 | -section_break_2 |
- - Section Break | -- - - | -- |
| 4 | -parent_assessment_group |
- - Link | -- Parent Assessment Group - - | -- - - - -Assessment Group - - - - | -
| 5 | -lft |
- - Int | -- lft - - | -- |
| 6 | -rgt |
- - Int | -- rgt - - | -- |
| 7 | -old_parent |
- - Link | -- old_parent - - | -- - - - -Assessment Group - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabAssessment Plan
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student_group |
- - Link | -- Student Group - - | -- - - - -Student Group - - - - | -
| 2 | -assessment_name |
- - Data | -- Assessment Name - - | -- |
| 3 | -assessment_group |
- - Link | -- Assessment Group - - | -- - - - -Assessment Group - - - - | -
| 4 | -grading_scale |
- - Link | -- Grading Scale - - | -- - - - -Grading Scale - - - - | -
| 5 | -column_break_2 |
- - Column Break | -- - - | -- |
| 6 | -course |
- - Link | -- Course - - | -- - - - -Course - - - - | -
| 7 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 8 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 9 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 10 | -section_break_5 |
- - Section Break | -- Schedule - - | -- |
| 11 | -schedule_date |
- - Date | -- Schedule Date - - | -- |
| 12 | -room |
- - Link | -- Room - - | -- - - - -Room - - - - | -
| 13 | -examiner |
- - Link | -- Examiner - - | -- - - - -Instructor - - - - | -
| 14 | -examiner_name |
- - Data | -- Examiner Name - - | -- |
| 15 | -column_break_4 |
- - Column Break | -- - - | -- |
| 16 | -from_time |
- - Time | -- From Time - - | -- |
| 17 | -to_time |
- - Time | -- To Time - - | -- |
| 18 | -supervisor |
- - Link | -- Supervisor - - | -- - - - -Instructor - - - - | -
| 19 | -supervisor_name |
- - Data | -- Supervisor Name - - | -- |
| 20 | -section_break_20 |
- - Section Break | -- Evaluate - - | -- |
| 21 | -maximum_assessment_score |
- - Float | -- Maximum Assessment Score - - | -- |
| 22 | -assessment_criteria |
- - Table | -- Assessment Criteria - - | -- - - - -Assessment Plan Criteria - - - - | -
| 23 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Assessment Plan - - - - | -
Inherits from frappe.model.document.Document - -
- - - set_missing_field - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_assessment_criteria - (self) -
-No docs
-- - - validate_max_score - (self) -
-No docs
-- - - validate_overlap - (self) -
-Validates overlap for Student Group, Instructor, Room
-Table Name: tabAssessment Plan Criteria
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -assessment_criteria |
- - Link | -- Assessment Criteria - - | -- - - - -Assessment Criteria - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -maximum_score |
- - Float | -- Maximum Score - - | -- |
Table Name: tabAssessment Result
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -assessment_plan |
- - Link | -- Assessment Plan - - | -- - - - -Assessment Plan - - - - | -
| 2 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 3 | -course |
- - Link | -- Course - - | -- - - - -Course - - - - | -
| 4 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 5 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 6 | -column_break_3 |
- - Column Break | -- - - | -- |
| 7 | -student |
- - Link | -- Student - - | -- - - - -Student - - - - | -
| 8 | -student_name |
- - Data | -- Student Name - - | -- |
| 9 | -student_group |
- - Link | -- Student Group - - | -- - - - -Student Group - - - - | -
| 10 | -assessment_group |
- - Link | -- Assessment Group - - | -- - - - -Assessment Group - - - - | -
| 11 | -grading_scale |
- - Link | -- Grading Scale - - | -- - - - -Grading Scale - - - - | -
| 12 | -section_break_5 |
- - Section Break | -- Result - - | -- |
| 13 | -details |
- - Table | -- Details - - | -- - - - -Assessment Result Detail - - - - | -
| 14 | -section_break_8 |
- - Section Break | -- - - | -- |
| 15 | -maximum_score |
- - Float | -- Maximum Score - - | -- |
| 16 | -column_break_11 |
- - Column Break | -- - - | -- |
| 17 | -total_score |
- - Float | -- Total Score - - | -- |
| 18 | -grade |
- - Data | -- Grade - - | -- |
| 19 | -section_break_13 |
- - Section Break | -- Summary - - | -- |
| 20 | -comment |
- - Small Text | -- Comment - - | -- |
| 21 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Assessment Result - - - - | -
Inherits from frappe.model.document.Document - -
- - - set_missing_values - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_duplicate - (self) -
-No docs
-- - - validate_grade - (self) -
-No docs
-- - - validate_maximum_score - (self) -
-No docs
-Table Name: tabAssessment Result Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -assessment_criteria |
- - Link | -- Assessment Criteria - - | -- - - - -Assessment Criteria - - - - | -
| 2 | -maximum_score |
- - Float | -- Maximum Score - - | -- |
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -score |
- - Float | -- Score - - | -- |
| 5 | -grade |
- - Data | -- Grade - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -assessment_plan |
- - Link | -- Assessment Plan - - | -- - - - -Assessment Plan - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -student_group |
- - Link | -- Student Group - - | -- - - - -Student Group - - - - | -
| 4 | -section_break_5 |
- - Section Break | -- - - | -- |
| 5 | -result_html |
- - HTML | -- Result HTML - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabCourse
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -course_name |
- - Data | -- Course Name - - | -- |
| 2 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 3 | -parent_course |
- - Data | -- Parent Course (Leave blank, if this isn't part of Parent Course) - - | -- |
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -course_code |
- - Data | -- Course Code - - | -- |
| 6 | -course_abbreviation |
- - Data | -- Course Abbreviation - - | -- |
| 7 | -section_break_6 |
- - Section Break | -- - - | -- |
| 8 | -course_intro |
- - Text Editor | -- Course Intro - - | -- |
| 9 | -assessment |
- - Section Break | -- Assessment - - | -- |
| 10 | -default_grading_scale |
- - Link | -- Default Grading Scale - - | -- - - - -Grading Scale - - - - | -
| 11 | -assessment_criteria |
- - Table | -- Assessment Criteria - - | -- - - - -Course Assessment Criteria - - - - | -
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_assessment_criteria - (self) -
-No docs
-Table Name: tabCourse Assessment Criteria
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -assessment_criteria |
- - Link | -- Assessment Criteria - - | -- - - - -Assessment Criteria - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -weightage |
- - Percent | -- Weightage - - | -- |
Table Name: tabCourse Schedule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student_group |
- - Link | -- Student Group - - | -- - - - -Student Group - - - - | -
| 2 | -instructor |
- - Link | -- Instructor - - | -- - - - -Instructor - - - - | -
| 3 | -instructor_name |
- - Read Only | -- Instructor Name - - | -- |
| 4 | -column_break_2 |
- - Column Break | -- - - | -- |
| 5 | -naming_series |
- - Select | -- Naming Series - - | -
- SH- |
-
| 6 | -course |
- - Link | -- Course - - | -- - - - -Course - - - - | -
| 7 | -color |
- - Color | -- Color - - | -- |
| 8 | -section_break_6 |
- - Section Break | -- - - | -- |
| 9 | -schedule_date |
- - Date | -- Schedule Date - - | -- |
| 10 | -room |
- - Link | -- Room - - | -- - - - -Room - - - - | -
| 11 | -column_break_9 |
- - Column Break | -- - - | -- |
| 12 | -from_time |
- - Time | -- From Time - - | -- |
| 13 | -to_time |
- - Time | -- To Time - - | -- |
| 14 | -title |
- - Data | -- Title - - | -- |
Inherits from frappe.model.document.Document - -
- - - set_title - (self) -
-Set document Title
-- - - validate - (self) -
-No docs
-- - - validate_course - (self) -
-No docs
-- - - validate_date - (self) -
-Validates if fromtime is greater than totime
-- - - validate_overlap - (self) -
-Validates overlap for Student Group, Instructor, Room
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student_group |
- - Link | -- Student Group - - | -- - - - -Student Group - - - - | -
| 2 | -course |
- - Link | -- Course - - | -- - - - -Course - - - - | -
| 3 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 6 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 7 | -section_break_6 |
- - Section Break | -- - - | -- |
| 8 | -instructor |
- - Link | -- Instructor - - | -- - - - -Instructor - - - - | -
| 9 | -instructor_name |
- - Read Only | -- Instructor Name - - | -- |
| 10 | -column_break_9 |
- - Column Break | -- - - | -- |
| 11 | -room |
- - Link | -- Room - - | -- - - - -Room - - - - | -
| 12 | -section_break_7 |
- - Section Break | -- - - | -- |
| 13 | -from_time |
- - Time | -- From Time - - | -- |
| 14 | -course_start_date |
- - Date | -- Course Start Date - - | -- |
| 15 | -day |
- - Select | -- Day - - | -
- -Monday -Tuesday -Wednesday -Thursday -Friday -Saturday -Sunday- |
-
| 16 | -reschedule |
- - Check | -- Reschedule - - | -- |
| 17 | -column_break_15 |
- - Column Break | -- - - | -- |
| 18 | -to_time |
- - Time | -- To TIme - - | -- |
| 19 | -course_end_date |
- - Date | -- Course End Date - - | -- |
Inherits from frappe.model.document.Document - -
- - - delete_course_schedule - (self, rescheduled, reschedule_errors) -
-Delete all course schedule within the Date range and specified filters
-- - - make_course_schedule - (self, date) -
-Makes a new Course Schedule.
- -Parameters:
- -date - Date on which Course Schedule will be created.- - - schedule_course - (self) -
-Creates course schedules as per specified parameters
-- - - validate_date - (self) -
-Validates if Course Start Date is greater than Course End Date
-- - - validate_mandatory - (self) -
-Validates all mandatory fields
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -current_academic_year |
- - Link | -- Current Academic Year - - | -- - - - -Academic Year - - - - | -
| 2 | -current_academic_term |
- - Link | -- Current Academic Term - - | -- - - - -Academic Term - - - - | -
| 3 | -attendance_freeze_date |
- - Date | -- Attendance Freeze Date - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -validate_batch |
- - Check | -
- Validate Batch for Students in Student Group
- - For Batch based Student Group, the Student Batch will be validated for every Student from the Program Enrollment. - |
- - |
| 6 | -validate_course |
- - Check | -
- Validate Enrolled Course for Students in Student Group
- - For Course based Student Group, the Course will be validated for every Student from the enrolled Courses in Program Enrollment. - |
- - |
| 7 | -section_break_7 |
- - Section Break | -- - - | -- |
| 8 | -instructor_created_by |
- - Select | -- Instructor Records to be created by - - | -
- Full Name -Naming Series -Employee Number- |
-
Inherits from frappe.model.document.Document - -
- - - get_defaults - (self) -
-No docs
-- - - on_update - (self) -
-update defaults
-- - - validate - (self) -
-No docs
-Table Name: tabFee Category
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -category_name |
- - Data | -- Name - - | -- |
| 2 | -description |
- - Small Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabFee Component
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -fees_category |
- - Link | -- Fees Category - - | -- - - - -Fee Category - - - - | -
| 2 | -description |
- - Small Text | -- Description - - | -- |
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -amount |
- - Currency | -- Amount - - | -- |
Table Name: tabFee Schedule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -fee_structure |
- - Link | -- Fee Structure - - | -- - - - -Fee Structure - - - - | -
| 2 | -due_date |
- - Date | -- Due Date - - | -- |
| 3 | -naming_series |
- - Select | -- Naming Series - - | -
- FRQ.- |
-
| 4 | -fee_creation_status |
- - Select | -- Fee Creation Status - - | -
- -In Process -Failed -Successful- |
-
| 5 | -send_email |
- - Check | -- Send Payment Request Email - - | -- |
| 6 | -column_break_4 |
- - Column Break | -- - - | -- |
| 7 | -student_category |
- - Link | -- Student Category - - | -- - - - -Student Category - - - - | -
| 8 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 9 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 10 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 11 | -section_break_10 |
- - Section Break | -- - - | -- |
| 12 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 13 | -student_groups |
- - Table | -- - - | -- - - - -Fee Schedule Student Group - - - - | -
| 14 | -section_break_14 |
- - Section Break | -- Fee Breakup for each student - - | -- |
| 15 | -components |
- - Table | -- - - | -- - - - -Fee Component - - - - | -
| 16 | -section_break_16 |
- - Section Break | -- - - | -- |
| 17 | -column_break_18 |
- - Column Break | -- - - | -- |
| 18 | -total_amount |
- - Currency | -- Total Amount per Student - - | -- |
| 19 | -grand_total |
- - Currency | -- Grand Total - - | -- |
| 20 | -grand_total_in_words |
- - Data | -- In Words - - | -- |
| 21 | -edit_printing_settings |
- - Section Break | -- Printing Settings - - | -- |
| 22 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 23 | -column_break_32 |
- - Column Break | -- - - | -- |
| 24 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 25 | -account |
- - Section Break | -- Accounting - - | -- |
| 26 | -receivable_account |
- - Link | -- Receivable Account - - | -- - - - -Account - - - - | -
| 27 | -income_account |
- - Link | -- Income Account - - | -- - - - -Account - - - - | -
| 28 | -column_break_39 |
- - Column Break | -- - - | -- |
| 29 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 30 | -company |
- - Link | -- Institution - - | -- - - - -Company - - - - | -
| 31 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Fee Schedule - - - - | -
| 32 | -section_break_31 |
- - Section Break | -- Error Log - - | -- |
| 33 | -error_log |
- - Read Only | -- Error Log - - | -- |
Inherits from frappe.model.document.Document - -
- - - calculate_total_and_program - (self) -
-No docs
-- - - create_fees - (self) -
-No docs
-- - - get_dashboard_info - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.education.doctype.fee_schedule.fee_schedule.generate_fee - (fee_schedule) -
-No docs
-Public API
- /api/method/erpnext.education.doctype.fee_schedule.fee_schedule.get_fee_structure
-
- - - erpnext.education.doctype.fee_schedule.fee_schedule.get_fee_structure - (source_name, target_doc=None) -
-No docs
-- - - erpnext.education.doctype.fee_schedule.fee_schedule.get_students - (student_group, academic_year, academic_term=None, student_category=None) -
-No docs
-Public API
- /api/method/erpnext.education.doctype.fee_schedule.fee_schedule.get_total_students
-
- - - erpnext.education.doctype.fee_schedule.fee_schedule.get_total_students - (student_group, academic_year, academic_term=None, student_category=None) -
-No docs
-Table Name: tabFee Schedule Program
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 2 | -student_batch |
- - Link | -- Student Batch - - | -- - - - -Student Batch Name - - - - | -
| 3 | -total_students |
- - Data | -- Total Students - - | -- |
Table Name: tabFee Schedule Student Group
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student_group |
- - Link | -- Student Group - - | -- - - - -Student Group - - - - | -
| 2 | -total_students |
- - Data | -- Total Students - - | -- |
Table Name: tabFee Structure
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Naming Series - - | -
- FS.- |
-
| 2 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 3 | -student_category |
- - Link | -- Student Category - - | -- - - - -Student Category - - - - | -
| 4 | -column_break_2 |
- - Column Break | -- - - | -- |
| 5 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 6 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 7 | -section_break_4 |
- - Section Break | -- - - | -- |
| 8 | -components |
- - Table | -- Components - - | -- - - - -Fee Component - - - - | -
| 9 | -section_break_6 |
- - Section Break | -- - - | -- |
| 10 | -column_break_11 |
- - Column Break | -- - - | -- |
| 11 | -total_amount |
- - Currency | -- Total Amount - - | -- |
| 12 | -accounts |
- - Section Break | -- Accounts - - | -- |
| 13 | -receivable_account |
- - Link | -- Receivable Account - - | -- - - - -Account - - - - | -
| 14 | -income_account |
- - Link | -- Income Account - - | -- - - - -Account - - - - | -
| 15 | -column_break_16 |
- - Column Break | -- - - | -- |
| 16 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 17 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 18 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Fee Structure - - - - | -
Inherits from frappe.model.document.Document - -
- - - calculate_total - (self) -
-Calculates total amount.
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.education.doctype.fee_structure.fee_structure.make_fee_schedule
-
- - - erpnext.education.doctype.fee_structure.fee_structure.make_fee_schedule - (source_name, target_doc=None) -
-No docs
-Table Name: tabFees
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Naming Series - - | -
- FEE.- |
-
| 2 | -student |
- - Link | -- Student - - | -- - - - -Student - - - - | -
| 3 | -student_name |
- - Data | -- Student Name - - | -- |
| 4 | -fee_schedule |
- - Link | -- Fee Schedule - - | -- - - - -Fee Schedule - - - - | -
| 5 | -include_payment |
- - Check | -- Include Payment - - | -- |
| 6 | -send_payment_request |
- - Check | -- Send Payment Request - - | -- |
| 7 | -column_break_4 |
- - Column Break | -- - - | -- |
| 8 | -company |
- - Link | -- Institution - - | -- - - - -Company - - - - | -
| 9 | -posting_date |
- - Date | -- Date - - | -- |
| 10 | -posting_time |
- - Time | -- Posting Time - - | -- |
| 11 | -set_posting_time |
- - Check | -- Edit Posting Date and Time - - | -- |
| 12 | -due_date |
- - Date | -- Due Date - - | -- |
| 13 | -student_details |
- - Section Break | -- Student Details - - | -- |
| 14 | -program_enrollment |
- - Link | -- Program Enrollment - - | -- - - - -Program Enrollment - - - - | -
| 15 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 16 | -student_batch |
- - Link | -- Student Batch - - | -- - - - -Student Batch Name - - - - | -
| 17 | -student_email |
- - Data | -- Student Email - - | -
- |
-
| 18 | -column_break_16 |
- - Column Break | -- - - | -- |
| 19 | -student_category |
- - Link | -- Student Category - - | -- - - - -Student Category - - - - | -
| 20 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 21 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 22 | -section_break_7 |
- - Section Break | -- - - | -- |
| 23 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 24 | -fee_structure |
- - Link | -- Fee Structure - - | -- - - - -Fee Structure - - - - | -
| 25 | -components |
- - Table | -- Components - - | -- - - - -Fee Component - - - - | -
| 26 | -section_break_10 |
- - Section Break | -- - - | -- |
| 27 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Fees - - - - | -
| 28 | -column_break_11 |
- - Column Break | -- - - | -- |
| 29 | -grand_total |
- - Currency | -- Grand Total - - | -- |
| 30 | -grand_total_in_words |
- - Data | -- In Words - - | -- |
| 31 | -paid_amount |
- - Currency | -- Paid Amount - - | -- |
| 32 | -outstanding_amount |
- - Currency | -- Outstanding Amount - - | -- |
| 33 | -edit_printing_settings |
- - Section Break | -- Printing Settings - - | -- |
| 34 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 35 | -column_break_32 |
- - Column Break | -- - - | -- |
| 36 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 37 | -account |
- - Section Break | -- Accounting - - | -- |
| 38 | -receivable_account |
- - Link | -- Receivable Account - - | -- - - - -Account - - - - | -
| 39 | -income_account |
- - Link | -- Income Account - - | -- - - - -Account - - - - | -
| 40 | -column_break_39 |
- - Column Break | -- - - | -- |
| 41 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
Inherits from erpnext.controllers.accounts_controller.AccountsController - -
- - - calculate_total - (self) -
-Calculates total amount.
-- - - get_student_emails - (self) -
-No docs
-- - - make_gl_entries - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - set_indicator - (self) -
-Set indicator for portal
-- - - set_missing_accounts_and_fields - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.education.doctype.fees.fees.get_fee_list - (doctype, txt, filters, limit_start, limit_page_length=20, order_by=modified) -
-No docs
-- - - erpnext.education.doctype.fees.fees.get_list_context - (context=None) -
-No docs
-Table Name: tabGrading Scale
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -grading_scale_name |
- - Data | -- Grading Scale Name - - | -- |
| 2 | -description |
- - Small Text | -- Description - - | -- |
| 3 | -grading_intervals_section |
- - Section Break | -- Grading Scale Intervals - - | -- |
| 4 | -intervals |
- - Table | -- Intervals - - | -- - - - -Grading Scale Interval - - - - | -
| 5 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Grading Scale - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabGrading Scale Interval
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -grade_code |
- - Data | -- Grade Code - - | -- |
| 2 | -threshold |
- - Percent | -- Threshold - - | -- |
| 3 | -grade_description |
- - Small Text | -- Grade Description - - | -- |
Table Name: tabGuardian
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -guardian_name |
- - Data | -- Guardian Name - - | -- |
| 2 | -email_address |
- - Data | -- Email Address - - | -- |
| 3 | -mobile_number |
- - Data | -- Mobile Number - - | -- |
| 4 | -alternate_number |
- - Data | -- Alternate Number - - | -- |
| 5 | -date_of_birth |
- - Date | -- Date of Birth - - | -- |
| 6 | -user |
- - Link | -- User Id - - | -- - - - -User - - - - | -
| 7 | -column_break_3 |
- - Column Break | -- - - | -- |
| 8 | -education |
- - Data | -- Education - - | -- |
| 9 | -occupation |
- - Data | -- Occupation - - | -- |
| 10 | -designation |
- - Data | -- Designation - - | -- |
| 11 | -work_address |
- - Text | -- Work Address - - | -- |
| 12 | -image |
- - Attach Image | -- Image - - | -- |
| 13 | -section_break_13 |
- - Section Break | -- Guardian Of - - | -- |
| 14 | -students |
- - Table | -- Students - - | -- - - - -Guardian Student - - - - | -
| 15 | -section_break_8 |
- - Section Break | -- Guardian Interests - - | -- |
| 16 | -interests |
- - Table | -- Interests - - | -- - - - -Guardian Interest - - - - | -
Inherits from frappe.model.document.Document - -
- - - __setup__ - (self) -
-No docs
-- - - load_students - (self) -
-Load students from the database
- - - onload - (self) -
-Load Students for quick view
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.education.doctype.guardian.guardian.invite_guardian
-
- - - erpnext.education.doctype.guardian.guardian.invite_guardian - (guardian) -
-No docs
-Table Name: tabGuardian Interest
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -interest |
- - Link | -- Interest - - | -- - - - -Interest - - - - | -
Table Name: tabGuardian Student
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student |
- - Link | -- Student - - | -- - - - -Student - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -student_name |
- - Data | -- Student Name - - | -- |
Table Name: tabInstructor
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -instructor_name |
- - Data | -- Instructor Name - - | -- |
| 2 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 3 | -column_break_5 |
- - Column Break | -- - - | -- |
| 4 | -naming_series |
- - Select | -- Naming Series - - | -
- INS/- |
-
| 5 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 6 | -image |
- - Attach Image | -- Image - - | -- |
| 7 | -log_details |
- - Section Break | -- Instructor Log - - | -- |
| 8 | -instructor_log |
- - Table | -- Instructor Log - - | -- - - - -Instructor Log - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabInstructor Log
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 2 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 3 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 6 | -course |
- - Link | -- Course - - | -- - - - -Course - - - - | -
| 7 | -student_group |
- - Link | -- Student Group - - | -- - - - -Student Group - - - - | -
| 8 | -section_break_8 |
- - Section Break | -- - - | -- |
| 9 | -other_details |
- - Small Text | -- Other details - - | -- |
Table Name: tabProgram
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -program_name |
- - Data | -- Program Name - - | -- |
| 2 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -program_code |
- - Data | -- Program Code - - | -- |
| 5 | -program_abbreviation |
- - Data | -- Program Abbreviation - - | -- |
| 6 | -section_break_5 |
- - Section Break | -- Course - - | -- |
| 7 | -courses |
- - Table | -- Courses - - | -- - - - -Program Course - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabProgram Course
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -course |
- - Link | -- Course - - | -- - - - -Course - - - - | -
| 2 | -column_break_3 |
- - Column Break | -- - - | -- |
| 3 | -course_name |
- - Data | -- Course Name - - | -- |
| 4 | -required |
- - Check | -- Mandatory - - | -- |
Table Name: tabProgram Enrollment
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student |
- - Link | -- Student - - | -- - - - -Student - - - - | -
| 2 | -student_name |
- - Read Only | -- Student Name - - | -- |
| 3 | -student_category |
- - Link | -- Student Category - - | -- - - - -Student Category - - - - | -
| 4 | -student_batch_name |
- - Link | -- Student Batch - - | -- - - - -Student Batch Name - - - - | -
| 5 | -school_house |
- - Link | -- School House - - | -- - - - -School House - - - - | -
| 6 | -column_break_4 |
- - Column Break | -- - - | -- |
| 7 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 8 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 9 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 10 | -enrollment_date |
- - Date | -- Enrollment Date - - | -- |
| 11 | -boarding_student |
- - Check | -
- Boarding Student
- - Check this if the Student is residing at the Institute's Hostel. - |
- - |
| 12 | -transportation |
- - Section Break | -- Transportation - - | -- |
| 13 | -mode_of_transportation |
- - Select | -- Mode of Transportation - - | -
- -Walking -Institute's Bus -Public Transport -Self-Driving Vehicle -Pick/Drop by Guardian- |
-
| 14 | -column_break_13 |
- - Column Break | -- - - | -- |
| 15 | -vehicle_no |
- - Data | -- Vehicle/Bus Number - - | -- |
| 16 | -enrolled_courses |
- - Section Break | -- Enrolled courses - - | -- |
| 17 | -courses |
- - Table | -- Courses - - | -- - - - -Program Enrollment Course - - - - | -
| 18 | -section_break_7 |
- - Section Break | -- Fees - - | -- |
| 19 | -fees |
- - Table | -- Fees - - | -- - - - -Program Fee - - - - | -
| 20 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Program Enrollment - - - - | -
| 21 | -image |
- - Attach Image | -- Image - - | -- |
Inherits from frappe.model.document.Document - -
- - - get_courses - (self) -
-No docs
-- - - make_fee_records - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - update_student_joining_date - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_duplication - (self) -
-No docs
-Public API
- /api/method/erpnext.education.doctype.program_enrollment.program_enrollment.get_program_courses
-
- - - erpnext.education.doctype.program_enrollment.program_enrollment.get_program_courses - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Public API
- /api/method/erpnext.education.doctype.program_enrollment.program_enrollment.get_students
-
- - - erpnext.education.doctype.program_enrollment.program_enrollment.get_students - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Table Name: tabProgram Enrollment Course
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -course |
- - Link | -- Course - - | -- - - - -Course - - - - | -
| 2 | -course_name |
- - Data | -- Course Name - - | -- |
Table Name: tabProgram Enrollment Fee
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 2 | -fee_structure |
- - Link | -- Fee Structure - - | -- - - - -Fee Structure - - - - | -
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -due_date |
- - Date | -- Due Date - - | -- |
| 5 | -amount |
- - Currency | -- Amount - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -get_students_from |
- - Select | -- Get Students From - - | -
- -Student Applicant -Program Enrollment- |
-
| 2 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 3 | -student_batch |
- - Link | -- Student Batch - - | -- - - - -Student Batch Name - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 6 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 7 | -section_break_5 |
- - Section Break | -- - - | -- |
| 8 | -get_students |
- - Button | -- Get Students - - | -- |
| 9 | -students |
- - Table | -- Students - - | -- - - - -Program Enrollment Tool Student - - - - | -
| 10 | -section_break_7 |
- - Section Break | -- Enrollment Details - - | -- |
| 11 | -new_program |
- - Link | -- New Program - - | -- - - - -Program - - - - | -
| 12 | -new_student_batch |
- - Link | -- New Student Batch - - | -- - - - -Student Batch Name - - - - | -
| 13 | -enroll_students |
- - Button | -- Enroll Students - - | -- |
| 14 | -column_break_12 |
- - Column Break | -- - - | -- |
| 15 | -new_academic_year |
- - Link | -- New Academic Year - - | -- - - - -Academic Year - - - - | -
| 16 | -new_academic_term |
- - Link | -- New Academic Term - - | -- - - - -Academic Term - - - - | -
Inherits from frappe.model.document.Document - -
- - - enroll_students - (self) -
-No docs
-- - - get_students - (self) -
-No docs
-Table Name: tabProgram Enrollment Tool Student
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student_applicant |
- - Link | -- Student Applicant - - | -- - - - -Student Applicant - - - - | -
| 2 | -student |
- - Link | -- Student - - | -- - - - -Student - - - - | -
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -student_name |
- - Data | -- Student Name - - | -- |
| 5 | -student_batch_name |
- - Link | -- Student Batch Name - - | -- - - - -Student Batch Name - - - - | -
Table Name: tabProgram Fee
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 2 | -fee_structure |
- - Link | -- Fee Structure - - | -- - - - -Fee Structure - - - - | -
| 3 | -student_category |
- - Link | -- Student Category - - | -- - - - -Student Category - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -due_date |
- - Date | -- Due Date - - | -- |
| 6 | -amount |
- - Currency | -- Amount - - | -- |
Table Name: tabRoom
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -room_name |
- - Data | -- Room Name - - | -- |
| 2 | -room_number |
- - Data | -- Room Number - - | -- |
| 3 | -seating_capacity |
- - Data | -- Seating Capacity - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabSchool House
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -house_name |
- - Data | -- House Name - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabStudent
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -section_break_1 |
- - Section Break | -- - - | -- |
| 2 | -enabled |
- - Check | -- Enabled - - | -- |
| 3 | -section_break_3 |
- - Section Break | -- - - | -- |
| 4 | -first_name |
- - Data | -- First Name - - | -- |
| 5 | -middle_name |
- - Data | -- Middle Name - - | -- |
| 6 | -last_name |
- - Data | -- Last Name - - | -- |
| 7 | -column_break_4 |
- - Column Break | -- - - | -- |
| 8 | -naming_series |
- - Select | -- Naming Series - - | -
- STUD.- |
-
| 9 | -student_email_id |
- - Data | -- Student Email Address - - | -- |
| 10 | -student_mobile_number |
- - Data | -- Student Mobile Number - - | -- |
| 11 | -joining_date |
- - Date | -- Joining Date - - | -- |
| 12 | -image |
- - Attach Image | -- Image - - | -- |
| 13 | -section_break_7 |
- - Section Break | -- Personal Details - - | -- |
| 14 | -date_of_birth |
- - Date | -- Date of Birth - - | -- |
| 15 | -blood_group |
- - Select | -- Blood Group - - | -
- -A+ -A- -B+ -B- -O+ -O- -AB+ -AB-- |
-
| 16 | -column_break_3 |
- - Column Break | -- - - | -- |
| 17 | -gender |
- - Select | -- Gender - - | -
- -Male -Female -Other- |
-
| 18 | -nationality |
- - Data | -- Nationality - - | -- |
| 19 | -student_applicant |
- - Link | -- Student Applicant - - | -- - - - -Student Applicant - - - - | -
| 20 | -section_break_22 |
- - Section Break | -- Home Address - - | -- |
| 21 | -address_line_1 |
- - Data | -- Address Line 1 - - | -- |
| 22 | -address_line_2 |
- - Data | -- Address Line 2 - - | -- |
| 23 | -pincode |
- - Data | -- Pincode - - | -- |
| 24 | -column_break_20 |
- - Column Break | -- - - | -- |
| 25 | -city |
- - Data | -- City - - | -- |
| 26 | -state |
- - Data | -- State - - | -- |
| 27 | -section_break_18 |
- - Section Break | -- Guardian Details - - | -- |
| 28 | -guardians |
- - Table | -- Guardians - - | -- - - - -Student Guardian - - - - | -
| 29 | -section_break_20 |
- - Section Break | -- Sibling Details - - | -
- Country- |
-
| 30 | -siblings |
- - Table | -- Siblings - - | -- - - - -Student Sibling - - - - | -
| 31 | -exit |
- - Section Break | -- Exit - - | -- |
| 32 | -date_of_leaving |
- - Date | -- Date of Leaving - - | -- |
| 33 | -leaving_certificate_number |
- - Data | -- Leaving Certificate Number - - | -- |
| 34 | -column_break_31 |
- - Column Break | -- - - | -- |
| 35 | -reason_for_leaving |
- - Text | -- Reason For Leaving - - | -- |
| 36 | -title |
- - Data | -- Title - - | -- |
Inherits from frappe.model.document.Document - -
- - - check_unique - (self) -
-Validates if the Student Applicant is Unique
-- - - update_applicant_status - (self) -
-Updates Student Applicant status to Admitted
-- - - update_student_name_in_linked_doctype - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.education.doctype.student.student.get_timeline_data - (doctype, name) -
-Return timeline for attendance
-Table Name: tabStudent Admission
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -route |
- - Data | -- Route - - | -- |
| 3 | -application_form_route |
- - Data | -- Application Form Route - - | -- |
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 6 | -admission_start_date |
- - Date | -- Admission Start Date - - | -- |
| 7 | -admission_end_date |
- - Date | -- Admission End Date - - | -- |
| 8 | -published |
- - Check | -- Publish on website - - | -- |
| 9 | -section_break_5 |
- - Section Break | -- Eligibility and Details - - | -- |
| 10 | -program_details |
- - Table | -- Eligibility and Details - - | -- - - - -Student Admission Program - - - - | -
| 11 | -introduction |
- - Text Editor | -- Introduction - - | -- |
Inherits from frappe.website.website_generator.WebsiteGenerator - -
- - - autoname - (self) -
-No docs
-- - - get_context - (self, context) -
-No docs
-- - - get_title - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.education.doctype.student_admission.student_admission.get_admission_list - (doctype, txt, filters, limit_start, limit_page_length=20, order_by=modified) -
-No docs
-- - - erpnext.education.doctype.student_admission.student_admission.get_list_context - (context=None) -
-No docs
-Table Name: tabStudent Admission Program
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 2 | -minimum_age |
- - Date | -- Minimum Age - - | -- |
| 3 | -maximum_age |
- - Date | -- Maximum Age - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -application_fee |
- - Currency | -- Application Fee - - | -- |
| 6 | -applicant_naming_series |
- - Data | -- Naming Series (for Student Applicant) - - | -- |
Table Name: tabStudent Applicant
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -first_name |
- - Data | -- First Name - - | -- |
| 2 | -middle_name |
- - Data | -- Middle Name - - | -- |
| 3 | -last_name |
- - Data | -- Last Name - - | -- |
| 4 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 5 | -paid |
- - Check | -- Paid - - | -- |
| 6 | -column_break_8 |
- - Column Break | -- - - | -- |
| 7 | -naming_series |
- - Select | -- Naming Series - - | -
- AP- |
-
| 8 | -application_status |
- - Select | -- Application Status - - | -
- Applied -Approved -Rejected -Admitted- |
-
| 9 | -application_date |
- - Date | -- Application Date - - | -- |
| 10 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 11 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 12 | -student_admission |
- - Link | -- Student Admission - - | -- - - - -Student Admission - - - - | -
| 13 | -image |
- - Attach Image | -- Image - - | -- |
| 14 | -section_break_4 |
- - Section Break | -- Personal Details - - | -- |
| 15 | -date_of_birth |
- - Date | -- Date of Birth - - | -- |
| 16 | -gender |
- - Select | -- Gender - - | -
- -Male -Female- |
-
| 17 | -blood_group |
- - Select | -- Blood Group - - | -
- -A+ -A- -B+ -B- -O+ -O- -AB+ -AB-- |
-
| 18 | -column_break_12 |
- - Column Break | -- - - | -- |
| 19 | -student_email_id |
- - Data | -- Student Email Address - - | -- |
| 20 | -student_mobile_number |
- - Data | -- Student Mobile Number - - | -- |
| 21 | -nationality |
- - Data | -- Nationality - - | -- |
| 22 | -home_address |
- - Section Break | -- Home Address - - | -- |
| 23 | -address_line_1 |
- - Data | -- Address Line 1 - - | -- |
| 24 | -address_line_2 |
- - Data | -- Address Line 2 - - | -- |
| 25 | -pincode |
- - Data | -- Pincode - - | -- |
| 26 | -column_break_23 |
- - Column Break | -- - - | -- |
| 27 | -city |
- - Data | -- City - - | -- |
| 28 | -state |
- - Data | -- State - - | -- |
| 29 | -section_break_20 |
- - Section Break | -- Guardian Details - - | -- |
| 30 | -guardians |
- - Table | -- Guardians - - | -- - - - -Student Guardian - - - - | -
| 31 | -section_break_21 |
- - Section Break | -- Sibling Details - - | -- |
| 32 | -siblings |
- - Table | -- Siblings - - | -- - - - -Student Sibling - - - - | -
| 33 | -section_break_23 |
- - Section Break | -- - - | -- |
| 34 | -title |
- - Data | -- Title - - | -- |
| 35 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Student Applicant - - - - | -
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - on_payment_authorized - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - on_update_after_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validation_from_student_admission - (self) -
-No docs
-- - - erpnext.education.doctype.student_applicant.student_applicant.get_student_admission_data - (student_admission, program) -
-No docs
-Table Name: tabStudent Attendance
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student |
- - Link | -- Student - - | -- - - - -Student - - - - | -
| 2 | -course_schedule |
- - Link | -- Course Schedule - - | -- - - - -Course Schedule - - - - | -
| 3 | -date |
- - Date | -- Date - - | -- |
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -student_name |
- - Read Only | -- Student Name - - | -- |
| 6 | -student_group |
- - Link | -- Student Group - - | -- - - - -Student Group - - - - | -
| 7 | -status |
- - Select | -- Status - - | -
- Present -Absent- |
-
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_course_schedule - (self) -
-No docs
-- - - validate_date - (self) -
-No docs
-- - - validate_duplication - (self) -
-Check if the Attendance Record is Unique
-- - - validate_mandatory - (self) -
-No docs
-- - - validate_student - (self) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -based_on |
- - Select | -- Based On - - | -
- Student Group -Course Schedule- |
-
| 2 | -group_based_on |
- - Select | -- Group Based On - - | -
- Batch -Course -Activity- |
-
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -student_group |
- - Link | -- Student Group - - | -- - - - -Student Group - - - - | -
| 5 | -course_schedule |
- - Link | -- Course Schedule - - | -- - - - -Course Schedule - - - - | -
| 6 | -date |
- - Date | -- Date - - | -- |
| 7 | -attendance |
- - Section Break | -- Attendance - - | -- |
| 8 | -students_html |
- - HTML | -- Students HTML - - | -- |
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.education.doctype.student_attendance_tool.student_attendance_tool.get_student_attendance_records
-
- - - erpnext.education.doctype.student_attendance_tool.student_attendance_tool.get_student_attendance_records - (based_on, date=None, student_group=None, course_schedule=None) -
-No docs
-Table Name: tabStudent Batch Name
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -batch_name |
- - Data | -- Batch Name - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabStudent Category
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -category |
- - Data | -- Category - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabStudent Group
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 2 | -group_based_on |
- - Select | -- Group Based on - - | -
- -Batch -Course -Activity- |
-
| 3 | -student_group_name |
- - Data | -- Student Group Name - - | -- |
| 4 | -max_strength |
- - Int | -
- Max Strength
- - Set 0 for no limit - |
- - |
| 5 | -column_break_3 |
- - Column Break | -- - - | -- |
| 6 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 7 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 8 | -batch |
- - Link | -- Batch - - | -- - - - -Student Batch Name - - - - | -
| 9 | -course |
- - Link | -- Course - - | -- - - - -Course - - - - | -
| 10 | -section_break_6 |
- - Section Break | -- Students - - | -- |
| 11 | -get_students |
- - Button | -- Get Students - - | -- |
| 12 | -students |
- - Table | -- Students - - | -- - - - -Student Group Student - - - - | -
| 13 | -section_break_12 |
- - Section Break | -- Instructors - - | -- |
| 14 | -instructors |
- - Table | -- Instructors - - | -- - - - -Student Group Instructor - - - - | -
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_and_set_child_table_fields - (self) -
-No docs
-- - - validate_mandatory_fields - (self) -
-No docs
-- - - validate_strength - (self) -
-No docs
-- - - validate_students - (self) -
-No docs
-Public API
- /api/method/erpnext.education.doctype.student_group.student_group.fetch_students
-
- - - erpnext.education.doctype.student_group.student_group.fetch_students - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.education.doctype.student_group.student_group.get_program_enrollment - (academic_year, academic_term=None, program=None, batch=None, course=None) -
-No docs
-Public API
- /api/method/erpnext.education.doctype.student_group.student_group.get_students
-
- - - erpnext.education.doctype.student_group.student_group.get_students - (academic_year, group_based_on, academic_term=None, program=None, batch=None, course=None) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 2 | -academic_term |
- - Link | -
- Academic Term
- - Leave blank if you make students groups per year - |
- - - - - -Academic Term - - - - | -
| 3 | -get_courses |
- - Button | -- Get Courses - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 6 | -separate_groups |
- - Check | -
- Separate course based Group for every Batch
- - Leave unchecked if you don't want to consider batch while making course based groups. - |
- - |
| 7 | -section_break_4 |
- - Section Break | -- - - | -- |
| 8 | -courses |
- - Table | -- Courses - - | -- - - - -Student Group Creation Tool Course - - - - | -
Inherits from frappe.model.document.Document - -
- - - create_student_groups - (self) -
-No docs
-- - - get_courses - (self) -
-No docs
-Table Name: tabStudent Group Creation Tool Course
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -group_based_on |
- - Select | -- Group Based On - - | -
- -Batch -Course- |
-
| 2 | -course |
- - Link | -- Course - - | -- - - - -Course - - - - | -
| 3 | -batch |
- - Link | -- Batch - - | -- - - - -Student Batch Name - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -student_group_name |
- - Data | -- Student Group Name - - | -- |
| 6 | -course_code |
- - Read Only | -- Course Code - - | -- |
| 7 | -max_strength |
- - Int | -- Max Strength - - | -- |
Table Name: tabStudent Group Instructor
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -instructor |
- - Link | -- Instructor - - | -- - - - -Instructor - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -instructor_name |
- - Read Only | -- Instructor Name - - | -- |
Table Name: tabStudent Group Student
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student |
- - Link | -- Student - - | -- - - - -Student - - - - | -
| 2 | -student_name |
- - Data | -- Student Name - - | -- |
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -group_roll_number |
- - Int | -- Group Roll Number - - | -- |
| 5 | -active |
- - Check | -- Active - - | -- |
Table Name: tabStudent Guardian
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -guardian |
- - Link | -- Guardian - - | -- - - - -Guardian - - - - | -
| 2 | -guardian_name |
- - Data | -- Guardian Name - - | -- |
| 3 | -relation |
- - Select | -- Relation - - | -
- -Mother -Father -Others- |
-
Table Name: tabStudent Language
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -language_name |
- - Data | -- Language Name - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabStudent Leave Application
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student |
- - Link | -- Student - - | -- - - - -Student - - - - | -
| 2 | -student_name |
- - Read Only | -- Student Name - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -from_date |
- - Date | -- From Date - - | -- |
| 5 | -to_date |
- - Date | -- To Date - - | -- |
| 6 | -mark_as_present |
- - Check | -
- Mark as Present
- - Will show the student as Present in Student Monthly Attendance Report - |
- - |
| 7 | -section_break_5 |
- - Section Break | -- - - | -- |
| 8 | -reason |
- - Text | -- Reason - - | -- |
| 9 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Student Leave Application - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabStudent Log
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student |
- - Link | -- Student - - | -- - - - -Student - - - - | -
| 2 | -student_name |
- - Read Only | -- Student Name - - | -- |
| 3 | -type |
- - Select | -- Type - - | -
- General -Academic -Medical -Achievement- |
-
| 4 | -date |
- - Date | -- Date - - | -- |
| 5 | -column_break_3 |
- - Column Break | -- - - | -- |
| 6 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 7 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 8 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 9 | -student_batch |
- - Link | -- Student Batch - - | -- - - - -Student Batch Name - - - - | -
| 10 | -section_break_5 |
- - Section Break | -- - - | -- |
| 11 | -log |
- - Text Editor | -- Log - - | -- |
Inherits from frappe.model.document.Document - -
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -student |
- - Link | -- Student - - | -- - - - -Student - - - - | -
| 2 | -student_name |
- - Read Only | -- Student Name - - | -- |
| 3 | -program |
- - Link | -- Program - - | -- - - - -Program - - - - | -
| 4 | -student_batch |
- - Link | -- Batch - - | -- - - - -Student Batch Name - - - - | -
| 5 | -include_all_assessment |
- - Check | -- Include All Assessment Group - - | -- |
| 6 | -show_marks |
- - Check | -- Show Marks - - | -- |
| 7 | -add_letterhead |
- - Check | -- Add letterhead - - | -- |
| 8 | -column_break_3 |
- - Column Break | -- - - | -- |
| 9 | -assessment_group |
- - Link | -- Assessment Group - - | -- - - - -Assessment Group - - - - | -
| 10 | -academic_year |
- - Link | -- Academic Year - - | -- - - - -Academic Year - - - - | -
| 11 | -academic_term |
- - Link | -- Academic Term - - | -- - - - -Academic Term - - - - | -
| 12 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 13 | -section_break_5 |
- - Section Break | -- Print Section - - | -- |
| 14 | -parents_meeting |
- - Data | -- Total Parents Teacher Meeting - - | -- |
| 15 | -parents_attendance |
- - Data | -- Attended by Parents - - | -- |
| 16 | -terms |
- - Link | -- Terms - - | -- - - - -Terms and Conditions - - - - | -
| 17 | -assessment_terms |
- - Text Editor | -- Assessment Terms - - | -- |
Inherits from frappe.model.document.Document - -
- - - erpnext.education.doctype.student_report_generation_tool.student_report_generation_tool.get_attendance_count - (student, academic_year, academic_term=None) -
-No docs
-- - - erpnext.education.doctype.student_report_generation_tool.student_report_generation_tool.get_courses_criteria - (courses) -
-No docs
-Public API
- /api/method/erpnext.education.doctype.student_report_generation_tool.student_report_generation_tool.preview_report_card
-
- - - erpnext.education.doctype.student_report_generation_tool.student_report_generation_tool.preview_report_card - (doc) -
-No docs
-Table Name: tabStudent Sibling
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -studying_in_same_institute |
- - Select | -- Studying in Same Institute - - | -
- NO -YES- |
-
| 2 | -full_name |
- - Data | -- Full Name - - | -- |
| 3 | -gender |
- - Select | -- Gender - - | -
- -Male -Female- |
-
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -student |
- - Link | -- Student ID - - | -- - - - -Student - - - - | -
| 6 | -institution |
- - Data | -- Institution - - | -- |
| 7 | -program |
- - Data | -- Program - - | -- |
| 8 | -date_of_birth |
- - Date | -- Date of Birth - - | -- |
Table Name: tabStudent Siblings
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -name1 |
- - Data | -- Name - - | -- |
| 2 | -gender |
- - Select | -- Gender - - | -
- -Male -Female- |
-
| 3 | -date_of_birth |
- - Date | -- Date of Birth - - | -- |
Table Name: tabGoCardless Mandate
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -disabled |
- - Check | -- Disabled - - | -- |
| 2 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 3 | -mandate |
- - Data | -- Mandate - - | -- |
| 4 | -gocardless_customer |
- - Data | -- GoCardless Customer - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabGoCardless Settings
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -gateway_name |
- - Data | -- Payment Gateway Name - - | -- |
| 2 | -section_break_2 |
- - Section Break | -- - - | -- |
| 3 | -access_token |
- - Data | -- Access Token - - | -- |
| 4 | -webhooks_secret |
- - Data | -- Webhooks Secret - - | -- |
| 5 | -use_sandbox |
- - Check | -- Use Sandbox - - | -- |
Inherits from frappe.model.document.Document - -
- - - check_mandate_validity - (self, data) -
-No docs
-- - - create_charge_on_gocardless - (self) -
-No docs
-- - - create_payment_request - (self, data) -
-No docs
-- - - get_environment - (self) -
-No docs
-- - - get_payment_url - (self) -
-No docs
-- - - initialize_client - (self) -
-No docs
-- - - on_payment_request_submission - (self, data) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_transaction_currency - (self, currency) -
-No docs
-- - - erpnext.erpnext_integrations.doctype.gocardless_settings.gocardless_settings.get_gateway_controller - (doc) -
-No docs
-- - - erpnext.erpnext_integrations.doctype.gocardless_settings.gocardless_settings.gocardless_initialization - (doc) -
-No docs
-Table Name: tabShopify Log
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -status |
- - Data | -- Status - - | -- |
| 3 | -method |
- - Small Text | -- Method - - | -- |
| 4 | -message |
- - Code | -- Message - - | -- |
| 5 | -traceback |
- - Code | -- Traceback - - | -- |
| 6 | -request_data |
- - Code | -- Request Data - - | -- |
Inherits from frappe.model.document.Document - -
- - - erpnext.erpnext_integrations.doctype.shopify_log.shopify_log.dump_request_data - (data, event=create/order) -
-No docs
-- - - erpnext.erpnext_integrations.doctype.shopify_log.shopify_log.make_shopify_log - (status=Queued, message=None, exception=False) -
-No docs
-Public API
- /api/method/erpnext.erpnext_integrations.doctype.shopify_log.shopify_log.resync
-
- - - erpnext.erpnext_integrations.doctype.shopify_log.shopify_log.resync - (method, name, request_data) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -status_html |
- - HTML | -- status html - - | -- |
| 2 | -enable_shopify |
- - Check | -- Enable Shopify - - | -- |
| 3 | -app_type |
- - Select | -- App Type - - | -
- Public -Private- |
-
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -last_sync_datetime |
- - Datetime | -- Last Sync Datetime - - | -- |
| 6 | -section_break_2 |
- - Section Break | -- - - | -- |
| 7 | -shopify_url |
- - Data | -
- Shop URL
- - eg: frappe.myshopify.com - |
- - |
| 8 | -api_key |
- - Data | -- API Key - - | -- |
| 9 | -column_break_3 |
- - Column Break | -- - - | -- |
| 10 | -password |
- - Password | -- Password - - | -- |
| 11 | -shared_secret |
- - Data | -- Shared secret - - | -- |
| 12 | -access_token |
- - Data | -- Access Token - - | -- |
| 13 | -section_break_38 |
- - Section Break | -- Webhooks Details - - | -- |
| 14 | -webhooks |
- - Table | -- Webhooks - - | -- - - - -Shopify Webhook Detail - - - - | -
| 15 | -section_break_15 |
- - Section Break | -- Customer Settings - - | -- |
| 16 | -default_customer |
- - Link | -
- Default Customer
- - If Shopify not contains a customer in Order, then while syncing Orders, the system will consider default customer for order - |
- - - - - -Customer - - - - | -
| 17 | -column_break_19 |
- - Column Break | -- - - | -- |
| 18 | -customer_group |
- - Link | -
- Customer Group
- - Customer Group will set to selected group while syncing customers from Shopify - |
- - - - - -Customer Group - - - - | -
| 19 | -company_dependent_settings |
- - Section Break | -- - - | -- |
| 20 | -company |
- - Link | -- For Company - - | -- - - - -Company - - - - | -
| 21 | -cash_bank_account |
- - Link | -
- Cash/Bank Account
- - Cash Account will used for Sales Invoice creation - |
- - - - - -Account - - - - | -
| 22 | -column_break_20 |
- - Column Break | -- - - | -- |
| 23 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 24 | -erp_settings |
- - Section Break | -- - - | -- |
| 25 | -price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 26 | -update_price_in_erpnext_price_list |
- - Check | -- Update Price from Shopify To ERPNext Price List - - | -- |
| 27 | -column_break_26 |
- - Column Break | -- - - | -- |
| 28 | -warehouse |
- - Link | -
- Warehouse
- - Default Warehouse to to create Sales Order and Delivery Note - |
- - - - - -Warehouse - - - - | -
| 29 | -section_break_25 |
- - Section Break | -- - - | -- |
| 30 | -sales_order_series |
- - Select | -- Sales Order Series - - | -- |
| 31 | -column_break_27 |
- - Column Break | -- - - | -- |
| 32 | -sync_delivery_note |
- - Check | -- Import Delivery Notes from Shopify on Shipment - - | -- |
| 33 | -delivery_note_series |
- - Select | -- Delivery Note Series - - | -- |
| 34 | -sync_sales_invoice |
- - Check | -- Import Sales Invoice from Shopify if Payment is marked - - | -- |
| 35 | -sales_invoice_series |
- - Select | -- Sales Invoice Series - - | -- |
| 36 | -section_break_22 |
- - Section Break | -- - - | -- |
| 37 | -html_16 |
- - HTML | -- - - | -- |
| 38 | -taxes |
- - Table | -- Shopify Tax Account - - | -- - - - -Shopify Tax Account - - - - | -
Inherits from frappe.model.document.Document - -
- - - register_webhooks - (self) -
-No docs
-- - - unregister_webhooks - (self) -
-No docs
-- - - update_webhook_table - (self, method, res) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_access_credentials - (self) -
-No docs
-- - - validate_app_type - (self) -
-No docs
-- - - erpnext.erpnext_integrations.doctype.shopify_settings.shopify_settings.get_header - (settings) -
-No docs
-Public API
- /api/method/erpnext.erpnext_integrations.doctype.shopify_settings.shopify_settings.get_series
-
- - - erpnext.erpnext_integrations.doctype.shopify_settings.shopify_settings.get_series - () -
-No docs
-- - - erpnext.erpnext_integrations.doctype.shopify_settings.shopify_settings.get_shopify_url - (path, settings) -
-No docs
-- - - erpnext.erpnext_integrations.doctype.shopify_settings.shopify_settings.setup_custom_fields - () -
-No docs
-Table Name: tabShopify Tax Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -shopify_tax |
- - Data | -- Shopify Tax/Shipping Title - - | -- |
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -tax_account |
- - Link | -- ERPNext Account - - | -- - - - -Account - - - - | -
Table Name: tabShopify Webhook Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -webhook_id |
- - Data | -- Webhook ID - - | -- |
| 2 | -method |
- - Data | -- Method - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -enable_sync |
- - Check | -- Enable Sync - - | -- |
| 2 | -sb_00 |
- - Section Break | -- - - | -- |
| 3 | -woocommerce_server_url |
- - Data | -- Woocommerce Server URL - - | -- |
| 4 | -secret |
- - Code | -- Secret - - | -- |
| 5 | -cb_00 |
- - Column Break | -- - - | -- |
| 6 | -api_consumer_key |
- - Data | -- API consumer key - - | -- |
| 7 | -api_consumer_secret |
- - Data | -- API consumer secret - - | -- |
| 8 | -sb_accounting_details |
- - Section Break | -- Accounting Details - - | -- |
| 9 | -tax_account |
- - Link | -- Tax Account - - | -- - - - -Account - - - - | -
| 10 | -column_break_10 |
- - Column Break | -- - - | -- |
| 11 | -f_n_f_account |
- - Link | -- Freight and Forwarding Account - - | -- - - - -Account - - - - | -
| 12 | -endpoints |
- - Section Break | -- Endpoints - - | -- |
| 13 | -endpoint |
- - Code | -- Endpoint - - | -- |
Inherits from frappe.model.document.Document - -
- - - create_delete_custom_fields - (self) -
-No docs
-- - - create_webhook_url - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_settings - (self) -
-No docs
-Public API
- /api/method/erpnext.erpnext_integrations.doctype.woocommerce_settings.woocommerce_settings.generate_secret
-
- - - erpnext.erpnext_integrations.doctype.woocommerce_settings.woocommerce_settings.generate_secret - () -
-No docs
-Table Name: tabAntibiotic
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -antibiotic_name |
- - Data | -- Antibiotic Name - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabAppointment Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -appointment_type |
- - Data | -- Type - - | -- |
| 2 | -ip |
- - Check | -- Is Inpatient - - | -- |
| 3 | -default_duration |
- - Int | -
- Default Duration
- - In Minutes - |
- - |
| 4 | -color |
- - Color | -- Color - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabClinical Procedure
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- PRO-- |
-
| 2 | -appointment |
- - Link | -- Appointment - - | -- - - - -Patient Appointment - - - - | -
| 3 | -patient |
- - Link | -- Patient - - | -- - - - -Patient - - - - | -
| 4 | -patient_age |
- - Data | -- Age - - | -- |
| 5 | -patient_sex |
- - Data | -- Gender - - | -- |
| 6 | -procedure_template |
- - Link | -- Procedure Template - - | -- - - - -Clinical Procedure Template - - - - | -
| 7 | -medical_department |
- - Link | -- Medical Department - - | -- - - - -Medical Department - - - - | -
| 8 | -column_break_7 |
- - Column Break | -- - - | -- |
| 9 | -service_unit |
- - Link | -- Service Unit - - | -- - - - -Healthcare Service Unit - - - - | -
| 10 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 11 | -start_date |
- - Date | -- Start Date - - | -- |
| 12 | -start_time |
- - Time | -- Time - - | -- |
| 13 | -sample |
- - Link | -- Sample - - | -- - - - -Sample Collection - - - - | -
| 14 | -is_invoiced |
- - Check | -- Is Invoiced - - | -- |
| 15 | -notes |
- - Small Text | -- Notes - - | -- |
| 16 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 17 | -consume_stock |
- - Check | -- Consume Stock - - | -- |
| 18 | -consumables |
- - Section Break | -- Consumables - - | -- |
| 19 | -items |
- - Table | -- Consumables - - | -- - - - -Clinical Procedure Item - - - - | -
| 20 | -status |
- - Select | -- Status - - | -
- Draft -In Progress -Completed -Pending -Cancelled- |
-
Inherits from frappe.model.document.Document - -
- - - after_insert - (self) -
-No docs
-- - - before_insert - (self) -
-No docs
-- - - complete - (self) -
-No docs
-- - - get_item_details - (self, args=None) -
-No docs
-- - - make_material_transfer - (self) -
-No docs
-- - - set_actual_qty - (self) -
-No docs
-- - - start - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.clinical_procedure.clinical_procedure.create_procedure
-
- - - erpnext.healthcare.doctype.clinical_procedure.clinical_procedure.create_procedure - (appointment) -
-No docs
-- - - erpnext.healthcare.doctype.clinical_procedure.clinical_procedure.create_stock_entry - (doc) -
-No docs
-- - - erpnext.healthcare.doctype.clinical_procedure.clinical_procedure.get_item_dict - (table, parent, parenttype) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.clinical_procedure.clinical_procedure.set_stock_items
-
- - - erpnext.healthcare.doctype.clinical_procedure.clinical_procedure.set_stock_items - (doc, stock_detail_parent, parenttype) -
-No docs
-Table Name: tabClinical Procedure Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 2 | -barcode |
- - Data | -- Barcode - - | -- |
| 3 | -item_name |
- - Data | -- Item Name - - | -- |
| 4 | -qty |
- - Float | -- Quantity - - | -- |
| 5 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 6 | -column_break_5 |
- - Column Break | -- - - | -- |
| 7 | -batch_no |
- - Link | -- Batch - - | -- - - - -Batch - - - - | -
| 8 | -conversion_factor |
- - Float | -- Conversion Factor - - | -- |
| 9 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 10 | -transfer_qty |
- - Float | -- Transfer Qty - - | -- |
| 11 | -actual_qty |
- - Float | -- Actual Qty (at source/target) - - | -- |
Table Name: tabClinical Procedure Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -template |
- - Data | -- Template Name - - | -- |
| 2 | -item_code |
- - Read Only | -- Item Code - - | -
- Item- |
-
| 3 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 4 | -medical_department |
- - Link | -- Medical Department - - | -- - - - -Medical Department - - - - | -
| 5 | -column_break_5 |
- - Column Break | -- - - | -- |
| 6 | -is_billable |
- - Check | -- Is Billable - - | -- |
| 7 | -rate |
- - Float | -- Rate - - | -- |
| 8 | -description |
- - Small Text | -- Description - - | -- |
| 9 | -section_break_9 |
- - Section Break | -- - - | -- |
| 10 | -consume_stock |
- - Check | -- Allow Stock Consumption - - | -- |
| 11 | -consumables |
- - Section Break | -- Consumables - - | -- |
| 12 | -items |
- - Table | -- Items - - | -- - - - -Clinical Procedure Item - - - - | -
| 13 | -sample_collection |
- - Section Break | -- Sample Collection - - | -- |
| 14 | -sample |
- - Link | -- Sample - - | -- - - - -Lab Test Sample - - - - | -
| 15 | -sample_uom |
- - Data | -- UOM - - | -- |
| 16 | -sample_qty |
- - Float | -- Quantity - - | -- |
| 17 | -column_break_21 |
- - Column Break | -- - - | -- |
| 18 | -sample_details |
- - Small Text | -- Collection Details - - | -- |
| 19 | -change_in_item |
- - Check | -- Change In Item - - | -- |
| 20 | -disabled |
- - Check | -- Disabled - - | -- |
| 21 | -item |
- - Link | -- Item - - | -- - - - -Item - - - - | -
Inherits from frappe.model.document.Document - -
- - - after_insert - (self) -
-No docs
-- - - get_item_details - (self, args=None) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.clinical_procedure_template.clinical_procedure_template.change_item_code_from_template
-
- - - erpnext.healthcare.doctype.clinical_procedure_template.clinical_procedure_template.change_item_code_from_template - (item_code, doc) -
-No docs
-- - - erpnext.healthcare.doctype.clinical_procedure_template.clinical_procedure_template.create_item_from_template - (doc) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.clinical_procedure_template.clinical_procedure_template.disable_enable_template
-
- - - erpnext.healthcare.doctype.clinical_procedure_template.clinical_procedure_template.disable_enable_template - (status, name, item_code) -
-No docs
-- - - erpnext.healthcare.doctype.clinical_procedure_template.clinical_procedure_template.make_item_price - (item, price_list_name, item_price) -
-No docs
-- - - erpnext.healthcare.doctype.clinical_procedure_template.clinical_procedure_template.updating_item - (self) -
-No docs
-- - - erpnext.healthcare.doctype.clinical_procedure_template.clinical_procedure_template.updating_rate - (self) -
-No docs
-Table Name: tabCodification Table
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -medical_code |
- - Link | -- Medical Code - - | -- - - - -Medical Code - - - - | -
| 2 | -code |
- - Read Only | -- Code - - | -- |
| 3 | -description |
- - Read Only | -- Description - - | -- |
Table Name: tabComplaint
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -complaints |
- - Data | -- Complaints - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabConsultation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -section_break_1 |
- - Section Break | -- - - | -- |
| 2 | -naming_series |
- - Select | -- Series - - | -
- C-- |
-
| 3 | -appointment |
- - Link | -- Appointment - - | -- - - - -Patient Appointment - - - - | -
| 4 | -type |
- - Link | -- Type - - | -- - - - -Appointment Type - - - - | -
| 5 | -patient |
- - Link | -- Patient - - | -- - - - -Patient - - - - | -
| 6 | -patient_age |
- - Data | -- Age - - | -- |
| 7 | -patient_sex |
- - Select | -- Gender - - | -
- -Male -Female -Other- |
-
| 8 | -physician |
- - Link | -- Doctor - - | -- - - - -Physician - - - - | -
| 9 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 10 | -column_break_6 |
- - Column Break | -- - - | -- |
| 11 | -visit_department |
- - Link | -- Department - - | -- - - - -Medical Department - - - - | -
| 12 | -consultation_date |
- - Date | -- Consultation Date - - | -- |
| 13 | -consultation_time |
- - Time | -- Consultation Time - - | -- |
| 14 | -invoice |
- - Link | -- Invoice - - | -- - - - -Sales Invoice - - - - | -
| 15 | -sb_symptoms |
- - Section Break | -- Encounter Impression - - | -- |
| 16 | -symptoms_select |
- - Link | -- Complaints - - | -- - - - -Complaint - - - - | -
| 17 | -symptoms |
- - Small Text | -- - - | -- |
| 18 | -symptoms_in_print |
- - Check | -- In print - - | -- |
| 19 | -physical_examination |
- - Column Break | -- - - | -- |
| 20 | -diagnosis_select |
- - Link | -- Diagnosis - - | -- - - - -Diagnosis - - - - | -
| 21 | -diagnosis |
- - Small Text | -- - - | -- |
| 22 | -diagnosis_in_print |
- - Check | -- In print - - | -- |
| 23 | -codification |
- - Section Break | -- Medical Coding - - | -- |
| 24 | -codification_table |
- - Table | -- Medical Coding - - | -- - - - -Codification Table - - - - | -
| 25 | -sb_drug_prescription |
- - Section Break | -- Medication - - | -- |
| 26 | -drug_prescription |
- - Table | -- Medication - - | -- - - - -Drug Prescription - - - - | -
| 27 | -sb_test_prescription |
- - Section Break | -- Investigations - - | -- |
| 28 | -test_prescription |
- - Table | -- Investigations - - | -- - - - -Lab Prescription - - - - | -
| 29 | -sb_procedures |
- - Section Break | -- Procedures - - | -- |
| 30 | -procedure_prescription |
- - Table | -- Procedures - - | -- - - - -Procedure Prescription - - - - | -
| 31 | -consultation_comment |
- - Small Text | -- Review Details - - | -- |
| 32 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Consultation - - - - | -
Inherits from frappe.model.document.Document - -
- - - after_insert - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.consultation.consultation.create_drug_invoice
-
- - - erpnext.healthcare.doctype.consultation.consultation.create_drug_invoice - (company, patient, prescriptions) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.consultation.consultation.create_invoice
-
- - - erpnext.healthcare.doctype.consultation.consultation.create_invoice - (company, patient, physician, consultation_id) -
-No docs
-- - - erpnext.healthcare.doctype.consultation.consultation.create_invoice_items - (physician, invoice, company) -
-No docs
-- - - erpnext.healthcare.doctype.consultation.consultation.create_sales_invoice_item_lines - (item, sales_invoice) -
-No docs
-- - - erpnext.healthcare.doctype.consultation.consultation.delete_medical_record - (consultation) -
-No docs
-- - - erpnext.healthcare.doctype.consultation.consultation.insert_consultation_to_medical_record - (doc) -
-No docs
-- - - erpnext.healthcare.doctype.consultation.consultation.set_sales_invoice_fields - (company, patient) -
-No docs
-- - - erpnext.healthcare.doctype.consultation.consultation.set_subject_field - (consultation) -
-No docs
-- - - erpnext.healthcare.doctype.consultation.consultation.update_consultation_to_medical_record - (consultation) -
-No docs
-Table Name: tabDiagnosis
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -diagnosis |
- - Data | -- Diagnosis - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabDosage Form
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -dosage_form |
- - Data | -- Dosage Form - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabDosage Strength
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -strength |
- - Float | -- Strength - - | -- |
| 2 | -strength_time |
- - Time | -- Time - - | -- |
Table Name: tabDrug Prescription
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -drug_code |
- - Link | -- Drug Code - - | -- - - - -Item - - - - | -
| 2 | -drug_name |
- - Data | -- Description/Strength - - | -- |
| 3 | -dosage |
- - Link | -- Dosage - - | -- - - - -Prescription Dosage - - - - | -
| 4 | -period |
- - Link | -- Period - - | -- - - - -Prescription Duration - - - - | -
| 5 | -dosage_form |
- - Link | -- Dosage Form - - | -- - - - -Dosage Form - - - - | -
| 6 | -column_break_7 |
- - Column Break | -- - - | -- |
| 7 | -comment |
- - Small Text | -- Comment - - | -- |
| 8 | -use_interval |
- - Check | -- Dosage by time interval - - | -- |
| 9 | -interval |
- - Int | -- Interval - - | -- |
| 10 | -in_every |
- - Select | -- Interval UOM - - | -
- -Hour -Day- |
-
| 11 | -update_schedule |
- - Check | -- Update Schedule - - | -- |
Table Name: tabFee Validity
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -physician |
- - Link | -- Physician - - | -- - - - -Physician - - - - | -
| 2 | -patient |
- - Link | -- Patient - - | -- - - - -Patient - - - - | -
| 3 | -max_visit |
- - Int | -- Max number of visit - - | -- |
| 4 | -visited |
- - Int | -- Visited yet - - | -- |
| 5 | -valid_till |
- - Date | -- Valid till - - | -- |
| 6 | -ref_invoice |
- - Link | -- Reference Inv - - | -- - - - -Sales Invoice - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabHealthcare Service Unit
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -healthcare_service_unit_name |
- - Data | -- Service Unit - - | -- |
| 2 | -parent_healthcare_service_unit |
- - Link | -- Parent Service Unit - - | -- - - - -Healthcare Service Unit - - - - | -
| 3 | -is_group |
- - Check | -- Is Group - - | -- |
| 4 | -allow_appointments |
- - Check | -- Allow Appointments - - | -- |
| 5 | -overlap_appointments |
- - Check | -- Allow Overlap - - | -- |
| 6 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 7 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 8 | -lft |
- - Int | -- lft - - | -- |
| 9 | -rgt |
- - Int | -- rgt - - | -- |
| 10 | -old_parent |
- - Link | -- Old Parent - - | -- - - - -Healthcare Service Unit - - - - | -
Inherits from frappe.utils.nestedset.NestedSet - -
- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -sb_op_settings |
- - Section Break | -- Out Patient Settings - - | -- |
| 2 | -patient_master_name |
- - Select | -- Patient Name By - - | -
- Patient Name -Naming Series- |
-
| 3 | -manage_customer |
- - Check | -
- Manage Customer
- - If checked, a customer will be created, mapped to Patient. -Patient Invoices will be created against this Customer. You can also select existing Customer while creating Patient. - |
- - |
| 4 | -default_medical_code_standard |
- - Link | -- Default Medical Code Standard - - | -- - - - -Medical Code Standard - - - - | -
| 5 | -column_break_9 |
- - Column Break | -- - - | -- |
| 6 | -collect_registration_fee |
- - Check | -- Collect Fee for Patient Registration - - | -- |
| 7 | -registration_fee |
- - Currency | -- Registration Fee - - | -
- Currency- |
-
| 8 | -max_visit |
- - Int | -- Consultations in valid days - - | -- |
| 9 | -valid_days |
- - Int | -- Valid number of days - - | -- |
| 10 | -out_patient_sms_alerts |
- - Section Break | -- Out Patient SMS Alerts - - | -- |
| 11 | -reg_sms |
- - Check | -- Patient Registration - - | -- |
| 12 | -reg_msg |
- - Small Text | -- Registration Message - - | -- |
| 13 | -app_con |
- - Check | -- Appointment Confirmation - - | -- |
| 14 | -app_con_msg |
- - Small Text | -- Confirmation Message - - | -- |
| 15 | -no_con |
- - Check | -
- Avoid Confirmation
- - Do not confirm if appointment is created for the same day - |
- - |
| 16 | -column_break_16 |
- - Column Break | -- - - | -- |
| 17 | -app_rem |
- - Check | -- Appointment Reminder - - | -- |
| 18 | -app_rem_msg |
- - Small Text | -- Reminder Message - - | -- |
| 19 | -rem_before |
- - Time | -- Remind Before - - | -- |
| 20 | -sb_in_ac |
- - Section Break | -
- Income Account
- - Default income accounts to be used if not set in Physician to book Consultation charges. - |
- - |
| 21 | -income_account |
- - Table | -- Income Account - - | -- - - - -Party Account - - - - | -
| 22 | -sb_r_ac |
- - Section Break | -
- Receivable Account
- - Default receivable accounts to be used if not set in Patient to book Consultation charges. - |
- - |
| 23 | -receivable_account |
- - Table | -- Receivable Account - - | -- - - - -Party Account - - - - | -
| 24 | -sb_lab_settings |
- - Section Break | -- Laboratory Settings - - | -- |
| 25 | -require_sample_collection |
- - Check | -
- Manage Sample Collection
- - Create documents for sample collection - |
- - |
| 26 | -require_test_result_approval |
- - Check | -- Require Lab Test Approval - - | -- |
| 27 | -column_break_34 |
- - Column Break | -- - - | -- |
| 28 | -employee_name_and_designation_in_print |
- - Check | -- Employee name and designation in print - - | -- |
| 29 | -custom_signature_in_print |
- - Small Text | -- Custom Signature in Print - - | -- |
| 30 | -laboratory_sms_alerts |
- - Section Break | -- Laboratory SMS Alerts - - | -- |
| 31 | -sms_printed |
- - Small Text | -- Result Printed - - | -- |
| 32 | -column_break_28 |
- - Column Break | -- - - | -- |
| 33 | -sms_emailed |
- - Small Text | -- Result Emailed - - | -- |
Inherits from frappe.model.document.Document - -
- - - erpnext.healthcare.doctype.healthcare_settings.healthcare_settings.get_account - (parent_type, parent_field, parent, company) -
-No docs
-- - - erpnext.healthcare.doctype.healthcare_settings.healthcare_settings.get_income_account - (physician, company) -
-No docs
-- - - erpnext.healthcare.doctype.healthcare_settings.healthcare_settings.get_receivable_account - (company) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.healthcare_settings.healthcare_settings.get_sms_text
-
- - - erpnext.healthcare.doctype.healthcare_settings.healthcare_settings.get_sms_text - (doc) -
-No docs
-- - - erpnext.healthcare.doctype.healthcare_settings.healthcare_settings.send_registration_sms - (doc) -
-No docs
-Table Name: tabLab Prescription
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -test_code |
- - Link | -- Test Code - - | -- - - - -Lab Test Template - - - - | -
| 2 | -test_name |
- - Data | -- Test - - | -- |
| 3 | -invoice |
- - Link | -- Invoice - - | -- - - - -Sales Invoice - - - - | -
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -test_comment |
- - Small Text | -- Comments - - | -- |
| 6 | -test_created |
- - Check | -- Test Created - - | -- |
Table Name: tabLab Test
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- LP-- |
-
| 2 | -invoice |
- - Link | -- Invoice - - | -- - - - -Sales Invoice - - - - | -
| 3 | -patient |
- - Link | -- Patient - - | -- - - - -Patient - - - - | -
| 4 | -patient_name |
- - Data | -- Patient Name - - | -- |
| 5 | -patient_age |
- - Data | -- Age - - | -- |
| 6 | -patient_sex |
- - Select | -- Gender - - | -
- -Male -Female -Other- |
-
| 7 | -physician |
- - Link | -- Doctor - - | -- - - - -Physician - - - - | -
| 8 | -email |
- - Data | -- Email - - | -- |
| 9 | -mobile |
- - Data | -- Mobile - - | -- |
| 10 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 11 | -c_b |
- - Column Break | -- - - | -- |
| 12 | -department |
- - Link | -- Department - - | -- - - - -Medical Department - - - - | -
| 13 | -status |
- - Select | -- Status - - | -
- Draft -Completed -Approved -Rejected -Cancelled- |
-
| 14 | -submitted_date |
- - Datetime | -- Submitted Date - - | -- |
| 15 | -approved_date |
- - Datetime | -- Approved Date - - | -- |
| 16 | -sample |
- - Link | -- Sample ID - - | -- - - - -Sample Collection - - - - | -
| 17 | -result_date |
- - Date | -- Result Date - - | -- |
| 18 | -employee |
- - Link | -- Lab Technician - - | -- - - - -Employee - - - - | -
| 19 | -employee_name |
- - Data | -- Technician Name - - | -- |
| 20 | -employee_designation |
- - Data | -- Designation - - | -- |
| 21 | -user |
- - Link | -- User - - | -- - - - -User - - - - | -
| 22 | -report_preference |
- - Data | -- Report Preference - - | -- |
| 23 | -sb_first |
- - Section Break | -- - - | -- |
| 24 | -test_name |
- - Data | -- Test Name - - | -- |
| 25 | -column_break_26 |
- - Column Break | -- - - | -- |
| 26 | -template |
- - Link | -- Test Template - - | -- - - - -Lab Test Template - - - - | -
| 27 | -test_group |
- - Link | -- Test Group - - | -- - - - -Item Group - - - - | -
| 28 | -sb_normal |
- - Section Break | -- - - | -- |
| 29 | -normal_test_items |
- - Table | -- - - | -- - - - -Normal Test Items - - - - | -
| 30 | -sb_special |
- - Section Break | -- - - | -- |
| 31 | -special_test_items |
- - Table | -- - - | -- - - - -Special Test Items - - - - | -
| 32 | -sb_sensitivity |
- - Section Break | -- - - | -- |
| 33 | -sensitivity_test_items |
- - Table | -- - - | -- - - - -Sensitivity Test Items - - - - | -
| 34 | -sb_comments |
- - Section Break | -- - - | -- |
| 35 | -test_comment |
- - Text | -- Comments - - | -- |
| 36 | -sb_customresult |
- - Section Break | -- Custom Result - - | -- |
| 37 | -custom_result |
- - Text Editor | -- Custom Result - - | -- |
| 38 | -email_sent |
- - Check | -- - - | -- |
| 39 | -sms_sent |
- - Check | -- - - | -- |
| 40 | -printed |
- - Check | -- - - | -- |
| 41 | -normal_toggle |
- - Check | -- - - | -- |
| 42 | -special_toggle |
- - Check | -- - - | -- |
| 43 | -sensitivity_toggle |
- - Check | -- - - | -- |
| 44 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Lab Test - - - - | -
| 45 | -prescription |
- - Link | -- Prescription - - | -- - - - -Lab Prescription - - - - | -
Inherits from frappe.model.document.Document - -
- - - after_insert - (self) -
-No docs
-- - - load_test_from_template - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.create_compounds - (template, lab_test, is_group) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.lab_test.lab_test.create_invoice
-
- - - erpnext.healthcare.doctype.lab_test.lab_test.create_invoice - (company, patient, lab_tests, prescriptions) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.create_item_line - (test_code, sales_invoice) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.create_lab_test - (patient, template, prescription, consultation, invoice) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.create_lab_test_doc - (invoice, consultation, patient, template) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.lab_test.lab_test.create_lab_test_from_desk
-
- - - erpnext.healthcare.doctype.lab_test.lab_test.create_lab_test_from_desk - (patient, template, prescription, invoice=None) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.create_normals - (template, lab_test) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.create_sample_collection - (lab_test, template, patient, invoice) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.create_sample_doc - (template, patient, invoice) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.create_specials - (template, lab_test) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.create_test_from_template - (lab_test) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.delete_lab_test_from_medical_record - (self) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.lab_test.lab_test.get_employee_by_user_id
-
- - - erpnext.healthcare.doctype.lab_test.lab_test.get_employee_by_user_id - (user_id) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.lab_test.lab_test.get_lab_test_prescribed
-
- - - erpnext.healthcare.doctype.lab_test.lab_test.get_lab_test_prescribed - (patient) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.insert_lab_test_to_medical_record - (doc) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test.lab_test.load_result_format - (lab_test, template, prescription, invoice) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.lab_test.lab_test.update_lab_test_print_sms_email_status
-
- - - erpnext.healthcare.doctype.lab_test.lab_test.update_lab_test_print_sms_email_status - (print_sms_email, name) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.lab_test.lab_test.update_status
-
- - - erpnext.healthcare.doctype.lab_test.lab_test.update_status - (status, name) -
-No docs
-Table Name: tabLab Test Groups
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -template_or_new_line |
- - Select | -- - - | -
- Add Test -Add new line- |
-
| 2 | -test_template |
- - Link | -- Test Name - - | -- - - - -Lab Test Template - - - - | -
| 3 | -test_rate |
- - Currency | -- Rate - - | -- |
| 4 | -test_description |
- - Data | -- Description - - | -- |
| 5 | -group_event |
- - Data | -- Event - - | -- |
| 6 | -group_test_uom |
- - Link | -- UOM - - | -- - - - -Lab Test UOM - - - - | -
| 7 | -group_test_normal_range |
- - Long Text | -- Normal Range - - | -- |
| 8 | -column_break_8 |
- - Column Break | -- - - | -- |
Table Name: tabLab Test Sample
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -sample |
- - Data | -- Sample - - | -- |
| 2 | -sample_uom |
- - Data | -- UOM - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabLab Test Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -test_name |
- - Data | -- Test Name - - | -- |
| 2 | -item |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 3 | -test_code |
- - Data | -- Item Code - - | -- |
| 4 | -test_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 5 | -department |
- - Link | -- Department - - | -- - - - -Medical Department - - - - | -
| 6 | -column_break_3 |
- - Column Break | -- - - | -- |
| 7 | -test_template_type |
- - Select | -
- Result Format
-
- Single for results which require only a single input, result UOM and normal value
- |
-
- -Single -Compound -Descriptive -Grouped -No Result- |
-
| 8 | -is_billable |
- - Check | -
- Is billable
- - If unchecked, the item wont be appear in Sales Invoice, but can be used in group test creation. - |
- - |
| 9 | -test_rate |
- - Currency | -
- Standard Selling Rate
- - This value is updated in the Default Sales Price List. - |
- - |
| 10 | -section_break_normal |
- - Section Break | -- Lab Routine - - | -- |
| 11 | -test_uom |
- - Link | -- UOM - - | -- - - - -Lab Test UOM - - - - | -
| 12 | -test_normal_range |
- - Long Text | -- Normal Range - - | -- |
| 13 | -column_break_10 |
- - Column Break | -- - - | -- |
| 14 | -section_break_compound |
- - Section Break | -- Compound - - | -- |
| 15 | -normal_test_templates |
- - Table | -- - - | -- - - - -Normal Test Template - - - - | -
| 16 | -section_break_special |
- - Section Break | -- Special - - | -- |
| 17 | -sensitivity |
- - Check | -- Sensitivity - - | -- |
| 18 | -special_test_template |
- - Table | -- - - | -- - - - -Special Test Template - - - - | -
| 19 | -section_break_group |
- - Section Break | -- Group - - | -- |
| 20 | -test_groups |
- - Table | -- - - | -- - - - -Lab Test Groups - - - - | -
| 21 | -section_break_description |
- - Section Break | -- - - | -- |
| 22 | -test_description |
- - Text | -- Description - - | -- |
| 23 | -sb_sample_collection |
- - Section Break | -- Sample Collection - - | -- |
| 24 | -sample |
- - Link | -- Sample - - | -- - - - -Lab Test Sample - - - - | -
| 25 | -sample_uom |
- - Data | -- UOM - - | -- |
| 26 | -sample_quantity |
- - Float | -- Quantity - - | -- |
| 27 | -sample_collection_details |
- - Text | -- Collection Details - - | -- |
| 28 | -change_in_item |
- - Check | -- Change In Item - - | -- |
| 29 | -disabled |
- - Check | -- disabled - - | -- |
Inherits from frappe.model.document.Document - -
- - - after_insert - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.lab_test_template.lab_test_template.change_test_code_from_template
-
- - - erpnext.healthcare.doctype.lab_test_template.lab_test_template.change_test_code_from_template - (test_code, doc) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test_template.lab_test_template.create_item_from_template - (doc) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.lab_test_template.lab_test_template.disable_enable_test_template
-
- - - erpnext.healthcare.doctype.lab_test_template.lab_test_template.disable_enable_test_template - (status, name, is_billable) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test_template.lab_test_template.item_price_exist - (doc) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test_template.lab_test_template.make_item_price - (item, price_list_name, item_price) -
-No docs
-- - - erpnext.healthcare.doctype.lab_test_template.lab_test_template.updating_item - (self) -
-No docs
-Table Name: tabLab Test UOM
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -test_uom |
- - Data | -- Test UOM - - | -- |
| 2 | -uom_description |
- - Data | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabMedical Code
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -medical_code_standard |
- - Link | -- Medical Code Standard - - | -- - - - -Medical Code Standard - - - - | -
| 2 | -code |
- - Data | -- Code - - | -- |
| 3 | -description |
- - Small Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabMedical Code Standard
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -medical_code |
- - Data | -- Medical Code - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabMedical Department
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -department |
- - Data | -- Department - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabNormal Test Items
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -test_name |
- - Data | -- Test Name - - | -- |
| 2 | -test_event |
- - Data | -- Event - - | -- |
| 3 | -result_value |
- - Data | -- Result Value - - | -- |
| 4 | -test_uom |
- - Data | -- UOM - - | -- |
| 5 | -normal_range |
- - Long Text | -- Normal Range - - | -- |
| 6 | -test_comment |
- - Data | -- Comment - - | -- |
| 7 | -require_result_value |
- - Check | -- Require Result Value - - | -- |
| 8 | -template |
- - Link | -- Template - - | -- - - - -Lab Test Template - - - - | -
Table Name: tabNormal Test Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -heading_text |
- - Heading | -- Test - - | -- |
| 2 | -test_event |
- - Data | -- Event - - | -- |
| 3 | -test_uom |
- - Link | -- UOM - - | -- - - - -Lab Test UOM - - - - | -
| 4 | -normal_range |
- - Long Text | -- Normal Range - - | -- |
| 5 | -column_break_5 |
- - Column Break | -- - - | -- |
Table Name: tabPatient
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -basic_info |
- - Section Break | -- Patient Demographics - - | -
- fa fa-user- |
-
| 2 | -naming_series |
- - Select | -- Patient ID - - | -
- PID-- |
-
| 3 | -patient_name |
- - Data | -- Full Name - - | -- |
| 4 | -sex |
- - Select | -- Gender - - | -
- -Male -Female -Other- |
-
| 5 | -blood_group |
- - Select | -- Blood Group - - | -
- -A Positive -A Negative -AB Positive -AB Negative -B Positive -B Negative -O Positive -O Negative- |
-
| 6 | -dob |
- - Date | -- Date of birth - - | -- |
| 7 | -age_html |
- - HTML | -- Age - - | -- |
| 8 | -status |
- - Select | -- Status - - | -
- Active -Dormant -Open- |
-
| 9 | -image |
- - Attach Image | -- Image - - | -- |
| 10 | -column_break_14 |
- - Column Break | -- - - | -- |
| 11 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 12 | -report_preference |
- - Select | -- Report Preference - - | -
- -Email -Print- |
-
| 13 | -mobile |
- - Data | -- Mobile - - | -- |
| 14 | -email |
- - Data | -- Email - - | -
- |
-
| 15 | -phone |
- - Data | -- Phone - - | -- |
| 16 | -disabled |
- - Check | -- Disabled - - | -- |
| 17 | -sb_relation |
- - Section Break | -- Patient Relation - - | -- |
| 18 | -patient_relation |
- - Table | -- Patient Relation - - | -- - - - -Patient Relation - - - - | -
| 19 | -allergy_medical_and_surgical_history |
- - Section Break | -- Allergies, Medical and Surgical History - - | -- |
| 20 | -allergies |
- - Small Text | -- Allergies - - | -- |
| 21 | -medication |
- - Small Text | -- Medication - - | -- |
| 22 | -column_break_20 |
- - Column Break | -- - - | -- |
| 23 | -medical_history |
- - Small Text | -- Medical History - - | -- |
| 24 | -surgical_history |
- - Small Text | -- Surgical History - - | -- |
| 25 | -personal_and_social_history |
- - Section Break | -- Personal and Social History - - | -- |
| 26 | -occupation |
- - Data | -- Occupation - - | -- |
| 27 | -column_break_25 |
- - Column Break | -- - - | -- |
| 28 | -marital_status |
- - Select | -- Marital Status - - | -
- -Single -Married -Divorced -Widow- |
-
| 29 | -risk_factors |
- - Section Break | -- Risk Factors - - | -- |
| 30 | -tobacco_past_use |
- - Data | -- Tobacco Past Use - - | -- |
| 31 | -tobacco_current_use |
- - Data | -- Tobacco Current Use - - | -- |
| 32 | -alcohol_past_use |
- - Data | -- Alcohol Past Use - - | -- |
| 33 | -alcohol_current_use |
- - Data | -- Alcohol Current Use - - | -- |
| 34 | -column_break_32 |
- - Column Break | -- - - | -- |
| 35 | -surrounding_factors |
- - Small Text | -- Occupational Hazards and Environmental Factors - - | -- |
| 36 | -other_risk_factors |
- - Small Text | -- Other Risk Factors - - | -- |
| 37 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 38 | -patient_details |
- - Text | -
- Patient Details
- - Additional information regarding the patient - |
- - |
| 39 | -ac_sb |
- - Section Break | -- Account Details - - | -- |
| 40 | -default_currency |
- - Link | -- Default Currency - - | -- - - - -Currency - - - - | -
Inherits from frappe.model.document.Document - -
- - - add_as_website_user - (self) -
-No docs
-- - - after_insert - (self) -
-No docs
-- - - autoname - (self) -
-No docs
-- - - get_age - (self) -
-No docs
-- - - get_patient_name - (self) -
-No docs
-- - - invoice_patient_registration - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - erpnext.healthcare.doctype.patient.patient.create_customer - (doc) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.patient.patient.get_patient_detail
-
- - - erpnext.healthcare.doctype.patient.patient.get_patient_detail - (patient) -
-No docs
-- - - erpnext.healthcare.doctype.patient.patient.make_invoice - (patient, company) -
-No docs
-Table Name: tabPatient Appointment
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -patient |
- - Link | -- Patient - - | -- - - - -Patient - - - - | -
| 2 | -department |
- - Link | -- Department - - | -- - - - -Medical Department - - - - | -
| 3 | -physician |
- - Link | -- Physician - - | -- - - - -Physician - - - - | -
| 4 | -get_procedure_from_consultation |
- - Button | -- Get prescribed procedures - - | -- |
| 5 | -procedure_prescription |
- - Link | -- Procedure Prescription - - | -- - - - -Procedure Prescription - - - - | -
| 6 | -procedure_template |
- - Link | -- Procedure - - | -- - - - -Clinical Procedure Template - - - - | -
| 7 | -appointment_date |
- - Date | -- Date - - | -- |
| 8 | -appointment_time |
- - Time | -- Time - - | -- |
| 9 | -duration |
- - Int | -
- Duration
- - In Minutes - |
- - |
| 10 | -check_availability |
- - Button | -- Check availability - - | -- |
| 11 | -column_break_1 |
- - Column Break | -- - - | -- |
| 12 | -service_unit |
- - Link | -- Service Unit - - | -- - - - -Healthcare Service Unit - - - - | -
| 13 | -patient_name |
- - Data | -- Patient Name - - | -- |
| 14 | -patient_sex |
- - Data | -- Gender - - | -- |
| 15 | -patient_age |
- - Data | -- Patient Age - - | -- |
| 16 | -status |
- - Select | -- Status - - | -
- -Scheduled -Open -Closed -Pending -Cancelled- |
-
| 17 | -appointment_type |
- - Link | -- Type - - | -- - - - -Appointment Type - - - - | -
| 18 | -section_break_1 |
- - Section Break | -- - - | -- |
| 19 | -appointment_datetime |
- - Datetime | -- Date TIme - - | -- |
| 20 | -column_break_2 |
- - Column Break | -- - - | -- |
| 21 | -sales_invoice |
- - Link | -- Sales Invoice - - | -- - - - -Sales Invoice - - - - | -
| 22 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 23 | -section_break_3 |
- - Section Break | -- More Info - - | -- |
| 24 | -notes |
- - Small Text | -- Notes - - | -- |
| 25 | -referring_physician |
- - Link | -- Referring Physician - - | -- - - - -Physician - - - - | -
| 26 | -reminded |
- - Check | -- Reminded - - | -- |
Inherits from frappe.model.document.Document - -
- - - after_insert - (self) -
-No docs
-- - - create_invoice - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.appointment_cancel - (appointment_id) -
-No docs
-- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.confirm_sms - (doc) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.patient_appointment.patient_appointment.create_consultation
-
- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.create_consultation - (appointment) -
-No docs
-- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.create_fee_validity - (physician, patient, date) -
-No docs
-- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.create_invoice_items - (physician, company, invoice, procedure_template) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.patient_appointment.patient_appointment.get_availability_data
-
- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.get_availability_data - (date, physician) -
-Get availability data of 'physician' on 'date'
-
-
-Parameters:
- -date - Date to check in schedulephysician - Name of the physician
:return: dict containing a list of available slots, list of appointments and time of appointments
Public API
- /api/method/erpnext.healthcare.doctype.patient_appointment.patient_appointment.get_events
-
- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.get_events - (start, end, filters=None) -
-Returns events for Gantt / Calendar view rendering.
- -Parameters:
- -start - Start date-time.end - End date-time.filters - Filters (JSON).- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.get_fee_validity - (physician, patient, date) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.patient_appointment.patient_appointment.get_procedure_prescribed
-
- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.get_procedure_prescribed - (patient) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.patient_appointment.patient_appointment.invoice_appointment
-
- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.invoice_appointment - (appointment_doc) -
-No docs
-- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.remind_appointment - () -
-No docs
-- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.send_message - (doc, message) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.patient_appointment.patient_appointment.set_open_appointments
-
- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.set_open_appointments - () -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.patient_appointment.patient_appointment.set_pending_appointments
-
- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.set_pending_appointments - () -
-No docs
-- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.update_fee_validity - (fee_validity, date) -
-No docs
-Public API
- /api/method/erpnext.healthcare.doctype.patient_appointment.patient_appointment.update_status
-
- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.update_status - (appointment_id, status) -
-No docs
-- - - erpnext.healthcare.doctype.patient_appointment.patient_appointment.validity_exists - (physician, patient) -
-No docs
-Table Name: tabPatient Medical Record
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- PMR-- |
-
| 2 | -patient |
- - Link | -- Patient - - | -- - - - -Patient - - - - | -
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -attach |
- - Attach | -- - - | -- |
| 5 | -section_break_4 |
- - Section Break | -- - - | -- |
| 6 | -subject |
- - Small Text | -- Subject - - | -- |
| 7 | -status |
- - Select | -- Status - - | -
- Open -Close- |
-
| 8 | -communication_date |
- - Date | -- Datetime - - | -- |
| 9 | -reference_doctype |
- - Link | -- Reference DocType - - | -- - - - -DocType - - - - | -
| 10 | -reference_name |
- - Dynamic Link | -- Reference Name - - | -
- reference_doctype- |
-
| 11 | -reference_owner |
- - Data | -- Reference Owner - - | -- |
| 12 | -user |
- - Link | -- User - - | -- - - - -User - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabPatient Relation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -relation |
- - Select | -- Relation - - | -
- -Father -Mother -Spouse -Siblings -Family- |
-
| 2 | -patient |
- - Link | -- Patient - - | -- - - - -Patient - - - - | -
| 3 | -description |
- - Data | -- Description - - | -- |
Table Name: tabPhysician
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -first_name |
- - Data | -- First Name - - | -- |
| 2 | -middle_name |
- - Data | -- Middle Name (Optional) - - | -- |
| 3 | -last_name |
- - Data | -- Last Name - - | -- |
| 4 | -image |
- - Attach Image | -- Image - - | -- |
| 5 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 6 | -user_id |
- - Link | -- User - - | -- - - - -User - - - - | -
| 7 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 8 | -department |
- - Link | -- Department - - | -- - - - -Medical Department - - - - | -
| 9 | -column_break_7 |
- - Column Break | -- - - | -- |
| 10 | -hospital |
- - Data | -- Hospital - - | -- |
| 11 | -mobile_phone |
- - Data | -- Mobile - - | -- |
| 12 | -residence_phone |
- - Data | -- Phone (R) - - | -- |
| 13 | -office_phone |
- - Data | -- Phone (Office) - - | -- |
| 14 | -appointments |
- - Section Break | -- Appointments - - | -- |
| 15 | -physician_schedules |
- - Table | -- Physician Schedules - - | -- - - - -Physician Service Unit Schedule - - - - | -
| 16 | -charges |
- - Section Break | -- Charges - - | -- |
| 17 | -op_consulting_charge |
- - Currency | -- OP Consulting Charge - - | -
- Currency- |
-
| 18 | -contacts_and_address |
- - Section Break | -- Contacts and Address - - | -- |
| 19 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 20 | -column_break_19 |
- - Column Break | -- - - | -- |
| 21 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
| 22 | -account_details |
- - Section Break | -- Account Details - - | -- |
| 23 | -accounts |
- - Table | -- Income Account - - | -- - - - -Party Account - - - - | -
| 24 | -default_currency |
- - Link | -- Default Currency - - | -- - - - -Currency - - - - | -
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_duplicate_user_id - (self) -
-No docs
-- - - validate_for_enabled_user_id - (self) -
-No docs
-Table Name: tabPhysician Schedule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -schedule_name |
- - Data | -- Schedule Name - - | -- |
| 2 | -time_slots |
- - Table | -- Time Slots - - | -- - - - -Physician Schedule Time Slot - - - - | -
| 3 | -disabled |
- - Check | -- Disabled - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabPhysician Schedule Time Slot
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -day |
- - Select | -- Day - - | -
- Sunday -Monday -Tuesday -Wednesday -Thursday -Friday -Saturday- |
-
| 2 | -from_time |
- - Time | -- From Time - - | -- |
| 3 | -to_time |
- - Time | -- To Time - - | -- |
Table Name: tabPhysician Service Unit Schedule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -schedule |
- - Link | -- Schedule - - | -- - - - -Physician Schedule - - - - | -
| 2 | -service_unit |
- - Link | -- Service Unit - - | -- - - - -Healthcare Service Unit - - - - | -
Table Name: tabPrescription Dosage
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -dosage |
- - Data | -- Dosage - - | -- |
| 2 | -dosage_strength |
- - Table | -- - - | -- - - - -Dosage Strength - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabPrescription Duration
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -number |
- - Int | -- Number - - | -- |
| 2 | -period |
- - Select | -- Period - - | -
- Hour -Day -Week -Month- |
-
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - get_days - (self) -
-No docs
-- - - get_hours - (self) -
-No docs
-- - - get_minutes - (self) -
-No docs
-- - - get_months - (self) -
-No docs
-- - - get_weeks - (self) -
-No docs
-Table Name: tabProcedure Prescription
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -procedure |
- - Link | -- Procedure - - | -- - - - -Clinical Procedure Template - - - - | -
| 2 | -procedure_name |
- - Data | -- Procedure Name - - | -- |
| 3 | -department |
- - Link | -- Department - - | -- - - - -Medical Department - - - - | -
| 4 | -physician |
- - Link | -- Physician - - | -- - - - -Physician - - - - | -
| 5 | -date |
- - Date | -- Date - - | -- |
| 6 | -comments |
- - Data | -- Comments - - | -- |
| 7 | -appointment_booked |
- - Check | -- Appointment Booked - - | -- |
Table Name: tabSample Collection
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- SMPL-- |
-
| 2 | -invoice |
- - Link | -- Invoice - - | -- - - - -Sales Invoice - - - - | -
| 3 | -patient |
- - Link | -- Patient - - | -- - - - -Patient - - - - | -
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -patient_age |
- - Data | -- Age - - | -- |
| 6 | -patient_sex |
- - Data | -- Gender - - | -- |
| 7 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 8 | -section_break_6 |
- - Section Break | -- - - | -- |
| 9 | -sample |
- - Link | -- Sample - - | -- - - - -Lab Test Sample - - - - | -
| 10 | -sample_uom |
- - Data | -- UOM - - | -- |
| 11 | -sample_quantity |
- - Float | -- Quantity - - | -- |
| 12 | -column_break_10 |
- - Column Break | -- - - | -- |
| 13 | -collected_by |
- - Link | -- Collected By - - | -- - - - -User - - - - | -
| 14 | -collected_time |
- - Datetime | -- Collected Time - - | -- |
| 15 | -num_print |
- - Int | -- No. of print - - | -- |
| 16 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Sample Collection - - - - | -
| 17 | -section_break_15 |
- - Section Break | -- - - | -- |
| 18 | -sample_collection_details |
- - Long Text | -- Collection Details - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabSensitivity
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -sensitivity |
- - Data | -- Sensitivity - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabSensitivity Test Items
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -antibiotic |
- - Link | -- Antibiotic - - | -- - - - -Antibiotic - - - - | -
| 2 | -antibiotic_sensitivity |
- - Link | -- Sensitivity - - | -- - - - -Sensitivity - - - - | -
Table Name: tabSpecial Test Items
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -test_particulars |
- - Data | -- Particulars - - | -- |
| 2 | -result_value |
- - Small Text | -- Value - - | -- |
| 3 | -require_result_value |
- - Check | -- Require Result Value - - | -- |
| 4 | -template |
- - Link | -- Template - - | -- - - - -Lab Test Template - - - - | -
Table Name: tabSpecial Test Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -particulars |
- - Data | -- Result Component - - | -- |
Table Name: tabVital Signs
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -patient |
- - Link | -- Patient - - | -- - - - -Patient - - - - | -
| 2 | -patient_name |
- - Data | -- Patient Name - - | -- |
| 3 | -appointment |
- - Link | -- Appointment - - | -- - - - -Patient Appointment - - - - | -
| 4 | -consultation |
- - Link | -- Consultation - - | -- - - - -Consultation - - - - | -
| 5 | -column_break_2 |
- - Column Break | -- - - | -- |
| 6 | -signs_date |
- - Date | -- Date - - | -- |
| 7 | -column_break_4 |
- - Column Break | -- - - | -- |
| 8 | -signs_time |
- - Time | -- Time - - | -- |
| 9 | -sb_vs |
- - Section Break | -- Vital Signs - - | -- |
| 10 | -temperature |
- - Data | -
- Body Temperature
- - Presence of a fever (temp > 38.5 °C/101.3 °F or sustained temp > 38 °C/100.4 °F) - |
- - |
| 11 | -pulse |
- - Data | -
- Heart Rate / Pulse
- - Adults' pulse rate is anywhere between 50 and 80 beats per minute. - |
- - |
| 12 | -respiratory_rate |
- - Data | -
- Respiratory rate
- - Normal reference range for an adult is 16–20 breaths/minute (RCP 2012) - |
- - |
| 13 | -column_break_8 |
- - Column Break | -- - - | -- |
| 14 | -bp_systolic |
- - Data | -- Blood Pressure (systolic) - - | -- |
| 15 | -bp_diastolic |
- - Data | -- Blood Pressure (diastolic) - - | -- |
| 16 | -bp |
- - Data | -
- Blood Pressure
- - Normal resting blood pressure in an adult is approximately 120 mmHg systolic, and 80 mmHg diastolic, abbreviated "120/80 mmHg" - |
- - |
| 17 | -vital_signs_note |
- - Small Text | -- Notes - - | -- |
| 18 | -sb_nutrition_values |
- - Section Break | -- Nutrition Values - - | -- |
| 19 | -height |
- - Float | -- Height (In Meter) - - | -- |
| 20 | -weight |
- - Float | -- Weight (In Kilogram) - - | -- |
| 21 | -bmi |
- - Float | -- BMI - - | -- |
| 22 | -column_break_14 |
- - Column Break | -- - - | -- |
| 23 | -nutrition_note |
- - Small Text | -- Notes - - | -- |
| 24 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 25 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Vital Signs - - - - | -
Inherits from frappe.model.document.Document - -
- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - erpnext.healthcare.doctype.vital_signs.vital_signs.delete_vital_signs_from_medical_record - (doc) -
-No docs
-- - - erpnext.healthcare.doctype.vital_signs.vital_signs.insert_vital_signs_to_medical_record - (doc) -
-No docs
-- - - erpnext.healthcare.doctype.vital_signs.vital_signs.set_subject_field - (doc) -
-No docs
-Table Name: tabHotel Room
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -hotel_room_type |
- - Link | -- Hotel Room Type - - | -- - - - -Hotel Room Type - - - - | -
| 2 | -capacity |
- - Int | -- Capacity - - | -- |
| 3 | -extra_bed_capacity |
- - Int | -- Extra Bed Capacity - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabHotel Room Amenity
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 2 | -billable |
- - Check | -- Billable - - | -- |
Table Name: tabHotel Room Package
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -hotel_room_type |
- - Link | -- Hotel Room Type - - | -- - - - -Hotel Room Type - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -item |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 4 | -section_break_4 |
- - Section Break | -- - - | -- |
| 5 | -amenities |
- - Table | -- Amenities - - | -- - - - -Hotel Room Amenity - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabHotel Room Pricing
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -enabled |
- - Check | -- Enabled - - | -- |
| 2 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 3 | -from_date |
- - Date | -- From Date - - | -- |
| 4 | -to_date |
- - Date | -- To Date - - | -- |
| 5 | -section_break_5 |
- - Section Break | -- - - | -- |
| 6 | -items |
- - Table | -- Items - - | -- - - - -Hotel Room Pricing Item - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabHotel Room Pricing Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 2 | -rate |
- - Currency | -- Rate - - | -- |
Table Name: tabHotel Room Pricing Package
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -from_date |
- - Date | -- From Date - - | -- |
| 2 | -to_date |
- - Date | -- To Date - - | -- |
| 3 | -hotel_room_package |
- - Link | -- Hotel Room Package - - | -- - - - -Hotel Room Package - - - - | -
| 4 | -rate |
- - Currency | -- Rate - - | -- |
Table Name: tabHotel Room Reservation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -guest_name |
- - Data | -- Guest Name - - | -- |
| 2 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 3 | -from_date |
- - Date | -- From Date - - | -- |
| 4 | -to_date |
- - Date | -- To Date - - | -- |
| 5 | -late_checkin |
- - Check | -- Late Checkin - - | -- |
| 6 | -column_break_6 |
- - Column Break | -- - - | -- |
| 7 | -status |
- - Select | -- Status - - | -
- Booked -Advance Paid -Invoiced -Paid -Completed -Cancelled- |
-
| 8 | -section_break_8 |
- - Section Break | -- - - | -- |
| 9 | -items |
- - Table | -- Items - - | -- - - - -Hotel Room Reservation Item - - - - | -
| 10 | -net_total |
- - Currency | -- Net Total - - | -- |
| 11 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Hotel Room Reservation - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - get_total_rooms - (self, item) -
-No docs
-- - - set_rates - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_availability - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Public API
- /api/method/erpnext.hotels.doctype.hotel_room_reservation.hotel_room_reservation.get_room_rate
-
- - - erpnext.hotels.doctype.hotel_room_reservation.hotel_room_reservation.get_room_rate - (hotel_room_reservation) -
-Calculate rate for each day as it may belong to different Hotel Room Pricing Item
-- - - erpnext.hotels.doctype.hotel_room_reservation.hotel_room_reservation.get_rooms_booked - (room_type, day, exclude_reservation=None) -
-No docs
-Table Name: tabHotel Room Reservation Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 2 | -qty |
- - Int | -- Qty - - | -- |
| 3 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 4 | -rate |
- - Currency | -- Rate - - | -- |
| 5 | -amount |
- - Currency | -- Amount - - | -- |
Table Name: tabHotel Room Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -capacity |
- - Int | -- Capacity - - | -- |
| 2 | -extra_bed_capacity |
- - Int | -- Extra Bed Capacity - - | -- |
| 3 | -section_break_3 |
- - Section Break | -- - - | -- |
| 4 | -amenities |
- - Table | -- Amenities - - | -- - - - -Hotel Room Amenity - - - - | -
Inherits from frappe.model.document.Document - -
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -default_customer |
- - Link | -- Default Customer - - | -- - - - -Customer - - - - | -
| 2 | -default_taxes_and_charges |
- - Link | -- Default Taxes and Charges - - | -- - - - -Sales Taxes and Charges Template - - - - | -
| 3 | -default_invoice_naming_series |
- - Data | -- Default Invoice Naming Series - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabAdditional Salary
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- ASC-- |
-
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 4 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 5 | -salary_component |
- - Link | -- Salary Component - - | -- - - - -Salary Component - - - - | -
| 6 | -type |
- - Data | -- Type - - | -- |
| 7 | -column_break_5 |
- - Column Break | -- - - | -- |
| 8 | -from_date |
- - Date | -- From Date - - | -- |
| 9 | -to_date |
- - Date | -- To Date - - | -- |
| 10 | -amount |
- - Currency | -- Amount - - | -- |
| 11 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 12 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Additional Salary - - - - | -
Inherits from frappe.model.document.Document - -
- - - get_amount - (self, sal_start_date, sal_end_date) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_dates - (self) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.additional_salary.additional_salary.get_additional_salary_component
-
- - - erpnext.hr.doctype.additional_salary.additional_salary.get_additional_salary_component - (employee, start_date, end_date) -
-No docs
-Table Name: tabAppraisal
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee_details |
- - Section Break | -- - - | -- |
| 2 | -naming_series |
- - Select | -- Series - - | -
- APRSL- |
-
| 3 | -kra_template |
- - Link | -- Appraisal Template - - | -- - - - -Appraisal Template - - - - | -
| 4 | -employee |
- - Link | -- For Employee - - | -- - - - -Employee - - - - | -
| 5 | -employee_name |
- - Data | -- For Employee Name - - | -- |
| 6 | -column_break0 |
- - Column Break | -- - - | -- |
| 7 | -status |
- - Select | -- Status - - | -
- -Draft -Submitted -Completed -Cancelled- |
-
| 8 | -start_date |
- - Date | -- Start Date - - | -- |
| 9 | -end_date |
- - Date | -- End Date - - | -- |
| 10 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 11 | -section_break0 |
- - Section Break | -- Goals - - | -
- Simple- |
-
| 12 | -goals |
- - Table | -- Goals - - | -- - - - -Appraisal Goal - - - - | -
| 13 | -calculate_total_score |
- - Button | -- Calculate Total Score - - | -
- calculate_total- |
-
| 14 | -total_score |
- - Float | -- Total Score (Out of 5) - - | -- |
| 15 | -section_break1 |
- - Section Break | -- - - | -- |
| 16 | -remarks |
- - Text | -
- Remarks
- - Any other remarks, noteworthy effort that should go in the records. - |
- - |
| 17 | -other_details |
- - Section Break | -- - - | -- |
| 18 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 19 | -column_break_17 |
- - Column Break | -- - - | -- |
| 20 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Appraisal - - - - | -
Inherits from frappe.model.document.Document - -
- - - calculate_total - (self) -
-No docs
-- - - get_employee_name - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_dates - (self) -
-No docs
-- - - validate_existing_appraisal - (self) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.appraisal.appraisal.fetch_appraisal_template
-
- - - erpnext.hr.doctype.appraisal.appraisal.fetch_appraisal_template - (source_name, target_doc=None) -
-No docs
-Table Name: tabAppraisal Goal
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -kra |
- - Small Text | -
- Goal
- - Key Responsibility Area - |
- - |
| 2 | -section_break_2 |
- - Section Break | -- - - | -- |
| 3 | -per_weightage |
- - Float | -- Weightage (%) - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -score |
- - Float | -- Score (0-5) - - | -- |
| 6 | -section_break_6 |
- - Section Break | -- - - | -- |
| 7 | -score_earned |
- - Float | -- Score Earned - - | -- |
Table Name: tabAppraisal Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -kra_title |
- - Data | -- Appraisal Template Title - - | -- |
| 2 | -description |
- - Small Text | -- Description - - | -- |
| 3 | -goals |
- - Table | -- Goals - - | -- - - - -Appraisal Template Goal - - - - | -
Inherits from frappe.model.document.Document - -
- - - check_total_points - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabAppraisal Template Goal
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -kra |
- - Small Text | -
- KRA
- - Key Performance Area - |
- - |
| 2 | -per_weightage |
- - Float | -- Weightage (%) - - | -- |
Table Name: tabAttendance
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -attendance_details |
- - Section Break | -- - - | -
- Simple- |
-
| 2 | -naming_series |
- - Select | -- Series - - | -
- ATT-- |
-
| 3 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 4 | -employee_name |
- - Read Only | -- Employee Name - - | -- |
| 5 | -status |
- - Select | -- Status - - | -
- -Present -Absent -On Leave -Half Day- |
-
| 6 | -leave_type |
- - Link | -- Leave Type - - | -- - - - -Leave Type - - - - | -
| 7 | -column_break0 |
- - Column Break | -- - - | -- |
| 8 | -attendance_date |
- - Date | -- Attendance Date - - | -- |
| 9 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 10 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 11 | -attendance_request |
- - Link | -- Attendance Request - - | -- - - - -Attendance Request - - - - | -
| 12 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Attendance - - - - | -
Inherits from frappe.model.document.Document - -
- - - check_leave_record - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_attendance_date - (self) -
-No docs
-- - - validate_duplicate_record - (self) -
-No docs
-- - - validate_employee - (self) -
-No docs
-- - - erpnext.hr.doctype.attendance.attendance.add_attendance - (events, start, end, conditions=None) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.attendance.attendance.get_events
-
- - - erpnext.hr.doctype.attendance.attendance.get_events - (start, end, filters=None) -
-No docs
-Table Name: tabAttendance Request
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 3 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 4 | -from_date |
- - Date | -- From Date - - | -- |
| 5 | -to_date |
- - Date | -- To Date - - | -- |
| 6 | -half_day |
- - Check | -- Half Day - - | -- |
| 7 | -half_day_date |
- - Date | -- Half Day Date - - | -- |
| 8 | -column_break_4 |
- - Column Break | -- - - | -- |
| 9 | -explanation |
- - Small Text | -- Explanation - - | -- |
| 10 | -reason |
- - Select | -- Reason - - | -
- Work From Home -On Duty- |
-
| 11 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 12 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Attendance Request - - - - | -
Inherits from frappe.model.document.Document - -
- - - create_attendance - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_if_attendance_not_applicable - (self, attendance_date) -
-No docs
-Table Name: tabBranch
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -branch |
- - Data | -- Branch - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabCompensatory Leave Request
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 3 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 4 | -work_from_date |
- - Date | -- Work From Date - - | -- |
| 5 | -work_end_date |
- - Date | -- Work End Date - - | -- |
| 6 | -column_break_4 |
- - Column Break | -- - - | -- |
| 7 | -leave_type |
- - Link | -- Leave Type - - | -- - - - -Leave Type - - - - | -
| 8 | -reason |
- - Small Text | -- Reason - - | -- |
| 9 | -leave_allocation |
- - Link | -- Leave Allocation - - | -- - - - -Leave Allocation - - - - | -
| 10 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Compensatory Leave Request - - - - | -
Inherits from frappe.model.document.Document - -
- - - create_leave_allocation - (self, leave_period, date_difference) -
-No docs
-- - - exists_allocation_for_period - (self, leave_period) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabDaily Work Summary
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -daily_work_summary_group |
- - Link | -- Daily Work Summary Group - - | -- - - - -Daily Work Summary Group - - - - | -
| 2 | -status |
- - Select | -- Status - - | -
- Open -Sent- |
-
| 3 | -email_sent_to |
- - Code | -- Email Sent To - - | -- |
Inherits from frappe.model.document.Document - -
- - - get_message_details - (self) -
-Return args for template
-- - - send_mails - (self, dws_group, emails) -
-Send emails to get daily work summary to all users in selected daily work summary group
-- - - send_summary - (self) -
-Send summary of all replies. Called at midnight
-- - - erpnext.hr.doctype.daily_work_summary.daily_work_summary.get_user_emails_from_group - (group) -
-Returns list of email of enabled users from the given group
- -Parameters:
- -group - Daily Work Summary Group nameTable Name: tabDaily Work Summary Group
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -enabled |
- - Check | -- Enabled - - | -- |
| 2 | -select_users |
- - Section Break | -- Select Users - - | -- |
| 3 | -users |
- - Table | -- Users - - | -- - - - -Daily Work Summary Group User - - - - | -
| 4 | -send_emails_at |
- - Select | -- Send Emails At - - | -
- 00:00 -01:00 -02:00 -03:00 -04:00 -05:00 -06:00 -07:00 -08:00 -09:00 -10:00 -11:00 -12:00 -13:00 -14:00 -15:00 -16:00 -17:00 -18:00 -19:00 -20:00 -21:00 -22:00 -23:00- |
-
| 5 | -holiday_list |
- - Link | -- Holiday List - - | -- - - - -Holiday List - - - - | -
| 6 | -mail_details |
- - Section Break | -- Reminder - - | -- |
| 7 | -subject |
- - Data | -- Subject - - | -- |
| 8 | -message |
- - Text Editor | -- Message - - | -- |
Inherits from frappe.model.document.Document - -
- - - erpnext.hr.doctype.daily_work_summary_group.daily_work_summary_group.is_current_hour - (hour) -
-No docs
-- - - erpnext.hr.doctype.daily_work_summary_group.daily_work_summary_group.is_holiday_today - (holiday_list) -
-No docs
-- - - erpnext.hr.doctype.daily_work_summary_group.daily_work_summary_group.is_incoming_account_enabled - () -
-No docs
-- - - erpnext.hr.doctype.daily_work_summary_group.daily_work_summary_group.send_summary - () -
-Send summary to everyone
-- - - erpnext.hr.doctype.daily_work_summary_group.daily_work_summary_group.trigger_emails - () -
-Send emails to Employees at the given hour asking - them what did they work on today
-Table Name: tabDaily Work Summary Group User
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -user |
- - Link | -- User - - | -- - - - -User - - - - | -
| 2 | -email |
- - Read Only | -- email - - | -- |
Table Name: tabDepartment
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -department_name |
- - Data | -- Department - - | -- |
| 2 | -parent_department |
- - Link | -- Parent Department - - | -- - - - -Department - - - - | -
| 3 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 4 | -is_group |
- - Check | -- Is Group - - | -- |
| 5 | -section_break_4 |
- - Section Break | -- - - | -- |
| 6 | -leave_block_list |
- - Link | -
- Leave Block List
- - Days for which Holidays are blocked for this department. - |
- - - - - -Leave Block List - - - - | -
| 7 | -leave_section |
- - Section Break | -- Leave Approvers - - | -- |
| 8 | -leave_approvers |
- - Table | -
- Leave Approver
- - The first Leave Approver in the list will be set as the default Leave Approver. - |
- - - - - -Department Approver - - - - | -
| 9 | -expense_section |
- - Section Break | -- Expense Approvers - - | -- |
| 10 | -expense_approvers |
- - Table | -
- Expense Approver
- - The first Expense Approver in the list will be set as the default Expense Approver. - |
- - - - - -Department Approver - - - - | -
| 11 | -lft |
- - Int | -- lft - - | -- |
| 12 | -rgt |
- - Int | -- rgt - - | -- |
| 13 | -old_parent |
- - Data | -- Old Parent - - | -- |
Inherits from frappe.utils.nestedset.NestedSet - -
- - - autoname - (self) -
-No docs
-- - - before_rename - (self, old, new, merge=False) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.department.department.add_node
-
- - - erpnext.hr.doctype.department.department.add_node - () -
-No docs
-- - - erpnext.hr.doctype.department.department.get_abbreviated_name - (name, company) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.department.department.get_children
-
- - - erpnext.hr.doctype.department.department.get_children - (doctype, parent=None, company=None, is_root=False) -
-No docs
-- - - erpnext.hr.doctype.department.department.on_doctype_update - () -
-No docs
-Table Name: tabDepartment Approver
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -approver |
- - Link | -- Approver - - | -- - - - -User - - - - | -
Table Name: tabDesignation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -designation_name |
- - Data | -- Designation - - | -- |
| 2 | -description |
- - Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabDriver
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- DRIVER-.#####- |
-
| 2 | -full_name |
- - Data | -- Full Name - - | -- |
| 3 | -status |
- - Select | -- Status - - | -
- Active -Suspended -Left- |
-
| 4 | -column_break_2 |
- - Column Break | -- - - | -- |
| 5 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 6 | -cell_number |
- - Data | -- Cellphone Number - - | -- |
| 7 | -license_details |
- - Section Break | -- License Details - - | -- |
| 8 | -license_number |
- - Data | -- License Number - - | -- |
| 9 | -column_break_8 |
- - Column Break | -- - - | -- |
| 10 | -issuing_date |
- - Date | -- Issuing Date - - | -- |
| 11 | -column_break_10 |
- - Column Break | -- - - | -- |
| 12 | -expiry_date |
- - Date | -- Expiry Date - - | -- |
| 13 | -driving_license_categories |
- - Section Break | -- Driving License Categories - - | -- |
| 14 | -driving_license_category |
- - Table | -- Driving License Category - - | -- - - - -Driving License Category - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabDriving License Category
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -class |
- - Data | -- Class - - | -- |
| 2 | -description |
- - Data | -- Description - - | -- |
| 3 | -issuing_date |
- - Date | -- Issuing Date - - | -- |
| 4 | -expiry_date |
- - Date | -- Expiry Date - - | -- |
Table Name: tabEmployee
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -basic_information |
- - Section Break | -- - - | -- |
| 2 | -employee |
- - Data | -- Employee - - | -- |
| 3 | -naming_series |
- - Select | -- Series - - | -
- EMP/- |
-
| 4 | -salutation |
- - Link | -- Salutation - - | -- - - - -Salutation - - - - | -
| 5 | -employee_name |
- - Data | -- Full Name - - | -- |
| 6 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 7 | -user_id |
- - Link | -
- User ID
- - System User (login) ID. If set, it will become default for all HR forms. - |
- - - - - -User - - - - | -
| 8 | -create_user_permission |
- - Check | -
- Create User Permission
- - This will restrict user access to other employee records - |
- - |
| 9 | -create_user |
- - Button | -- Create User - - | -- |
| 10 | -image |
- - Attach Image | -- Image - - | -- |
| 11 | -column_break1 |
- - Column Break | -- - - | -- |
| 12 | -employee_number |
- - Data | -- Employee Number - - | -- |
| 13 | -job_applicant |
- - Link | -- Job Applicant - - | -- - - - -Job Applicant - - - - | -
| 14 | -date_of_joining |
- - Date | -- Date of Joining - - | -- |
| 15 | -date_of_birth |
- - Date | -
- Date of Birth
- - You can enter any date manually - |
- - |
| 16 | -gender |
- - Link | -- Gender - - | -- - - - -Gender - - - - | -
| 17 | -employment_details |
- - Section Break | -- Employment Details - - | -- |
| 18 | -status |
- - Select | -- Status - - | -
- -Active -Temporary Leave -Left- |
-
| 19 | -employment_type |
- - Link | -- Employment Type - - | -- - - - -Employment Type - - - - | -
| 20 | -holiday_list |
- - Link | -
- Holiday List
- - Applicable Holiday List - |
- - - - - -Holiday List - - - - | -
| 21 | -health_insurance_provider |
- - Link | -- Health Insurance Provider - - | -- - - - -Employee Health Insurance - - - - | -
| 22 | -health_insurance_no |
- - Data | -- Health Insurance No - - | -- |
| 23 | -col_break_22 |
- - Column Break | -- - - | -- |
| 24 | -scheduled_confirmation_date |
- - Date | -- Offer Date - - | -- |
| 25 | -final_confirmation_date |
- - Date | -- Confirmation Date - - | -- |
| 26 | -contract_end_date |
- - Date | -- Contract End Date - - | -- |
| 27 | -date_of_retirement |
- - Date | -- Date Of Retirement - - | -- |
| 28 | -job_profile |
- - Section Break | -- Job Profile - - | -- |
| 29 | -branch |
- - Link | -- Branch - - | -- - - - -Branch - - - - | -
| 30 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 31 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 32 | -grade |
- - Link | -- Grade - - | -- - - - -Employee Grade - - - - | -
| 33 | -notice_number_of_days |
- - Int | -- Notice (days) - - | -- |
| 34 | -salary_information |
- - Column Break | -- Salary Information - - | -- |
| 35 | -salary_mode |
- - Select | -- Salary Mode - - | -
- -Bank -Cash -Cheque- |
-
| 36 | -bank_name |
- - Data | -- Bank Name - - | -- |
| 37 | -bank_ac_no |
- - Data | -- Bank A/C No. - - | -- |
| 38 | -organization_profile |
- - Section Break | -- Organization Profile - - | -- |
| 39 | -reports_to |
- - Link | -- Reports to - - | -- - - - -Employee - - - - | -
| 40 | -leave_policy |
- - Link | -- Leave Policy - - | -- - - - -Leave Policy - - - - | -
| 41 | -contact_details |
- - Section Break | -- Contact Details - - | -- |
| 42 | -cell_number |
- - Data | -- Cell Number - - | -- |
| 43 | -prefered_contact_email |
- - Select | -- Prefered Contact Email - - | -
- -Company Email -Personal Email -User ID- |
-
| 44 | -prefered_email |
- - Data | -- Prefered Email - - | -
- |
-
| 45 | -company_email |
- - Data | -
- Company Email
- - Provide Email Address registered in company - |
-
- |
-
| 46 | -personal_email |
- - Data | -- Personal Email - - | -
- |
-
| 47 | -unsubscribed |
- - Check | -- Unsubscribed - - | -- |
| 48 | -person_to_be_contacted |
- - Data | -- Emergency Contact - - | -- |
| 49 | -relation |
- - Data | -- Relation - - | -- |
| 50 | -emergency_phone_number |
- - Data | -- Emergency Phone - - | -- |
| 51 | -column_break4 |
- - Column Break | -- - - | -- |
| 52 | -permanent_accommodation_type |
- - Select | -- Permanent Address Is - - | -
- -Rented -Owned- |
-
| 53 | -permanent_address |
- - Small Text | -- Permanent Address - - | -- |
| 54 | -current_accommodation_type |
- - Select | -- Current Address Is - - | -
- -Rented -Owned- |
-
| 55 | -current_address |
- - Small Text | -- Current Address - - | -- |
| 56 | -sb53 |
- - Section Break | -- - - | -- |
| 57 | -bio |
- - Text Editor | -
- Bio
- - Short biography for website and other publications. - |
- - |
| 58 | -personal_details |
- - Section Break | -- Personal Details - - | -- |
| 59 | -passport_number |
- - Data | -- Passport Number - - | -- |
| 60 | -date_of_issue |
- - Date | -- Date of Issue - - | -- |
| 61 | -valid_upto |
- - Date | -- Valid Upto - - | -- |
| 62 | -place_of_issue |
- - Data | -- Place of Issue - - | -- |
| 63 | -column_break6 |
- - Column Break | -- - - | -- |
| 64 | -marital_status |
- - Select | -- Marital Status - - | -
- -Single -Married -Divorced -Widowed- |
-
| 65 | -blood_group |
- - Select | -- Blood Group - - | -
- -A+ -A- -B+ -B- -AB+ -AB- -O+ -O-- |
-
| 66 | -family_background |
- - Small Text | -
- Family Background
- - Here you can maintain family details like name and occupation of parent, spouse and children - |
- - |
| 67 | -health_details |
- - Small Text | -
- Health Details
- - Here you can maintain height, weight, allergies, medical concerns etc - |
- - |
| 68 | -educational_qualification |
- - Section Break | -- Educational Qualification - - | -- |
| 69 | -education |
- - Table | -- Education - - | -- - - - -Employee Education - - - - | -
| 70 | -previous_work_experience |
- - Section Break | -- Previous Work Experience - - | -
- Simple- |
-
| 71 | -external_work_history |
- - Table | -- External Work History - - | -- - - - -Employee External Work History - - - - | -
| 72 | -history_in_company |
- - Section Break | -- History In Company - - | -
- Simple- |
-
| 73 | -internal_work_history |
- - Table | -- Internal Work History - - | -- - - - -Employee Internal Work History - - - - | -
| 74 | -exit |
- - Section Break | -- Exit - - | -- |
| 75 | -resignation_letter_date |
- - Date | -- Resignation Letter Date - - | -- |
| 76 | -relieving_date |
- - Date | -- Relieving Date - - | -- |
| 77 | -reason_for_leaving |
- - Data | -- Reason for Leaving - - | -- |
| 78 | -leave_encashed |
- - Select | -- Leave Encashed? - - | -
- -Yes -No- |
-
| 79 | -encashment_date |
- - Date | -- Encashment Date - - | -- |
| 80 | -exit_interview_details |
- - Column Break | -- Exit Interview Details - - | -- |
| 81 | -held_on |
- - Date | -- Held On - - | -- |
| 82 | -reason_for_resignation |
- - Select | -- Reason for Resignation - - | -
- -Better Prospects -Health Concerns- |
-
| 83 | -new_workplace |
- - Data | -- New Workplace - - | -- |
| 84 | -feedback |
- - Small Text | -- Feedback - - | -- |
| 85 | -lft |
- - Int | -- lft - - | -- |
| 86 | -rgt |
- - Int | -- rgt - - | -- |
| 87 | -old_parent |
- - Data | -- Old Parent - - | -- |
Inherits from frappe.utils.nestedset.NestedSet - -
- - - autoname - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - update_nsm_model - (self) -
-No docs
-- - - update_user - (self) -
-No docs
-- - - update_user_permissions - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_date - (self) -
-No docs
-- - - validate_duplicate_user_id - (self) -
-No docs
-- - - validate_email - (self) -
-No docs
-- - - validate_for_enabled_user_id - (self) -
-No docs
-- - - validate_onboarding_process - (self) -
-No docs
-- - - validate_preferred_email - (self) -
-No docs
-- - - validate_reports_to - (self) -
-No docs
-- - - validate_status - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Public API
- /api/method/erpnext.hr.doctype.employee.employee.create_user
-
- - - erpnext.hr.doctype.employee.employee.create_user - (employee, user=None, email=None) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.employee.employee.deactivate_sales_person
-
- - - erpnext.hr.doctype.employee.employee.deactivate_sales_person - (status=None, employee=None) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.employee.employee.get_children
-
- - - erpnext.hr.doctype.employee.employee.get_children - (doctype, parent=None, company=None, is_root=False, is_tree=False) -
-No docs
-- - - erpnext.hr.doctype.employee.employee.get_employee_emails - (employee_list) -
-Returns list of employee emails either based on userid or companyemail
-- - - erpnext.hr.doctype.employee.employee.get_employees_who_are_born_today - () -
-Get Employee properties whose birthday is today.
-- - - erpnext.hr.doctype.employee.employee.get_holiday_list_for_employee - (employee, raise_exception=True) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.employee.employee.get_retirement_date
-
- - - erpnext.hr.doctype.employee.employee.get_retirement_date - (date_of_birth=None) -
-No docs
-- - - erpnext.hr.doctype.employee.employee.get_timeline_data - (doctype, name) -
-Return timeline for attendance
-- - - erpnext.hr.doctype.employee.employee.has_user_permission_for_employee - (user_name, employee_name) -
-No docs
-- - - erpnext.hr.doctype.employee.employee.is_holiday - (employee, date=None) -
-Returns True if given Employee has an holiday on the given date
- -Parameters:
- -employee - Employee namedate - Date to check. Will check for today if None- - - erpnext.hr.doctype.employee.employee.on_doctype_update - () -
-No docs
-- - - erpnext.hr.doctype.employee.employee.send_birthday_reminders - () -
-Send Employee birthday reminders if no 'Stop Birthday Reminders' is not set.
-- - - erpnext.hr.doctype.employee.employee.update_user_permissions - (doc, method) -
-No docs
-- - - erpnext.hr.doctype.employee.employee.validate_employee_role - (doc, method) -
-No docs
-Table Name: tabEmployee Advance
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- EA-- |
-
| 2 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 3 | -employee_name |
- - Read Only | -- Employee Name - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 6 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 7 | -section_break_8 |
- - Section Break | -- - - | -- |
| 8 | -purpose |
- - Small Text | -- Purpose - - | -- |
| 9 | -column_break_11 |
- - Column Break | -- - - | -- |
| 10 | -advance_amount |
- - Currency | -- Advance Amount - - | -
- Company:company:default_currency- |
-
| 11 | -paid_amount |
- - Currency | -- Paid Amount - - | -
- Company:company:default_currency- |
-
| 12 | -due_advance_amount |
- - Currency | -- Due Advance Amount - - | -
- Company:company:default_currency- |
-
| 13 | -claimed_amount |
- - Currency | -- Claimed Amount - - | -
- Company:company:default_currency- |
-
| 14 | -section_break_7 |
- - Section Break | -- - - | -- |
| 15 | -status |
- - Select | -- Status - - | -
- Draft -Paid -Unpaid -Claimed -Cancelled- |
-
| 16 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 17 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Employee Advance - - - - | -
| 18 | -column_break_18 |
- - Column Break | -- - - | -- |
| 19 | -advance_account |
- - Link | -- Advance Account - - | -- - - - -Account - - - - | -
| 20 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
Inherits from frappe.model.document.Document - -
- - - on_cancel - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - set_status - (self) -
-No docs
-- - - set_total_advance_paid - (self) -
-No docs
-- - - update_claimed_amount - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Public API
- /api/method/erpnext.hr.doctype.employee_advance.employee_advance.get_due_advance_amount
-
- - - erpnext.hr.doctype.employee_advance.employee_advance.get_due_advance_amount - (employee, posting_date) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.employee_advance.employee_advance.make_bank_entry
-
- - - erpnext.hr.doctype.employee_advance.employee_advance.make_bank_entry - (dt, dn) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -date |
- - Date | -- Date - - | -- |
| 2 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -branch |
- - Link | -- Branch - - | -- - - - -Branch - - - - | -
| 5 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 6 | -unmarked_attendance_section |
- - Section Break | -- Unmarked Attendance - - | -- |
| 7 | -employees_html |
- - HTML | -- Employees HTML - - | -- |
| 8 | -marked_attendance_section |
- - Section Break | -- Marked Attendance - - | -- |
| 9 | -marked_attendance_html |
- - HTML | -- Marked Attendance HTML - - | -- |
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.hr.doctype.employee_attendance_tool.employee_attendance_tool.get_employees
-
- - - erpnext.hr.doctype.employee_attendance_tool.employee_attendance_tool.get_employees - (date, department=None, branch=None, company=None) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.employee_attendance_tool.employee_attendance_tool.mark_employee_attendance
-
- - - erpnext.hr.doctype.employee_attendance_tool.employee_attendance_tool.mark_employee_attendance - (employee_list, status, date, leave_type=None, company=None) -
-No docs
-Table Name: tabEmployee Benefit Application
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 3 | -max_benefits |
- - Currency | -- Max Benefits (Yearly) - - | -- |
| 4 | -remainig_benefits |
- - Currency | -- Remainig Benefits (Yearly) - - | -- |
| 5 | -column_break_2 |
- - Column Break | -- - - | -- |
| 6 | -date |
- - Date | -- Date - - | -- |
| 7 | -payroll_period |
- - Link | -- Payroll Period - - | -- - - - -Payroll Period - - - - | -
| 8 | -pro_rata_dispensed_amount |
- - Currency | -- Pro Rata Dispensed Amount - - | -- |
| 9 | -total_amount |
- - Currency | -- Total Amount - - | -- |
| 10 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 11 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Employee Benefit Application - - - - | -
| 12 | -section_break_4 |
- - Section Break | -- - - | -- |
| 13 | -employee_benefits |
- - Table | -- Employee Benefits - - | -- - - - -Employee Benefit Application Detail - - - - | -
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_duplicate_on_payroll_period - (self) -
-No docs
-- - - validate_max_benefit - (self, earning_component_name) -
-No docs
-- - - validate_max_benefit_for_component - (self) -
-No docs
-- - - validate_remaining_benefit_amount - (self) -
-No docs
-- - - erpnext.hr.doctype.employee_benefit_application.employee_benefit_application.calculate_lwp - (employee, start_date, holidays, working_days) -
-No docs
-- - - erpnext.hr.doctype.employee_benefit_application.employee_benefit_application.get_amount - (payroll_period_days, amount, payment_days) -
-No docs
-- - - erpnext.hr.doctype.employee_benefit_application.employee_benefit_application.get_benefit_amount - (application, struct_row, payroll_period_days, payment_days) -
-No docs
-- - - erpnext.hr.doctype.employee_benefit_application.employee_benefit_application.get_benefit_component_amount - (employee, start_date, end_date, struct_row, sal_struct, payment_days, working_days) -
-No docs
-- - - erpnext.hr.doctype.employee_benefit_application.employee_benefit_application.get_benefit_pro_rata_ratio_amount - (sal_struct, component_max) -
-No docs
-- - - erpnext.hr.doctype.employee_benefit_application.employee_benefit_application.get_earning_components - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.employee_benefit_application.employee_benefit_application.get_max_benefits
-
- - - erpnext.hr.doctype.employee_benefit_application.employee_benefit_application.get_max_benefits - (employee, on_date) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.employee_benefit_application.employee_benefit_application.get_max_benefits_remaining
-
- - - erpnext.hr.doctype.employee_benefit_application.employee_benefit_application.get_max_benefits_remaining - (employee, on_date, payroll_period) -
-No docs
-Table Name: tabEmployee Benefit Application Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -earning_component |
- - Link | -- Earning Component - - | -- - - - -Salary Component - - - - | -
| 2 | -is_pro_rata_applicable |
- - Check | -- Is Pro-rata Applicable - - | -- |
| 3 | -max_benefit_amount |
- - Currency | -- Max Benefit Amount - - | -- |
| 4 | -amount |
- - Currency | -- Amount - - | -- |
Table Name: tabEmployee Benefit Claim
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 3 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 4 | -claim_date |
- - Date | -- Claim Date - - | -- |
| 5 | -column_break_3 |
- - Column Break | -- - - | -- |
| 6 | -earning_component |
- - Link | -- Earning Component - - | -- - - - -Salary Component - - - - | -
| 7 | -max_amount_eligible |
- - Currency | -- Max Amount Eligible - - | -- |
| 8 | -is_pro_rata_applicable |
- - Check | -- Is Pro-Rata Applicable - - | -- |
| 9 | -claimed_amount |
- - Currency | -- Claimed Amount - - | -- |
| 10 | -salary_slip |
- - Link | -- Salary Slip - - | -- - - - -Salary Slip - - - - | -
| 11 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Employee Benefit Claim - - - - | -
| 12 | -section_break_9 |
- - Section Break | -- - - | -- |
| 13 | -attachments |
- - Attach | -- Attachments - - | -- |
Inherits from frappe.model.document.Document - -
- - - get_benefit_pro_rata_ratio_amount - (self) -
-No docs
-- - - get_previous_claimed_amount - (self, payroll_period, non_pro_rata=False, component=False) -
-No docs
-- - - get_pro_rata_amount_in_application - (self, payroll_period) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_benefit_claim_amount - (self, max_benefits, payroll_period) -
-No docs
-- - - validate_max_benefit_for_component - (self, payroll_period) -
-No docs
-- - - validate_max_benefit_for_sal_struct - (self, max_benefits) -
-No docs
-- - - validate_non_pro_rata_benefit_claim - (self, max_benefits, payroll_period) -
-No docs
-- - - erpnext.hr.doctype.employee_benefit_claim.employee_benefit_claim.get_benefit_claim_amount - (employee, start_date, end_date, struct_row) -
-No docs
-Table Name: tabEmployee Boarding Activity
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -activity_name |
- - Data | -- Activity Name - - | -- |
| 2 | -user |
- - Link | -- User - - | -- - - - -User - - - - | -
| 3 | -role |
- - Link | -- Role - - | -- - - - -Role - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -task |
- - Link | -- Task - - | -- - - - -Task - - - - | -
| 6 | -required_for_employee_creation |
- - Check | -
- Required for Employee Creation
- - Applicable in the case of Employee Onboarding - |
- - |
| 7 | -section_break_6 |
- - Section Break | -- - - | -- |
| 8 | -description |
- - Text Editor | -- Description - - | -- |
Table Name: tabEmployee Education
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -school_univ |
- - Small Text | -- School/University - - | -- |
| 2 | -qualification |
- - Data | -- Qualification - - | -- |
| 3 | -level |
- - Select | -- Level - - | -
- Graduate -Post Graduate -Under Graduate- |
-
| 4 | -year_of_passing |
- - Int | -- Year of Passing - - | -- |
| 5 | -class_per |
- - Data | -- Class / Percentage - - | -- |
| 6 | -maj_opt_subj |
- - Text | -- Major/Optional Subjects - - | -- |
Table Name: tabEmployee External Work History
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company_name |
- - Data | -- Company - - | -- |
| 2 | -designation |
- - Data | -- Designation - - | -- |
| 3 | -salary |
- - Currency | -- Salary - - | -
- Company:company:default_currency- |
-
| 4 | -address |
- - Small Text | -- Address - - | -- |
| 5 | -contact |
- - Data | -- Contact - - | -- |
| 6 | -total_experience |
- - Data | -- Total Experience - - | -- |
Table Name: tabEmployee Grade
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -default_leave_policy |
- - Link | -- Default Leave Policy - - | -- - - - -Leave Policy - - - - | -
| 2 | -default_salary_structure |
- - Link | -- Default Salary Structure - - | -- - - - -Salary Structure - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabEmployee Health Insurance
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -health_insurance_name |
- - Data | -- Health Insurance Name - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabEmployee Incentive
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -incentive_amount |
- - Currency | -- Incentive Amount - - | -- |
| 3 | -payroll_date |
- - Date | -- Payroll Date - - | -- |
| 4 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Employee Incentive - - - - | -
| 5 | -column_break_5 |
- - Column Break | -- - - | -- |
| 6 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 7 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabEmployee Internal Work History
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -branch |
- - Link | -- Branch - - | -- - - - -Branch - - - - | -
| 2 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 3 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 4 | -from_date |
- - Date | -- From Date - - | -- |
| 5 | -to_date |
- - Date | -- To Date - - | -- |
Table Name: tabEmployee Onboarding
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -job_applicant |
- - Link | -- Job Applicant - - | -- - - - -Job Applicant - - - - | -
| 2 | -job_offer |
- - Link | -- Job Offer - - | -- - - - -Job Offer - - - - | -
| 3 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 4 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 5 | -date_of_joining |
- - Date | -- Date of Joining - - | -- |
| 6 | -boarding_status |
- - Select | -- Status - - | -
- -Pending -In Process -Completed- |
-
| 7 | -column_break_7 |
- - Column Break | -- - - | -- |
| 8 | -employee_onboarding_template |
- - Link | -- Employee Onboarding Template - - | -- - - - -Employee Onboarding Template - - - - | -
| 9 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 10 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 11 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 12 | -employee_grade |
- - Link | -- Employee Grade - - | -- - - - -Employee Grade - - - - | -
| 13 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 14 | -table_for_activity |
- - Section Break | -- - - | -- |
| 15 | -activities |
- - Table | -- Activities - - | -- - - - -Employee Boarding Activity - - - - | -
| 16 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Employee Onboarding - - - - | -
Inherits from erpnext.hr.utils.EmployeeBoardingController - -
- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_employee_creation - (self) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.employee_onboarding.employee_onboarding.make_employee
-
- - - erpnext.hr.doctype.employee_onboarding.employee_onboarding.make_employee - (source_name, target_doc=None) -
-No docs
-Table Name: tabEmployee Onboarding Activity
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -activity_name |
- - Data | -- Activity Name - - | -- |
| 2 | -user |
- - Link | -- User - - | -- - - - -User - - - - | -
| 3 | -role |
- - Link | -- Role - - | -- - - - -Role - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -completed |
- - Check | -- Completed - - | -- |
| 6 | -required_for_employee_creation |
- - Check | -- Required for Employee Creation - - | -- |
| 7 | -section_break_6 |
- - Section Break | -- - - | -- |
| 8 | -description |
- - Text Editor | -- Description - - | -- |
Table Name: tabEmployee Onboarding Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 3 | -column_break_7 |
- - Column Break | -- - - | -- |
| 4 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 5 | -employee_grade |
- - Link | -- Employee Grade - - | -- - - - -Employee Grade - - - - | -
| 6 | -section_break_7 |
- - Section Break | -- Activities - - | -- |
| 7 | -activities |
- - Table | -- Activities - - | -- - - - -Employee Boarding Activity - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabEmployee Promotion
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 3 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -promotion_date |
- - Date | -- Promotion Date - - | -- |
| 6 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 7 | -details_section |
- - Section Break | -- Employee Promotion Details - - | -- |
| 8 | -promotion_details |
- - Table | -- Employee Promotion Detail - - | -- - - - -Employee Property History - - - - | -
| 9 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Employee Promotion - - - - | -
Inherits from frappe.model.document.Document - -
- - - before_submit - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabEmployee Property History
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -property |
- - Data | -- Property - - | -- |
| 2 | -current |
- - Data | -- Current - - | -- |
| 3 | -new |
- - Data | -- New - - | -- |
| 4 | -fieldname |
- - Data | -- Field Name - - | -- |
Table Name: tabEmployee Separation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 3 | -resignation_letter_date |
- - Date | -- Resignation Letter Date - - | -- |
| 4 | -boarding_status |
- - Select | -- Status - - | -
- -Pending -In Process -Completed- |
-
| 5 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 6 | -column_break_7 |
- - Column Break | -- - - | -- |
| 7 | -employee_separation_template |
- - Link | -- Employee Separation Template - - | -- - - - -Employee Separation Template - - - - | -
| 8 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 9 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 10 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 11 | -employee_grade |
- - Link | -- Employee Grade - - | -- - - - -Employee Grade - - - - | -
| 12 | -table_for_activity |
- - Section Break | -- - - | -- |
| 13 | -activities |
- - Table | -- Activities - - | -- - - - -Employee Boarding Activity - - - - | -
| 14 | -section_break_14 |
- - Section Break | -- - - | -- |
| 15 | -exit_interview |
- - Text Editor | -- Exit Interview Summary - - | -- |
| 16 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Employee Separation - - - - | -
Inherits from erpnext.hr.utils.EmployeeBoardingController - -
- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabEmployee Separation Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 3 | -column_break_7 |
- - Column Break | -- - - | -- |
| 4 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 5 | -employee_grade |
- - Link | -- Employee Grade - - | -- - - - -Employee Grade - - - - | -
| 6 | -section_break_7 |
- - Section Break | -- Activities - - | -- |
| 7 | -activities |
- - Table | -- Activities - - | -- - - - -Employee Boarding Activity - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabEmployee Tax Exemption Category
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -deduction_component |
- - Link | -- Deduction Component - - | -- - - - -Salary Component - - - - | -
| 2 | -max_amount |
- - Currency | -- Max Amount - - | -- |
| 3 | -is_active |
- - Check | -- Is Active - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabEmployee Tax Exemption Declaration
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -payroll_period |
- - Link | -- Payroll Period - - | -- - - - -Payroll Period - - - - | -
| 5 | -total_exemption_amount |
- - Currency | -- Total Exemption Amount - - | -- |
| 6 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 7 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Employee Tax Exemption Declaration - - - - | -
| 8 | -section_break_8 |
- - Section Break | -- - - | -- |
| 9 | -declarations |
- - Table | -- Declarations - - | -- - - - -Employee Tax Exemption Declaration Category - - - - | -
| 10 | -hra_declaration_section |
- - Section Break | -- HRA Declaration - - | -- |
| 11 | -salary_structure_hra |
- - Currency | -- HRA as per Salary Structure - - | -- |
| 12 | -monthly_house_rent |
- - Currency | -- Monthly House Rent - - | -- |
| 13 | -rented_in_metro_city |
- - Check | -- Rented in Metro City - - | -- |
| 14 | -coloum_break_3 |
- - Column Break | -- - - | -- |
| 15 | -annual_hra_exemption |
- - Currency | -- Annual HRA Exemption - - | -- |
| 16 | -monthly_hra_exemption |
- - Currency | -- Monthly HRA Exemption - - | -- |
Inherits from frappe.model.document.Document - -
- - - before_submit - (self) -
-No docs
-- - - calculate_hra_exemption - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabEmployee Tax Exemption Declaration Category
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -exemption_sub_category |
- - Link | -- Exemption Sub Category - - | -- - - - -Employee Tax Exemption Sub Category - - - - | -
| 2 | -exemption_category |
- - Link | -- Exemption Category - - | -- - - - -Employee Tax Exemption Category - - - - | -
| 3 | -amount |
- - Currency | -- Amount - - | -- |
Table Name: tabEmployee Tax Exemption Proof Submission
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -payroll_period |
- - Link | -- Payroll Period - - | -- - - - -Payroll Period - - - - | -
| 5 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 6 | -processed_in_payroll |
- - Check | -- Processed in Payroll - - | -- |
| 7 | -total_amount |
- - Currency | -- Total Exemption Amount - - | -- |
| 8 | -section_break_5 |
- - Section Break | -- - - | -- |
| 9 | -tax_exemption_proofs |
- - Table | -- Tax Exemption Proofs - - | -- - - - -Employee Tax Exemption Proof Submission Detail - - - - | -
| 10 | -section_break_9 |
- - Section Break | -- - - | -- |
| 11 | -house_rent_payment_amount |
- - Currency | -- House Rent Payment Amount - - | -- |
| 12 | -rented_in_metro_city |
- - Check | -- Rented in Metro City - - | -- |
| 13 | -rented_from_date |
- - Date | -- Rented From Date - - | -- |
| 14 | -rented_to_date |
- - Date | -- Rented To Date - - | -- |
| 15 | -column_break_12 |
- - Column Break | -- - - | -- |
| 16 | -monthly_house_rent |
- - Currency | -- Monthly House Rent - - | -- |
| 17 | -monthly_hra_exemption |
- - Currency | -- Monthly Eligible Amount - - | -- |
| 18 | -total_eligible_hra_exemption |
- - Currency | -- Total Eligible HRA Exemption - - | -- |
| 19 | -attachment_section |
- - Section Break | -- - - | -- |
| 20 | -attachments |
- - Attach | -- Attachments - - | -- |
| 21 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Employee Tax Exemption Proof Submission - - - - | -
Inherits from frappe.model.document.Document - -
- - - calculate_hra_exemption - (self) -
-No docs
-- - - calculate_total_exemption - (self) -
-No docs
-- - - get_monthly_hra - (self) -
-No docs
-- - - get_rented_days_factor - (self, rounded=True) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_house_rent_dates - (self) -
-No docs
-Table Name: tabEmployee Tax Exemption Proof Submission Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -exemption_sub_category |
- - Link | -- Exemption Sub Category - - | -- - - - -Employee Tax Exemption Sub Category - - - - | -
| 2 | -exemption_category |
- - Read Only | -- Exemption Category - - | -- |
| 3 | -type_of_proof |
- - Data | -- Type of Proof - - | -- |
| 4 | -amount |
- - Currency | -- Amount - - | -- |
Table Name: tabEmployee Tax Exemption Sub Category
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -exemption_category |
- - Link | -- Tax Exemption Category - - | -- - - - -Employee Tax Exemption Category - - - - | -
| 2 | -max_amount |
- - Currency | -- Max Amount - - | -- |
| 3 | -is_active |
- - Check | -- Is Active - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabEmployee Transfer
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 3 | -transfer_date |
- - Date | -- Transfer Date - - | -- |
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 6 | -new_company |
- - Link | -- New Company - - | -- - - - -Company - - - - | -
| 7 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 8 | -details_section |
- - Section Break | -- Employee Transfer Details - - | -- |
| 9 | -transfer_details |
- - Table | -- Employee Transfer Detail - - | -- - - - -Employee Property History - - - - | -
| 10 | -reallocate_leaves |
- - Check | -- Re-allocate Leaves - - | -- |
| 11 | -create_new_employee_id |
- - Check | -- Create New Employee Id - - | -- |
| 12 | -new_employee_id |
- - Link | -- New Employee ID - - | -- - - - -Employee - - - - | -
| 13 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Employee Transfer - - - - | -
Inherits from frappe.model.document.Document - -
- - - before_submit - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_user_in_details - (self) -
-No docs
-Table Name: tabEmployee Transfer Property
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -property |
- - Data | -- Property - - | -- |
| 2 | -current |
- - Data | -- Current - - | -- |
| 3 | -new |
- - Data | -- New - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabEmployment Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee_type_name |
- - Data | -- Employment Type - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabExpense Claim
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- EXP- |
-
| 2 | -employee |
- - Link | -- From Employee - - | -- - - - -Employee - - - - | -
| 3 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 4 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 5 | -column_break_5 |
- - Column Break | -- - - | -- |
| 6 | -expense_approver |
- - Link | -- Expense Approver - - | -- - - - -User - - - - | -
| 7 | -approval_status |
- - Select | -- Approval Status - - | -
- Draft -Approved -Rejected- |
-
| 8 | -total_claimed_amount |
- - Currency | -- Total Claimed Amount - - | -
- Company:company:default_currency- |
-
| 9 | -total_sanctioned_amount |
- - Currency | -- Total Sanctioned Amount - - | -
- Company:company:default_currency- |
-
| 10 | -is_paid |
- - Check | -- Is Paid - - | -- |
| 11 | -expense_details |
- - Section Break | -- - - | -- |
| 12 | -expenses |
- - Table | -- Expenses - - | -- - - - -Expense Claim Detail - - - - | -
| 13 | -sb1 |
- - Section Break | -- - - | -
- Simple- |
-
| 14 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 15 | -vehicle_log |
- - Link | -- Vehicle Log - - | -- - - - -Vehicle Log - - - - | -
| 16 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 17 | -task |
- - Link | -- Task - - | -- - - - -Task - - - - | -
| 18 | -cb1 |
- - Column Break | -- - - | -- |
| 19 | -total_amount_reimbursed |
- - Currency | -- Total Amount Reimbursed - - | -
- Company:company:default_currency- |
-
| 20 | -remark |
- - Small Text | -- Remark - - | -- |
| 21 | -title |
- - Data | -- Title - - | -- |
| 22 | -email_id |
- - Data | -- Employees Email Id - - | -- |
| 23 | -accounting_details |
- - Section Break | -- Accounting Details - - | -- |
| 24 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 25 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
| 26 | -column_break_24 |
- - Column Break | -- - - | -- |
| 27 | -payable_account |
- - Link | -- Payable Account - - | -- - - - -Account - - - - | -
| 28 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 29 | -more_details |
- - Section Break | -- More Details - - | -- |
| 30 | -status |
- - Select | -- Status - - | -
- Draft -Paid -Unpaid -Rejected -Submitted -Cancelled- |
-
| 31 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Expense Claim - - - - | -
| 32 | -advance_payments |
- - Section Break | -- Advance Payments - - | -- |
| 33 | -advances |
- - Table | -- Advances - - | -- - - - -Expense Claim Advance - - - - | -
| 34 | -total_advance_amount |
- - Currency | -- Total Advance Amount - - | -
- Company:company:default_currency- |
-
Inherits from frappe.exceptions.ValidationError - -
Inherits from erpnext.controllers.accounts_controller.AccountsController - -
- - - calculate_total_amount - (self) -
-No docs
-- - - get_gl_entries - (self) -
-No docs
-- - - make_gl_entries - (self, cancel=False) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - set_cost_center - (self) -
-No docs
-- - - set_expense_account - (self) -
-No docs
-- - - set_payable_account - (self) -
-No docs
-- - - set_status - (self) -
-No docs
-- - - update_claimed_amount_in_employee_advance - (self) -
-No docs
-- - - update_task - (self) -
-No docs
-- - - update_task_and_project - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_account_details - (self) -
-No docs
-- - - validate_advances - (self) -
-No docs
-- - - validate_sanctioned_amount - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Public API
- /api/method/erpnext.hr.doctype.expense_claim.expense_claim.get_advances
-
- - - erpnext.hr.doctype.expense_claim.expense_claim.get_advances - (employee, advance_id=None) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.expense_claim.expense_claim.get_expense_claim
-
- - - erpnext.hr.doctype.expense_claim.expense_claim.get_expense_claim - (employee_name, company, employee_advance_name, posting_date, paid_amount, claimed_amount) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.expense_claim.expense_claim.get_expense_claim_account
-
- - - erpnext.hr.doctype.expense_claim.expense_claim.get_expense_claim_account - (expense_claim_type, company) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.expense_claim.expense_claim.make_bank_entry
-
- - - erpnext.hr.doctype.expense_claim.expense_claim.make_bank_entry - (dt, dn) -
-No docs
-- - - erpnext.hr.doctype.expense_claim.expense_claim.update_reimbursed_amount - (doc) -
-No docs
-Table Name: tabExpense Claim Account
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -default_account |
- - Link | -- Default Account - - | -- - - - -Account - - - - | -
Table Name: tabExpense Claim Advance
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee_advance |
- - Link | -- Employee Advance - - | -- - - - -Employee Advance - - - - | -
| 2 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 3 | -advance_paid |
- - Currency | -- Advance Paid - - | -
- Company:company.default_currency- |
-
| 4 | -unclaimed_amount |
- - Currency | -- Unclaimed amount - - | -
- Company:company.default_currency- |
-
| 5 | -allocated_amount |
- - Currency | -- Allocated amount - - | -
- Company:company.default_currency- |
-
| 6 | -advance_account |
- - Link | -- Advance Account - - | -- - - - -Account - - - - | -
Table Name: tabExpense Claim Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -expense_date |
- - Date | -- Expense Date - - | -- |
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -expense_type |
- - Link | -- Expense Claim Type - - | -- - - - -Expense Claim Type - - - - | -
| 4 | -default_account |
- - Link | -- Default Account - - | -- - - - -Account - - - - | -
| 5 | -section_break_4 |
- - Section Break | -- - - | -- |
| 6 | -description |
- - Text Editor | -- Description - - | -- |
| 7 | -section_break_6 |
- - Section Break | -- - - | -- |
| 8 | -claim_amount |
- - Currency | -- Claim Amount - - | -
- Company:company:default_currency- |
-
| 9 | -column_break_8 |
- - Column Break | -- - - | -- |
| 10 | -sanctioned_amount |
- - Currency | -- Sanctioned Amount - - | -
- Company:company:default_currency- |
-
Table Name: tabExpense Claim Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -expense_type |
- - Data | -- Expense Claim Type - - | -- |
| 2 | -description |
- - Small Text | -- Description - - | -- |
| 3 | -accounts |
- - Table | -- Accounts - - | -- - - - -Expense Claim Account - - - - | -
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_accounts - (self) -
-No docs
-- - - validate_repeating_companies - (self) -
-Error when Same Company is entered multiple times in accounts
-Table Name: tabHoliday
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -holiday_date |
- - Date | -- Date - - | -- |
| 2 | -description |
- - Text Editor | -- Description - - | -- |
Table Name: tabHoliday List
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -holiday_list_name |
- - Data | -- Holiday List Name - - | -- |
| 2 | -from_date |
- - Date | -- From Date - - | -- |
| 3 | -to_date |
- - Date | -- To Date - - | -- |
| 4 | -weekly_off |
- - Select | -- Weekly Off - - | -
- -Sunday -Monday -Tuesday -Wednesday -Thursday -Friday -Saturday- |
-
| 5 | -get_weekly_off_dates |
- - Button | -- Get Weekly Off Dates - - | -
- get_weekly_off_dates- |
-
| 6 | -holidays |
- - Table | -- Holidays - - | -- - - - -Holiday - - - - | -
| 7 | -clear_table |
- - Button | -- Clear Table - - | -
- clear_table- |
-
| 8 | -section_break_9 |
- - Section Break | -- - - | -- |
| 9 | -color |
- - Color | -- Color - - | -- |
Inherits from frappe.model.document.Document - -
- - - clear_table - (self) -
-No docs
-- - - get_weekly_off_date_list - (self, start_date, end_date) -
-No docs
-- - - get_weekly_off_dates - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_days - (self) -
-No docs
-- - - validate_values - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Public API
- /api/method/erpnext.hr.doctype.holiday_list.holiday_list.get_events
-
- - - erpnext.hr.doctype.holiday_list.holiday_list.get_events - (start, end, filters=None) -
-Returns events for Gantt / Calendar view rendering.
- -Parameters:
- -start - Start date-time.end - End date-time.filters - Filters (JSON).| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee_settings |
- - Section Break | -- Employee Settings - - | -- |
| 2 | -retirement_age |
- - Data | -
- Retirement Age
- - Enter retirement age in years - |
- - |
| 3 | -emp_created_by |
- - Select | -
- Employee Records to be created by
- - Employee record is created using selected field. - |
-
- Naming Series -Employee Number -Full Name- |
-
| 4 | -leave_approval_notification_template |
- - Link | -- Leave Approval Notification Template - - | -- - - - -Email Template - - - - | -
| 5 | -leave_status_notification_template |
- - Link | -- Leave Status Notification Template - - | -- - - - -Email Template - - - - | -
| 6 | -column_break_4 |
- - Column Break | -- - - | -- |
| 7 | -stop_birthday_reminders |
- - Check | -
- Stop Birthday Reminders
- - Don't send Employee Birthday Reminders - |
- - |
| 8 | -maintain_bill_work_hours_same |
- - Check | -- Maintain Billing Hours and Working Hours Same on Timesheet - - | -- |
| 9 | -leave_approver_mandatory_in_leave_application |
- - Check | -- Leave Approver Mandatory In Leave Application - - | -- |
| 10 | -expense_approver_mandatory_in_expense_claim |
- - Check | -- Expense Approver Mandatory In Expense Claim - - | -- |
| 11 | -payroll_settings |
- - Section Break | -- Payroll Settings - - | -- |
| 12 | -include_holidays_in_total_working_days |
- - Check | -
- Include holidays in Total no. of Working Days
- - If checked, Total no. of Working Days will include holidays, and this will reduce the value of Salary Per Day - |
- - |
| 13 | -email_salary_slip_to_employee |
- - Check | -
- Email Salary Slip to Employee
- - Emails salary slip to employee based on preferred email selected in Employee - |
- - |
| 14 | -max_working_hours_against_timesheet |
- - Float | -- Max working hours against Timesheet - - | -- |
| 15 | -leave_settings |
- - Section Break | -- Leave Settings - - | -- |
| 16 | -show_leaves_of_all_department_members_in_calendar |
- - Check | -- Show Leaves Of All Department Members In Calendar - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabIdentification Document Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -identification_document_type |
- - Data | -- Identification Document Type - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabInterest
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -interest |
- - Data | -- Interest - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabJob Applicant
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -applicant_name |
- - Data | -- Applicant Name - - | -- |
| 2 | -email_id |
- - Data | -- Email Address - - | -
- |
-
| 3 | -status |
- - Select | -- Status - - | -
- Open -Replied -Rejected -Hold- |
-
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -job_title |
- - Link | -- Job Opening - - | -- - - - -Job Opening - - - - | -
| 6 | -section_break_6 |
- - Section Break | -- - - | -- |
| 7 | -cover_letter |
- - Text | -- Cover Letter - - | -- |
| 8 | -resume_attachment |
- - Attach | -- Resume Attachment - - | -- |
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - check_email_id_is_unique - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabJob Offer
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -job_applicant |
- - Link | -- Job Applicant - - | -- - - - -Job Applicant - - - - | -
| 2 | -applicant_name |
- - Data | -- Applicant Name - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -status |
- - Select | -- Status - - | -
- Awaiting Response -Accepted -Rejected- |
-
| 5 | -offer_date |
- - Date | -- Offer Date - - | -- |
| 6 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 7 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 8 | -section_break_4 |
- - Section Break | -- - - | -- |
| 9 | -offer_terms |
- - Table | -- Job Offer Terms - - | -- - - - -Job Offer Term - - - - | -
| 10 | -section_break_14 |
- - Section Break | -- - - | -- |
| 11 | -select_terms |
- - Link | -- Select Terms and Conditions - - | -- - - - -Terms and Conditions - - - - | -
| 12 | -terms |
- - Text Editor | -- Terms and Conditions - - | -- |
| 13 | -printing_details |
- - Section Break | -- Printing Details - - | -- |
| 14 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 15 | -column_break_16 |
- - Column Break | -- - - | -- |
| 16 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 17 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Job Offer - - - - | -
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.hr.doctype.job_offer.job_offer.make_employee
-
- - - erpnext.hr.doctype.job_offer.job_offer.make_employee - (source_name, target_doc=None) -
-No docs
-Table Name: tabJob Offer Term
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -offer_term |
- - Link | -- Offer Term - - | -- - - - -Offer Term - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -value |
- - Small Text | -- Value / Description - - | -- |
Table Name: tabJob Opening
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -job_title |
- - Data | -- Job Title - - | -- |
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -status |
- - Select | -- Status - - | -
- Open -Closed- |
-
| 4 | -column_break_5 |
- - Column Break | -- - - | -- |
| 5 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 6 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 7 | -staffing_plan |
- - Link | -- Staffing Plan - - | -- - - - -Staffing Plan - - - - | -
| 8 | -planned_vacancies |
- - Int | -- Planned number of Positions - - | -- |
| 9 | -section_break_6 |
- - Section Break | -- - - | -- |
| 10 | -publish |
- - Check | -- Publish on website - - | -- |
| 11 | -route |
- - Data | -- Route - - | -- |
| 12 | -description |
- - Text Editor | -
- Description
- - Job profile, qualifications required etc. - |
- - |
Inherits from frappe.website.website_generator.WebsiteGenerator - -
- - - get_context - (self, context) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_current_vacancies - (self) -
-No docs
-- - - erpnext.hr.doctype.job_opening.job_opening.get_list_context - (context) -
-No docs
-Table Name: tabLeave Allocation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- LAL/- |
-
| 2 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 3 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 4 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 5 | -column_break1 |
- - Column Break | -- - - | -- |
| 6 | -description |
- - Small Text | -- Description - - | -- |
| 7 | -section_break_6 |
- - Section Break | -- - - | -- |
| 8 | -leave_type |
- - Link | -- Leave Type - - | -- - - - -Leave Type - - - - | -
| 9 | -from_date |
- - Date | -- From Date - - | -- |
| 10 | -to_date |
- - Date | -- To Date - - | -- |
| 11 | -column_break_10 |
- - Column Break | -- - - | -- |
| 12 | -new_leaves_allocated |
- - Float | -- New Leaves Allocated - - | -- |
| 13 | -carry_forward |
- - Check | -- Add unused leaves from previous allocations - - | -- |
| 14 | -carry_forwarded_leaves |
- - Float | -- Unused leaves - - | -- |
| 15 | -total_leaves_allocated |
- - Float | -- Total Leaves Allocated - - | -- |
| 16 | -total_leaves_encashed |
- - Float | -- Total Leaves Encashed - - | -- |
| 17 | -compensatory_request |
- - Link | -- Compensatory Leave Request - - | -- - - - -Compensatory Leave Request - - - - | -
| 18 | -leave_period |
- - Link | -- Leave Period - - | -- - - - -Leave Period - - - - | -
| 19 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Leave Allocation - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - on_update_after_submit - (self) -
-No docs
-- - - set_total_leaves_allocated - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_against_leave_applications - (self) -
-No docs
-- - - validate_allocation_overlap - (self) -
-No docs
-- - - validate_back_dated_allocation - (self) -
-No docs
-- - - validate_leave_allocation_days - (self) -
-No docs
-- - - validate_lwp - (self) -
-No docs
-- - - validate_new_leaves_allocated_value - (self) -
-validate that leave allocation is in multiples of 0.5
-- - - validate_period - (self) -
-No docs
-- - - validate_total_leaves_allocated - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Public API
- /api/method/erpnext.hr.doctype.leave_allocation.leave_allocation.get_carry_forwarded_leaves
-
- - - erpnext.hr.doctype.leave_allocation.leave_allocation.get_carry_forwarded_leaves - (employee, leave_type, date, carry_forward=None) -
-No docs
-- - - erpnext.hr.doctype.leave_allocation.leave_allocation.get_leave_allocation_for_period - (employee, leave_type, from_date, to_date) -
-No docs
-- - - erpnext.hr.doctype.leave_allocation.leave_allocation.validate_carry_forward - (leave_type) -
-No docs
-Table Name: tabLeave Application
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- LAP/- |
-
| 2 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 3 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -leave_type |
- - Link | -- Leave Type - - | -- - - - -Leave Type - - - - | -
| 6 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 7 | -leave_balance |
- - Float | -- Leave Balance Before Application - - | -- |
| 8 | -section_break_5 |
- - Section Break | -- - - | -- |
| 9 | -from_date |
- - Date | -- From Date - - | -- |
| 10 | -to_date |
- - Date | -- To Date - - | -- |
| 11 | -half_day |
- - Check | -- Half Day - - | -- |
| 12 | -half_day_date |
- - Date | -- Half Day Date - - | -- |
| 13 | -total_leave_days |
- - Float | -- Total Leave Days - - | -- |
| 14 | -column_break1 |
- - Column Break | -- - - | -- |
| 15 | -description |
- - Small Text | -- Reason - - | -- |
| 16 | -section_break_7 |
- - Section Break | -- - - | -- |
| 17 | -leave_approver |
- - Link | -- Leave Approver - - | -- - - - -User - - - - | -
| 18 | -leave_approver_name |
- - Data | -- Leave Approver Name - - | -- |
| 19 | -column_break_18 |
- - Column Break | -- - - | -- |
| 20 | -status |
- - Select | -- Status - - | -
- Open -Approved -Rejected -Cancelled- |
-
| 21 | -sb10 |
- - Section Break | -- - - | -- |
| 22 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 23 | -follow_via_email |
- - Check | -- Follow via Email - - | -- |
| 24 | -color |
- - Color | -- Color - - | -- |
| 25 | -column_break_17 |
- - Column Break | -- - - | -- |
| 26 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 27 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 28 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Leave Application - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - get_feed - (self) -
-No docs
-- - - get_total_leaves_on_half_day - (self) -
-No docs
-- - - notify - (self, args) -
-No docs
-- - - notify_employee - (self) -
-No docs
-- - - notify_leave_approver - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - show_block_day_warning - (self) -
-No docs
-- - - throw_overlap_error - (self, d) -
-No docs
-- - - update_attendance - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_applicable_after - (self) -
-No docs
-- - - validate_attendance - (self) -
-No docs
-- - - validate_back_dated_application - (self) -
-No docs
-- - - validate_balance_leaves - (self) -
-No docs
-- - - validate_block_days - (self) -
-No docs
-- - - validate_dates - (self) -
-No docs
-- - - validate_dates_across_allocation - (self) -
-No docs
-- - - validate_leave_overlap - (self) -
-No docs
-- - - validate_max_days - (self) -
-No docs
-- - - validate_optional_leave - (self) -
-No docs
-- - - validate_salary_processed_days - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.hr.doctype.leave_application.leave_application.add_block_dates - (events, start, end, employee, company) -
-No docs
-- - - erpnext.hr.doctype.leave_application.leave_application.add_department_leaves - (events, start, end, employee, company) -
-No docs
-- - - erpnext.hr.doctype.leave_application.leave_application.add_holidays - (events, start, end, employee, company) -
-No docs
-- - - erpnext.hr.doctype.leave_application.leave_application.add_leaves - (events, start, end, match_conditions=None) -
-No docs
-- - - erpnext.hr.doctype.leave_application.leave_application.get_approved_leaves_for_period - (employee, leave_type, from_date, to_date) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.leave_application.leave_application.get_events
-
- - - erpnext.hr.doctype.leave_application.leave_application.get_events - (start, end, filters=None) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.leave_application.leave_application.get_holidays
-
- - - erpnext.hr.doctype.leave_application.leave_application.get_holidays - (employee, from_date, to_date) -
-get holidays between two dates for the given employee
-- - - erpnext.hr.doctype.leave_application.leave_application.get_leave_allocation_records - (date, employee=None) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.leave_application.leave_application.get_leave_approver
-
- - - erpnext.hr.doctype.leave_application.leave_application.get_leave_approver - (employee, department=None) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.leave_application.leave_application.get_leave_balance_on
-
- - - erpnext.hr.doctype.leave_application.leave_application.get_leave_balance_on - (employee, leave_type, date, allocation_records=None, consider_all_leaves_in_the_allocation_period=False, consider_encashed_leaves=True) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.leave_application.leave_application.get_leave_details
-
- - - erpnext.hr.doctype.leave_application.leave_application.get_leave_details - (employee, date) -
-No docs
-- - - erpnext.hr.doctype.leave_application.leave_application.get_leaves_for_period - (employee, leave_type, from_date, to_date, status) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.leave_application.leave_application.get_mandatory_approval
-
- - - erpnext.hr.doctype.leave_application.leave_application.get_mandatory_approval - (doctype) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.leave_application.leave_application.get_number_of_leave_days
-
- - - erpnext.hr.doctype.leave_application.leave_application.get_number_of_leave_days - (employee, leave_type, from_date, to_date, half_day=None, half_day_date=None) -
-No docs
-- - - erpnext.hr.doctype.leave_application.leave_application.is_lwp - (leave_type) -
-No docs
-Table Name: tabLeave Block List
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -leave_block_list_name |
- - Data | -- Leave Block List Name - - | -- |
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -applies_to_all_departments |
- - Check | -
- Applies to Company
- - If not checked, the list will have to be added to each Department where it has to be applied. - |
- - |
| 4 | -block_days |
- - Section Break | -
- Block Days
- - Stop users from making Leave Applications on following days. - |
- - |
| 5 | -leave_block_list_dates |
- - Table | -- Leave Block List Dates - - | -- - - - -Leave Block List Date - - - - | -
| 6 | -allow_list |
- - Section Break | -
- Allow Users
- - Allow the following users to approve Leave Applications for block days. - |
- - |
| 7 | -leave_block_list_allowed |
- - Table | -- Leave Block List Allowed - - | -- - - - -Leave Block List Allow - - - - | -
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.hr.doctype.leave_block_list.leave_block_list.get_applicable_block_dates
-
- - - erpnext.hr.doctype.leave_block_list.leave_block_list.get_applicable_block_dates - (from_date, to_date, employee=None, company=None, all_lists=False) -
-No docs
-- - - erpnext.hr.doctype.leave_block_list.leave_block_list.get_applicable_block_lists - (employee=None, company=None, all_lists=False) -
-No docs
-- - - erpnext.hr.doctype.leave_block_list.leave_block_list.is_user_in_allow_list - (block_list) -
-No docs
-Table Name: tabLeave Block List Allow
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -allow_user |
- - Link | -- Allow User - - | -- - - - -User - - - - | -
Table Name: tabLeave Block List Date
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -block_date |
- - Date | -- Block Date - - | -- |
| 2 | -reason |
- - Text | -- Reason - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -employment_type |
- - Link | -
- Employment Type
- - Leave blank if considered for all employee types - |
- - - - - -Employment Type - - - - | -
| 3 | -branch |
- - Link | -
- Branch
- - Leave blank if considered for all branches - |
- - - - - -Branch - - - - | -
| 4 | -department |
- - Link | -
- Department
- - Leave blank if considered for all departments - |
- - - - - -Department - - - - | -
| 5 | -designation |
- - Link | -
- Designation
- - Leave blank if considered for all designations - |
- - - - - -Designation - - - - | -
| 6 | -employee_grade |
- - Link | -- Employee Grade - - | -- - - - -Employee Grade - - - - | -
| 7 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 8 | -column_break1 |
- - Column Break | -- - - | -- |
| 9 | -from_date |
- - Date | -- From Date - - | -- |
| 10 | -to_date |
- - Date | -- To Date - - | -- |
| 11 | -leave_policy |
- - Link | -- Leave Policy - - | -- - - - -Leave Policy - - - - | -
| 12 | -leave_type |
- - Link | -- Leave Type - - | -- - - - -Leave Type - - - - | -
| 13 | -carry_forward |
- - Check | -
- Carry Forward
- - Please select Carry Forward if you also want to include previous fiscal year's balance leaves to this fiscal year - |
- - |
| 14 | -no_of_days |
- - Float | -- New Leaves Allocated (In Days) - - | -- |
| 15 | -allocate |
- - Button | -- Allocate - - | -
- allocate_leave- |
-
Inherits from frappe.model.document.Document - -
- - - allocate_leave - (self) -
-No docs
-- - - get_employees - (self) -
-No docs
-- - - to_date_validation - (self) -
-No docs
-- - - validate_values - (self) -
-No docs
-Table Name: tabLeave Encashment
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -leave_period |
- - Link | -- Leave Period - - | -- - - - -Leave Period - - - - | -
| 2 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 3 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 4 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 5 | -leave_type |
- - Link | -- Leave Type - - | -- - - - -Leave Type - - - - | -
| 6 | -column_break_4 |
- - Column Break | -- - - | -- |
| 7 | -leave_allocation |
- - Link | -- Leave Allocation - - | -- - - - -Leave Allocation - - - - | -
| 8 | -leave_balance |
- - Float | -- Leave Balance - - | -- |
| 9 | -encashable_days |
- - Float | -- Encashable days - - | -- |
| 10 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Leave Encashment - - - - | -
| 11 | -payroll |
- - Section Break | -- Payroll - - | -- |
| 12 | -encashment_amount |
- - Currency | -- Encashment Amount - - | -- |
| 13 | -encashment_date |
- - Date | -- Encashment Date - - | -- |
| 14 | -additional_salary |
- - Link | -- Additional Salary - - | -- - - - -Additional Salary - - - - | -
Inherits from frappe.model.document.Document - -
- - - before_submit - (self) -
-No docs
-- - - get_leave_allocation - (self) -
-No docs
-- - - get_leave_details_for_encashment - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabLeave Period
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -from_date |
- - Date | -- From Date - - | -- |
| 2 | -to_date |
- - Date | -- To Date - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 5 | -is_active |
- - Check | -- Is Active - - | -- |
| 6 | -optional_holiday_list |
- - Link | -- Holiday List for Optional Leave - - | -- - - - -Holiday List - - - - | -
| 7 | -grant_leaves |
- - Section Break | -- Grant Leaves - - | -- |
| 8 | -filter_by |
- - Column Break | -- Filter By - - | -- |
| 9 | -grade |
- - Link | -- Employee Grade - - | -- - - - -Employee Grade - - - - | -
| 10 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 11 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 12 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 13 | -grant |
- - Button | -- Grant - - | -- |
| 14 | -column_break_12 |
- - Column Break | -- - - | -- |
| 15 | -carry_forward_leaves |
- - Check | -- Carry Forward Leaves - - | -- |
Inherits from frappe.model.document.Document - -
- - - create_leave_allocation - (self, employee, leave_type, new_leaves_allocated) -
-No docs
-- - - get_employees - (self) -
-No docs
-- - - grant_leave_alloc - (self, employee) -
-No docs
-- - - grant_leave_alloc_for_employees - (self) -
-No docs
-- - - grant_leave_allocation - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_allocation_exists - (self, employee) -
-No docs
-- - - validate_dates - (self) -
-No docs
-Table Name: tabLeave Policy
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -leave_policy_details |
- - Table | -- Leave Policy Details - - | -- - - - -Leave Policy Detail - - - - | -
| 2 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Leave Policy - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabLeave Policy Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -leave_type |
- - Link | -- Leave Type - - | -- - - - -Leave Type - - - - | -
| 2 | -annual_allocation |
- - Float | -- Annual Allocation - - | -- |
Table Name: tabLeave Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -leave_type_name |
- - Data | -- Leave Type Name - - | -- |
| 2 | -max_leaves_allowed |
- - Int | -- Max Leaves Allowed - - | -- |
| 3 | -applicable_after |
- - Int | -- Applicable After (Working Days) - - | -- |
| 4 | -max_continuous_days_allowed |
- - Int | -- Maximum Continuous Days Applicable - - | -- |
| 5 | -column_break_3 |
- - Column Break | -- - - | -- |
| 6 | -is_carry_forward |
- - Check | -- Is Carry Forward - - | -- |
| 7 | -is_lwp |
- - Check | -- Is Leave Without Pay - - | -- |
| 8 | -is_optional_leave |
- - Check | -- Is Optional Leave - - | -- |
| 9 | -allow_negative |
- - Check | -- Allow Negative Balance - - | -- |
| 10 | -include_holiday |
- - Check | -- Include holidays within leaves as leaves - - | -- |
| 11 | -is_compensatory |
- - Check | -- Is Compensatory - - | -- |
| 12 | -encashment |
- - Section Break | -- Encashment - - | -- |
| 13 | -allow_encashment |
- - Check | -- Allow Encashment - - | -- |
| 14 | -encashment_threshold_days |
- - Int | -- Encashment Threshold Days - - | -- |
| 15 | -earning_component |
- - Link | -- Earning Component - - | -- - - - -Salary Component - - - - | -
| 16 | -earned_leave |
- - Section Break | -- Earned Leave - - | -- |
| 17 | -is_earned_leave |
- - Check | -- Is Earned Leave - - | -- |
| 18 | -earned_leave_frequency |
- - Select | -- Earned Leave Frequency - - | -
- Monthly -Quarterly -Yearly- |
-
| 19 | -rounding |
- - Select | -- Rounding - - | -
- 0.5 -1.0- |
-
Inherits from frappe.model.document.Document - -
Table Name: tabLoan
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -applicant_type |
- - Select | -- Applicant Type - - | -
- Employee -Member- |
-
| 2 | -applicant |
- - Dynamic Link | -- Applicant - - | -
- applicant_type- |
-
| 3 | -applicant_name |
- - Data | -- Applicant Name - - | -- |
| 4 | -loan_application |
- - Link | -- Loan Application - - | -- - - - -Loan Application - - - - | -
| 5 | -loan_type |
- - Link | -- Loan Type - - | -- - - - -Loan Type - - - - | -
| 6 | -column_break_3 |
- - Column Break | -- - - | -- |
| 7 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 8 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 9 | -status |
- - Select | -- Status - - | -
- Sanctioned -Disbursed -Repaid/Closed- |
-
| 10 | -repay_from_salary |
- - Check | -- Repay from Salary - - | -- |
| 11 | -section_break_8 |
- - Section Break | -- Loan Details - - | -- |
| 12 | -loan_amount |
- - Currency | -- Loan Amount - - | -
- Company:company:default_currency- |
-
| 13 | -rate_of_interest |
- - Percent | -- Rate of Interest (%) / Year - - | -- |
| 14 | -disbursement_date |
- - Date | -- Disbursement Date - - | -- |
| 15 | -repayment_start_date |
- - Date | -- Repayment Start Date - - | -- |
| 16 | -column_break_11 |
- - Column Break | -- - - | -- |
| 17 | -repayment_method |
- - Select | -- Repayment Method - - | -
- -Repay Fixed Amount per Period -Repay Over Number of Periods- |
-
| 18 | -repayment_periods |
- - Int | -- Repayment Period in Months - - | -- |
| 19 | -monthly_repayment_amount |
- - Currency | -- Monthly Repayment Amount - - | -
- Company:company:default_currency- |
-
| 20 | -account_info |
- - Section Break | -- Account Info - - | -- |
| 21 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
| 22 | -payment_account |
- - Link | -- Payment Account - - | -- - - - -Account - - - - | -
| 23 | -column_break_9 |
- - Column Break | -- - - | -- |
| 24 | -loan_account |
- - Link | -- Loan Account - - | -- - - - -Account - - - - | -
| 25 | -interest_income_account |
- - Link | -- Interest Income Account - - | -- - - - -Account - - - - | -
| 26 | -section_break_15 |
- - Section Break | -- Repayment Schedule - - | -- |
| 27 | -repayment_schedule |
- - Table | -- Repayment Schedule - - | -- - - - -Repayment Schedule - - - - | -
| 28 | -section_break_17 |
- - Section Break | -- Totals - - | -- |
| 29 | -total_payment |
- - Currency | -- Total Payment - - | -
- Company:company:default_currency- |
-
| 30 | -column_break_19 |
- - Column Break | -- - - | -- |
| 31 | -total_interest_payable |
- - Currency | -- Total Interest Payable - - | -
- Company:company:default_currency- |
-
| 32 | -total_amount_paid |
- - Currency | -- Total Amount Paid - - | -
- Company:company:default_currency- |
-
| 33 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Loan - - - - | -
Inherits from erpnext.controllers.accounts_controller.AccountsController - -
- - - calculate_totals - (self) -
-No docs
-- - - make_jv_entry - (self) -
-No docs
-- - - make_repayment_schedule - (self) -
-No docs
-- - - set_repayment_period - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.hr.doctype.loan.loan.check_repayment_method - (repayment_method, loan_amount, monthly_repayment_amount, repayment_periods) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.loan.loan.get_loan_application
-
- - - erpnext.hr.doctype.loan.loan.get_loan_application - (loan_application) -
-No docs
-- - - erpnext.hr.doctype.loan.loan.get_monthly_repayment_amount - (repayment_method, loan_amount, rate_of_interest, repayment_periods) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.loan.loan.make_jv_entry
-
- - - erpnext.hr.doctype.loan.loan.make_jv_entry - (loan, company, loan_account, applicant_type, applicant, loan_amount, payment_account=None) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.loan.loan.make_repayment_entry
-
- - - erpnext.hr.doctype.loan.loan.make_repayment_entry - (payment_rows, loan, company, loan_account, applicant_type, applicant, payment_account=None, interest_income_account=None) -
-No docs
-- - - erpnext.hr.doctype.loan.loan.update_disbursement_status - (doc) -
-No docs
-- - - erpnext.hr.doctype.loan.loan.update_total_amount_paid - (doc) -
-No docs
-Table Name: tabLoan Application
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -applicant_type |
- - Select | -- Applicant Type - - | -
- Employee -Member- |
-
| 2 | -applicant |
- - Dynamic Link | -- Applicant - - | -
- applicant_type- |
-
| 3 | -applicant_name |
- - Data | -- Applicant Name - - | -- |
| 4 | -column_break_2 |
- - Column Break | -- - - | -- |
| 5 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 6 | -status |
- - Select | -- Status - - | -
- Open -Approved -Rejected- |
-
| 7 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 8 | -section_break_4 |
- - Section Break | -- Loan Info - - | -- |
| 9 | -loan_type |
- - Link | -- Loan Type - - | -- - - - -Loan Type - - - - | -
| 10 | -loan_amount |
- - Currency | -- Loan Amount - - | -
- Company:company:default_currency- |
-
| 11 | -required_by_date |
- - Date | -- Required by Date - - | -- |
| 12 | -column_break_7 |
- - Column Break | -- - - | -- |
| 13 | -description |
- - Small Text | -- Reason - - | -- |
| 14 | -repayment_info |
- - Section Break | -- Repayment Info - - | -- |
| 15 | -repayment_method |
- - Select | -- Repayment Method - - | -
- -Repay Fixed Amount per Period -Repay Over Number of Periods- |
-
| 16 | -rate_of_interest |
- - Percent | -- Rate of Interest - - | -- |
| 17 | -total_payable_interest |
- - Currency | -- Total Payable Interest - - | -
- Company:company:default_currency- |
-
| 18 | -column_break_11 |
- - Column Break | -- - - | -- |
| 19 | -repayment_amount |
- - Currency | -- Monthly Repayment Amount - - | -
- Company:company:default_currency- |
-
| 20 | -repayment_periods |
- - Int | -- Repayment Period in Months - - | -- |
| 21 | -total_payable_amount |
- - Currency | -- Total Payable Amount - - | -
- Company:company:default_currency- |
-
| 22 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Loan Application - - - - | -
Inherits from frappe.model.document.Document - -
- - - calculate_payable_amount - (self) -
-No docs
-- - - get_repayment_details - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_loan_amount - (self) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.loan_application.loan_application.make_loan
-
- - - erpnext.hr.doctype.loan_application.loan_application.make_loan - (source_name, target_doc=None) -
-No docs
-Table Name: tabLoan Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -loan_name |
- - Data | -- Loan Name - - | -- |
| 2 | -maximum_loan_amount |
- - Currency | -- Maximum Loan Amount - - | -
- Company:company:default_currency- |
-
| 3 | -rate_of_interest |
- - Percent | -- Rate of Interest (%) Yearly - - | -- |
| 4 | -column_break_2 |
- - Column Break | -- - - | -- |
| 5 | -disabled |
- - Check | -- Disabled - - | -- |
| 6 | -description |
- - Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabOffer Term
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -offer_term |
- - Data | -- Offer Term - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabPayroll Employee Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 5 | -designation |
- - Data | -- Designation - - | -- |
Table Name: tabPayroll Entry
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -section_break0 |
- - Section Break | -- Select Employees - - | -- |
| 2 | -column_break0 |
- - Column Break | -- - - | -- |
| 3 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 4 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 5 | -payroll_frequency |
- - Select | -- Payroll Frequency - - | -
- -Monthly -Fortnightly -Bimonthly -Weekly -Daily- |
-
| 6 | -column_break1 |
- - Column Break | -- - - | -- |
| 7 | -branch |
- - Link | -- Branch - - | -- - - - -Branch - - - - | -
| 8 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 9 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 10 | -section_break_8 |
- - Section Break | -- - - | -- |
| 11 | -get_employee_details |
- - Button | -- Get Employee Details - - | -- |
| 12 | -employees |
- - Table | -- Employees - - | -- - - - -Payroll Employee Detail - - - - | -
| 13 | -section_break_12 |
- - Section Break | -- - - | -- |
| 14 | -salary_slip_based_on_timesheet |
- - Check | -- Salary Slip Based on Timesheet - - | -- |
| 15 | -select_payroll_period |
- - Section Break | -- Select Payroll Period - - | -- |
| 16 | -start_date |
- - Date | -- Start Date - - | -- |
| 17 | -end_date |
- - Date | -- End Date - - | -- |
| 18 | -column_break_11 |
- - Column Break | -- - - | -- |
| 19 | -deduct_tax_for_unclaimed_employee_benefits |
- - Check | -- Deduct Tax For Unclaimed Employee Benefits - - | -- |
| 20 | -deduct_tax_for_unsubmitted_tax_exemption_proof |
- - Check | -- Deduct Tax For Unsubmitted Tax Exemption Proof - - | -- |
| 21 | -section_break_16 |
- - Section Break | -- Accounts - - | -- |
| 22 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 23 | -column_break_18 |
- - Column Break | -- - - | -- |
| 24 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 25 | -column_break2 |
- - Column Break | -- - - | -- |
| 26 | -account |
- - Section Break | -- Payment Entry - - | -- |
| 27 | -payment_account |
- - Link | -
- Payment Account
- - Select Payment Account to make Bank Entry - |
- - - - - -Account - - - - | -
| 28 | -section_break2 |
- - Section Break | -- - - | -- |
| 29 | -activity_log |
- - HTML | -- Activity Log - - | -- |
| 30 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Payroll Entry - - - - | -
Inherits from frappe.model.document.Document - -
- - - check_mandatory - (self) -
-No docs
-- - - create_journal_entry - (self, je_payment_amount, user_remark) -
-No docs
-- - - create_salary_slips - (self) -
- Creates salary slip for selected employees if already not created
-
-- - - email_salary_slip - (self, submitted_ss) -
-No docs
-- - - fill_employee_details - (self) -
-No docs
-- - - get_account - (self, component_dict=None) -
-No docs
-- - - get_default_payroll_payable_account - (self) -
-No docs
-- - - get_emp_list - (self) -
- Returns list of active employees based on selected criteria
- and for which salary structure exists
-
-- - - get_filter_condition - (self) -
-No docs
-- - - get_joining_releiving_condition - (self) -
-No docs
-- - - get_loan_details - (self) -
- Get loan details from submitted salary slip based on selected criteria
-
-- - - get_sal_slip_list - (self, ss_status, as_dict=False) -
- Returns list of salary slips based on selected criteria
-
-- - - get_salary_component_account - (self, salary_component) -
-No docs
-- - - get_salary_component_total - (self, component_type=None) -
-No docs
-- - - get_salary_components - (self, component_type) -
-No docs
-- - - make_accrual_jv_entry - (self) -
-No docs
-- - - make_payment_entry - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - set_start_end_dates - (self) -
-No docs
-- - - submit_salary_slips - (self) -
- Submit all salary slips based on selected criteria
-
-- - - update_salary_slip_status - (self, jv_name=None) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.payroll_entry.payroll_entry.create_log
-
- - - erpnext.hr.doctype.payroll_entry.payroll_entry.create_log - (ss_list) -
-No docs
-- - - erpnext.hr.doctype.payroll_entry.payroll_entry.create_submit_log - (submitted_ss, not_submitted_ss, jv_name) -
-No docs
-- - - erpnext.hr.doctype.payroll_entry.payroll_entry.format_as_links - (salary_slip) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.payroll_entry.payroll_entry.get_end_date
-
- - - erpnext.hr.doctype.payroll_entry.payroll_entry.get_end_date - (start_date, frequency) -
-No docs
-- - - erpnext.hr.doctype.payroll_entry.payroll_entry.get_frequency_kwargs - (frequency_name) -
-No docs
-- - - erpnext.hr.doctype.payroll_entry.payroll_entry.get_month_details - (year, month) -
-No docs
-- - - erpnext.hr.doctype.payroll_entry.payroll_entry.get_payroll_entry_bank_entries - (payroll_entry_name) -
-No docs
-- - - erpnext.hr.doctype.payroll_entry.payroll_entry.get_salary_slip_list - (name, docstatus, as_dict=0) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.payroll_entry.payroll_entry.get_start_end_dates
-
- - - erpnext.hr.doctype.payroll_entry.payroll_entry.get_start_end_dates - (payroll_frequency, start_date=None, company=None) -
-Returns dict of start and end dates for given payroll frequency based on start_date
-Public API
- /api/method/erpnext.hr.doctype.payroll_entry.payroll_entry.payroll_entry_has_bank_entries
-
- - - erpnext.hr.doctype.payroll_entry.payroll_entry.payroll_entry_has_bank_entries - (name) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.payroll_entry.payroll_entry.payroll_entry_has_created_slips
-
- - - erpnext.hr.doctype.payroll_entry.payroll_entry.payroll_entry_has_created_slips - (name) -
-No docs
-Table Name: tabPayroll Period
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -start_date |
- - Date | -- Start Date - - | -- |
| 4 | -end_date |
- - Date | -- End Date - - | -- |
| 5 | -section_break_5 |
- - Section Break | -- Payroll Periods - - | -- |
| 6 | -periods |
- - Table | -- Payroll Periods - - | -- - - - -Payroll Period Date - - - - | -
| 7 | -section_break_7 |
- - Section Break | -- Taxable Salary Slabs - - | -- |
| 8 | -taxable_salary_slabs |
- - Table | -- Taxable Salary Slabs - - | -- - - - -Taxable Salary Slab - - - - | -
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_dates - (self) -
-No docs
-- - - validate_overlap - (self) -
-No docs
-- - - erpnext.hr.doctype.payroll_period.payroll_period.get_payroll_period_days - (start_date, end_date, employee) -
-No docs
-Table Name: tabPayroll Period Date
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -start_date |
- - Date | -- Start Date - - | -- |
| 2 | -end_date |
- - Date | -- End Date - - | -- |
Table Name: tabPurpose of Travel
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -purpose_of_travel |
- - Data | -- Purpose of Travel - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabRepayment Schedule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -payment_date |
- - Date | -- Payment Date - - | -- |
| 2 | -principal_amount |
- - Currency | -- Principal Amount - - | -
- Company:company:default_currency- |
-
| 3 | -interest_amount |
- - Currency | -- Interest Amount - - | -
- Company:company:default_currency- |
-
| 4 | -total_payment |
- - Currency | -- Total Payment - - | -
- Company:company:default_currency- |
-
| 5 | -balance_loan_amount |
- - Currency | -- Balance Loan Amount - - | -
- Company:company:default_currency- |
-
| 6 | -paid |
- - Check | -- Paid - - | -- |
Table Name: tabRetention Bonus
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 3 | -bonus_payment_date |
- - Date | -- Bonus Payment Date - - | -- |
| 4 | -bonus_amount |
- - Currency | -- Bonus Amount - - | -- |
| 5 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Retention Bonus - - - - | -
| 6 | -column_break_6 |
- - Column Break | -- - - | -- |
| 7 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 8 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 9 | -date_of_joining |
- - Data | -- Date of Joining - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabSalary Component
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -salary_component |
- - Data | -- Name - - | -- |
| 2 | -salary_component_abbr |
- - Data | -- Abbr - - | -- |
| 3 | -type |
- - Select | -- Type - - | -
- Earning -Deduction- |
-
| 4 | -is_additional_component |
- - Check | -- Is Additional Component - - | -- |
| 5 | -is_tax_applicable |
- - Check | -- Is Tax Applicable - - | -- |
| 6 | -is_payable |
- - Check | -- Is Payable - - | -- |
| 7 | -depends_on_lwp |
- - Check | -- Depends on Leave Without Pay - - | -- |
| 8 | -do_not_include_in_total |
- - Check | -- Do not include in total - - | -- |
| 9 | -column_break_4 |
- - Column Break | -- - - | -- |
| 10 | -disabled |
- - Check | -- Disabled - - | -- |
| 11 | -description |
- - Small Text | -- Description - - | -- |
| 12 | -statistical_component |
- - Check | -
- Statistical Component
- - If selected, the value specified or calculated in this component will not contribute to the earnings or deductions. However, it's value can be referenced by other components that can be added or deducted. - |
- - |
| 13 | -flexible_benefits |
- - Section Break | -- Flexible Benefits - - | -- |
| 14 | -is_flexible_benefit |
- - Check | -- Is Flexible Benefit - - | -- |
| 15 | -max_benefit_amount |
- - Currency | -- Max Benefit Amount (Yearly) - - | -- |
| 16 | -column_break_9 |
- - Column Break | -- - - | -- |
| 17 | -is_pro_rata_applicable |
- - Check | -- Is Pro-rata Applicable - - | -- |
| 18 | -only_tax_impact |
- - Check | -- Only Tax Impact (Cannot Claim But Part of Taxable Income) - - | -- |
| 19 | -create_separate_payment_entry_against_benefit_claim |
- - Check | -- Create Separate Payment Entry Against Benefit Claim - - | -- |
| 20 | -section_break_11 |
- - Section Break | -- - - | -- |
| 21 | -variable_based_on_taxable_salary |
- - Check | -- Variable Based On Taxable Salary - - | -- |
| 22 | -section_break_5 |
- - Section Break | -- Accounts - - | -- |
| 23 | -accounts |
- - Table | -- Accounts - - | -- - - - -Salary Component Account - - - - | -
| 24 | -condition_and_formula |
- - Section Break | -- Condition and Formula - - | -- |
| 25 | -condition |
- - Code | -- Condition - - | -- |
| 26 | -amount_based_on_formula |
- - Check | -- Amount based on formula - - | -- |
| 27 | -formula |
- - Code | -- Formula - - | -- |
| 28 | -amount |
- - Currency | -- Amount - - | -- |
| 29 | -column_break_28 |
- - Column Break | -- - - | -- |
| 30 | -help |
- - HTML | -- Help - - | -- |
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_abbr - (self) -
-No docs
-Table Name: tabSalary Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -salary_component |
- - Link | -- Component - - | -- - - - -Salary Component - - - - | -
| 2 | -abbr |
- - Data | -- Abbr - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -statistical_component |
- - Check | -
- Statistical Component
- - If selected, the value specified or calculated in this component will not contribute to the earnings or deductions. However, it's value can be referenced by other components that can be added or deducted. - |
- - |
| 5 | -is_tax_applicable |
- - Check | -- Is Tax Applicable - - | -- |
| 6 | -is_flexible_benefit |
- - Check | -- Is Flexible Benefit - - | -- |
| 7 | -variable_based_on_taxable_salary |
- - Check | -- Variable Based On Taxable Salary - - | -- |
| 8 | -section_break_2 |
- - Section Break | -- - - | -- |
| 9 | -condition |
- - Code | -- Condition - - | -- |
| 10 | -amount_based_on_formula |
- - Check | -- Amount based on formula - - | -- |
| 11 | -formula |
- - Code | -- Formula - - | -- |
| 12 | -amount |
- - Currency | -- Amount - - | -
- Company:company:default_currency- |
-
| 13 | -depends_on_lwp |
- - Check | -- Depends on Leave Without Pay - - | -- |
| 14 | -do_not_include_in_total |
- - Check | -- Do not include in total - - | -- |
| 15 | -default_amount |
- - Currency | -- Default Amount - - | -
- Company:company:default_currency- |
-
| 16 | -section_break_11 |
- - Column Break | -- - - | -- |
| 17 | -condition_and_formula_help |
- - HTML | -- Condition and Formula Help - - | -- |
Table Name: tabSalary Slip
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 2 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 3 | -employee_name |
- - Read Only | -- Employee Name - - | -- |
| 4 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 5 | -designation |
- - Read Only | -- Designation - - | -- |
| 6 | -branch |
- - Read Only | -- Branch - - | -- |
| 7 | -column_break1 |
- - Column Break | -- - - | -- |
| 8 | -status |
- - Select | -- Status - - | -
- Draft -Submitted -Cancelled- |
-
| 9 | -journal_entry |
- - Link | -- Journal Entry - - | -- - - - -Journal Entry - - - - | -
| 10 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 11 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 12 | -section_break_10 |
- - Section Break | -- - - | -- |
| 13 | -salary_slip_based_on_timesheet |
- - Check | -- Salary Slip Based on Timesheet - - | -- |
| 14 | -start_date |
- - Date | -- Start Date - - | -- |
| 15 | -end_date |
- - Date | -- End Date - - | -- |
| 16 | -column_break_15 |
- - Column Break | -- - - | -- |
| 17 | -salary_structure |
- - Link | -- Salary Structure - - | -- - - - -Salary Structure - - - - | -
| 18 | -payroll_frequency |
- - Select | -- Payroll Frequency - - | -
- -Monthly -Fortnightly -Bimonthly -Weekly -Daily- |
-
| 19 | -total_working_days |
- - Float | -- Working Days - - | -- |
| 20 | -leave_without_pay |
- - Float | -- Leave Without Pay - - | -- |
| 21 | -payment_days |
- - Float | -- Payment Days - - | -- |
| 22 | -hourly_wages |
- - Section Break | -- - - | -- |
| 23 | -timesheets |
- - Table | -- Salary Slip Timesheet - - | -- - - - -Salary Slip Timesheet - - - - | -
| 24 | -column_break_20 |
- - Column Break | -- - - | -- |
| 25 | -total_working_hours |
- - Float | -- Total Working Hours - - | -- |
| 26 | -hour_rate |
- - Currency | -- Hour Rate - - | -
- Company:company:default_currency- |
-
| 27 | -section_break_26 |
- - Section Break | -- - - | -- |
| 28 | -bank_name |
- - Data | -- Bank Name - - | -- |
| 29 | -bank_account_no |
- - Data | -- Bank Account No. - - | -- |
| 30 | -column_break_01 |
- - Column Break | -- - - | -- |
| 31 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Salary Slip - - - - | -
| 32 | -section_break_32 |
- - Section Break | -- - - | -- |
| 33 | -deduct_tax_for_unclaimed_employee_benefits |
- - Check | -- Deduct Tax For Unclaimed Employee Benefits - - | -- |
| 34 | -deduct_tax_for_unsubmitted_tax_exemption_proof |
- - Check | -- Deduct Tax For Unsubmitted Tax Exemption Proof - - | -- |
| 35 | -earning_deduction |
- - Section Break | -- Earning & Deduction - - | -- |
| 36 | -earning |
- - Column Break | -- Earning - - | -- |
| 37 | -earnings |
- - Table | -- Earnings - - | -- - - - -Salary Detail - - - - | -
| 38 | -deduction |
- - Column Break | -- Deduction - - | -- |
| 39 | -deductions |
- - Table | -- Deductions - - | -- - - - -Salary Detail - - - - | -
| 40 | -totals |
- - Section Break | -- - - | -- |
| 41 | -gross_pay |
- - Currency | -- Gross Pay - - | -
- Company:company:default_currency- |
-
| 42 | -column_break_25 |
- - Column Break | -- - - | -- |
| 43 | -total_deduction |
- - Currency | -- Total Deduction - - | -
- Company:company:default_currency- |
-
| 44 | -loan_repayment |
- - Section Break | -- Loan repayment - - | -- |
| 45 | -loans |
- - Table | -- Employee Loan - - | -- - - - -Salary Slip Loan - - - - | -
| 46 | -section_break_43 |
- - Section Break | -- - - | -- |
| 47 | -total_principal_amount |
- - Currency | -- Total Principal Amount - - | -
- Company:company:default_currency- |
-
| 48 | -total_interest_amount |
- - Currency | -- Total Interest Amount - - | -
- Company:company:default_currency- |
-
| 49 | -column_break_45 |
- - Column Break | -- - - | -- |
| 50 | -total_loan_repayment |
- - Currency | -- Total Loan Repayment - - | -
- Company:company:default_currency- |
-
| 51 | -net_pay_info |
- - Section Break | -- net pay info - - | -- |
| 52 | -net_pay |
- - Currency | -
- Net Pay
- - Gross Pay - Total Deduction - Loan Repayment - |
-
- Company:company:default_currency- |
-
| 53 | -column_break_53 |
- - Column Break | -- - - | -- |
| 54 | -rounded_total |
- - Currency | -- Rounded Total - - | -
- Company:company:default_currency- |
-
| 55 | -section_break_55 |
- - Section Break | -- - - | -- |
| 56 | -total_in_words |
- - Data | -
- Total in words
- - Net Pay (in words) will be visible once you save the Salary Slip. - |
- - |
Inherits from erpnext.utilities.transaction_base.TransactionBase - -
- - - add_earning_for_hourly_wages - (self, doc, salary_component, amount) -
-No docs
-- - - add_employee_flexi_benefits - (self, struct_row) -
-No docs
-- - - autoname - (self) -
-No docs
-- - - calculate_component_amounts - (self) -
-No docs
-- - - calculate_lwp - (self, holidays, working_days) -
-No docs
-- - - calculate_net_pay - (self) -
-No docs
-- - - calculate_tax - (self, payroll_period, tax_component, annual_taxable_earning, period_factor, tax_paid=0, benefit_amount_to_tax=0) -
-No docs
-- - - calculate_tax_by_tax_slab - (self, payroll_period, annual_earning) -
-No docs
-- - - calculate_tax_for_payroll_period - (self, tax_component, payroll_period) -
-No docs
-- - - calculate_unclaimed_taxable_benefit - (self, payroll_period) -
-No docs
-- - - calculate_unclaimed_taxable_earning - (self, payroll_period, tax_component, benefit_amount_to_tax) -
-No docs
-- - - calculate_variable_based_on_taxable_salary - (self, tax_component) -
-No docs
-- - - calculate_variable_tax - (self, tax_component, payroll_period, benefit_amount_to_tax=0) -
-No docs
-- - - check_existing - (self) -
-No docs
-- - - check_sal_struct - (self, joining_date, relieving_date) -
-No docs
-- - - email_salary_slip - (self) -
-No docs
-- - - eval_condition_and_formula - (self, d, data) -
-No docs
-- - - get_amount_from_exisiting_component - (self, salary_component) -
-No docs
-- - - get_data_for_eval - (self) -
-Returns data for evaluating formula
-- - - get_date_details - (self) -
-No docs
-- - - get_emp_and_leave_details - (self) -
-First time, load all the components from salary structure
-- - - get_holidays_for_employee - (self, start_date, end_date) -
-No docs
-- - - get_leave_details - (self, joining_date=None, relieving_date=None, lwp=None) -
-No docs
-- - - get_loan_details - (self) -
-No docs
-- - - get_payment_days - (self, joining_date, relieving_date) -
-No docs
-- - - get_period_factor - (self, period_start, period_end, start_date=None, end_date=None) -
-No docs
-- - - get_salary_slip_row - (self, salary_component) -
-No docs
-- - - get_status - (self) -
-No docs
-- - - get_tax_detail_till_date - (self, payroll_period, tax_component) -
-No docs
-- - - get_taxable_earnings - (self, include_flexi=0, only_flexi=0) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - process_salary_structure - (self) -
-Calculate salary after salary structure details have been updated
-- - - pull_emp_details - (self) -
-No docs
-- - - pull_sal_struct - (self) -
-No docs
-- - - set_loan_repayment - (self) -
-No docs
-- - - set_status - (self, status=None) -
-Get and update status
-- - - set_time_sheet - (self) -
-No docs
-- - - sum_components - (self, component_type, total_field) -
-No docs
-- - - update_component_row - (self, struct_row, amount, key) -
-No docs
-- - - update_status - (self, salary_slip=None) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_dates - (self) -
-No docs
-- - - erpnext.hr.doctype.salary_slip.salary_slip.unlink_ref_doc_from_salary_slip - (ref_no) -
-No docs
-Table Name: tabSalary Slip Loan
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -loan |
- - Link | -- Loan - - | -- - - - -Loan - - - - | -
| 2 | -loan_account |
- - Link | -- Loan Account - - | -- - - - -Account - - - - | -
| 3 | -interest_income_account |
- - Link | -- Interest Income Account - - | -- - - - -Account - - - - | -
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -principal_amount |
- - Currency | -- Principal Amount - - | -- |
| 6 | -interest_amount |
- - Currency | -- Interest Amount - - | -- |
| 7 | -total_payment |
- - Currency | -- Total Payment - - | -- |
Table Name: tabSalary Slip Timesheet
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -time_sheet |
- - Link | -- Time Sheet - - | -- - - - -Timesheet - - - - | -
| 2 | -working_hours |
- - Float | -- Working Hours - - | -- |
Table Name: tabSalary Structure
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 3 | -column_break1 |
- - Column Break | -- - - | -- |
| 4 | -is_active |
- - Select | -- Is Active - - | -
- -Yes -No- |
-
| 5 | -payroll_frequency |
- - Select | -- Payroll Frequency - - | -
- -Monthly -Fortnightly -Bimonthly -Weekly -Daily- |
-
| 6 | -is_default |
- - Select | -- Is Default - - | -
- Yes -No- |
-
| 7 | -time_sheet_earning_detail |
- - Section Break | -- - - | -- |
| 8 | -salary_slip_based_on_timesheet |
- - Check | -- Salary Slip Based on Timesheet - - | -- |
| 9 | -column_break_17 |
- - Column Break | -- - - | -- |
| 10 | -salary_component |
- - Link | -
- Salary Component
- - Salary Component for timesheet based payroll. - |
- - - - - -Salary Component - - - - | -
| 11 | -hour_rate |
- - Currency | -- Hour Rate - - | -
- Company:company:default_currency- |
-
| 12 | -leave_encashment_amount_per_day |
- - Currency | -- Leave Encashment Amount Per Day - - | -- |
| 13 | -max_benefits |
- - Currency | -- Max Benefits (Amount) - - | -- |
| 14 | -earning_deduction |
- - Section Break | -
-
- - Salary breakup based on Earning and Deduction. - |
- - |
| 15 | -earning |
- - Section Break | -- Earning - - | -- |
| 16 | -earnings |
- - Table | -- Earnings - - | -- - - - -Salary Detail - - - - | -
| 17 | -deduction |
- - Section Break | -- Deduction - - | -- |
| 18 | -deductions |
- - Table | -- Deductions - - | -- - - - -Salary Detail - - - - | -
| 19 | -net_pay_detail |
- - Section Break | -- - - | -
- Simple- |
-
| 20 | -column_break2 |
- - Column Break | -- - - | -- |
| 21 | -total_earning |
- - Currency | -- Total Earning - - | -
- Company:company:default_currency- |
-
| 22 | -total_deduction |
- - Currency | -- Total Deduction - - | -
- Company:company:default_currency- |
-
| 23 | -net_pay |
- - Currency | -- Net Pay - - | -
- Company:company:default_currency- |
-
| 24 | -account |
- - Section Break | -- Account - - | -- |
| 25 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
| 26 | -column_break_28 |
- - Column Break | -- - - | -- |
| 27 | -payment_account |
- - Link | -- Payment Account - - | -- - - - -Account - - - - | -
| 28 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Salary Structure - - - - | -
Inherits from frappe.model.document.Document - -
- - - strip_condition_and_formula_fields - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_amount - (self) -
-No docs
-- - - validate_max_benefits_with_flexi - (self) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.salary_structure.salary_structure.get_employees
-
- - - erpnext.hr.doctype.salary_structure.salary_structure.get_employees - (salary_structure) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.salary_structure.salary_structure.make_salary_slip
-
- - - erpnext.hr.doctype.salary_structure.salary_structure.make_salary_slip - (source_name, target_doc=None, employee=None, as_print=False, print_format=None) -
-No docs
-Table Name: tabSalary Structure Assignment
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 3 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 4 | -salary_structure |
- - Link | -- Salary Structure - - | -- - - - -Salary Structure - - - - | -
| 5 | -column_break_6 |
- - Column Break | -- - - | -- |
| 6 | -from_date |
- - Date | -- From Date - - | -- |
| 7 | -to_date |
- - Date | -- To Date - - | -- |
| 8 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 9 | -section_break_7 |
- - Section Break | -- - - | -- |
| 10 | -base |
- - Currency | -- Base - - | -- |
| 11 | -column_break_9 |
- - Column Break | -- - - | -- |
| 12 | -variable |
- - Currency | -- Variable - - | -- |
| 13 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Salary Structure Assignment - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_dates - (self) -
-No docs
-- - - validate_duplicate_assignments - (self) -
-No docs
-- - - erpnext.hr.doctype.salary_structure_assignment.salary_structure_assignment.get_assigned_salary_structure - (employee, on_date) -
-No docs
-Table Name: tabSalary Structure Employee
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Read Only | -- Employee Name - - | -- |
| 3 | -from_date |
- - Date | -- From Date - - | -- |
| 4 | -to_date |
- - Date | -- To Date - - | -- |
| 5 | -base |
- - Currency | -- Base - - | -
- Company:company:default_currency- |
-
| 6 | -variable |
- - Currency | -- Variable - - | -
- Company:company:default_currency- |
-
Table Name: tabShift Assignment
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 3 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 4 | -shift_type |
- - Link | -- Shift Type - - | -- - - - -Shift Type - - - - | -
| 5 | -present |
- - Check | -- Present - - | -- |
| 6 | -column_break_3 |
- - Column Break | -- - - | -- |
| 7 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 8 | -date |
- - Date | -- Date - - | -- |
| 9 | -shift_request |
- - Link | -- Shift Request - - | -- - - - -Shift Request - - - - | -
| 10 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Shift Assignment - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - throw_overlap_error - (self, d) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_overlapping_dates - (self) -
-No docs
-- - - erpnext.hr.doctype.shift_assignment.shift_assignment.add_assignments - (events, start, end, conditions=None) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.shift_assignment.shift_assignment.get_events
-
- - - erpnext.hr.doctype.shift_assignment.shift_assignment.get_events - (start, end, filters=None) -
-No docs
-Table Name: tabShift Request
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -shift_type |
- - Link | -- Shift Type - - | -- - - - -Shift Type - - - - | -
| 2 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 3 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 4 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 5 | -column_break_4 |
- - Column Break | -- - - | -- |
| 6 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 7 | -from_date |
- - Date | -- From Date - - | -- |
| 8 | -to_date |
- - Date | -- To Date - - | -- |
| 9 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Shift Request - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - get_working_days - (self, start_date, end_date) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - throw_overlap_error - (self, d) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_dates - (self) -
-No docs
-- - - validate_shift_request_overlap_dates - (self) -
-No docs
-Table Name: tabShift Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -start_time |
- - Time | -- Start Time - - | -- |
| 2 | -end_time |
- - Time | -- End Time - - | -- |
| 3 | -holiday_list |
- - Link | -- Holiday List - - | -- - - - -Holiday List - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabStaffing Plan
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -from_date |
- - Date | -- From Date - - | -- |
| 5 | -to_date |
- - Date | -- To Date - - | -- |
| 6 | -staffing_plan_details |
- - Section Break | -- Staffing Plan Details - - | -- |
| 7 | -staffing_details |
- - Table | -- Staffing Plan Detail - - | -- - - - -Staffing Plan Detail - - - - | -
| 8 | -section_break_8 |
- - Section Break | -- - - | -- |
| 9 | -total_estimated_budget |
- - Currency | -- Total Estimated Budget - - | -- |
| 10 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Staffing Plan - - - - | -
Inherits from frappe.model.document.Document - -
- - - validate - (self) -
-No docs
-- - - validate_overlap - (self, staffing_plan_detail) -
-No docs
-- - - validate_with_parent_plan - (self, staffing_plan_detail) -
-No docs
-- - - validate_with_subsidiary_plans - (self, staffing_plan_detail) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.staffing_plan.staffing_plan.get_active_staffing_plan_details
-
- - - erpnext.hr.doctype.staffing_plan.staffing_plan.get_active_staffing_plan_details - (company, designation, department=None, date=2018-06-25) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.staffing_plan.staffing_plan.get_designation_counts
-
- - - erpnext.hr.doctype.staffing_plan.staffing_plan.get_designation_counts - (designation, company) -
-No docs
-Table Name: tabStaffing Plan Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -designation |
- - Link | -- Designation - - | -- - - - -Designation - - - - | -
| 2 | -number_of_positions |
- - Int | -- Number Of Positions - - | -- |
| 3 | -estimated_cost_per_position |
- - Currency | -- Estimated Cost Per Position - - | -- |
| 4 | -column_break_5 |
- - Column Break | -- - - | -- |
| 5 | -current_count |
- - Int | -- Current Count - - | -- |
| 6 | -current_openings |
- - Int | -- Current Openings - - | -- |
| 7 | -vacancies |
- - Int | -- Vacancies - - | -- |
| 8 | -total_estimated_cost |
- - Currency | -- Total Estimated Cost - - | -- |
Table Name: tabTaxable Salary Slab
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -from_amount |
- - Currency | -- From Amount - - | -- |
| 2 | -to_amount |
- - Currency | -- To Amount - - | -- |
| 3 | -percent_deduction |
- - Float | -- Percent Deduction - - | -- |
| 4 | -condition |
- - Data | -- Condition - - | -- |
Table Name: tabTraining Event
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -event_name |
- - Data | -- Event Name - - | -- |
| 2 | -training_program |
- - Link | -- Training Program - - | -- - - - -Training Program - - - - | -
| 3 | -event_status |
- - Select | -- Event Status - - | -
- Scheduled -Completed -Cancelled- |
-
| 4 | -has_certificate |
- - Check | -- Has Certificate - - | -- |
| 5 | -column_break_2 |
- - Column Break | -- - - | -- |
| 6 | -type |
- - Select | -- Type - - | -
- Seminar -Theory -Workshop -Conference -Exam -Internet -Self-Study- |
-
| 7 | -level |
- - Select | -- Level - - | -
- -Beginner -Expert -Advance- |
-
| 8 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 9 | -section_break_4 |
- - Section Break | -- - - | -- |
| 10 | -trainer_name |
- - Data | -- Trainer Name - - | -- |
| 11 | -trainer_email |
- - Data | -- Trainer Email - - | -- |
| 12 | -column_break_7 |
- - Column Break | -- - - | -- |
| 13 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 14 | -contact_number |
- - Data | -- Contact Number - - | -- |
| 15 | -section_break_9 |
- - Section Break | -- - - | -- |
| 16 | -course |
- - Link | -- Course - - | -- - - - -Course - - - - | -
| 17 | -location |
- - Data | -- Location - - | -- |
| 18 | -column_break_12 |
- - Column Break | -- - - | -- |
| 19 | -start_time |
- - Datetime | -- Start Time - - | -- |
| 20 | -end_time |
- - Datetime | -- End Time - - | -- |
| 21 | -section_break_15 |
- - Section Break | -- - - | -- |
| 22 | -introduction |
- - Text Editor | -- Introduction - - | -- |
| 23 | -section_break_18 |
- - Section Break | -- Attendees - - | -- |
| 24 | -employees |
- - Table | -- Employees - - | -- - - - -Training Event Employee - - - - | -
| 25 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Training Event - - - - | -
| 26 | -employee_emails |
- - Small Text | -- Employee Emails - - | -
- |
-
Inherits from frappe.model.document.Document - -
Table Name: tabTraining Event Employee
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Read Only | -- Employee Name - - | -- |
| 3 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 4 | -column_break_3 |
- - Column Break | -- - - | -- |
| 5 | -status |
- - Select | -- Status - - | -
- Open -Invited -Completed -Feedback Submitted- |
-
| 6 | -attendance |
- - Select | -- Attendance - - | -
- Mandatory -Optional- |
-
Table Name: tabTraining Feedback
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -employee_name |
- - Read Only | -- Employee Name - - | -- |
| 3 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 4 | -course |
- - Link | -- Course - - | -- - - - -Course - - - - | -
| 5 | -column_break_3 |
- - Column Break | -- - - | -- |
| 6 | -training_event |
- - Link | -- Training Event - - | -- - - - -Training Event - - - - | -
| 7 | -event_name |
- - Data | -- Event Name - - | -- |
| 8 | -trainer_name |
- - Data | -- Trainer Name - - | -- |
| 9 | -section_break_6 |
- - Section Break | -- - - | -- |
| 10 | -feedback |
- - Text | -- Feedback - - | -- |
| 11 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Training Feedback - - - - | -
Inherits from frappe.model.document.Document - -
- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabTraining Program
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -training_program |
- - Data | -- Training Program - - | -- |
| 2 | -status |
- - Select | -- Status - - | -
- Scheduled -Completed -Cancelled- |
-
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 5 | -section_break_5 |
- - Section Break | -- - - | -- |
| 6 | -trainer_name |
- - Data | -- Trainer Name - - | -- |
| 7 | -trainer_email |
- - Data | -- Trainer Email - - | -- |
| 8 | -column_break_8 |
- - Column Break | -- - - | -- |
| 9 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 10 | -contact_number |
- - Data | -- Contact Number - - | -- |
| 11 | -section_break_11 |
- - Section Break | -- - - | -- |
| 12 | -description |
- - Text Editor | -- Description - - | -- |
| 13 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Training Program - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabTraining Result
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -training_event |
- - Link | -- Training Event - - | -- - - - -Training Event - - - - | -
| 2 | -section_break_3 |
- - Section Break | -- - - | -- |
| 3 | -employees |
- - Table | -- Employees - - | -- - - - -Training Result Employee - - - - | -
| 4 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Training Result - - - - | -
| 5 | -employee_emails |
- - Small Text | -- Employee Emails - - | -
- |
-
Inherits from frappe.model.document.Document - -
- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.training_result.training_result.get_employees
-
- - - erpnext.hr.doctype.training_result.training_result.get_employees - (training_event) -
-No docs
-Table Name: tabTraining Result Employee
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -employee_name |
- - Read Only | -- Employee Name - - | -- |
| 4 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 5 | -section_break_5 |
- - Section Break | -- - - | -- |
| 6 | -hours |
- - Float | -- Hours - - | -- |
| 7 | -grade |
- - Data | -- Grade - - | -- |
| 8 | -column_break_7 |
- - Column Break | -- - - | -- |
| 9 | -comments |
- - Text | -- Comments - - | -- |
Table Name: tabTravel Itinerary
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -travel_from |
- - Data | -- Travel From - - | -- |
| 2 | -travel_to |
- - Data | -- Travel To - - | -- |
| 3 | -mode_of_travel |
- - Select | -- Mode of Travel - - | -
- -Flight -Train -Taxi -Rented Car- |
-
| 4 | -meal_preference |
- - Select | -- Meal Preference - - | -
- -Vegetarian -Non-Vegetarian -Gluten Free -Non Diary- |
-
| 5 | -travel_advance_required |
- - Check | -- Travel Advance Required - - | -- |
| 6 | -advance_amount |
- - Data | -- Advance Amount - - | -- |
| 7 | -column_break_6 |
- - Column Break | -- - - | -- |
| 8 | -departure_date |
- - Datetime | -- Departure Datetime - - | -- |
| 9 | -arrival_date |
- - Datetime | -- Arrival Datetime - - | -- |
| 10 | -lodging_required |
- - Check | -- Lodging Required - - | -- |
| 11 | -preferred_area_for_lodging |
- - Data | -- Preferred Area for Lodging - - | -- |
| 12 | -check_in_date |
- - Date | -- Check-in Date - - | -- |
| 13 | -check_out_date |
- - Date | -- Check-out Date - - | -- |
| 14 | -section_break_14 |
- - Section Break | -- - - | -- |
| 15 | -other_details |
- - Small Text | -- Other Details - - | -- |
Table Name: tabTravel Request
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -travel_type |
- - Select | -- Travel Type - - | -
- -Domestic -International- |
-
| 2 | -travel_funding |
- - Select | -- Travel Funding - - | -
- -Require Full Funding -Fully Sponsored -Partially Sponsored, Require Partial Funding- |
-
| 3 | -travel_proof |
- - Attach | -- Copy of Invitation/Announcement - - | -- |
| 4 | -column_break_2 |
- - Column Break | -- - - | -- |
| 5 | -purpose_of_travel |
- - Link | -- Purpose of Travel - - | -- - - - -Purpose of Travel - - - - | -
| 6 | -details_of_sponsor |
- - Data | -- Details of Sponsor (Name, Location) - - | -- |
| 7 | -section_break_4 |
- - Section Break | -- Description - - | -- |
| 8 | -description |
- - Small Text | -- Any other details - - | -- |
| 9 | -employee_details |
- - Section Break | -- Employee Details - - | -- |
| 10 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 11 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 12 | -cell_number |
- - Data | -- Contact Number - - | -- |
| 13 | -prefered_email |
- - Data | -- Contact Email - - | -- |
| 14 | -column_break_7 |
- - Column Break | -- - - | -- |
| 15 | -date_of_birth |
- - Date | -- Date of Birth - - | -- |
| 16 | -personal_id_type |
- - Link | -- Identification Document Type - - | -- - - - -Identification Document Type - - - - | -
| 17 | -personal_id_number |
- - Data | -- Identification Document Number - - | -- |
| 18 | -passport_number |
- - Data | -- Passport Number - - | -- |
| 19 | -travel_itinerary |
- - Section Break | -- Travel Itinerary - - | -- |
| 20 | -itinerary |
- - Table | -- - - | -- - - - -Travel Itinerary - - - - | -
| 21 | -costing_details |
- - Section Break | -- Costing Details - - | -- |
| 22 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 23 | -costings |
- - Table | -- Costing - - | -- - - - -Travel Request Costing - - - - | -
| 24 | -event_details |
- - Section Break | -- Event Details - - | -- |
| 25 | -name_of_organizer |
- - Data | -- Name of Organizer - - | -- |
| 26 | -address_of_organizer |
- - Data | -- Address of Organizer - - | -- |
| 27 | -other_details |
- - Text | -- Other Details - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabTravel Request Costing
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -expense_type |
- - Link | -- Expense Type - - | -- - - - -Expense Claim Type - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -sponsored_amount |
- - Currency | -- Sponsored Amount - - | -- |
| 4 | -funded_amount |
- - Currency | -- Funded Amount - - | -- |
| 5 | -total_amount |
- - Currency | -- Total Amount - - | -- |
| 6 | -section_break_4 |
- - Section Break | -- - - | -- |
| 7 | -comments |
- - Small Text | -- Comments - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -download_template |
- - Section Break | -- Download Template - - | -- |
| 2 | -att_fr_date |
- - Date | -- Attendance From Date - - | -- |
| 3 | -att_to_date |
- - Date | -- Attendance To Date - - | -- |
| 4 | -get_template |
- - Button | -- Get Template - - | -- |
| 5 | -upload_attendance_data |
- - Section Break | -- Import Attendance - - | -- |
| 6 | -upload_html |
- - HTML | -- Upload HTML - - | -- |
| 7 | -import_log |
- - HTML | -- Import Log - - | -- |
Inherits from frappe.model.document.Document - -
- - - erpnext.hr.doctype.upload_attendance.upload_attendance.add_data - (w, args) -
-No docs
-- - - erpnext.hr.doctype.upload_attendance.upload_attendance.add_header - (w) -
-No docs
-- - - erpnext.hr.doctype.upload_attendance.upload_attendance.get_active_employees - () -
-No docs
-- - - erpnext.hr.doctype.upload_attendance.upload_attendance.get_dates - (args) -
-get list of dates in between from date and to date
-- - - erpnext.hr.doctype.upload_attendance.upload_attendance.get_existing_attendance_records - (args) -
-No docs
-- - - erpnext.hr.doctype.upload_attendance.upload_attendance.get_naming_series - () -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.upload_attendance.upload_attendance.get_template
-
- - - erpnext.hr.doctype.upload_attendance.upload_attendance.get_template - () -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.upload_attendance.upload_attendance.upload
-
- - - erpnext.hr.doctype.upload_attendance.upload_attendance.upload - () -
-No docs
-Table Name: tabVehicle
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -license_plate |
- - Data | -- License Plate - - | -- |
| 2 | -make |
- - Data | -- Make - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -model |
- - Data | -- Model - - | -- |
| 5 | -vehicle_details |
- - Section Break | -- Details - - | -- |
| 6 | -last_odometer |
- - Int | -- Odometer Value (Last) - - | -- |
| 7 | -acquisition_date |
- - Date | -- Acquisition Date - - | -- |
| 8 | -location |
- - Data | -- Location - - | -- |
| 9 | -column_break_8 |
- - Column Break | -- - - | -- |
| 10 | -chassis_no |
- - Data | -- Chassis No - - | -- |
| 11 | -vehicle_value |
- - Currency | -- Vehicle Value - - | -- |
| 12 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 13 | -insurance_details |
- - Section Break | -- Insurance Details - - | -- |
| 14 | -insurance_company |
- - Data | -- Insurance Company - - | -- |
| 15 | -policy_no |
- - Data | -- Policy No - - | -- |
| 16 | -column_break_15 |
- - Column Break | -- - - | -- |
| 17 | -start_date |
- - Date | -- Start Date - - | -- |
| 18 | -end_date |
- - Date | -- End Date - - | -- |
| 19 | -additional_details |
- - Section Break | -- Additional Details - - | -- |
| 20 | -fuel_type |
- - Select | -- Fuel Type - - | -
- Petrol -Diesel -Natural Gas -Electric- |
-
| 21 | -uom |
- - Link | -- Fuel UOM - - | -- - - - -UOM - - - - | -
| 22 | -carbon_check_date |
- - Date | -- Last Carbon Check - - | -- |
| 23 | -column_break_21 |
- - Column Break | -- - - | -- |
| 24 | -color |
- - Data | -- Color - - | -- |
| 25 | -wheels |
- - Int | -- Wheels - - | -- |
| 26 | -doors |
- - Int | -- Doors - - | -- |
| 27 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Vehicle - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabVehicle Log
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -vehicle_section |
- - Section Break | -- - - | -
- fa fa-user- |
-
| 2 | -naming_series |
- - Select | -- Series - - | -
- VLOG.- |
-
| 3 | -license_plate |
- - Link | -- License Plate - - | -- - - - -Vehicle - - - - | -
| 4 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 5 | -column_break_4 |
- - Column Break | -- - - | -- |
| 6 | -column_break_7 |
- - Column Break | -- - - | -- |
| 7 | -model |
- - Read Only | -- Model - - | -- |
| 8 | -make |
- - Read Only | -- Make - - | -- |
| 9 | -odometer_reading |
- - Section Break | -- Odometer Reading - - | -- |
| 10 | -date |
- - Date | -- Date - - | -- |
| 11 | -odometer |
- - Int | -- Odometer - - | -- |
| 12 | -refuelling_details |
- - Section Break | -- Refuelling Details - - | -- |
| 13 | -fuel_qty |
- - Float | -- Fuel Qty - - | -- |
| 14 | -price |
- - Currency | -- Fuel Price - - | -- |
| 15 | -column_break_15 |
- - Column Break | -- - - | -- |
| 16 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 17 | -invoice |
- - Data | -- Invoice Ref - - | -- |
| 18 | -service_details |
- - Section Break | -- Service Details - - | -- |
| 19 | -service_detail |
- - Table | -- Service Detail - - | -- - - - -Vehicle Service - - - - | -
| 20 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Vehicle Log - - - - | -
Inherits from frappe.model.document.Document - -
- - - on_submit - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.vehicle_log.vehicle_log.get_make_model
-
- - - erpnext.hr.doctype.vehicle_log.vehicle_log.get_make_model - (license_plate) -
-No docs
-Public API
- /api/method/erpnext.hr.doctype.vehicle_log.vehicle_log.make_expense_claim
-
- - - erpnext.hr.doctype.vehicle_log.vehicle_log.make_expense_claim - (docname) -
-No docs
-Table Name: tabVehicle Service
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -service_item |
- - Select | -- Service Item - - | -
- -Brake Oil -Brake Pad -Clutch Plate -Engine Oil -Oil Change -Wheels- |
-
| 2 | -type |
- - Select | -- Type - - | -
- -Inspection -Service -Change- |
-
| 3 | -frequency |
- - Select | -- Frequency - - | -
- -Mileage -Monthly -Quarterly -Half Yearly -Yearly- |
-
| 4 | -expense_amount |
- - Currency | -- Expense - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -enabled |
- - Check | -- Enabled - - | -- |
| 2 | -suspended |
- - Check | -- Suspended - - | -- |
| 3 | -hub_username |
- - Data | -- Hub Username - - | -- |
| 4 | -user |
- - Link | -- User - - | -- - - - -User - - - - | -
| 5 | -column_break_0 |
- - Column Break | -- - - | -- |
| 6 | -hub_user_status |
- - Data | -- Status - - | -- |
| 7 | -language |
- - Data | -- Language - - | -- |
| 8 | -seller_profile_section |
- - Section Break | -- Company and Seller Profile - - | -- |
| 9 | -company_registered |
- - Check | -- Company Registered - - | -- |
| 10 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 11 | -company_email |
- - Data | -- Company Email - - | -- |
| 12 | -country |
- - Link | -- Country - - | -- - - - -Country - - - - | -
| 13 | -company_logo |
- - Attach Image | -- Company Logo - - | -- |
| 14 | -seller_description |
- - Text Editor | -- Description - - | -- |
| 15 | -users_sb |
- - Section Break | -- Enabled Users - - | -- |
| 16 | -users |
- - Table | -- Users - - | -- - - - -Hub Users - - - - | -
| 17 | -publish_section |
- - Section Break | -- Publish - - | -- |
| 18 | -publish |
- - Check | -- Publish Items to Hub - - | -- |
| 19 | -publish_pricing |
- - Check | -- Publish Pricing - - | -- |
| 20 | -selling_price_list |
- - Link | -- Selling Price List - - | -- - - - -Price List - - - - | -
| 21 | -publish_availability |
- - Check | -- Publish Availability - - | -- |
| 22 | -last_sync_datetime |
- - Datetime | -- Last Sync On - - | -- |
| 23 | -custom_data |
- - Code | -- Custom Data - - | -- |
| 24 | -unregister_section |
- - Section Break | -- Unregister - - | -- |
| 25 | -unregister_from_hub |
- - Button | -- Unregister from Hub - - | -- |
Inherits from frappe.model.document.Document - -
- - - create_hub_connector - (self, message) -
-No docs
-- - - get_hub_url - (self) -
-No docs
-- - - pre_reg - (self) -
-No docs
-- - - register - (self) -
-Create a User on hub.erpnext.org and return username/password
-- - - sync - (self) -
-Create and execute Data Migration Run for Hub Sync plan
-- - - unregister - (self) -
-Disable the User on hub.erpnext.org
-- - - validate - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - __init__ - (self, headers) -
-No docs
-- - - get - (self, url, params, headers, verify) -
-No docs
-- - - post - (self, url, data, verify) -
-No docs
-- - - put - (self, url, data, verify) -
-No docs
-- - - erpnext.hub_node.doctype.hub_settings.hub_settings.reset_hub_publishing_settings - (last_sync_datetime=) -
-No docs
-- - - erpnext.hub_node.doctype.hub_settings.hub_settings.reset_hub_settings - (last_sync_datetime=) -
-No docs
-Public API
- /api/method/erpnext.hub_node.doctype.hub_settings.hub_settings.sync
-
- - - erpnext.hub_node.doctype.hub_settings.hub_settings.sync - () -
-No docs
-Table Name: tabHub Tracked Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Data | -- Item Code - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabHub Users
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -user |
- - Link | -- User - - | -- - - - -User - - - - | -
Browse DocTypes by Module
- -Table Name: tabMaintenance Schedule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -customer_details |
- - Section Break | -- - - | -
- fa fa-user- |
-
| 2 | -naming_series |
- - Select | -- Series - - | -
- MS- |
-
| 3 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 4 | -column_break0 |
- - Column Break | -- - - | -- |
| 5 | -status |
- - Select | -- Status - - | -
- -Draft -Submitted -Cancelled- |
-
| 6 | -transaction_date |
- - Date | -- Transaction Date - - | -- |
| 7 | -items_section |
- - Section Break | -- - - | -
- fa fa-shopping-cart- |
-
| 8 | -items |
- - Table | -- Items - - | -- - - - -Maintenance Schedule Item - - - - | -
| 9 | -schedule |
- - Section Break | -- Schedule - - | -
- fa fa-time- |
-
| 10 | -generate_schedule |
- - Button | -- Generate Schedule - - | -- |
| 11 | -schedules |
- - Table | -- Schedules - - | -- - - - -Maintenance Schedule Detail - - - - | -
| 12 | -contact_info |
- - Section Break | -- Contact Info - - | -- |
| 13 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 14 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 15 | -contact_mobile |
- - Data | -- Mobile No - - | -- |
| 16 | -contact_email |
- - Data | -- Contact Email - - | -- |
| 17 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 18 | -column_break_17 |
- - Column Break | -- - - | -- |
| 19 | -customer_address |
- - Link | -- Customer Address - - | -- - - - -Address - - - - | -
| 20 | -address_display |
- - Small Text | -- Address - - | -- |
| 21 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 22 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 23 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 24 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Maintenance Schedule - - - - | -
Inherits from erpnext.utilities.transaction_base.TransactionBase - -
- - - check_serial_no_added - (self) -
-No docs
-- - - create_schedule_list - (self, start_date, end_date, no_of_visit, sales_person) -
-No docs
-- - - generate_schedule - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - update_amc_date - (self, serial_nos, amc_expiry_date=None) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_dates_with_periodicity - (self) -
-No docs
-- - - validate_maintenance_detail - (self) -
-No docs
-- - - validate_sales_order - (self) -
-No docs
-- - - validate_schedule - (self) -
-No docs
-- - - validate_schedule_date_for_holiday_list - (self, schedule_date, sales_person) -
-No docs
-- - - validate_serial_no - (self, serial_nos, amc_start_date) -
-No docs
-Public API
- /api/method/erpnext.maintenance.doctype.maintenance_schedule.maintenance_schedule.make_maintenance_visit
-
- - - erpnext.maintenance.doctype.maintenance_schedule.maintenance_schedule.make_maintenance_visit - (source_name, target_doc=None) -
-No docs
-Table Name: tabMaintenance Schedule Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -item_name |
- - Data | -- Item Name - - | -- |
| 3 | -scheduled_date |
- - Date | -- Scheduled Date - - | -- |
| 4 | -actual_date |
- - Date | -- Actual Date - - | -- |
| 5 | -sales_person |
- - Link | -- Sales Person - - | -- - - - -Sales Person - - - - | -
| 6 | -serial_no |
- - Small Text | -- Serial No - - | -- |
Table Name: tabMaintenance Schedule Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -item_name |
- - Data | -- Item Name - - | -- |
| 3 | -description |
- - Text Editor | -- Description - - | -- |
| 4 | -schedule_details |
- - Section Break | -- - - | -- |
| 5 | -start_date |
- - Date | -- Start Date - - | -- |
| 6 | -end_date |
- - Date | -- End Date - - | -- |
| 7 | -periodicity |
- - Select | -- Periodicity - - | -
- -Weekly -Monthly -Quarterly -Half Yearly -Yearly -Random- |
-
| 8 | -no_of_visits |
- - Int | -- No of Visits - - | -- |
| 9 | -sales_person |
- - Link | -- Sales Person - - | -- - - - -Sales Person - - - - | -
| 10 | -reference |
- - Section Break | -- Reference - - | -- |
| 11 | -serial_no |
- - Small Text | -- Serial No - - | -- |
| 12 | -sales_order |
- - Link | -- Sales Order - - | -- - - - -Sales Order - - - - | -
Table Name: tabMaintenance Visit
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -customer_details |
- - Section Break | -- - - | -
- fa fa-user- |
-
| 2 | -column_break0 |
- - Column Break | -- - - | -- |
| 3 | -naming_series |
- - Select | -- Series - - | -
- MV- |
-
| 4 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 5 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 6 | -address_display |
- - Small Text | -- Address - - | -- |
| 7 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 8 | -contact_mobile |
- - Data | -- Mobile No - - | -- |
| 9 | -contact_email |
- - Data | -- Contact Email - - | -- |
| 10 | -column_break1 |
- - Column Break | -- - - | -- |
| 11 | -mntc_date |
- - Date | -- Maintenance Date - - | -- |
| 12 | -mntc_time |
- - Time | -- Maintenance Time - - | -- |
| 13 | -maintenance_details |
- - Section Break | -- - - | -
- fa fa-wrench- |
-
| 14 | -completion_status |
- - Select | -- Completion Status - - | -
- -Partially Completed -Fully Completed- |
-
| 15 | -column_break_14 |
- - Column Break | -- - - | -- |
| 16 | -maintenance_type |
- - Select | -- Maintenance Type - - | -
- -Scheduled -Unscheduled -Breakdown- |
-
| 17 | -section_break0 |
- - Section Break | -- - - | -
- fa fa-wrench- |
-
| 18 | -purposes |
- - Table | -- Purposes - - | -- - - - -Maintenance Visit Purpose - - - - | -
| 19 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 20 | -customer_feedback |
- - Small Text | -- Customer Feedback - - | -- |
| 21 | -col_break3 |
- - Column Break | -- - - | -- |
| 22 | -status |
- - Data | -- Status - - | -
- -Draft -Cancelled -Submitted- |
-
| 23 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Maintenance Visit - - - - | -
| 24 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 25 | -contact_info_section |
- - Section Break | -- Contact Info - - | -
- fa fa-bullhorn- |
-
| 26 | -customer_address |
- - Link | -- Customer Address - - | -- - - - -Address - - - - | -
| 27 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 28 | -col_break4 |
- - Column Break | -- - - | -- |
| 29 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 30 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
Inherits from erpnext.utilities.transaction_base.TransactionBase - -
- - - check_if_last_visit - (self) -
-check if last maintenance visit against same sales order/ Warranty Claim
-- - - get_feed - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - update_customer_issue - (self, flag) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_serial_no - (self) -
-No docs
-Table Name: tabMaintenance Visit Purpose
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -item_name |
- - Data | -- Item Name - - | -- |
| 3 | -serial_no |
- - Small Text | -- Serial No - - | -- |
| 4 | -description |
- - Text Editor | -- Description - - | -- |
| 5 | -work_details |
- - Section Break | -- - - | -- |
| 6 | -service_person |
- - Link | -- Sales Person - - | -- - - - -Sales Person - - - - | -
| 7 | -work_done |
- - Small Text | -- Work Done - - | -- |
| 8 | -prevdoc_doctype |
- - Link | -- Document Type - - | -- - - - -DocType - - - - | -
| 9 | -prevdoc_docname |
- - Dynamic Link | -- Against Document No - - | -
- prevdoc_doctype- |
-
| 10 | -prevdoc_detail_docname |
- - Data | -- Against Document Detail No - - | -- |
Table Name: tabBOM
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item |
- - Link | -
- Item
- - Item to be manufactured or repacked - |
- - - - - -Item - - - - | -
| 2 | -item_name |
- - Data | -- Item Name - - | -- |
| 3 | -quantity |
- - Float | -
- Quantity
- - Quantity of item obtained after manufacturing / repacking from given quantities of raw materials - |
- - |
| 4 | -uom |
- - Link | -- Item UOM - - | -- - - - -UOM - - - - | -
| 5 | -inspection_required |
- - Check | -- Inspection Required - - | -- |
| 6 | -quality_inspection_template |
- - Link | -- Quality Inspection Template - - | -- - - - -Quality Inspection Template - - - - | -
| 7 | -cb0 |
- - Column Break | -- - - | -- |
| 8 | -is_active |
- - Check | -- Is Active - - | -- |
| 9 | -is_default |
- - Check | -- Is Default - - | -- |
| 10 | -with_operations |
- - Check | -
- With Operations
- - Manage cost of operations - |
- - |
| 11 | -rm_cost_as_per |
- - Select | -- Rate Of Materials Based On - - | -
- Valuation Rate -Last Purchase Rate -Price List- |
-
| 12 | -buying_price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 13 | -set_rate_of_sub_assembly_item_based_on_bom |
- - Check | -- Set rate of sub-assembly item based on BOM - - | -- |
| 14 | -allow_alternative_item |
- - Check | -- Allow Alternative Item - - | -- |
| 15 | -currency_detail |
- - Section Break | -- - - | -- |
| 16 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 17 | -column_break_12 |
- - Column Break | -- - - | -- |
| 18 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 19 | -conversion_rate |
- - Float | -- Conversion Rate - - | -- |
| 20 | -operations_section |
- - Section Break | -
- Operations
- - Specify the operations, operating cost and give a unique Operation no to your operations. - |
- - |
| 21 | -operations |
- - Table | -- Operations - - | -- - - - -BOM Operation - - - - | -
| 22 | -materials_section |
- - Section Break | -- Materials - - | -- |
| 23 | -items |
- - Table | -- Items - - | -- - - - -BOM Item - - - - | -
| 24 | -scrap_section |
- - Section Break | -- Scrap - - | -- |
| 25 | -scrap_items |
- - Table | -- Scrap Items - - | -- - - - -BOM Scrap Item - - - - | -
| 26 | -costing |
- - Section Break | -- Costing - - | -- |
| 27 | -operating_cost |
- - Currency | -- Operating Cost - - | -
- currency- |
-
| 28 | -raw_material_cost |
- - Currency | -- Raw Material Cost - - | -
- currency- |
-
| 29 | -scrap_material_cost |
- - Currency | -- Scrap Material Cost - - | -
- currency- |
-
| 30 | -cb1 |
- - Column Break | -- - - | -- |
| 31 | -base_operating_cost |
- - Currency | -- Operating Cost (Company Currency) - - | -
- Company:company:default_currency- |
-
| 32 | -base_raw_material_cost |
- - Currency | -- Raw Material Cost(Company Currency) - - | -
- Company:company:default_currency- |
-
| 33 | -base_scrap_material_cost |
- - Data | -- Scrap Material Cost(Company Currency) - - | -
- Company:company:default_currency- |
-
| 34 | -total_cost_of_bom |
- - Section Break | -- - - | -- |
| 35 | -total_cost |
- - Currency | -- Total Cost - - | -
- currency- |
-
| 36 | -column_break_26 |
- - Column Break | -- - - | -- |
| 37 | -base_total_cost |
- - Currency | -- Total Cost(Company Currency) - - | -
- Company:company:default_currency- |
-
| 38 | -more_info_section |
- - Section Break | -- - - | -- |
| 39 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 40 | -amended_from |
- - Link | -- Amended From - - | -- - - - -BOM - - - - | -
| 41 | -col_break23 |
- - Column Break | -- - - | -- |
| 42 | -section_break_25 |
- - Section Break | -- - - | -- |
| 43 | -description |
- - Small Text | -- Item Description - - | -- |
| 44 | -column_break_27 |
- - Column Break | -- - - | -- |
| 45 | -image |
- - Attach | -- Image - - | -- |
| 46 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 47 | -section_break0 |
- - Section Break | -- Materials Required (Exploded) - - | -- |
| 48 | -exploded_items |
- - Table | -- Exploded_items - - | -- - - - -BOM Explosion Item - - - - | -
| 49 | -website_section |
- - Section Break | -- Website - - | -- |
| 50 | -show_in_website |
- - Check | -- Show in Website - - | -- |
| 51 | -route |
- - Small Text | -- Route - - | -- |
| 52 | -website_image |
- - Attach Image | -
- Image
- - Item Image (if not slideshow) - |
- - |
| 53 | -thumbnail |
- - Data | -- Thumbnail - - | -- |
| 54 | -sb_web_spec |
- - Section Break | -- Website Specifications - - | -- |
| 55 | -web_long_description |
- - Text Editor | -- Website Description - - | -- |
| 56 | -show_items |
- - Check | -- Show Items - - | -- |
| 57 | -show_operations |
- - Check | -- Show Operations - - | -- |
Inherits from frappe.website.website_generator.WebsiteGenerator - -
- - - add_exploded_items - (self) -
-Add items to Flat BOM table
-- - - add_to_cur_exploded_items - (self, args) -
-No docs
-- - - autoname - (self) -
-No docs
-- - - calculate_cost - (self) -
-Calculate bom totals
-- - - calculate_op_cost - (self) -
-Update workstation rate and calculates totals
-- - - calculate_rm_cost - (self) -
-Fetch RM rate as per today's valuation rate and calculate totals
-- - - calculate_sm_cost - (self) -
-Fetch RM rate as per today's valuation rate and calculate totals
-- - - check_recursion - (self) -
-Check whether recursion occurs in any bom
-- - - clear_operations - (self) -
-No docs
-- - - company_currency - (self) -
-No docs
-- - - get_bom_material_detail - (self, args=None) -
-Get raw material details like uom, desc and rate
-- - - get_bom_unitcost - (self, bom_no) -
-No docs
-- - - get_child_exploded_items - (self, bom_no, stock_qty) -
-Add all items from Flat BOM of child BOM
-- - - get_context - (self, context) -
-No docs
-- - - get_exploded_items - (self) -
-Get all raw materials including items from child bom
-- - - get_item_det - (self, item_code) -
-No docs
-- - - get_rm_rate - (self, arg) -
-Get raw material rate as per selected method, if bom exists takes bom cost
-
-- - - get_valuation_rate - (self, args) -
-Get weighted average of valuation rate from all warehouses
-- - - manage_default_bom - (self) -
-Uncheck others if current one is selected as default, - update default bom in item master
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - on_update_after_submit - (self) -
-No docs
-- - - set_bom_material_details - (self) -
-No docs
-- - - set_conversion_rate - (self) -
-No docs
-- - - traverse_tree - (self, bom_list=None) -
-No docs
-- - - update_cost - (self, update_parent=True, from_child_bom=False) -
-No docs
-- - - update_cost_and_exploded_items - (self, bom_list=[]) -
-No docs
-- - - update_exploded_items - (self) -
-Update Flat BOM, following will be correct data
-- - - update_parent_cost - (self) -
-No docs
-- - - update_stock_qty - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_bom_currecny - (self, item) -
-No docs
-- - - validate_bom_links - (self) -
-No docs
-- - - validate_currency - (self) -
-No docs
-- - - validate_main_item - (self) -
-Validate main FG item
-- - - validate_materials - (self) -
-Validate raw material entries
-- - - validate_operations - (self) -
-No docs
-- - - validate_rm_item - (self, item) -
-No docs
-- - - validate_uom_is_interger - (self) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.bom.bom.get_bom_items
-
- - - erpnext.manufacturing.doctype.bom.bom.get_bom_items - (bom, company, qty=1, fetch_exploded=1) -
-No docs
-- - - erpnext.manufacturing.doctype.bom.bom.get_bom_items_as_dict - (bom, company, qty=1, fetch_exploded=1, fetch_scrap_items=0) -
-No docs
-- - - erpnext.manufacturing.doctype.bom.bom.get_boms_in_bottom_up_order - (bom_no=None) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.bom.bom.get_children
-
- - - erpnext.manufacturing.doctype.bom.bom.get_children - (doctype, parent=None, is_root=False) -
-No docs
-- - - erpnext.manufacturing.doctype.bom.bom.get_list_context - (context) -
-No docs
-- - - erpnext.manufacturing.doctype.bom.bom.validate_bom_no - (item, bom_no) -
-Validate BOM No of sub-contracted items
-Table Name: tabBOM Explosion Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -cb |
- - Column Break | -- - - | -- |
| 3 | -item_name |
- - Data | -- Item Name - - | -- |
| 4 | -source_warehouse |
- - Link | -- Source Warehouse - - | -- - - - -Warehouse - - - - | -
| 5 | -section_break_3 |
- - Section Break | -- - - | -- |
| 6 | -description |
- - Text Editor | -- Description - - | -- |
| 7 | -column_break_2 |
- - Column Break | -- - - | -- |
| 8 | -image |
- - Attach | -- Image - - | -- |
| 9 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 10 | -section_break_4 |
- - Section Break | -- - - | -- |
| 11 | -stock_qty |
- - Float | -- Stock Qty - - | -- |
| 12 | -rate |
- - Currency | -- Rate - - | -
- Company:company:default_currency- |
-
| 13 | -qty_consumed_per_unit |
- - Float | -- Qty Consumed Per Unit - - | -- |
| 14 | -column_break_8 |
- - Column Break | -- - - | -- |
| 15 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 16 | -amount |
- - Currency | -- Amount - - | -
- Company:company:default_currency- |
-
Table Name: tabBOM Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -item_name |
- - Data | -- Item Name - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -bom_no |
- - Link | -- BOM No - - | -- - - - -BOM - - - - | -
| 5 | -source_warehouse |
- - Link | -- Source Warehouse - - | -- - - - -Warehouse - - - - | -
| 6 | -section_break_5 |
- - Section Break | -- Description - - | -- |
| 7 | -description |
- - Text Editor | -- Item Description - - | -- |
| 8 | -col_break1 |
- - Column Break | -- - - | -- |
| 9 | -image |
- - Attach | -- Image - - | -- |
| 10 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 11 | -quantity_and_rate |
- - Section Break | -- Quantity and Rate - - | -- |
| 12 | -qty |
- - Float | -- Qty - - | -- |
| 13 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 14 | -col_break2 |
- - Column Break | -- - - | -- |
| 15 | -stock_qty |
- - Float | -- Stock Qty - - | -- |
| 16 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 17 | -conversion_factor |
- - Float | -- Conversion Factor - - | -- |
| 18 | -rate_amount_section |
- - Section Break | -- Rate & Amount - - | -- |
| 19 | -rate |
- - Currency | -- Rate - - | -
- currency- |
-
| 20 | -base_rate |
- - Currency | -- Basic Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 21 | -column_break_21 |
- - Column Break | -- - - | -- |
| 22 | -amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 23 | -base_amount |
- - Currency | -- Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 24 | -section_break_18 |
- - Section Break | -- - - | -- |
| 25 | -scrap |
- - Float | -- Scrap % - - | -- |
| 26 | -qty_consumed_per_unit |
- - Float | -- Qty Consumed Per Unit - - | -- |
| 27 | -section_break_27 |
- - Section Break | -- - - | -- |
| 28 | -allow_alternative_item |
- - Check | -- Allow Alternative Item - - | -- |
| 29 | -original_item |
- - Link | -- Original Item - - | -- - - - -Item - - - - | -
Table Name: tabBOM Operation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -operation |
- - Link | -- Operation - - | -- - - - -Operation - - - - | -
| 2 | -workstation |
- - Link | -- Workstation - - | -- - - - -Workstation - - - - | -
| 3 | -description |
- - Text Editor | -- Description - - | -- |
| 4 | -col_break1 |
- - Column Break | -- - - | -- |
| 5 | -hour_rate |
- - Currency | -- Hour Rate - - | -
- currency- |
-
| 6 | -time_in_mins |
- - Float | -
- Operation Time
- - In minutes - |
- - |
| 7 | -operating_cost |
- - Currency | -- Operating Cost - - | -
- currency- |
-
| 8 | -base_hour_rate |
- - Currency | -- Base Hour Rate(Company Currency) - - | -
- Company:company:default_currency- |
-
| 9 | -base_operating_cost |
- - Currency | -- Operating Cost(Company Currency) - - | -
- Company:company:default_currency- |
-
| 10 | -image |
- - Attach | -- Image - - | -- |
Table Name: tabBOM Scrap Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -item_name |
- - Data | -- Item Name - - | -- |
| 3 | -quantity_and_rate |
- - Section Break | -- Quantity and Rate - - | -- |
| 4 | -stock_qty |
- - Float | -- Qty - - | -- |
| 5 | -rate |
- - Currency | -- Rate - - | -
- currency- |
-
| 6 | -amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 7 | -column_break_6 |
- - Column Break | -- - - | -- |
| 8 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 9 | -base_rate |
- - Currency | -- Basic Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 10 | -base_amount |
- - Currency | -- Basic Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -replace_bom_section |
- - Section Break | -- Replace BOM - - | -- |
| 2 | -current_bom |
- - Link | -
- Current BOM
- - The BOM which will be replaced - |
- - - - - -BOM - - - - | -
| 3 | -new_bom |
- - Link | -
- New BOM
- - The new BOM after replacement - |
- - - - - -BOM - - - - | -
| 4 | -replace |
- - Button | -- Replace - - | -
- replace_bom- |
-
| 5 | -update_cost_section |
- - Section Break | -- Update Cost - - | -- |
| 6 | -update_latest_price_in_all_boms |
- - Button | -- Update latest price in all BOMs - - | -- |
Inherits from frappe.model.document.Document - -
- - - get_parent_boms - (self, bom, bom_list=None) -
-No docs
-- - - replace_bom - (self) -
-No docs
-- - - update_new_bom - (self) -
-No docs
-- - - validate_bom - (self) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool.enqueue_update_cost
-
- - - erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool.enqueue_update_cost - () -
-No docs
-- - - erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool.update_cost - () -
-No docs
-- - - erpnext.manufacturing.doctype.bom_update_tool.bom_update_tool.update_latest_price_in_all_boms - () -
-No docs
-Table Name: tabBOM Website Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -item_name |
- - Data | -- Item Name - - | -
- Workstation- |
-
| 3 | -description |
- - Text Editor | -- Item Description - - | -- |
| 4 | -qty |
- - Float | -- Qty - - | -- |
| 5 | -website_image |
- - Attach | -- Image - - | -- |
Table Name: tabBOM Website Operation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -operation |
- - Link | -- Operation - - | -- - - - -Operation - - - - | -
| 2 | -workstation |
- - Link | -- Workstation - - | -- - - - -Workstation - - - - | -
| 3 | -time_in_mins |
- - Float | -- Operation Time - - | -- |
| 4 | -website_image |
- - Attach | -- Image - - | -- |
| 5 | -thumbnail |
- - Data | -- Thumbnail - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -capacity_planning |
- - Section Break | -- Capacity Planning - - | -- |
| 2 | -disable_capacity_planning |
- - Check | -
- Disable Capacity Planning and Time Tracking
- - Disables creation of time logs against Work Orders. Operations shall not be tracked against Work Order - |
- - |
| 3 | -allow_overtime |
- - Check | -
- Allow Overtime
- - Plan time logs outside Workstation Working Hours. - |
- - |
| 4 | -allow_production_on_holidays |
- - Check | -- Allow Production on Holidays - - | -- |
| 5 | -column_break_3 |
- - Column Break | -- - - | -- |
| 6 | -capacity_planning_for_days |
- - Int | -
- Capacity Planning For (Days)
- - Try planning operations for X days in advance. - |
- - |
| 7 | -mins_between_operations |
- - Int | -
- Time Between Operations (in mins)
- - Default 10 mins - |
- - |
| 8 | -section_break_6 |
- - Section Break | -- - - | -- |
| 9 | -overproduction_percentage_for_sales_order |
- - Percent | -- Overproduction Percentage For Sales Order - - | -- |
| 10 | -overproduction_percentage_for_work_order |
- - Percent | -- Overproduction Percentage For Work Order - - | -- |
| 11 | -backflush_raw_materials_based_on |
- - Select | -- Backflush Raw Materials Based On - - | -
- BOM -Material Transferred for Manufacture- |
-
| 12 | -material_consumption |
- - Check | -
- Allow Multiple Material Consumption
- - Allow multiple Material Consumption against a Work Order - |
- - |
| 13 | -update_bom_costs_automatically |
- - Check | -
- Update BOM Cost Automatically
- - Update BOM cost automatically via Scheduler, based on latest valuation rate / price list rate / last purchase rate of raw materials. - |
- - |
| 14 | -column_break_11 |
- - Column Break | -- - - | -- |
| 15 | -default_wip_warehouse |
- - Link | -- Default Work In Progress Warehouse - - | -- - - - -Warehouse - - - - | -
| 16 | -default_fg_warehouse |
- - Link | -- Default Finished Goods Warehouse - - | -- - - - -Warehouse - - - - | -
Inherits from frappe.model.document.Document - -
- - - erpnext.manufacturing.doctype.manufacturing_settings.manufacturing_settings.get_mins_between_operations - () -
-No docs
-Table Name: tabMaterial Request Plan Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -item_name |
- - Data | -- Item Name - - | -- |
| 3 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -quantity |
- - Float | -- Quantity - - | -- |
| 6 | -actual_qty |
- - Float | -- Actual Qty - - | -- |
| 7 | -min_order_qty |
- - Float | -- Minimum Order Quantity - - | -- |
| 8 | -section_break_8 |
- - Section Break | -- Reference - - | -- |
| 9 | -sales_order |
- - Link | -- Sales Order - - | -- - - - -Sales Order - - - - | -
| 10 | -requested_qty |
- - Float | -- Requested Qty - - | -- |
Table Name: tabOperation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -workstation |
- - Link | -- Default Workstation - - | -- - - - -Workstation - - - - | -
| 2 | -section_break_4 |
- - Section Break | -- - - | -- |
| 3 | -description |
- - Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabProduction Plan
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Naming Series - - | -
- PLN-- |
-
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -get_items_from |
- - Select | -- Get Items From - - | -
- -Sales Order -Material Request- |
-
| 4 | -column_break1 |
- - Column Break | -- - - | -- |
| 5 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 6 | -filters |
- - Section Break | -- Filters - - | -- |
| 7 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 8 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 9 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 10 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 11 | -column_break2 |
- - Column Break | -- - - | -- |
| 12 | -from_date |
- - Date | -- From Date - - | -- |
| 13 | -to_date |
- - Date | -- To Date - - | -- |
| 14 | -sales_orders_detail |
- - Section Break | -- Sales Orders Detail - - | -- |
| 15 | -get_sales_orders |
- - Button | -- Get Sales Orders - - | -- |
| 16 | -sales_orders |
- - Table | -- Sales Orders - - | -- - - - -Production Plan Sales Order - - - - | -
| 17 | -material_request_detail |
- - Section Break | -- Material Request Detail - - | -- |
| 18 | -get_material_request |
- - Button | -- Get Material Request - - | -- |
| 19 | -material_requests |
- - Table | -- Material Requests - - | -- - - - -Production Plan Material Request - - - - | -
| 20 | -items_for_production |
- - Section Break | -- Select Items - - | -- |
| 21 | -get_items |
- - Button | -- Get Items For Work Order - - | -- |
| 22 | -po_items |
- - Table | -- Items - - | -- - - - -Production Plan Item - - - - | -
| 23 | -material_request_planning |
- - Section Break | -- Material Request Planning - - | -- |
| 24 | -include_non_stock_items |
- - Check | -- Include Non Stock Items - - | -- |
| 25 | -ignore_existing_ordered_qty |
- - Check | -- Ignore Existing Ordered Quantity - - | -- |
| 26 | -column_break_25 |
- - Column Break | -- - - | -- |
| 27 | -include_subcontracted_items |
- - Check | -- Include Subcontracted Items - - | -- |
| 28 | -section_break_27 |
- - Section Break | -- - - | -- |
| 29 | -get_items_for_mr |
- - Button | -- Get Raw Materials For Production - - | -- |
| 30 | -mr_items |
- - Table | -- Material Request Plan Item - - | -- - - - -Material Request Plan Item - - - - | -
| 31 | -other_details |
- - Section Break | -- Other Details - - | -- |
| 32 | -total_planned_qty |
- - Float | -- Total Planned Qty - - | -- |
| 33 | -total_produced_qty |
- - Float | -- Total Produced Qty - - | -- |
| 34 | -column_break_32 |
- - Column Break | -- - - | -- |
| 35 | -status |
- - Select | -- Status - - | -
- -Draft -Submitted -Not Started -In Process -Completed -Stopped -Cancelled -Material Requested- |
-
| 36 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Production Plan - - - - | -
Inherits from frappe.model.document.Document - -
- - - add_item_in_material_request_items - (self, item, row, data) -
-No docs
-- - - add_items - (self, items) -
-No docs
-- - - add_mr_in_table - (self, pending_mr) -
-Add Material Requests in the table
-- - - add_so_in_table - (self, open_so) -
-Add sales orders in the table
-- - - calculate_total_planned_qty - (self) -
-No docs
-- - - calculate_total_produced_qty - (self) -
-No docs
-- - - create_work_order - (self, item) -
-No docs
-- - - delete_draft_work_order - (self) -
-No docs
-- - - get_items - (self) -
-No docs
-- - - get_items_for_material_requests - (self) -
-No docs
-- - - get_itemwise_qty - (self) -
-No docs
-- - - get_mr_items - (self) -
-No docs
-- - - get_open_sales_orders - (self) -
-Pull sales orders which are pending to deliver based on criteria selected
-- - - get_pending_material_requests - (self) -
-Pull Material Requests that are pending based on criteria selected
-- - - get_production_items - (self) -
-No docs
-- - - get_so_items - (self) -
-No docs
-- - - get_subitems - (self, data, bom_wise_item_details, bom_no, parent_qty) -
-No docs
-- - - make_material_request - (self) -
-No docs
-- - - make_work_order - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - set_status - (self) -
-No docs
-- - - update_ordered_status - (self) -
-No docs
-- - - update_produced_qty - (self, produced_qty, production_plan_item) -
-No docs
-- - - update_requested_status - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_data - (self) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.production_plan.production_plan.get_bin_details
-
- - - erpnext.manufacturing.doctype.production_plan.production_plan.get_bin_details - (row) -
-No docs
-- - - erpnext.manufacturing.doctype.production_plan.production_plan.get_sales_orders - (self) -
-No docs
-Table Name: tabProduction Plan Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -include_exploded_items |
- - Check | -- Include Exploded Items - - | -- |
| 2 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 3 | -bom_no |
- - Link | -- BOM No - - | -- - - - -BOM - - - - | -
| 4 | -planned_qty |
- - Float | -- Planned Qty - - | -- |
| 5 | -planned_start_date |
- - Datetime | -- Planned Start Date - - | -- |
| 6 | -column_break_6 |
- - Column Break | -- - - | -- |
| 7 | -warehouse |
- - Link | -
- Warehouse
- - Reserved Warehouse in Sales Order / Finished Goods Warehouse - |
- - - - - -Warehouse - - - - | -
| 8 | -produced_qty |
- - Float | -- Produced Qty - - | -- |
| 9 | -sales_order |
- - Link | -- Sales Order - - | -- - - - -Sales Order - - - - | -
| 10 | -sales_order_item |
- - Data | -- Sales Order Item - - | -- |
| 11 | -material_request |
- - Link | -- Material Request - - | -- - - - -Material Request - - - - | -
| 12 | -pending_qty |
- - Float | -- Pending Qty - - | -- |
| 13 | -stock_uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 14 | -description |
- - Text Editor | -- Description - - | -- |
| 15 | -material_request_item |
- - Data | -- material_request_item - - | -- |
| 16 | -ordered_qty |
- - Float | -- Ordered Qty - - | -- |
| 17 | -product_bundle_item |
- - Link | -- Product Bundle Item - - | -- - - - -Item - - - - | -
Table Name: tabProduction Plan Material Request
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -material_request |
- - Link | -- Material Request - - | -- - - - -Material Request - - - - | -
| 2 | -col_break1 |
- - Column Break | -- - - | -- |
| 3 | -material_request_date |
- - Date | -- Material Request Date - - | -- |
Table Name: tabProduction Plan Sales Order
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -sales_order |
- - Link | -- Sales Order - - | -- - - - -Sales Order - - - - | -
| 2 | -sales_order_date |
- - Date | -- Sales Order Date - - | -- |
| 3 | -col_break1 |
- - Column Break | -- - - | -- |
| 4 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 5 | -grand_total |
- - Currency | -- Grand Total - - | -- |
Table Name: tabWork Order
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item |
- - Section Break | -- - - | -
- fa fa-gift- |
-
| 2 | -naming_series |
- - Select | -- Series - - | -
- WO-- |
-
| 3 | -status |
- - Select | -- Status - - | -
- -Draft -Submitted -Not Started -In Process -Completed -Stopped -Cancelled- |
-
| 4 | -production_item |
- - Link | -- Item To Manufacture - - | -- - - - -Item - - - - | -
| 5 | -bom_no |
- - Link | -- BOM No - - | -- - - - -BOM - - - - | -
| 6 | -use_multi_level_bom |
- - Check | -
- Use Multi-Level BOM
- - Plan material for sub-assemblies - |
- - |
| 7 | -allow_alternative_item |
- - Check | -- Allow Alternative Item - - | -- |
| 8 | -column_break1 |
- - Column Break | -- - - | -- |
| 9 | -qty |
- - Float | -- Qty To Manufacture - - | -- |
| 10 | -material_transferred_for_manufacturing |
- - Float | -- Material Transferred for Manufacturing - - | -- |
| 11 | -produced_qty |
- - Float | -- Manufactured Qty - - | -- |
| 12 | -sales_order |
- - Link | -- Sales Order - - | -- - - - -Sales Order - - - - | -
| 13 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 14 | -skip_transfer |
- - Check | -
- Skip Material Transfer
- - Check if material transfer entry is not required - |
- - |
| 15 | -warehouses |
- - Section Break | -- Warehouses - - | -
- fa fa-building- |
-
| 16 | -wip_warehouse |
- - Link | -- Work-in-Progress Warehouse - - | -- - - - -Warehouse - - - - | -
| 17 | -fg_warehouse |
- - Link | -- Target Warehouse - - | -- - - - -Warehouse - - - - | -
| 18 | -column_break_12 |
- - Column Break | -- - - | -- |
| 19 | -scrap_warehouse |
- - Link | -- Scrap Warehouse - - | -- - - - -Warehouse - - - - | -
| 20 | -required_items_section |
- - Section Break | -- Required Items - - | -- |
| 21 | -required_items |
- - Table | -- Required Items - - | -- - - - -Work Order Item - - - - | -
| 22 | -time |
- - Section Break | -- Time - - | -
- fa fa-time- |
-
| 23 | -planned_start_date |
- - Datetime | -- Planned Start Date - - | -- |
| 24 | -actual_start_date |
- - Datetime | -- Actual Start Date - - | -- |
| 25 | -column_break_13 |
- - Column Break | -- - - | -- |
| 26 | -planned_end_date |
- - Datetime | -- Planned End Date - - | -- |
| 27 | -actual_end_date |
- - Datetime | -- Actual End Date - - | -- |
| 28 | -expected_delivery_date |
- - Date | -- Expected Delivery Date - - | -- |
| 29 | -operations_section |
- - Section Break | -- Operations - - | -
- fa fa-wrench- |
-
| 30 | -operations |
- - Table | -- Operations - - | -- - - - -Work Order Operation - - - - | -
| 31 | -section_break_22 |
- - Section Break | -- Operation Cost - - | -- |
| 32 | -planned_operating_cost |
- - Currency | -- Planned Operating Cost - - | -
- Company:company:default_currency- |
-
| 33 | -actual_operating_cost |
- - Currency | -- Actual Operating Cost - - | -
- Company:company:default_currency- |
-
| 34 | -additional_operating_cost |
- - Currency | -- Additional Operating Cost - - | -
- Company:company:default_currency- |
-
| 35 | -column_break_24 |
- - Column Break | -- - - | -- |
| 36 | -total_operating_cost |
- - Currency | -- Total Operating Cost - - | -
- Company:company:default_currency- |
-
| 37 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 38 | -description |
- - Small Text | -- Item Description - - | -- |
| 39 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 40 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 41 | -column_break2 |
- - Column Break | -- - - | -- |
| 42 | -material_request |
- - Link | -
- Material Request
- - Manufacture against Material Request - |
- - - - - -Material Request - - - - | -
| 43 | -material_request_item |
- - Data | -- Material Request Item - - | -- |
| 44 | -sales_order_item |
- - Data | -- Sales Order Item - - | -- |
| 45 | -production_plan |
- - Link | -- Production Plan - - | -- - - - -Production Plan - - - - | -
| 46 | -production_plan_item |
- - Data | -- Production Plan Item - - | -- |
| 47 | -product_bundle_item |
- - Link | -- Product Bundle Item - - | -- - - - -Item - - - - | -
| 48 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Work Order - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - before_submit - (self) -
-No docs
-- - - calculate_operating_cost - (self) -
-No docs
-- - - calculate_time - (self) -
-No docs
-- - - check_operation_fits_in_working_hours - (self, d) -
-Raises expection if operation is longer than working hours in the given workstation.
-- - - delete_timesheet - (self) -
-No docs
-- - - get_holidays - (self, workstation) -
-No docs
-- - - get_items_and_operations_from_bom - (self) -
-No docs
-- - - get_operations_data - (self, data) -
-No docs
-- - - get_start_end_time - (self, timesheet, operation_id) -
-No docs
-- - - get_status - (self, status=None) -
-Return the status based on stock entries against this work order
-- - - make_time_logs - (self, open_new=False) -
-Capacity Planning. Plan time logs based on earliest availablity of workstation after - Planned Start Date. Time logs will be created and remain in Draft mode and must be submitted - before manufacturing entry can be made.
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - set_actual_dates - (self) -
-No docs
-- - - set_available_qty - (self) -
-No docs
-- - - set_default_warehouse - (self) -
-No docs
-- - - set_required_items - (self, reset_only_qty=False) -
-set required_items for production to keep track of reserved qty
-- - - set_start_end_time_for_workstation - (self, data, index) -
-Set start and end time for given operation. If first operation, set start as
- planned_start_date, else add time diff to end time of earlier operation.
- - - set_work_order_operations - (self) -
-Fetch operations from BOM and set in 'Work Order'
-- - - update_completed_qty_in_material_request - (self) -
-No docs
-- - - update_consumed_qty_for_required_items - (self) -
-update consumed qty from submitted stock entries for that item against - the work order
-- - - update_operation_status - (self) -
-No docs
-- - - update_ordered_qty - (self) -
-No docs
-- - - update_planned_qty - (self) -
-No docs
-- - - update_production_plan_status - (self) -
-No docs
-- - - update_required_items - (self) -
- update bin reserved_qty_for_production
- called from Stock Entry for production, after submit, cancel
-
-- - - update_reserved_qty_for_production - (self, items=None) -
-update reservedqtyfor_production in bins
-- - - update_status - (self, status=None) -
-Update status of work order if unknown
-- - - update_transaferred_qty_for_required_items - (self) -
-update transferred qty from submitted stock entries for that item against - the work order
-- - - update_work_order_qty - (self) -
-Update Manufactured Qty and Material Transferred for Qty in Work Order - based on Stock Entry
-- - - update_work_order_qty_in_so - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_cancel - (self) -
-No docs
-- - - validate_operation_time - (self) -
-No docs
-- - - validate_production_item - (self) -
-No docs
-- - - validate_qty - (self) -
-No docs
-- - - validate_sales_order - (self) -
-No docs
-- - - validate_warehouse_belongs_to_company - (self) -
-No docs
-- - - validate_work_order_against_so - (self) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.work_order.work_order.add_timesheet_detail
-
- - - erpnext.manufacturing.doctype.work_order.work_order.add_timesheet_detail - (timesheet, args) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.work_order.work_order.check_if_scrap_warehouse_mandatory
-
- - - erpnext.manufacturing.doctype.work_order.work_order.check_if_scrap_warehouse_mandatory - (bom_no) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.work_order.work_order.get_default_warehouse
-
- - - erpnext.manufacturing.doctype.work_order.work_order.get_default_warehouse - () -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.work_order.work_order.get_item_details
-
- - - erpnext.manufacturing.doctype.work_order.work_order.get_item_details - (item, project=None) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.work_order.work_order.make_new_timesheet
-
- - - erpnext.manufacturing.doctype.work_order.work_order.make_new_timesheet - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.work_order.work_order.make_stock_entry
-
- - - erpnext.manufacturing.doctype.work_order.work_order.make_stock_entry - (work_order_id, purpose, qty=None) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.work_order.work_order.make_timesheet
-
- - - erpnext.manufacturing.doctype.work_order.work_order.make_timesheet - (work_order, company) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.work_order.work_order.query_sales_order
-
- - - erpnext.manufacturing.doctype.work_order.work_order.query_sales_order - (production_item) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.work_order.work_order.set_work_order_ops
-
- - - erpnext.manufacturing.doctype.work_order.work_order.set_work_order_ops - (name) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.work_order.work_order.stop_unstop
-
- - - erpnext.manufacturing.doctype.work_order.work_order.stop_unstop - (work_order, status) -
-Called from client side on Stop/Unstop event
-Table Name: tabWork Order Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -source_warehouse |
- - Link | -- Source Warehouse - - | -- - - - -Warehouse - - - - | -
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -item_name |
- - Data | -- Item Name - - | -- |
| 5 | -description |
- - Text | -- Description - - | -- |
| 6 | -qty_section |
- - Section Break | -- Qty - - | -- |
| 7 | -required_qty |
- - Float | -- Required Qty - - | -- |
| 8 | -transferred_qty |
- - Float | -- Transferred Qty - - | -- |
| 9 | -allow_alternative_item |
- - Check | -- Allow Alternative Item - - | -- |
| 10 | -consumed_qty |
- - Float | -- Consumed Qty - - | -- |
| 11 | -available_qty_at_source_warehouse |
- - Float | -- Available Qty at Source Warehouse - - | -- |
| 12 | -available_qty_at_wip_warehouse |
- - Float | -- Available Qty at WIP Warehouse - - | -- |
Table Name: tabWork Order Operation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -details |
- - Section Break | -- - - | -- |
| 2 | -operation |
- - Link | -- Operation - - | -- - - - -Operation - - - - | -
| 3 | -bom |
- - Link | -- BOM - - | -- - - - -BOM - - - - | -
| 4 | -description |
- - Text Editor | -- Operation Description - - | -- |
| 5 | -col_break1 |
- - Column Break | -- - - | -- |
| 6 | -completed_qty |
- - Float | -
- Completed Qty
- - Operation completed for how many finished goods? - |
- - |
| 7 | -status |
- - Select | -- Status - - | -
- Pending -Work in Progress -Completed- |
-
| 8 | -workstation |
- - Link | -- Workstation - - | -- - - - -Workstation - - - - | -
| 9 | -estimated_time_and_cost |
- - Section Break | -- Estimated Time and Cost - - | -- |
| 10 | -planned_start_time |
- - Datetime | -- Planned Start Time - - | -- |
| 11 | -planned_end_time |
- - Datetime | -- Planned End Time - - | -- |
| 12 | -column_break_10 |
- - Column Break | -- - - | -- |
| 13 | -time_in_mins |
- - Float | -
- Operation Time
- - in Minutes - |
- - |
| 14 | -hour_rate |
- - Float | -- Hour Rate - - | -- |
| 15 | -planned_operating_cost |
- - Currency | -- Planned Operating Cost - - | -
- Company:company:default_currency- |
-
| 16 | -section_break_9 |
- - Section Break | -- Actual Time and Cost - - | -- |
| 17 | -actual_start_time |
- - Datetime | -- Actual Start Time - - | -- |
| 18 | -actual_end_time |
- - Datetime | -
- Actual End Time
- - Updated via 'Time Log' - |
- - |
| 19 | -column_break_11 |
- - Column Break | -- - - | -- |
| 20 | -actual_operation_time |
- - Float | -
- Actual Operation Time
- - in Minutes -Updated via 'Time Log' - |
- - |
| 21 | -actual_operating_cost |
- - Currency | -
- Actual Operating Cost
- - (Hour Rate / 60) * Actual Operation Time - |
-
- Company:company:default_currency- |
-
Table Name: tabWorkstation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -description_section |
- - Section Break | -- Description - - | -- |
| 2 | -workstation_name |
- - Data | -- Workstation Name - - | -- |
| 3 | -description |
- - Text | -- Description - - | -- |
| 4 | -over_heads |
- - Section Break | -- Operating Costs - - | -- |
| 5 | -hour_rate_electricity |
- - Currency | -
- Electricity Cost
- - per hour - |
- - |
| 6 | -hour_rate_consumable |
- - Currency | -
- Consumable Cost
- - per hour - |
- - |
| 7 | -column_break_11 |
- - Column Break | -- - - | -- |
| 8 | -hour_rate_rent |
- - Currency | -
- Rent Cost
- - per hour - |
- - |
| 9 | -hour_rate_labour |
- - Currency | -
- Wages
- - Wages per hour - |
- - |
| 10 | -hour_rate |
- - Currency | -
- Net Hour Rate
- - per hour - |
- - |
| 11 | -working_hours_section |
- - Section Break | -- Working Hours - - | -- |
| 12 | -working_hours |
- - Table | -- Working Hours - - | -- - - - -Workstation Working Hour - - - - | -
| 13 | -holiday_list |
- - Link | -- Holiday List - - | -- - - - -Holiday List - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - on_update - (self) -
-No docs
-- - - update_bom_operation - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_overlap_for_operation_timings - (self) -
-Check if there is no overlap in setting Workstation Operating Hours
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.manufacturing.doctype.workstation.workstation.check_if_within_operating_hours - (workstation, operation, from_datetime, to_datetime) -
-No docs
-- - - erpnext.manufacturing.doctype.workstation.workstation.check_workstation_for_holiday - (workstation, from_datetime, to_datetime) -
-No docs
-Public API
- /api/method/erpnext.manufacturing.doctype.workstation.workstation.get_default_holiday_list
-
- - - erpnext.manufacturing.doctype.workstation.workstation.get_default_holiday_list - () -
-No docs
-- - - erpnext.manufacturing.doctype.workstation.workstation.is_within_operating_hours - (workstation, operation, from_datetime, to_datetime) -
-No docs
-Table Name: tabWorkstation Working Hour
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -start_time |
- - Time | -- Start Time - - | -- |
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -end_time |
- - Time | -- End Time - - | -- |
| 4 | -enabled |
- - Check | -- Enabled - - | -- |
Table Name: tabChapter
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -chapter_head |
- - Link | -- Chapter Head - - | -- - - - -Member - - - - | -
| 2 | -column_break_3 |
- - Column Break | -- - - | -- |
| 3 | -region |
- - Data | -- Region - - | -- |
| 4 | -section_break_5 |
- - Section Break | -- - - | -- |
| 5 | -introduction |
- - Text Editor | -- Introduction - - | -- |
| 6 | -meetup_embed_html |
- - Code | -- Meetup Embed HTML - - | -- |
| 7 | -address |
- - Text | -- Address - - | -- |
| 8 | -route |
- - Data | -
- Route
- - chapters/chapter_name -leave blank automatically set after saving chapter. - |
- - |
| 9 | -published |
- - Check | -- Published - - | -- |
| 10 | -chapter_members |
- - Section Break | -- Chapter Members - - | -- |
| 11 | -members |
- - Table | -- Members - - | -- - - - -Chapter Member - - - - | -
Inherits from frappe.website.website_generator.WebsiteGenerator - -
- - - enable - (self) -
-No docs
-- - - get_context - (self, context) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.non_profit.doctype.chapter.chapter.get_list_context - (context) -
-No docs
-Public API
- /api/method/erpnext.non_profit.doctype.chapter.chapter.leave
-
- - - erpnext.non_profit.doctype.chapter.chapter.leave - (title, user_id, leave_reason) -
-No docs
-Table Name: tabChapter Member
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -user |
- - Link | -- User - - | -- - - - -User - - - - | -
| 2 | -introduction |
- - Data | -- Introduction - - | -- |
| 3 | -website_url |
- - Data | -- Website URL - - | -- |
| 4 | -enabled |
- - Check | -- Enabled - - | -- |
| 5 | -leave_reason |
- - Data | -- Leave Reason - - | -- |
Table Name: tabDonor
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -donor_name |
- - Data | -- Donor Name - - | -- |
| 2 | -column_break_5 |
- - Column Break | -- - - | -- |
| 3 | -donor_type |
- - Link | -- Donor Type - - | -- - - - -Donor Type - - - - | -
| 4 | -email |
- - Data | -- Email - - | -- |
| 5 | -image |
- - Attach Image | -- Image - - | -- |
| 6 | -address_contacts |
- - Section Break | -- Address and Contact - - | -
- fa fa-map-marker- |
-
| 7 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 8 | -column_break_9 |
- - Column Break | -- - - | -- |
| 9 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabDonor Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -donor_type |
- - Data | -- Donor Type - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabGrant Application
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -applicant_type |
- - Select | -- Applicant Type - - | -
- Individual -Organization- |
-
| 2 | -applicant_name |
- - Data | -- Name - - | -- |
| 3 | -contact_person |
- - Data | -- Contact Person - - | -- |
| 4 | -email |
- - Data | -- Email - - | -- |
| 5 | -column_break_5 |
- - Column Break | -- - - | -- |
| 6 | -status |
- - Select | -- Status - - | -
- Open -Received -In Progress -Approved -Rejected -Expired -Withdrawn- |
-
| 7 | -website_url |
- - Data | -- Website URL - - | -- |
| 8 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 9 | -address_contacts |
- - Section Break | -- Address and Contact - - | -
- fa fa-map-marker- |
-
| 10 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 11 | -column_break_9 |
- - Column Break | -- - - | -- |
| 12 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
| 13 | -grant_application_details |
- - Section Break | -- Grant Application Details - - | -- |
| 14 | -grant_description |
- - Long Text | -- Grant Description - - | -- |
| 15 | -section_break_15 |
- - Section Break | -- - - | -- |
| 16 | -amount |
- - Currency | -- Requested Amount - - | -- |
| 17 | -has_any_past_grant_record |
- - Check | -- Has any past Grant Record - - | -- |
| 18 | -column_break_17 |
- - Column Break | -- - - | -- |
| 19 | -route |
- - Data | -- Route - - | -- |
| 20 | -published |
- - Check | -- Show on Website - - | -- |
| 21 | -assessment_result |
- - Section Break | -- Assessment Result - - | -- |
| 22 | -assessment_mark |
- - Float | -- Assessment Mark (Out of 10) - - | -- |
| 23 | -note |
- - Small Text | -- Note - - | -- |
| 24 | -column_break_24 |
- - Column Break | -- - - | -- |
| 25 | -assessment_manager |
- - Link | -- Assessment Manager - - | -- - - - -User - - - - | -
| 26 | -email_notification_sent |
- - Check | -- Email Notification Sent - - | -- |
Inherits from frappe.website.website_generator.WebsiteGenerator - -
- - - get_context - (self, context) -
-No docs
-- - - onload - (self) -
-Load address and contacts in __onload
- - - validate - (self) -
-No docs
-- - - erpnext.non_profit.doctype.grant_application.grant_application.get_list_context - (context) -
-No docs
-Public API
- /api/method/erpnext.non_profit.doctype.grant_application.grant_application.send_grant_review_emails
-
- - - erpnext.non_profit.doctype.grant_application.grant_application.send_grant_review_emails - (grant_application) -
-No docs
-Table Name: tabMember
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- MEM-- |
-
| 2 | -member_name |
- - Data | -- Member Name - - | -- |
| 3 | -membership_expiry_date |
- - Date | -- Membership Expiry Date - - | -- |
| 4 | -column_break_5 |
- - Column Break | -- - - | -- |
| 5 | -membership_type |
- - Link | -- Membership Type - - | -- - - - -Membership Type - - - - | -
| 6 | -email |
- - Link | -- Email - - | -- - - - -User - - - - | -
| 7 | -image |
- - Attach Image | -- Image - - | -- |
| 8 | -customer_section |
- - Section Break | -- Customer - - | -- |
| 9 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 10 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 11 | -supplier_section |
- - Section Break | -- Supplier - - | -- |
| 12 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 13 | -address_contacts |
- - Section Break | -- Address and Contact - - | -
- fa fa-map-marker- |
-
| 14 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 15 | -column_break_9 |
- - Column Break | -- - - | -- |
| 16 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
Inherits from frappe.model.document.Document - -
- - - onload - (self) -
-Load address and contacts in __onload
- - - validate - (self) -
-No docs
-- - - validate_email_type - (self, email) -
-No docs
-Table Name: tabMembership
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -member |
- - Link | -- Member - - | -- - - - -Member - - - - | -
| 2 | -membership_type |
- - Link | -- Membership Type - - | -- - - - -Membership Type - - - - | -
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -membership_status |
- - Select | -- Membership Status - - | -
- New -Current -Expired -Pending -Cancelled- |
-
| 5 | -membership_validaty_section |
- - Section Break | -- membership validaty section - - | -- |
| 6 | -from_date |
- - Date | -- From - - | -- |
| 7 | -to_date |
- - Date | -- To - - | -- |
| 8 | -column_break_8 |
- - Column Break | -- - - | -- |
| 9 | -member_since_date |
- - Date | -- Member Since - - | -- |
| 10 | -payment_details |
- - Section Break | -- Payment Details - - | -- |
| 11 | -paid |
- - Check | -- Paid - - | -- |
| 12 | -currency |
- - Select | -- Currency - - | -
- USD -INR- |
-
| 13 | -amount |
- - Float | -- Amount - - | -- |
Inherits from frappe.model.document.Document - -
- - - on_payment_authorized - (self, status_changed_to=None) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabMembership Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -membership_type |
- - Data | -- Membership Type - - | -- |
| 2 | -amount |
- - Float | -- Amount - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabVolunteer
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -volunteer_name |
- - Data | -- Volunteer Name - - | -- |
| 2 | -column_break_5 |
- - Column Break | -- - - | -- |
| 3 | -volunteer_type |
- - Link | -- Volunteer Type - - | -- - - - -Volunteer Type - - - - | -
| 4 | -email |
- - Data | -- Email - - | -- |
| 5 | -image |
- - Attach Image | -- Image - - | -- |
| 6 | -address_contacts |
- - Section Break | -- Address and Contact - - | -
- fa fa-map-marker- |
-
| 7 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 8 | -column_break_9 |
- - Column Break | -- - - | -- |
| 9 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
| 10 | -volunteer_availability_and_skills_details |
- - Section Break | -- Availability and Skills - - | -- |
| 11 | -availability |
- - Select | -- Availability - - | -
- -Weekly -Weekdays -Weekends- |
-
| 12 | -availability_timeslot |
- - Select | -- Availability Timeslot - - | -
- -Morning -Afternoon -Evening -Anytime- |
-
| 13 | -column_break_12 |
- - Column Break | -- - - | -- |
| 14 | -volunteer_skills |
- - Table | -- Volunteer Skills - - | -- - - - -Volunteer Skill - - - - | -
| 15 | -section_break_15 |
- - Section Break | -- - - | -- |
| 16 | -note |
- - Long Text | -- Note - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabVolunteer Skill
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -volunteer_skill |
- - Data | -- Volunteer Skill - - | -- |
Table Name: tabVolunteer Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -amount |
- - Float | -- Amount - - | -- |
Inherits from frappe.model.document.Document - -
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -title |
- - Data | -- TItle - - | -- |
| 3 | -tag_line |
- - Data | -
- Tag Line
- - Company Tagline for website homepage - |
- - |
| 4 | -description |
- - Text | -
- Description
- - Company Description for website homepage - |
- - |
| 5 | -products_section |
- - Section Break | -- Products - - | -- |
| 6 | -products_url |
- - Data | -- URL for "All Products" - - | -- |
| 7 | -products |
- - Table | -
- Products
- - Products to be shown on website homepage - |
- - - - - -Homepage Featured Product - - - - | -
Inherits from frappe.model.document.Document - -
- - - setup_items - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabHomepage Featured Product
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -col_break1 |
- - Column Break | -- - - | -- |
| 3 | -item_name |
- - Data | -- Item Name - - | -- |
| 4 | -view |
- - Button | -- View - - | -- |
| 5 | -section_break_5 |
- - Section Break | -- Description - - | -- |
| 6 | -description |
- - Text Editor | -- Description - - | -- |
| 7 | -column_break_7 |
- - Column Break | -- - - | -- |
| 8 | -image |
- - Attach Image | -- Image - - | -- |
| 9 | -thumbnail |
- - Attach Image | -- Thumbnail - - | -- |
| 10 | -route |
- - Small Text | -- route - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -home_page_is_products |
- - Check | -
- Home Page is Products
- - If checked, the Home page will be the default Item Group for the website - |
- - |
| 2 | -products_as_list |
- - Check | -- Show Products as a List - - | -- |
| 3 | -products_per_page |
- - Int | -- Products per Page - - | -- |
Inherits from frappe.model.document.Document - -
- - - erpnext.portal.doctype.products_settings.products_settings.home_page_is_products - (doc, method) -
-Called on saving Website Settings
-Table Name: tabActivity Cost
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -activity_type |
- - Link | -- Activity Type - - | -- - - - -Activity Type - - - - | -
| 2 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 5 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 6 | -section_break_4 |
- - Section Break | -- - - | -- |
| 7 | -billing_rate |
- - Currency | -
- Billing Rate
- - per hour - |
- - |
| 8 | -column_break_6 |
- - Column Break | -- - - | -- |
| 9 | -costing_rate |
- - Currency | -
- Costing Rate
- - per hour - |
- - |
| 10 | -title |
- - Data | -- title - - | -- |
Inherits from frappe.model.document.Document - -
- - - check_unique - (self) -
-No docs
-- - - set_title - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Table Name: tabActivity Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -activity_type |
- - Data | -- Activity Type - - | -- |
| 2 | -costing_rate |
- - Currency | -- Default Costing Rate - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -billing_rate |
- - Currency | -- Default Billing Rate - - | -- |
| 5 | -disabled |
- - Check | -- Disabled - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabDependent Task
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -task |
- - Link | -- Task - - | -- - - - -Task - - - - | -
Table Name: tabProject
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -project_name |
- - Data | -- Project Name - - | -- |
| 2 | -status |
- - Select | -- Status - - | -
- Open -Completed -Cancelled- |
-
| 3 | -project_type |
- - Link | -- Project Type - - | -- - - - -Project Type - - - - | -
| 4 | -is_active |
- - Select | -- Is Active - - | -
- Yes -No- |
-
| 5 | -percent_complete_method |
- - Select | -- % Complete Method - - | -
- Task Completion -Task Progress -Task Weight- |
-
| 6 | -percent_complete |
- - Percent | -- % Completed - - | -- |
| 7 | -column_break_5 |
- - Column Break | -- - - | -- |
| 8 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 9 | -priority |
- - Select | -- Priority - - | -
- Medium -Low -High- |
-
| 10 | -expected_start_date |
- - Date | -- Expected Start Date - - | -- |
| 11 | -expected_end_date |
- - Date | -- Expected End Date - - | -- |
| 12 | -customer_details |
- - Section Break | -- Customer Details - - | -
- fa fa-user- |
-
| 13 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 14 | -column_break_14 |
- - Column Break | -- - - | -- |
| 15 | -sales_order |
- - Link | -- Sales Order - - | -- - - - -Sales Order - - - - | -
| 16 | -users_section |
- - Section Break | -- Users - - | -- |
| 17 | -users |
- - Table | -
- Users
- - Project will be accessible on the website to these users - |
- - - - - -Project User - - - - | -
| 18 | -sb_milestones |
- - Section Break | -- Tasks - - | -
- fa fa-flag- |
-
| 19 | -tasks |
- - Table | -- Tasks - - | -- - - - -Project Task - - - - | -
| 20 | -copied_from |
- - Data | -- Copied From - - | -- |
| 21 | -section_break0 |
- - Section Break | -- Notes - - | -
- fa fa-list- |
-
| 22 | -notes |
- - Text Editor | -- Notes - - | -- |
| 23 | -section_break_18 |
- - Section Break | -- Start and End Dates - - | -- |
| 24 | -actual_start_date |
- - Data | -- Actual Start Date - - | -- |
| 25 | -actual_time |
- - Float | -- Actual Time (in Hours) - - | -- |
| 26 | -column_break_20 |
- - Column Break | -- - - | -- |
| 27 | -actual_end_date |
- - Date | -- Actual End Date - - | -- |
| 28 | -project_details |
- - Section Break | -- Costing and Billing - - | -
- fa fa-money- |
-
| 29 | -estimated_costing |
- - Currency | -- Estimated Cost - - | -
- Company:company:default_currency- |
-
| 30 | -total_costing_amount |
- - Currency | -- Total Costing Amount (via Timesheets) - - | -- |
| 31 | -total_expense_claim |
- - Currency | -- Total Expense Claim (via Expense Claims) - - | -- |
| 32 | -total_purchase_cost |
- - Currency | -- Total Purchase Cost (via Purchase Invoice) - - | -- |
| 33 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 34 | -column_break_28 |
- - Column Break | -- - - | -- |
| 35 | -total_sales_amount |
- - Currency | -- Total Sales Amount (via Sales Order) - - | -- |
| 36 | -total_billable_amount |
- - Currency | -- Total Billable Amount (via Timesheets) - - | -- |
| 37 | -total_billed_amount |
- - Currency | -- Total Billed Amount (via Sales Invoices) - - | -- |
| 38 | -total_consumed_material_cost |
- - Currency | -- Total Consumed Material Cost (via Stock Entry) - - | -- |
| 39 | -cost_center |
- - Link | -- Default Cost Center - - | -- - - - -Cost Center - - - - | -
| 40 | -margin |
- - Section Break | -- Margin - - | -- |
| 41 | -gross_margin |
- - Currency | -- Gross Margin - - | -
- Company:company:default_currency- |
-
| 42 | -column_break_37 |
- - Column Break | -- - - | -- |
| 43 | -per_gross_margin |
- - Percent | -- Gross Margin % - - | -- |
| 44 | -monitor_progress |
- - Section Break | -- Monitor Progress - - | -- |
| 45 | -collect_progress |
- - Check | -- Collect Progress - - | -- |
| 46 | -frequency |
- - Select | -- Frequency To Collect Progress - - | -
- Hourly -Twice Daily -Daily -Weekly- |
-
| 47 | -column_break_45 |
- - Column Break | -- - - | -- |
| 48 | -from |
- - Time | -- From - - | -- |
| 49 | -to |
- - Time | -- To - - | -- |
| 50 | -first_email |
- - Time | -- First Email - - | -- |
| 51 | -second_email |
- - Time | -- Second Email - - | -- |
| 52 | -daily_time_to_send |
- - Time | -- Time to send - - | -- |
| 53 | -day_to_send |
- - Select | -- Day to Send - - | -
- Monday -Tuesday -Wednesday -Thursday -Friday -Saturday -Sunday- |
-
| 54 | -weekly_time_to_send |
- - Time | -- Time to send - - | -- |
Inherits from frappe.model.document.Document - -
- - - __setup__ - (self) -
-No docs
-- - - after_insert - (self) -
-No docs
-- - - get_feed - (self) -
-No docs
-- - - get_tasks - (self) -
-No docs
-- - - load_tasks - (self) -
-Load tasks from the database
- - - map_custom_fields - (self, source, target) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - onload - (self) -
-Load project tasks for quick view
-- - - send_welcome_email - (self) -
-No docs
-- - - sync_tasks - (self) -
-sync tasks and remove table
-- - - update_billed_amount - (self) -
-No docs
-- - - update_costing - (self) -
-No docs
-- - - update_dependencies_on_duplicated_project - (self) -
-No docs
-- - - update_percent_complete - (self) -
-No docs
-- - - update_project - (self) -
-No docs
-- - - update_purchase_costing - (self) -
-No docs
-- - - update_sales_amount - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_dates - (self) -
-No docs
-- - - validate_project_name - (self) -
-No docs
-- - - validate_weights - (self) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.project.project.create_kanban_board_if_not_exists
-
- - - erpnext.projects.doctype.project.project.create_kanban_board_if_not_exists - (project) -
-No docs
-- - - erpnext.projects.doctype.project.project.create_project_update - (project) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.project.project.daily_reminder
-
- - - erpnext.projects.doctype.project.project.daily_reminder - () -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.project.project.get_cost_center_name
-
- - - erpnext.projects.doctype.project.project.get_cost_center_name - (project) -
-No docs
-- - - erpnext.projects.doctype.project.project.get_list_context - (context=None) -
-No docs
-- - - erpnext.projects.doctype.project.project.get_project_list - (doctype, txt, filters, limit_start, limit_page_length=20, order_by=modified) -
-No docs
-- - - erpnext.projects.doctype.project.project.get_timeline_data - (doctype, name) -
-Return timeline for attendance
-- - - erpnext.projects.doctype.project.project.get_users_for_project - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.project.project.hourly_reminder
-
- - - erpnext.projects.doctype.project.project.hourly_reminder - () -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.project.project.times_check
-
- - - erpnext.projects.doctype.project.project.times_check - (from1, to, first_email, second_email, daily_time_to_send, weekly_time_to_send) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.project.project.twice_daily_reminder
-
- - - erpnext.projects.doctype.project.project.twice_daily_reminder - () -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.project.project.weekly
-
- - - erpnext.projects.doctype.project.project.weekly - () -
-No docs
-Table Name: tabProject Task
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -status |
- - Select | -- Status - - | -
- Open -Working -Pending Review -Closed -Cancelled- |
-
| 3 | -edit_task |
- - Button | -- View Task - - | -- |
| 4 | -edit_timesheet |
- - Button | -- View Timesheet - - | -- |
| 5 | -make_timesheet |
- - Button | -- Make Timesheet - - | -- |
| 6 | -column_break_6 |
- - Column Break | -- - - | -- |
| 7 | -start_date |
- - Date | -- Start Date - - | -- |
| 8 | -end_date |
- - Date | -- End Date - - | -- |
| 9 | -task_weight |
- - Float | -- Weight - - | -- |
| 10 | -section_break_6 |
- - Section Break | -- - - | -- |
| 11 | -description |
- - Text Editor | -- Description - - | -- |
| 12 | -task_id |
- - Link | -- Task ID - - | -- - - - -Task - - - - | -
Table Name: tabProject Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -project_type |
- - Data | -- Project Type - - | -- |
| 2 | -description |
- - Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabProject Update
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -date |
- - Date | -- Date - - | -- |
| 4 | -time |
- - Time | -- Time - - | -- |
| 5 | -section_break_5 |
- - Section Break | -- - - | -- |
| 6 | -progress |
- - Select | -- How is the Project Progressing Right Now? - - | -
- Not Updated -Great/Quickly -Good/Steady -Challenging/Slow -Problematic/Stuck- |
-
| 7 | -users |
- - Table | -- Users - - | -- - - - -Project User - - - - | -
| 8 | -progress_details |
- - Text Editor | -- Progress Details - - | -- |
| 9 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Project Update - - - - | -
| 10 | -naming_series |
- - Data | -- Series - - | -
- UPDATE-.project.-.YY.MM.DD.-.####- |
-
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.projects.doctype.project_update.project_update.daily_reminder
-
- - - erpnext.projects.doctype.project_update.project_update.daily_reminder - () -
-No docs
-- - - erpnext.projects.doctype.project_update.project_update.email_sending - (project_name, frequency, date_start, date_end, progress, number_of_drafts, update) -
-No docs
-Table Name: tabProject User
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -user |
- - Link | -- User - - | -- - - - -User - - - - | -
| 2 | -welcome_email_sent |
- - Check | -- Welcome email sent - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -timesheet_sb |
- - Section Break | -- Timesheets - - | -- |
| 2 | -ignore_workstation_time_overlap |
- - Check | -- Ignore Workstation Time Overlap - - | -- |
| 3 | -ignore_user_time_overlap |
- - Check | -- Ignore User Time Overlap - - | -- |
| 4 | -ignore_employee_time_overlap |
- - Check | -- Ignore Employee Time Overlap - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabTask
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -subject |
- - Data | -- Subject - - | -- |
| 2 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 3 | -is_group |
- - Check | -- Is Group - - | -- |
| 4 | -column_break0 |
- - Column Break | -- - - | -- |
| 5 | -status |
- - Select | -- Status - - | -
- Open -Working -Pending Review -Overdue -Closed -Cancelled- |
-
| 6 | -priority |
- - Select | -- Priority - - | -
- Low -Medium -High -Urgent- |
-
| 7 | -parent_task |
- - Link | -- Parent Task - - | -- - - - -Task - - - - | -
| 8 | -section_break_10 |
- - Section Break | -- - - | -- |
| 9 | -exp_start_date |
- - Date | -- Expected Start Date - - | -- |
| 10 | -expected_time |
- - Float | -- Expected Time (in hours) - - | -- |
| 11 | -task_weight |
- - Float | -- Weight - - | -- |
| 12 | -column_break_11 |
- - Column Break | -- - - | -- |
| 13 | -exp_end_date |
- - Date | -- Expected End Date - - | -- |
| 14 | -progress |
- - Percent | -- % Progress - - | -- |
| 15 | -is_milestone |
- - Check | -- Is Milestone - - | -- |
| 16 | -color |
- - Color | -- Color - - | -- |
| 17 | -section_break0 |
- - Section Break | -- - - | -
- Simple- |
-
| 18 | -description |
- - Text Editor | -- Details - - | -- |
| 19 | -section_break |
- - Section Break | -- Depends On - - | -- |
| 20 | -depends_on |
- - Table | -- depends_on - - | -- - - - -Task Depends On - - - - | -
| 21 | -depends_on_tasks |
- - Data | -- Depends on Tasks - - | -- |
| 22 | -actual |
- - Section Break | -- - - | -- |
| 23 | -act_start_date |
- - Date | -- Actual Start Date (via Time Sheet) - - | -- |
| 24 | -actual_time |
- - Float | -- Actual Time (in hours) - - | -- |
| 25 | -column_break_15 |
- - Column Break | -- - - | -- |
| 26 | -act_end_date |
- - Date | -- Actual End Date (via Time Sheet) - - | -- |
| 27 | -section_break_17 |
- - Section Break | -- - - | -- |
| 28 | -total_costing_amount |
- - Currency | -- Total Costing Amount (via Time Sheet) - - | -
- Company:company:default_currency- |
-
| 29 | -total_expense_claim |
- - Currency | -- Total Expense Claim (via Expense Claim) - - | -
- Company:company:default_currency- |
-
| 30 | -column_break_20 |
- - Column Break | -- - - | -- |
| 31 | -total_billing_amount |
- - Currency | -- Total Billing Amount (via Time Sheet) - - | -- |
| 32 | -more_details |
- - Section Break | -- - - | -- |
| 33 | -review_date |
- - Date | -- Review Date - - | -- |
| 34 | -closing_date |
- - Date | -- Closing Date - - | -- |
| 35 | -column_break_22 |
- - Column Break | -- - - | -- |
| 36 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 37 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 38 | -lft |
- - Int | -- lft - - | -- |
| 39 | -rgt |
- - Int | -- rgt - - | -- |
| 40 | -old_parent |
- - Data | -- Old Parent - - | -- |
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.utils.nestedset.NestedSet - -
- - - check_recursion - (self) -
-No docs
-- - - get_customer_details - (self) -
-No docs
-- - - get_feed - (self) -
-No docs
-- - - get_project_details - (self) -
-No docs
-- - - has_webform_permission - (doc) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - populate_depends_on - (self) -
-No docs
-- - - reschedule_dependent_tasks - (self) -
-No docs
-- - - unassign_todo - (self) -
-No docs
-- - - update_depends_on - (self) -
-No docs
-- - - update_nsm_model - (self) -
-No docs
-- - - update_project - (self) -
-No docs
-- - - update_time_and_costing - (self) -
-No docs
-- - - update_total_expense_claim - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_dates - (self) -
-No docs
-- - - validate_progress - (self) -
-No docs
-- - - validate_status - (self) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.task.task.add_multiple_tasks
-
- - - erpnext.projects.doctype.task.task.add_multiple_tasks - (data, parent) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.task.task.add_node
-
- - - erpnext.projects.doctype.task.task.add_node - () -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.task.task.check_if_child_exists
-
- - - erpnext.projects.doctype.task.task.check_if_child_exists - (name) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.task.task.get_children
-
- - - erpnext.projects.doctype.task.task.get_children - (doctype, parent, task=None, project=None, is_root=False) -
-No docs
-- - - erpnext.projects.doctype.task.task.get_project - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.projects.doctype.task.task.on_doctype_update - () -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.task.task.set_multiple_status
-
- - - erpnext.projects.doctype.task.task.set_multiple_status - (names, status) -
-No docs
-- - - erpnext.projects.doctype.task.task.set_tasks_as_overdue - () -
-No docs
-Table Name: tabTask Depends On
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -task |
- - Link | -- Task - - | -- - - - -Task - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -subject |
- - Text | -- Subject - - | -- |
| 4 | -project |
- - Text | -- Project - - | -- |
Table Name: tabTimesheet
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -naming_series |
- - Select | -- Series - - | -
- TS- -TLB-- |
-
| 3 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 4 | -sales_invoice |
- - Link | -- Sales Invoice - - | -- - - - -Sales Invoice - - - - | -
| 5 | -column_break_3 |
- - Column Break | -- - - | -- |
| 6 | -salary_slip |
- - Link | -- Salary Slip - - | -- - - - -Salary Slip - - - - | -
| 7 | -status |
- - Select | -- Status - - | -
- Draft -Submitted -Billed -Payslip -Completed -Cancelled- |
-
| 8 | -employee_detail |
- - Section Break | -- Employee Detail - - | -- |
| 9 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 10 | -employee_name |
- - Data | -- Employee Name - - | -- |
| 11 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 12 | -column_break_9 |
- - Column Break | -- - - | -- |
| 13 | -user |
- - Link | -- User - - | -- - - - -User - - - - | -
| 14 | -start_date |
- - Date | -- Start Date - - | -- |
| 15 | -end_date |
- - Date | -- End Date - - | -- |
| 16 | -work_detail |
- - Section Break | -- Work Detail - - | -- |
| 17 | -work_order |
- - Link | -- Work Order - - | -- - - - -Work Order - - - - | -
| 18 | -section_break_5 |
- - Section Break | -- - - | -- |
| 19 | -time_logs |
- - Table | -- Time Sheets - - | -- - - - -Timesheet Detail - - - - | -
| 20 | -working_hours |
- - Section Break | -- - - | -- |
| 21 | -total_hours |
- - Float | -- Total Working Hours - - | -- |
| 22 | -billing_details |
- - Section Break | -- Billing Details - - | -- |
| 23 | -total_billable_hours |
- - Float | -- Total Billable Hours - - | -- |
| 24 | -total_billed_hours |
- - Float | -- Total Billed Hours - - | -- |
| 25 | -total_costing_amount |
- - Float | -- Total Costing Amount - - | -- |
| 26 | -column_break_10 |
- - Column Break | -- - - | -- |
| 27 | -total_billable_amount |
- - Float | -- Total Billable Amount - - | -- |
| 28 | -total_billed_amount |
- - Float | -- Total Billed Amount - - | -- |
| 29 | -per_billed |
- - Percent | -- % Amount Billed - - | -- |
| 30 | -section_break_18 |
- - Section Break | -- - - | -- |
| 31 | -note |
- - Text Editor | -- Note - - | -- |
| 32 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Timesheet - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - before_cancel - (self) -
-No docs
-- - - calculate_percentage_billed - (self) -
-No docs
-- - - calculate_total_amounts - (self) -
-No docs
-- - - check_workstation_timings - (self, args) -
-Checks if Time Log is between operating hours of the Workstation.
-- - - check_workstation_working_day - (self, data) -
-No docs
-- - - get_actual_timesheet_summary - (self, operation_id) -
-Returns 'Actual Operating Time'.
-- - - get_last_working_slot - (self, time_sheet, workstation) -
-No docs
-- - - get_overlap_for - (self, fieldname, args, value) -
-No docs
-- - - get_to_time - (self, data) -
-No docs
-- - - move_to_next_day - (self, data) -
-Move start and end time one day forward
-- - - move_to_next_non_overlapping_slot - (self, data) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - schedule_for_work_order - (self, index) -
-No docs
-- - - set_dates - (self) -
-No docs
-- - - set_employee_name - (self) -
-No docs
-- - - set_status - (self) -
-No docs
-- - - update_billing_hours - (self, args) -
-No docs
-- - - update_cost - (self) -
-No docs
-- - - update_task_and_project - (self) -
-No docs
-- - - update_time_rates - (self, ts_detail) -
-No docs
-- - - update_work_order - (self, time_sheet) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_dates - (self) -
-No docs
-- - - validate_mandatory_fields - (self) -
-No docs
-- - - validate_overlap - (self, data) -
-No docs
-- - - validate_overlap_for - (self, fieldname, args, value, ignore_validation=False) -
-No docs
-- - - validate_time_logs - (self) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.timesheet.timesheet.get_activity_cost
-
- - - erpnext.projects.doctype.timesheet.timesheet.get_activity_cost - (employee=None, activity_type=None) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.timesheet.timesheet.get_events
-
- - - erpnext.projects.doctype.timesheet.timesheet.get_events - (start, end, filters=None) -
-Returns events for Gantt / Calendar view rendering.
- -Parameters:
- -start - Start date-time.end - End date-time.filters - Filters (JSON).- - - erpnext.projects.doctype.timesheet.timesheet.get_list_context - (context=None) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.timesheet.timesheet.get_projectwise_timesheet_data
-
- - - erpnext.projects.doctype.timesheet.timesheet.get_projectwise_timesheet_data - (project, parent=None) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.timesheet.timesheet.get_timesheet
-
- - - erpnext.projects.doctype.timesheet.timesheet.get_timesheet - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.timesheet.timesheet.get_timesheet_data
-
- - - erpnext.projects.doctype.timesheet.timesheet.get_timesheet_data - (name, project) -
-No docs
-- - - erpnext.projects.doctype.timesheet.timesheet.get_timesheets_list - (doctype, txt, filters, limit_start, limit_page_length=20, order_by=modified) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.timesheet.timesheet.make_salary_slip
-
- - - erpnext.projects.doctype.timesheet.timesheet.make_salary_slip - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.projects.doctype.timesheet.timesheet.make_sales_invoice
-
- - - erpnext.projects.doctype.timesheet.timesheet.make_sales_invoice - (source_name, item_code=None, customer=None) -
-No docs
-- - - erpnext.projects.doctype.timesheet.timesheet.set_missing_values - (time_sheet, target) -
-No docs
-Table Name: tabTimesheet Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -activity_type |
- - Link | -- Activity Type - - | -- - - - -Activity Type - - - - | -
| 2 | -from_time |
- - Datetime | -- From Time - - | -- |
| 3 | -section_break_3 |
- - Column Break | -- - - | -- |
| 4 | -expected_hours |
- - Float | -- Expected Hrs - - | -- |
| 5 | -hours |
- - Float | -- Hrs - - | -- |
| 6 | -to_time |
- - Datetime | -- To Time - - | -- |
| 7 | -completed |
- - Check | -- Completed - - | -- |
| 8 | -section_break_7 |
- - Section Break | -- - - | -- |
| 9 | -completed_qty |
- - Float | -- Completed Qty - - | -- |
| 10 | -workstation |
- - Link | -- Workstation - - | -- - - - -Workstation - - - - | -
| 11 | -column_break_12 |
- - Column Break | -- - - | -- |
| 12 | -operation |
- - Link | -- Operation - - | -- - - - -Operation - - - - | -
| 13 | -operation_id |
- - Data | -- Operation Id - - | -- |
| 14 | -project_details |
- - Section Break | -- - - | -- |
| 15 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 16 | -column_break_2 |
- - Column Break | -- - - | -- |
| 17 | -task |
- - Link | -- Task - - | -- - - - -Task - - - - | -
| 18 | -section_break_6 |
- - Section Break | -- - - | -- |
| 19 | -billable |
- - Check | -- Bill - - | -- |
| 20 | -column_break_8 |
- - Column Break | -- - - | -- |
| 21 | -billing_hours |
- - Float | -- Billing Hours - - | -- |
| 22 | -section_break_11 |
- - Section Break | -- - - | -- |
| 23 | -billing_rate |
- - Currency | -- Billing Rate - - | -- |
| 24 | -billing_amount |
- - Currency | -- Billing Amount - - | -- |
| 25 | -column_break_14 |
- - Column Break | -- - - | -- |
| 26 | -costing_rate |
- - Currency | -- Costing Rate - - | -- |
| 27 | -costing_amount |
- - Currency | -- Costing Amount - - | -- |
| 28 | -reference |
- - Section Break | -- Reference - - | -- |
| 29 | -sales_invoice |
- - Link | -- Sales Invoice - - | -- - - - -Sales Invoice - - - - | -
Table Name: tabGST HSN Code
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -hsn_code |
- - Data | -- HSN Code - - | -- |
| 2 | -description |
- - Small Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -gst_summary |
- - HTML | -- GST Summary - - | -- |
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -gstin_email_sent_on |
- - Date | -- GSTIN Email Sent On - - | -- |
| 4 | -section_break_4 |
- - Section Break | -- - - | -- |
| 5 | -gst_accounts |
- - Table | -- GST Accounts - - | -- - - - -GST Account - - - - | -
| 6 | -b2c_limit |
- - Data | -
- B2C Limit
- - Set Invoice Value for B2C. B2CL and B2CS calculated based on this invoice value. - |
- - |
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - erpnext.regional.doctype.gst_settings.gst_settings._send_gstin_reminder - (party_type, party, default_email_id=None, sent_to=None) -
-Send GST Reminder email
-Public API
- /api/method/erpnext.regional.doctype.gst_settings.gst_settings.send_gstin_reminder
-
- - - erpnext.regional.doctype.gst_settings.gst_settings.send_gstin_reminder - (party_type, party) -
-Send GSTIN reminder to one party (called from Customer, Supplier form)
-- - - erpnext.regional.doctype.gst_settings.gst_settings.send_gstin_reminder_to_all_parties - () -
-No docs
-Public API
- /api/method/erpnext.regional.doctype.gst_settings.gst_settings.send_reminder
-
- - - erpnext.regional.doctype.gst_settings.gst_settings.send_reminder - () -
-No docs
-Table Name: tabRestaurant
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -image |
- - Attach Image | -- Image - - | -- |
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -default_customer |
- - Link | -- Default Customer - - | -- - - - -Customer - - - - | -
| 4 | -invoice_series_prefix |
- - Data | -- Invoice Series Prefix - - | -- |
| 5 | -column_break_4 |
- - Column Break | -- - - | -- |
| 6 | -active_menu |
- - Link | -- Active Menu - - | -- - - - -Restaurant Menu - - - - | -
| 7 | -default_tax_template |
- - Link | -- Default Tax Template - - | -- - - - -Sales Taxes and Charges Template - - - - | -
| 8 | -address |
- - Link | -- Address - - | -- - - - -Address - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabRestaurant Menu
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -restaurant |
- - Link | -- Restaurant - - | -- - - - -Restaurant - - - - | -
| 2 | -enabled |
- - Check | -- Enabled - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -price_list |
- - Link | -- Price List (Auto created) - - | -- - - - -Price List - - - - | -
| 5 | -items_section |
- - Section Break | -- Items - - | -- |
| 6 | -items |
- - Table | -- Items - - | -- - - - -Restaurant Menu Item - - - - | -
Inherits from frappe.model.document.Document - -
- - - clear_item_price - (self, price_list=None) -
-clear all item prices for this menu
-- - - get_price_list - (self) -
-Create price list for menu if missing
-- - - make_price_list - (self) -
-No docs
-- - - on_trash - (self) -
-clear prices
-- - - on_update - (self) -
-Sync Price List
-- - - validate - (self) -
-No docs
-Table Name: tabRestaurant Menu Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 2 | -rate |
- - Currency | -- Rate - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -restaurant_table |
- - Link | -- Restaurant Table - - | -- - - - -Restaurant Table - - - - | -
| 2 | -add_item |
- - Link | -
- Add Item
- - Click Enter To Add - |
- - - - - -Item - - - - | -
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -grand_total |
- - Currency | -- Grand Total - - | -- |
| 5 | -last_sales_invoice |
- - Link | -- Last Sales Invoice - - | -- - - - -Sales Invoice - - - - | -
| 6 | -current_order |
- - Section Break | -- Current Order - - | -- |
| 7 | -items |
- - Table | -- Items - - | -- - - - -Restaurant Order Entry Item - - - - | -
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.restaurant.doctype.restaurant_order_entry.restaurant_order_entry.get_invoice
-
- - - erpnext.restaurant.doctype.restaurant_order_entry.restaurant_order_entry.get_invoice - (table) -
-returns the active invoice linked to the given table
-- - - erpnext.restaurant.doctype.restaurant_order_entry.restaurant_order_entry.get_restaurant_and_menu_name - (table) -
-No docs
-- - - erpnext.restaurant.doctype.restaurant_order_entry.restaurant_order_entry.item_query_restaurant - (doctype=Item, txt=, searchfield=name, start=0, page_len=20, filters=None, as_dict=False) -
-Return items that are selected in active menu of the restaurant
-Public API
- /api/method/erpnext.restaurant.doctype.restaurant_order_entry.restaurant_order_entry.make_invoice
-
- - - erpnext.restaurant.doctype.restaurant_order_entry.restaurant_order_entry.make_invoice - (table, customer, mode_of_payment) -
-Make table based on Sales Order
-Public API
- /api/method/erpnext.restaurant.doctype.restaurant_order_entry.restaurant_order_entry.sync
-
- - - erpnext.restaurant.doctype.restaurant_order_entry.restaurant_order_entry.sync - (table, items) -
-Sync the sales order related to the table
-Table Name: tabRestaurant Order Entry Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 2 | -qty |
- - Int | -- Qty - - | -- |
| 3 | -served |
- - Int | -- Served - - | -- |
| 4 | -rate |
- - Currency | -- Rate - - | -- |
Table Name: tabRestaurant Reservation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -status |
- - Select | -- Status - - | -
- Open -Waitlisted -Cancelled -No Show -Success- |
-
| 2 | -restaurant |
- - Link | -- Restaurant - - | -- - - - -Restaurant - - - - | -
| 3 | -no_of_people |
- - Int | -- No of People - - | -- |
| 4 | -reservation_time |
- - Datetime | -- Reservation Time - - | -- |
| 5 | -reservation_end_time |
- - Datetime | -- Reservation End Time - - | -- |
| 6 | -column_break_4 |
- - Column Break | -- - - | -- |
| 7 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 8 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 9 | -contact_number |
- - Data | -- Contact Number - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabRestaurant Table
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -restaurant |
- - Link | -- Restaurant - - | -- - - - -Restaurant - - - - | -
| 2 | -no_of_seats |
- - Int | -- No of Seats - - | -- |
| 3 | -minimum_seating |
- - Int | -- Minimum Seating - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabCampaign
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -campaign |
- - Section Break | -- Campaign - - | -- |
| 2 | -campaign_name |
- - Data | -- Campaign Name - - | -- |
| 3 | -naming_series |
- - Select | -- Naming Series - - | -
- Campaign-.####- |
-
| 4 | -description |
- - Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabCustomer
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -basic_info |
- - Section Break | -- Name and Type - - | -
- fa fa-user- |
-
| 2 | -naming_series |
- - Select | -- Series - - | -
- CUST-- |
-
| 3 | -salutation |
- - Link | -- Salutation - - | -- - - - -Salutation - - - - | -
| 4 | -customer_name |
- - Data | -- Full Name - - | -- |
| 5 | -gender |
- - Link | -- Gender - - | -- - - - -Gender - - - - | -
| 6 | -customer_type |
- - Select | -- Type - - | -
- Company -Individual- |
-
| 7 | -lead_name |
- - Link | -- From Lead - - | -- - - - -Lead - - - - | -
| 8 | -image |
- - Attach Image | -- Image - - | -- |
| 9 | -column_break0 |
- - Column Break | -- - - | -- |
| 10 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 11 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 12 | -tax_id |
- - Data | -- Tax ID - - | -- |
| 13 | -disabled |
- - Check | -- Disabled - - | -- |
| 14 | -is_internal_customer |
- - Check | -- Is Internal Customer - - | -- |
| 15 | -represents_company |
- - Link | -- Represents Company - - | -- - - - -Company - - - - | -
| 16 | -allowed_to_transact_section |
- - Section Break | -- Allowed To Transact With - - | -- |
| 17 | -companies |
- - Table | -- Allowed To Transact With - - | -- - - - -Allowed To Transact With - - - - | -
| 18 | -currency_and_price_list |
- - Section Break | -- Currency and Price List - - | -- |
| 19 | -default_currency |
- - Link | -- Billing Currency - - | -- - - - -Currency - - - - | -
| 20 | -default_price_list |
- - Link | -- Default Price List - - | -- - - - -Price List - - - - | -
| 21 | -column_break_14 |
- - Column Break | -- - - | -- |
| 22 | -language |
- - Link | -- Print Language - - | -- - - - -Language - - - - | -
| 23 | -address_contacts |
- - Section Break | -- Address and Contact - - | -
- fa fa-map-marker- |
-
| 24 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 25 | -website |
- - Data | -- Website - - | -- |
| 26 | -column_break1 |
- - Column Break | -- - - | -- |
| 27 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
| 28 | -primary_address_and_contact_detail |
- - Section Break | -
- Primary Address and Contact Detail
- - Select, to make the customer searchable with these fields - |
- - |
| 29 | -customer_primary_contact |
- - Link | -
- Customer Primary Contact
- - Reselect, if the chosen contact is edited after save - |
- - - - - -Contact - - - - | -
| 30 | -mobile_no |
- - Read Only | -- Mobile No - - | -- |
| 31 | -email_id |
- - Read Only | -- Email Id - - | -- |
| 32 | -column_break_26 |
- - Column Break | -- - - | -- |
| 33 | -customer_primary_address |
- - Link | -
- Customer Primary Address
- - Reselect, if the chosen address is edited after save - |
- - - - - -Address - - - - | -
| 34 | -primary_address |
- - Read Only | -- Primary Address - - | -- |
| 35 | -default_receivable_accounts |
- - Section Break | -- Accounting - - | -- |
| 36 | -accounts |
- - Table | -
- Accounts
- - Mention if non-standard receivable account - |
- - - - - -Party Account - - - - | -
| 37 | -credit_limit_section |
- - Section Break | -- Credit Limit and Payment Terms - - | -- |
| 38 | -credit_limit |
- - Currency | -- Credit Limit - - | -- |
| 39 | -bypass_credit_limit_check_at_sales_order |
- - Check | -- Bypass credit limit check at Sales Order - - | -- |
| 40 | -column_break_34 |
- - Column Break | -- - - | -- |
| 41 | -payment_terms |
- - Link | -- Default Payment Terms Template - - | -- - - - -Payment Terms Template - - - - | -
| 42 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 43 | -customer_details |
- - Text | -
- Customer Details
- - Additional information regarding the customer. - |
- - |
| 44 | -is_frozen |
- - Check | -- Is Frozen - - | -- |
| 45 | -sales_team_section_break |
- - Section Break | -- Sales Partner and Commission - - | -
- fa fa-group- |
-
| 46 | -default_sales_partner |
- - Link | -- Sales Partner - - | -- - - - -Sales Partner - - - - | -
| 47 | -default_commission_rate |
- - Float | -- Commission Rate - - | -- |
| 48 | -sales_team_section |
- - Section Break | -- Sales Team - - | -- |
| 49 | -sales_team |
- - Table | -- Sales Team Details - - | -- - - - -Sales Team - - - - | -
| 50 | -customer_pos_id |
- - Data | -- Customer POS id - - | -- |
Inherits from erpnext.utilities.transaction_base.TransactionBase - -
- - - after_insert - (self) -
-If customer created from Lead, update customer id in quotations, opportunities
-- - - after_rename - (self, olddn, newdn, merge=False) -
-No docs
-- - - autoname - (self) -
-No docs
-- - - check_customer_group_change - (self) -
-No docs
-- - - create_lead_address_contact - (self) -
-No docs
-- - - create_primary_address - (self) -
-No docs
-- - - create_primary_contact - (self) -
-No docs
-- - - get_customer_name - (self) -
-No docs
-- - - get_feed - (self) -
-No docs
-- - - load_dashboard_info - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - onload - (self) -
-Load address and contacts in __onload
- - - update_customer_groups - (self) -
-No docs
-- - - update_lead_status - (self) -
-If Customer created from Lead, update lead status to "Converted" - update Customer link in Quotation, Opportunity
-- - - validate - (self) -
-No docs
-- - - validate_credit_limit_on_change - (self) -
-No docs
-- - - validate_name_with_customer_group - (self) -
-No docs
-- - - erpnext.selling.doctype.customer.customer.check_credit_limit - (customer, company, ignore_outstanding_sales_order=False, extra_amount=0) -
-No docs
-- - - erpnext.selling.doctype.customer.customer.get_credit_limit - (customer, company) -
-No docs
-- - - erpnext.selling.doctype.customer.customer.get_customer_list - (doctype, txt, searchfield, start, page_len, filters=None) -
-No docs
-- - - erpnext.selling.doctype.customer.customer.get_customer_outstanding - (customer, company, ignore_outstanding_sales_order=False) -
-No docs
-- - - erpnext.selling.doctype.customer.customer.get_customer_primary_address - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.selling.doctype.customer.customer.get_customer_primary_contact - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.selling.doctype.customer.customer.make_address - (args, is_primary_address=1) -
-No docs
-- - - erpnext.selling.doctype.customer.customer.make_contact - (args, is_primary_contact=1) -
-No docs
-Table Name: tabIndustry Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -industry |
- - Data | -- Industry - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabInstallation Note
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -installation_note |
- - Section Break | -- Installation Note - - | -- |
| 2 | -column_break0 |
- - Column Break | -- - - | -- |
| 3 | -naming_series |
- - Select | -- Series - - | -
- IN-- |
-
| 4 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 5 | -customer_address |
- - Link | -- Customer Address - - | -- - - - -Address - - - - | -
| 6 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 7 | -customer_name |
- - Data | -- Name - - | -- |
| 8 | -address_display |
- - Small Text | -- Address - - | -- |
| 9 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 10 | -contact_mobile |
- - Small Text | -- Mobile No - - | -- |
| 11 | -contact_email |
- - Data | -- Contact Email - - | -
- |
-
| 12 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 13 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 14 | -column_break1 |
- - Column Break | -- - - | -- |
| 15 | -inst_date |
- - Date | -- Installation Date - - | -- |
| 16 | -inst_time |
- - Time | -- Installation Time - - | -- |
| 17 | -status |
- - Select | -- Status - - | -
- Draft -Submitted -Cancelled- |
-
| 18 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 19 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Installation Note - - - - | -
| 20 | -remarks |
- - Small Text | -- Remarks - - | -- |
| 21 | -item_details |
- - Section Break | -- - - | -
- Simple- |
-
| 22 | -items |
- - Table | -- Items - - | -- - - - -Installation Note Item - - - - | -
Inherits from erpnext.utilities.transaction_base.TransactionBase - -
- - - __init__ - (self) -
-No docs
-- - - check_item_table - (self) -
-No docs
-- - - get_prevdoc_serial_no - (self, prevdoc_detail_docname) -
-No docs
-- - - is_serial_no_added - (self, item_code, serial_no) -
-No docs
-- - - is_serial_no_exist - (self, item_code, serial_no) -
-No docs
-- - - is_serial_no_match - (self, cur_s_no, prevdoc_s_no, prevdoc_docname) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_installation_date - (self) -
-No docs
-- - - validate_serial_no - (self) -
-No docs
-Table Name: tabInstallation Note Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -serial_no |
- - Small Text | -- Serial No - - | -- |
| 3 | -qty |
- - Float | -- Installed Qty - - | -- |
| 4 | -description |
- - Text Editor | -- Description - - | -- |
| 5 | -prevdoc_detail_docname |
- - Data | -- Against Document Detail No - - | -- |
| 6 | -prevdoc_docname |
- - Data | -- Against Document No - - | -- |
| 7 | -prevdoc_doctype |
- - Data | -- Document Type - - | -- |
Table Name: tabLead Source
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -source_name |
- - Data | -- Source Name - - | -- |
| 2 | -details |
- - Text Editor | -- Details - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabPOS Closing Voucher
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -period_start_date |
- - Date | -- Period Start Date - - | -- |
| 2 | -period_end_date |
- - Date | -- Period End Date - - | -- |
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 5 | -section_break_5 |
- - Section Break | -- - - | -- |
| 6 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 7 | -column_break_7 |
- - Column Break | -- - - | -- |
| 8 | -pos_profile |
- - Link | -- POS Profile - - | -- - - - -POS Profile - - - - | -
| 9 | -user |
- - Link | -- Cashier - - | -- - - - -User - - - - | -
| 10 | -section_break_9 |
- - Section Break | -- - - | -- |
| 11 | -payment_reconciliation_details |
- - HTML | -- - - | -- |
| 12 | -section_break_11 |
- - Section Break | -- Modes of Payment - - | -- |
| 13 | -payment_reconciliation |
- - Table | -- Payment Reconciliation - - | -- - - - -POS Closing Voucher Details - - - - | -
| 14 | -section_break_13 |
- - Section Break | -- Details - - | -- |
| 15 | -grand_total |
- - Currency | -- Grand Total - - | -- |
| 16 | -net_total |
- - Currency | -- Net Total - - | -- |
| 17 | -total_quantity |
- - Float | -- Total Quantity - - | -- |
| 18 | -column_break_16 |
- - Column Break | -- Taxes - - | -- |
| 19 | -taxes |
- - Table | -- Taxes - - | -- - - - -POS Closing Voucher Taxes - - - - | -
| 20 | -section_break_12 |
- - Section Break | -- Linked Invoices - - | -- |
| 21 | -sales_invoices_summary |
- - Table | -- Sales Invoices Summary - - | -- - - - -POS Closing Voucher Invoices - - - - | -
| 22 | -section_break_14 |
- - Section Break | -- - - | -- |
| 23 | -amended_from |
- - Link | -- Amended From - - | -- - - - -POS Closing Voucher - - - - | -
Inherits from frappe.model.document.Document - -
- - - get_closing_voucher_details - (self) -
-No docs
-- - - get_payment_reconciliation_details - (self) -
-No docs
-- - - set_invoice_list - (self, invoice_list) -
-No docs
-- - - set_mode_of_payments - (self, mop) -
-No docs
-- - - set_sales_summary_values - (self, sales_summary) -
-No docs
-- - - set_taxes - (self, taxes) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.pos_closing_voucher.pos_closing_voucher.get_cashiers
-
- - - erpnext.selling.doctype.pos_closing_voucher.pos_closing_voucher.get_cashiers - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-- - - erpnext.selling.doctype.pos_closing_voucher.pos_closing_voucher.get_company_currency - (doc) -
-No docs
-- - - erpnext.selling.doctype.pos_closing_voucher.pos_closing_voucher.get_invoices - (filters) -
-No docs
-- - - erpnext.selling.doctype.pos_closing_voucher.pos_closing_voucher.get_mode_of_payment_details - (invoice_list) -
-No docs
-- - - erpnext.selling.doctype.pos_closing_voucher.pos_closing_voucher.get_sales_summary - (invoice_list) -
-No docs
-- - - erpnext.selling.doctype.pos_closing_voucher.pos_closing_voucher.get_tax_details - (invoice_list) -
-No docs
-Table Name: tabPOS Closing Voucher Details
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -mode_of_payment |
- - Link | -- Mode of Payment - - | -- - - - -Mode of Payment - - - - | -
| 2 | -collected_amount |
- - Currency | -- Collected Amount - - | -
- currency- |
-
| 3 | -expected_amount |
- - Currency | -- Expected Amount - - | -- |
| 4 | -difference |
- - Currency | -- Difference - - | -- |
Table Name: tabPOS Closing Voucher Invoices
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -invoice |
- - Link | -- Invoices - - | -- - - - -Sales Invoice - - - - | -
| 2 | -qty_of_items |
- - Data | -- Quantity of Items - - | -- |
| 3 | -grand_total |
- - Currency | -- Grand Total - - | -- |
Table Name: tabPOS Closing Voucher Taxes
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -rate |
- - Percent | -- Rate - - | -- |
| 2 | -amount |
- - Currency | -- Amount - - | -- |
Table Name: tabProduct Bundle
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -basic_section |
- - Section Break | -- - - | -- |
| 2 | -new_item_code |
- - Link | -- Parent Item - - | -- - - - -Item - - - - | -
| 3 | -description |
- - Data | -- Description - - | -- |
| 4 | -item_section |
- - Section Break | -
- Items
- - List items that form the package. - |
- - |
| 5 | -items |
- - Table | -- Items - - | -- - - - -Product Bundle Item - - - - | -
| 6 | -section_break_4 |
- - Section Break | -- - - | -- |
| 7 | -about |
- - HTML | -- - - | -- |
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_child_items - (self) -
-No docs
-- - - validate_main_item - (self) -
-Validates, main Item is not a stock item
-- - - erpnext.selling.doctype.product_bundle.product_bundle.get_new_item_code - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Table Name: tabProduct Bundle Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 2 | -qty |
- - Float | -- Qty - - | -- |
| 3 | -description |
- - Text Editor | -- Description - - | -- |
| 4 | -rate |
- - Float | -- Rate - - | -- |
| 5 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
Table Name: tabQuotation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -customer_section |
- - Section Break | -- - - | -
- fa fa-user- |
-
| 2 | -title |
- - Data | -- Title - - | -- |
| 3 | -naming_series |
- - Select | -- Series - - | -
- QTN-- |
-
| 4 | -quotation_to |
- - Select | -- Quotation To - - | -
- -Lead -Customer- |
-
| 5 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 6 | -lead |
- - Link | -- Lead - - | -- - - - -Lead - - - - | -
| 7 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 8 | -column_break1 |
- - Column Break | -- - - | -- |
| 9 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Quotation - - - - | -
| 10 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 11 | -transaction_date |
- - Date | -- Date - - | -- |
| 12 | -valid_till |
- - Date | -- Valid Till - - | -- |
| 13 | -order_type |
- - Select | -- Order Type - - | -
- -Sales -Maintenance -Shopping Cart- |
-
| 14 | -contact_section |
- - Section Break | -- Address and Contact - - | -
- fa fa-bullhorn- |
-
| 15 | -customer_address |
- - Link | -- Customer Address - - | -- - - - -Address - - - - | -
| 16 | -address_display |
- - Small Text | -- Address - - | -- |
| 17 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 18 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 19 | -contact_mobile |
- - Small Text | -- Mobile No - - | -- |
| 20 | -contact_email |
- - Data | -- Contact Email - - | -
- |
-
| 21 | -col_break98 |
- - Column Break | -- - - | -- |
| 22 | -shipping_address_name |
- - Link | -- Shipping Address - - | -- - - - -Address - - - - | -
| 23 | -shipping_address |
- - Small Text | -- Shipping Address - - | -- |
| 24 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 25 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 26 | -currency_and_price_list |
- - Section Break | -- Currency and Price List - - | -
- fa fa-tag- |
-
| 27 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 28 | -conversion_rate |
- - Float | -
- Exchange Rate
- - Rate at which customer's currency is converted to company's base currency - |
- - |
| 29 | -column_break2 |
- - Column Break | -- - - | -- |
| 30 | -selling_price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 31 | -price_list_currency |
- - Link | -- Price List Currency - - | -- - - - -Currency - - - - | -
| 32 | -plc_conversion_rate |
- - Float | -
- Price List Exchange Rate
- - Rate at which Price list currency is converted to company's base currency - |
- - |
| 33 | -ignore_pricing_rule |
- - Check | -- Ignore Pricing Rule - - | -- |
| 34 | -items_section |
- - Section Break | -- - - | -
- fa fa-shopping-cart- |
-
| 35 | -items |
- - Table | -- Items - - | -- - - - -Quotation Item - - - - | -
| 36 | -sec_break23 |
- - Section Break | -- - - | -- |
| 37 | -total_qty |
- - Float | -- Total Quantity - - | -- |
| 38 | -base_total |
- - Currency | -- Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 39 | -base_net_total |
- - Currency | -- Net Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 40 | -column_break_28 |
- - Column Break | -- - - | -- |
| 41 | -total |
- - Currency | -- Total - - | -
- currency- |
-
| 42 | -net_total |
- - Currency | -- Net Total - - | -
- currency- |
-
| 43 | -total_net_weight |
- - Float | -- Total Net Weight - - | -- |
| 44 | -taxes_section |
- - Section Break | -- Taxes and Charges - - | -
- fa fa-money- |
-
| 45 | -taxes_and_charges |
- - Link | -- Taxes and Charges - - | -- - - - -Sales Taxes and Charges Template - - - - | -
| 46 | -column_break_34 |
- - Column Break | -- - - | -- |
| 47 | -shipping_rule |
- - Link | -- Shipping Rule - - | -- - - - -Shipping Rule - - - - | -
| 48 | -section_break_36 |
- - Section Break | -- - - | -- |
| 49 | -taxes |
- - Table | -- Sales Taxes and Charges - - | -- - - - -Sales Taxes and Charges - - - - | -
| 50 | -sec_tax_breakup |
- - Section Break | -- Tax Breakup - - | -- |
| 51 | -other_charges_calculation |
- - Text | -- Taxes and Charges Calculation - - | -- |
| 52 | -section_break_39 |
- - Section Break | -- - - | -- |
| 53 | -base_total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges (Company Currency) - - | -
- Company:company:default_currency- |
-
| 54 | -column_break_42 |
- - Column Break | -- - - | -- |
| 55 | -total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges - - | -
- currency- |
-
| 56 | -section_break_44 |
- - Section Break | -- Additional Discount - - | -- |
| 57 | -apply_discount_on |
- - Select | -- Apply Additional Discount On - - | -
- -Grand Total -Net Total- |
-
| 58 | -base_discount_amount |
- - Currency | -- Additional Discount Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 59 | -column_break_46 |
- - Column Break | -- - - | -- |
| 60 | -additional_discount_percentage |
- - Float | -- Additional Discount Percentage - - | -- |
| 61 | -discount_amount |
- - Currency | -- Additional Discount Amount - - | -
- currency- |
-
| 62 | -totals |
- - Section Break | -- - - | -
- fa fa-money- |
-
| 63 | -base_grand_total |
- - Currency | -- Grand Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 64 | -base_rounding_adjustment |
- - Currency | -- Rounding Adjustment (Company Currency) - - | -
- Company:company:default_currency- |
-
| 65 | -base_in_words |
- - Data | -
- In Words (Company Currency)
- - In Words will be visible once you save the Quotation. - |
- - |
| 66 | -base_rounded_total |
- - Currency | -- Rounded Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 67 | -column_break3 |
- - Column Break | -- - - | -- |
| 68 | -grand_total |
- - Currency | -- Grand Total - - | -
- currency- |
-
| 69 | -rounding_adjustment |
- - Currency | -- Rounding Adjustment - - | -
- currency- |
-
| 70 | -rounded_total |
- - Currency | -- Rounded Total - - | -
- currency- |
-
| 71 | -in_words |
- - Data | -- In Words - - | -- |
| 72 | -payment_schedule_section |
- - Section Break | -- Payment Terms - - | -- |
| 73 | -payment_terms_template |
- - Link | -- Payment Terms Template - - | -- - - - -Payment Terms Template - - - - | -
| 74 | -payment_schedule |
- - Table | -- Payment Schedule - - | -- - - - -Payment Schedule - - - - | -
| 75 | -terms_section_break |
- - Section Break | -- Terms and Conditions - - | -
- fa fa-legal- |
-
| 76 | -tc_name |
- - Link | -- Terms - - | -- - - - -Terms and Conditions - - - - | -
| 77 | -terms |
- - Text Editor | -- Term Details - - | -- |
| 78 | -print_settings |
- - Section Break | -- Print Settings - - | -- |
| 79 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 80 | -group_same_items |
- - Check | -- Group same items - - | -- |
| 81 | -column_break_73 |
- - Column Break | -- - - | -- |
| 82 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 83 | -language |
- - Data | -- Print Language - - | -- |
| 84 | -subscription_section |
- - Section Break | -- Auto Repeat Section - - | -- |
| 85 | -auto_repeat |
- - Link | -- Auto Repeat - - | -- - - - -Auto Repeat - - - - | -
| 86 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 87 | -campaign |
- - Link | -- Campaign - - | -- - - - -Campaign - - - - | -
| 88 | -source |
- - Link | -- Source - - | -- - - - -Lead Source - - - - | -
| 89 | -order_lost_reason |
- - Small Text | -- Quotation Lost Reason - - | -- |
| 90 | -column_break4 |
- - Column Break | -- - - | -- |
| 91 | -status |
- - Select | -- Status - - | -
- Draft -Submitted -Ordered -Lost -Cancelled -Open -Replied- |
-
| 92 | -enq_det |
- - Text | -- Opportunity Item - - | -- |
| 93 | -supplier_quotation |
- - Link | -- Supplier Quotation - - | -- - - - -Supplier Quotation - - - - | -
| 94 | -opportunity |
- - Link | -- Opportunity - - | -- - - - -Opportunity - - - - | -
Inherits from erpnext.controllers.selling_controller.SellingController - -
- - - declare_order_lost - (self, arg) -
-No docs
-- - - has_sales_order - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_recurring - (self, reference_doc, auto_repeat_doc) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - print_other_charges - (self, docname) -
-No docs
-- - - set_indicator - (self) -
-No docs
-- - - update_lead - (self) -
-No docs
-- - - update_opportunity - (self) -
-No docs
-- - - update_opportunity_status - (self, opportunity=None) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_order_type - (self) -
-No docs
-- - - validate_quotation_to - (self) -
-No docs
-- - - validate_valid_till - (self) -
-No docs
-- - - erpnext.selling.doctype.quotation.quotation._make_customer - (source_name, ignore_permissions=False) -
-No docs
-- - - erpnext.selling.doctype.quotation.quotation._make_sales_invoice - (source_name, target_doc=None, ignore_permissions=False) -
-No docs
-- - - erpnext.selling.doctype.quotation.quotation._make_sales_order - (source_name, target_doc=None, ignore_permissions=False) -
-No docs
-- - - erpnext.selling.doctype.quotation.quotation.get_list_context - (context=None) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.quotation.quotation.make_sales_invoice
-
- - - erpnext.selling.doctype.quotation.quotation.make_sales_invoice - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.quotation.quotation.make_sales_order
-
- - - erpnext.selling.doctype.quotation.quotation.make_sales_order - (source_name, target_doc=None) -
-No docs
-Table Name: tabQuotation Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -customer_item_code |
- - Data | -- Customer's Item Code - - | -- |
| 3 | -col_break1 |
- - Column Break | -- - - | -- |
| 4 | -item_name |
- - Data | -- Item Name - - | -- |
| 5 | -section_break_5 |
- - Section Break | -- Description - - | -- |
| 6 | -description |
- - Text Editor | -- Description - - | -- |
| 7 | -column_break_7 |
- - Column Break | -- - - | -- |
| 8 | -image |
- - Attach | -- Image - - | -- |
| 9 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 10 | -quantity_and_rate |
- - Section Break | -- Quantity and Rate - - | -- |
| 11 | -qty |
- - Float | -- Quantity - - | -- |
| 12 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 13 | -col_break2 |
- - Column Break | -- - - | -- |
| 14 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 15 | -conversion_factor |
- - Float | -- UOM Conversion Factor - - | -- |
| 16 | -stock_qty |
- - Float | -- Qty as per Stock UOM - - | -- |
| 17 | -section_break_16 |
- - Section Break | -- - - | -- |
| 18 | -price_list_rate |
- - Currency | -- Price List Rate - - | -
- currency- |
-
| 19 | -base_price_list_rate |
- - Currency | -- Price List Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 20 | -discount_and_margin |
- - Section Break | -- Discount and Margin - - | -- |
| 21 | -margin_type |
- - Select | -- Margin Type - - | -
- -Percentage -Amount- |
-
| 22 | -margin_rate_or_amount |
- - Float | -- Margin Rate or Amount - - | -- |
| 23 | -rate_with_margin |
- - Currency | -- Rate With Margin - - | -
- currency- |
-
| 24 | -column_break_18 |
- - Column Break | -- - - | -- |
| 25 | -discount_percentage |
- - Percent | -- Discount (%) on Price List Rate with Margin - - | -- |
| 26 | -base_rate_with_margin |
- - Currency | -- Rate With Margin (Company Currency) - - | -
- Company:company:default_currency- |
-
| 27 | -section_break1 |
- - Section Break | -- - - | -- |
| 28 | -rate |
- - Currency | -- Rate - - | -
- currency- |
-
| 29 | -net_rate |
- - Currency | -- Net Rate - - | -- |
| 30 | -amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 31 | -net_amount |
- - Currency | -- Net Amount - - | -
- currency- |
-
| 32 | -col_break3 |
- - Column Break | -- - - | -- |
| 33 | -base_rate |
- - Currency | -- Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 34 | -base_net_rate |
- - Currency | -- Net Rate (Company Currency) - - | -- |
| 35 | -base_amount |
- - Currency | -- Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 36 | -base_net_amount |
- - Currency | -- Net Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 37 | -pricing_rule |
- - Link | -- Pricing Rule - - | -- - - - -Pricing Rule - - - - | -
| 38 | -item_weight_details |
- - Section Break | -- Item Weight Details - - | -- |
| 39 | -weight_per_unit |
- - Float | -- Weight Per Unit - - | -- |
| 40 | -total_weight |
- - Float | -- Total Weight - - | -- |
| 41 | -column_break_20 |
- - Column Break | -- - - | -- |
| 42 | -weight_uom |
- - Link | -- Weight UOM - - | -- - - - -UOM - - - - | -
| 43 | -item_balance |
- - Section Break | -- Item Balance - - | -- |
| 44 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 45 | -column_break_30 |
- - Column Break | -- - - | -- |
| 46 | -projected_qty |
- - Float | -- Projected Qty - - | -- |
| 47 | -actual_qty |
- - Float | -- Actual Qty - - | -- |
| 48 | -stock_balance |
- - Button | -- Stock Balance - - | -- |
| 49 | -reference |
- - Section Break | -- Reference - - | -- |
| 50 | -prevdoc_doctype |
- - Link | -- Against Doctype - - | -- - - - -DocType - - - - | -
| 51 | -prevdoc_docname |
- - Dynamic Link | -- Against Docname - - | -
- prevdoc_doctype- |
-
| 52 | -item_tax_rate |
- - Code | -- Item Tax Rate - - | -- |
| 53 | -col_break4 |
- - Column Break | -- - - | -- |
| 54 | -page_break |
- - Check | -- Page Break - - | -- |
| 55 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 56 | -brand |
- - Link | -- Brand - - | -- - - - -Brand - - - - | -
Table Name: tabSales Order
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -customer_section |
- - Section Break | -- - - | -
- fa fa-user- |
-
| 2 | -column_break0 |
- - Column Break | -- - - | -- |
| 3 | -title |
- - Data | -- Title - - | -- |
| 4 | -naming_series |
- - Select | -- Series - - | -
- SO-- |
-
| 5 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 6 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 7 | -order_type |
- - Select | -- Order Type - - | -
- -Sales -Maintenance -Shopping Cart- |
-
| 8 | -column_break1 |
- - Column Break | -- - - | -- |
| 9 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Sales Order - - - - | -
| 10 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 11 | -transaction_date |
- - Date | -- Date - - | -- |
| 12 | -delivery_date |
- - Date | -- Delivery Date - - | -- |
| 13 | -po_no |
- - Data | -- Customer's Purchase Order - - | -- |
| 14 | -po_date |
- - Date | -- Customer's Purchase Order Date - - | -- |
| 15 | -tax_id |
- - Data | -- Tax Id - - | -- |
| 16 | -contact_info |
- - Section Break | -- Address and Contact - - | -
- fa fa-bullhorn- |
-
| 17 | -customer_address |
- - Link | -- Customer Address - - | -- - - - -Address - - - - | -
| 18 | -address_display |
- - Small Text | -- Address - - | -- |
| 19 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 20 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 21 | -contact_mobile |
- - Small Text | -- Mobile No - - | -- |
| 22 | -contact_email |
- - Data | -- Contact Email - - | -
- |
-
| 23 | -col_break46 |
- - Column Break | -- - - | -- |
| 24 | -shipping_address_name |
- - Link | -- Shipping Address Name - - | -- - - - -Address - - - - | -
| 25 | -shipping_address |
- - Small Text | -- Shipping Address - - | -- |
| 26 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 27 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 28 | -currency_and_price_list |
- - Section Break | -- Currency and Price List - - | -
- fa fa-tag- |
-
| 29 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 30 | -conversion_rate |
- - Float | -
- Exchange Rate
- - Rate at which customer's currency is converted to company's base currency - |
- - |
| 31 | -column_break2 |
- - Column Break | -- - - | -- |
| 32 | -selling_price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 33 | -price_list_currency |
- - Link | -- Price List Currency - - | -- - - - -Currency - - - - | -
| 34 | -plc_conversion_rate |
- - Float | -
- Price List Exchange Rate
- - Rate at which Price list currency is converted to company's base currency - |
- - |
| 35 | -ignore_pricing_rule |
- - Check | -- Ignore Pricing Rule - - | -- |
| 36 | -items_section |
- - Section Break | -- - - | -
- fa fa-shopping-cart- |
-
| 37 | -items |
- - Table | -- Items - - | -- - - - -Sales Order Item - - - - | -
| 38 | -section_break_31 |
- - Section Break | -- - - | -- |
| 39 | -column_break_33a |
- - Column Break | -- - - | -- |
| 40 | -total_qty |
- - Float | -- Total Quantity - - | -- |
| 41 | -base_total |
- - Currency | -- Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 42 | -base_net_total |
- - Currency | -- Net Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 43 | -column_break_33 |
- - Column Break | -- - - | -- |
| 44 | -total |
- - Currency | -- Total - - | -
- currency- |
-
| 45 | -net_total |
- - Currency | -- Net Total - - | -
- currency- |
-
| 46 | -total_net_weight |
- - Float | -- Total Net Weight - - | -- |
| 47 | -taxes_section |
- - Section Break | -- Taxes and Charges - - | -
- fa fa-money- |
-
| 48 | -taxes_and_charges |
- - Link | -- Taxes and Charges - - | -- - - - -Sales Taxes and Charges Template - - - - | -
| 49 | -column_break_38 |
- - Column Break | -- - - | -- |
| 50 | -shipping_rule |
- - Link | -- Shipping Rule - - | -- - - - -Shipping Rule - - - - | -
| 51 | -section_break_40 |
- - Section Break | -- - - | -- |
| 52 | -taxes |
- - Table | -- Sales Taxes and Charges - - | -- - - - -Sales Taxes and Charges - - - - | -
| 53 | -sec_tax_breakup |
- - Section Break | -- Tax Breakup - - | -- |
| 54 | -other_charges_calculation |
- - Text | -- Taxes and Charges Calculation - - | -- |
| 55 | -section_break_43 |
- - Section Break | -- - - | -- |
| 56 | -base_total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges (Company Currency) - - | -
- Company:company:default_currency- |
-
| 57 | -column_break_46 |
- - Column Break | -- - - | -- |
| 58 | -total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges - - | -
- currency- |
-
| 59 | -section_break_48 |
- - Section Break | -- Additional Discount - - | -- |
| 60 | -apply_discount_on |
- - Select | -- Apply Additional Discount On - - | -
- -Grand Total -Net Total- |
-
| 61 | -base_discount_amount |
- - Currency | -- Additional Discount Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 62 | -column_break_50 |
- - Column Break | -- - - | -- |
| 63 | -additional_discount_percentage |
- - Float | -- Additional Discount Percentage - - | -- |
| 64 | -discount_amount |
- - Currency | -- Additional Discount Amount - - | -
- currency- |
-
| 65 | -totals |
- - Section Break | -- - - | -
- fa fa-money- |
-
| 66 | -base_grand_total |
- - Currency | -- Grand Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 67 | -base_rounding_adjustment |
- - Currency | -- Rounding Adjustment (Company Currency) - - | -
- Company:company:default_currency- |
-
| 68 | -base_rounded_total |
- - Currency | -- Rounded Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 69 | -base_in_words |
- - Data | -
- In Words (Company Currency)
- - In Words will be visible once you save the Sales Order. - |
- - |
| 70 | -column_break3 |
- - Column Break | -- - - | -- |
| 71 | -grand_total |
- - Currency | -- Grand Total - - | -
- currency- |
-
| 72 | -rounding_adjustment |
- - Currency | -- Rounding Adjustment - - | -
- currency- |
-
| 73 | -rounded_total |
- - Currency | -- Rounded Total - - | -
- currency- |
-
| 74 | -in_words |
- - Data | -- In Words - - | -- |
| 75 | -advance_paid |
- - Currency | -- Advance Paid - - | -
- party_account_currency- |
-
| 76 | -packing_list |
- - Section Break | -- Packing List - - | -
- fa fa-suitcase- |
-
| 77 | -packed_items |
- - Table | -- Packed Items - - | -- - - - -Packed Item - - - - | -
| 78 | -payment_schedule_section |
- - Section Break | -- Payment Terms - - | -- |
| 79 | -payment_terms_template |
- - Link | -- Payment Terms Template - - | -- - - - -Payment Terms Template - - - - | -
| 80 | -payment_schedule |
- - Table | -- Payment Schedule - - | -- - - - -Payment Schedule - - - - | -
| 81 | -terms_section_break |
- - Section Break | -- Terms and Conditions - - | -
- fa fa-legal- |
-
| 82 | -tc_name |
- - Link | -- Terms - - | -- - - - -Terms and Conditions - - - - | -
| 83 | -terms |
- - Text Editor | -- Terms and Conditions Details - - | -- |
| 84 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 85 | -project |
- - Link | -
- Project
- - Track this Sales Order against any Project - |
- - - - - -Project - - - - | -
| 86 | -party_account_currency |
- - Link | -- Party Account Currency - - | -- - - - -Currency - - - - | -
| 87 | -column_break_77 |
- - Column Break | -- - - | -- |
| 88 | -source |
- - Link | -- Source - - | -- - - - -Lead Source - - - - | -
| 89 | -campaign |
- - Link | -- Campaign - - | -- - - - -Campaign - - - - | -
| 90 | -printing_details |
- - Section Break | -- Printing Details - - | -- |
| 91 | -language |
- - Data | -- Print Language - - | -- |
| 92 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 93 | -column_break4 |
- - Column Break | -- - - | -- |
| 94 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 95 | -group_same_items |
- - Check | -- Group same items - - | -- |
| 96 | -section_break_78 |
- - Section Break | -- Billing and Delivery Status - - | -- |
| 97 | -status |
- - Select | -- Status - - | -
- -Draft -To Deliver and Bill -To Bill -To Deliver -Completed -Cancelled -Closed- |
-
| 98 | -delivery_status |
- - Select | -- Delivery Status - - | -
- Not Delivered -Fully Delivered -Partly Delivered -Closed -Not Applicable- |
-
| 99 | -per_delivered |
- - Percent | -
- % Delivered
- - % of materials delivered against this Sales Order - |
- - |
| 100 | -column_break_81 |
- - Column Break | -- - - | -- |
| 101 | -per_billed |
- - Percent | -
- % Amount Billed
- - % of materials billed against this Sales Order - |
- - |
| 102 | -billing_status |
- - Select | -- Billing Status - - | -
- Not Billed -Fully Billed -Partly Billed -Closed- |
-
| 103 | -sales_team_section_break |
- - Section Break | -- Commission - - | -
- fa fa-group- |
-
| 104 | -sales_partner |
- - Link | -- Sales Partner - - | -- - - - -Sales Partner - - - - | -
| 105 | -column_break7 |
- - Column Break | -- - - | -- |
| 106 | -commission_rate |
- - Float | -- Commission Rate - - | -- |
| 107 | -total_commission |
- - Currency | -- Total Commission - - | -
- Company:company:default_currency- |
-
| 108 | -section_break1 |
- - Section Break | -- Sales Team - - | -- |
| 109 | -sales_team |
- - Table | -- Sales Team1 - - | -- - - - -Sales Team - - - - | -
| 110 | -subscription_section |
- - Section Break | -- Auto Repeat Section - - | -- |
| 111 | -from_date |
- - Date | -- From Date - - | -- |
| 112 | -to_date |
- - Date | -- To Date - - | -- |
| 113 | -column_break_108 |
- - Column Break | -- - - | -- |
| 114 | -auto_repeat |
- - Link | -- Auto Repeat - - | -- - - - -Auto Repeat - - - - | -
Inherits from erpnext.controllers.selling_controller.SellingController - -
- - - __init__ - (self) -
-No docs
-- - - before_update_after_submit - (self) -
-No docs
-- - - check_credit_limit - (self) -
-No docs
-- - - check_modified_date - (self) -
-No docs
-- - - check_nextdoc_docstatus - (self) -
-No docs
-- - - get_work_order_items - (self) -
-Returns items with BOM that already do not have a linked work order
-- - - on_cancel - (self) -
-No docs
-- - - on_recurring - (self, reference_doc, auto_repeat_doc) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - product_bundle_has_stock_item - (self, product_bundle) -
-Returns true if product bundle has stock item
-- - - set_indicator - (self) -
-Set indicator for portal
-- - - update_delivery_status - (self) -
-Update delivery status from Purchase Order for drop shipping
-- - - update_enquiry_status - (self, prevdoc, flag) -
-No docs
-- - - update_prevdoc_status - (self, flag) -
-No docs
-- - - update_project - (self) -
-No docs
-- - - update_reserved_qty - (self, so_item_rows=None) -
-update requested qty (before ordered_qty is updated)
-- - - update_status - (self, status) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_delivery_date - (self) -
-No docs
-- - - validate_drop_ship - (self) -
-No docs
-- - - validate_for_items - (self) -
-No docs
-- - - validate_order_type - (self) -
-No docs
-- - - validate_po - (self) -
-No docs
-- - - validate_proj_cust - (self) -
-No docs
-- - - validate_sales_mntc_quotation - (self) -
-No docs
-- - - validate_supplier_after_submit - (self) -
-Check that supplier is the same after submit if PO is already made
-- - - validate_warehouse - (self) -
-No docs
-- - - validate_with_previous_doc - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.close_or_unclose_sales_orders
-
- - - erpnext.selling.doctype.sales_order.sales_order.close_or_unclose_sales_orders - (names, status) -
-No docs
-- - - erpnext.selling.doctype.sales_order.sales_order.get_default_bom_item - (item_code) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.get_events
-
- - - erpnext.selling.doctype.sales_order.sales_order.get_events - (start, end, filters=None) -
-Returns events for Gantt / Calendar view rendering.
- -Parameters:
- -start - Start date-time.end - End date-time.filters - Filters (JSON).- - - erpnext.selling.doctype.sales_order.sales_order.get_list_context - (context=None) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.get_supplier
-
- - - erpnext.selling.doctype.sales_order.sales_order.get_supplier - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.make_delivery_note
-
- - - erpnext.selling.doctype.sales_order.sales_order.make_delivery_note - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.make_maintenance_schedule
-
- - - erpnext.selling.doctype.sales_order.sales_order.make_maintenance_schedule - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.make_maintenance_visit
-
- - - erpnext.selling.doctype.sales_order.sales_order.make_maintenance_visit - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.make_material_request
-
- - - erpnext.selling.doctype.sales_order.sales_order.make_material_request - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.make_project
-
- - - erpnext.selling.doctype.sales_order.sales_order.make_project - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.make_purchase_order_for_drop_shipment
-
- - - erpnext.selling.doctype.sales_order.sales_order.make_purchase_order_for_drop_shipment - (source_name, for_supplier, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.make_sales_invoice
-
- - - erpnext.selling.doctype.sales_order.sales_order.make_sales_invoice - (source_name, target_doc=None, ignore_permissions=False) -
-No docs
-Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.make_work_orders
-
- - - erpnext.selling.doctype.sales_order.sales_order.make_work_orders - (items, sales_order, company, project=None) -
-Make Work Orders against the given Sales Order for the given items
Public API
- /api/method/erpnext.selling.doctype.sales_order.sales_order.update_status
-
- - - erpnext.selling.doctype.sales_order.sales_order.update_status - (status, name) -
-No docs
-Table Name: tabSales Order Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -customer_item_code |
- - Data | -- Customer's Item Code - - | -- |
| 3 | -col_break1 |
- - Column Break | -- - - | -- |
| 4 | -item_name |
- - Data | -- Item Name - - | -- |
| 5 | -section_break_5 |
- - Section Break | -- Description - - | -- |
| 6 | -description |
- - Text Editor | -- Description - - | -- |
| 7 | -delivery_date |
- - Date | -- Delivery Date - - | -- |
| 8 | -column_break_7 |
- - Column Break | -- - - | -- |
| 9 | -image |
- - Attach | -- Image - - | -- |
| 10 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 11 | -quantity_and_rate |
- - Section Break | -- Quantity and Rate - - | -- |
| 12 | -qty |
- - Float | -- Quantity - - | -- |
| 13 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 14 | -col_break2 |
- - Column Break | -- - - | -- |
| 15 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 16 | -conversion_factor |
- - Float | -- UOM Conversion Factor - - | -- |
| 17 | -stock_qty |
- - Float | -- Qty as per Stock UOM - - | -- |
| 18 | -section_break_16 |
- - Section Break | -- - - | -- |
| 19 | -price_list_rate |
- - Currency | -- Price List Rate - - | -
- currency- |
-
| 20 | -base_price_list_rate |
- - Currency | -- Price List Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 21 | -discount_and_margin |
- - Section Break | -- Discount and Margin - - | -- |
| 22 | -margin_type |
- - Select | -- Margin Type - - | -
- -Percentage -Amount- |
-
| 23 | -margin_rate_or_amount |
- - Float | -- Margin Rate or Amount - - | -- |
| 24 | -rate_with_margin |
- - Currency | -- Rate With Margin - - | -
- currency- |
-
| 25 | -column_break_19 |
- - Column Break | -- - - | -- |
| 26 | -discount_percentage |
- - Percent | -- Discount (%) on Price List Rate with Margin - - | -- |
| 27 | -base_rate_with_margin |
- - Currency | -- Rate With Margin (Company Currency) - - | -
- Company:company:default_currency- |
-
| 28 | -section_break_simple1 |
- - Section Break | -- - - | -- |
| 29 | -rate |
- - Currency | -- Rate - - | -
- currency- |
-
| 30 | -amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 31 | -col_break3 |
- - Column Break | -- - - | -- |
| 32 | -base_rate |
- - Currency | -- Basic Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 33 | -base_amount |
- - Currency | -- Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 34 | -pricing_rule |
- - Link | -- Pricing Rule - - | -- - - - -Pricing Rule - - - - | -
| 35 | -section_break_24 |
- - Section Break | -- - - | -- |
| 36 | -net_rate |
- - Currency | -- Net Rate - - | -
- currency- |
-
| 37 | -net_amount |
- - Currency | -- Net Amount - - | -
- currency- |
-
| 38 | -column_break_27 |
- - Column Break | -- - - | -- |
| 39 | -base_net_rate |
- - Currency | -- Net Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 40 | -base_net_amount |
- - Currency | -- Net Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 41 | -drop_ship_section |
- - Section Break | -- Drop Ship - - | -- |
| 42 | -delivered_by_supplier |
- - Check | -- Supplier delivers to Customer - - | -- |
| 43 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 44 | -item_weight_details |
- - Section Break | -- Item Weight Details - - | -- |
| 45 | -weight_per_unit |
- - Float | -- Weight Per Unit - - | -- |
| 46 | -total_weight |
- - Float | -- Total Weight - - | -- |
| 47 | -column_break_21 |
- - Column Break | -- - - | -- |
| 48 | -weight_uom |
- - Link | -- Weight UOM - - | -- - - - -UOM - - - - | -
| 49 | -warehouse_and_reference |
- - Section Break | -- Warehouse and Reference - - | -- |
| 50 | -warehouse |
- - Link | -- Delivery Warehouse - - | -- - - - -Warehouse - - - - | -
| 51 | -target_warehouse |
- - Link | -- Customer Warehouse (Optional) - - | -- - - - -Warehouse - - - - | -
| 52 | -prevdoc_docname |
- - Link | -- Quotation - - | -- - - - -Quotation - - - - | -
| 53 | -brand |
- - Link | -- Brand Name - - | -- - - - -Brand - - - - | -
| 54 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 55 | -billed_amt |
- - Currency | -- Billed Amt - - | -
- currency- |
-
| 56 | -valuation_rate |
- - Currency | -- Valuation Rate - - | -
- Company:company:default_currency- |
-
| 57 | -gross_profit |
- - Currency | -- Gross Profit - - | -
- Company:company:default_currency- |
-
| 58 | -page_break |
- - Check | -- Page Break - - | -- |
| 59 | -col_break4 |
- - Column Break | -- - - | -- |
| 60 | -projected_qty |
- - Float | -- Projected Qty - - | -- |
| 61 | -actual_qty |
- - Float | -- Actual Qty - - | -- |
| 62 | -ordered_qty |
- - Float | -- Ordered Qty - - | -- |
| 63 | -delivered_qty |
- - Float | -- Delivered Qty - - | -- |
| 64 | -work_order_qty |
- - Float | -- Work Order Qty - - | -- |
| 65 | -returned_qty |
- - Float | -- Returned Qty - - | -- |
| 66 | -section_break_63 |
- - Section Break | -- - - | -- |
| 67 | -planned_qty |
- - Float | -
- Planned Quantity
- - For Production - |
- - |
| 68 | -produced_qty |
- - Float | -
- Produced Quantity
- - For Production - |
- - |
| 69 | -item_tax_rate |
- - Code | -- Item Tax Rate - - | -- |
| 70 | -transaction_date |
- - Date | -
- Sales Order Date
- - Used for Production Plan - |
- - |
Table Name: tabSales Team
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -sales_person |
- - Link | -- Sales Person - - | -- - - - -Sales Person - - - - | -
| 2 | -contact_no |
- - Data | -- Contact No. - - | -- |
| 3 | -allocated_percentage |
- - Float | -- Contribution (%) - - | -- |
| 4 | -allocated_amount |
- - Currency | -- Contribution to Net Total - - | -
- Company:company:default_currency- |
-
| 5 | -incentives |
- - Currency | -- Incentives - - | -
- Company:company:default_currency- |
-
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -cust_master_name |
- - Select | -- Customer Naming By - - | -
- Customer Name -Naming Series- |
-
| 2 | -campaign_naming_by |
- - Select | -- Campaign Naming By - - | -
- Campaign Name -Naming Series- |
-
| 3 | -customer_group |
- - Link | -- Default Customer Group - - | -- - - - -Customer Group - - - - | -
| 4 | -territory |
- - Link | -- Default Territory - - | -- - - - -Territory - - - - | -
| 5 | -selling_price_list |
- - Link | -- Default Price List - - | -- - - - -Price List - - - - | -
| 6 | -close_opportunity_after_days |
- - Int | -
- Close Opportunity After Days
- - Auto close Opportunity after 15 days - |
- - |
| 7 | -default_valid_till |
- - Data | -- Default Quotation Validity Days - - | -- |
| 8 | -column_break_5 |
- - Column Break | -- - - | -- |
| 9 | -so_required |
- - Select | -- Sales Order Required - - | -
- No -Yes- |
-
| 10 | -dn_required |
- - Select | -- Delivery Note Required - - | -
- No -Yes- |
-
| 11 | -maintain_same_sales_rate |
- - Check | -- Maintain Same Rate Throughout Sales Cycle - - | -- |
| 12 | -editable_price_list_rate |
- - Check | -- Allow user to edit Price List Rate in transactions - - | -- |
| 13 | -allow_multiple_items |
- - Check | -- Allow Item to be added multiple times in a transaction - - | -- |
| 14 | -allow_against_multiple_purchase_orders |
- - Check | -- Allow multiple Sales Orders against a Customer's Purchase Order - - | -- |
| 15 | -validate_selling_price |
- - Check | -- Validate Selling Price for Item against Purchase Rate or Valuation Rate - - | -- |
| 16 | -hide_tax_id |
- - Check | -- Hide Customer's Tax Id from Sales Transactions - - | -- |
Inherits from frappe.model.document.Document - -
- - - on_update - (self) -
-No docs
-- - - set_default_customer_group_and_territory - (self) -
-No docs
-- - - toggle_hide_tax_id - (self) -
-No docs
-- - - validate - (self) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -send_to |
- - Select | -- Send To - - | -
- -All Contact -All Customer Contact -All Supplier Contact -All Sales Partner Contact -All Lead (Open) -All Employee (Active) -All Sales Person- |
-
| 2 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 3 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 4 | -sales_partner |
- - Link | -- Sales Partner - - | -- - - - -Sales Partner - - - - | -
| 5 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 6 | -branch |
- - Link | -- Branch - - | -- - - - -Branch - - - - | -
| 7 | -create_receiver_list |
- - Button | -- Create Receiver List - - | -
- create_receiver_list- |
-
| 8 | -receiver_list |
- - Code | -- Receiver List - - | -- |
| 9 | -column_break9 |
- - Column Break | -- - - | -- |
| 10 | -message |
- - Text | -
- Message
- - Messages greater than 160 characters will be split into multiple messages - |
- - |
| 11 | -total_characters |
- - Int | -- Total Characters - - | -- |
| 12 | -total_messages |
- - Int | -- Total Message(s) - - | -- |
| 13 | -send_sms |
- - Button | -- Send SMS - - | -
- send_sms- |
-
Inherits from frappe.model.document.Document - -
- - - create_receiver_list - (self) -
-No docs
-- - - get_receiver_nos - (self) -
-No docs
-- - - send_sms - (self) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|
Inherits from erpnext.utilities.transaction_base.TransactionBase - -
- - - bifurcate_based_on_type - (self, doctype_name, total, av_dis, based_on, doc_obj, val, company) -
-No docs
-- - - get_appr_user_role - (self, det, doctype_name, total, based_on, condition, item, company) -
-No docs
-- - - get_approver_name - (self, doctype_name, total, doc_obj=) -
-No docs
-- - - get_value_based_rule - (self, doctype_name, employee, total_claimed_amount, company) -
-No docs
-- - - validate_approving_authority - (self, doctype_name, company, total, doc_obj=) -
-No docs
-- - - validate_auth_rule - (self, doctype_name, total, based_on, cond, company, item=) -
-No docs
-Table Name: tabAuthorization Rule
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -transaction |
- - Select | -- Transaction - - | -
- -Sales Order -Purchase Order -Quotation -Delivery Note -Sales Invoice -Purchase Invoice -Purchase Receipt -Appraisal- |
-
| 2 | -based_on |
- - Select | -- Based On - - | -
- -Grand Total -Average Discount -Customerwise Discount -Itemwise Discount -Not Applicable- |
-
| 3 | -customer_or_item |
- - Select | -- Customer or Item - - | -
- Customer -Item- |
-
| 4 | -master_name |
- - Dynamic Link | -- Customer / Item Name - - | -
- customer_or_item- |
-
| 5 | -column_break_3 |
- - Column Break | -- - - | -- |
| 6 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 7 | -section_break_17 |
- - Section Break | -- - - | -- |
| 8 | -value |
- - Float | -- Authorized Value - - | -- |
| 9 | -section_break_7 |
- - Section Break | -- - - | -- |
| 10 | -system_role |
- - Link | -- Applicable To (Role) - - | -- - - - -Role - - - - | -
| 11 | -to_emp |
- - Link | -- Applicable To (Employee) - - | -- - - - -Employee - - - - | -
| 12 | -column_break_10 |
- - Column Break | -- - - | -- |
| 13 | -system_user |
- - Link | -- Applicable To (User) - - | -- - - - -User - - - - | -
| 14 | -to_designation |
- - Link | -- Applicable To (Designation) - - | -- - - - -Designation - - - - | -
| 15 | -section_break_13 |
- - Section Break | -- - - | -- |
| 16 | -approving_role |
- - Link | -- Approving Role (above authorized value) - - | -- - - - -Role - - - - | -
| 17 | -column_break_15 |
- - Column Break | -- - - | -- |
| 18 | -approving_user |
- - Link | -- Approving User (above authorized value) - - | -- - - - -User - - - - | -
Inherits from frappe.model.document.Document - -
- - - check_duplicate_entry - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_rule - (self) -
-No docs
-Table Name: tabBrand
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -brand |
- - Data | -- Brand Name - - | -- |
| 2 | -description |
- - Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabCompany
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -details |
- - Section Break | -- - - | -- |
| 2 | -company_name |
- - Data | -- Company - - | -- |
| 3 | -abbr |
- - Data | -- Abbr - - | -- |
| 4 | -change_abbr |
- - Button | -- Change Abbreviation - - | -- |
| 5 | -is_group |
- - Check | -- Is Group - - | -- |
| 6 | -default_finance_book |
- - Link | -- Default Finance Book - - | -- - - - -Finance Book - - - - | -
| 7 | -cb0 |
- - Column Break | -- - - | -- |
| 8 | -domain |
- - Link | -- Domain - - | -- - - - -Domain - - - - | -
| 9 | -parent_company |
- - Link | -- Parent Comapny - - | -- - - - -Company - - - - | -
| 10 | -sales_settings |
- - Section Break | -- Sales - - | -- |
| 11 | -sales_monthly_history |
- - Small Text | -- Sales Monthly History - - | -- |
| 12 | -transactions_annual_history |
- - Code | -- Transactions Annual History - - | -- |
| 13 | -monthly_sales_target |
- - Currency | -- Monthly Sales Target - - | -
- default_currency- |
-
| 14 | -column_break_goals |
- - Column Break | -- - - | -- |
| 15 | -total_monthly_sales |
- - Currency | -- Total Monthly Sales - - | -
- default_currency- |
-
| 16 | -charts_section |
- - Section Break | -- Default Values - - | -- |
| 17 | -default_currency |
- - Link | -- Default Currency - - | -- - - - -Currency - - - - | -
| 18 | -default_letter_head |
- - Link | -- Default Letter Head - - | -- - - - -Letter Head - - - - | -
| 19 | -default_holiday_list |
- - Link | -- Default Holiday List - - | -- - - - -Holiday List - - - - | -
| 20 | -default_terms |
- - Link | -- Default Terms - - | -- - - - -Terms and Conditions - - - - | -
| 21 | -column_break_10 |
- - Column Break | -- - - | -- |
| 22 | -country |
- - Link | -- Country - - | -- - - - -Country - - - - | -
| 23 | -create_chart_of_accounts_based_on |
- - Select | -- Create Chart Of Accounts Based On - - | -
- -Standard Template -Existing Company- |
-
| 24 | -chart_of_accounts |
- - Select | -- Chart Of Accounts Template - - | -- |
| 25 | -existing_company |
- - Link | -- Existing Company - - | -- - - - -Company - - - - | -
| 26 | -tax_id |
- - Data | -- Tax ID - - | -- |
| 27 | -date_of_establishment |
- - Date | -- Date of Establishment - - | -- |
| 28 | -default_settings |
- - Section Break | -- Accounts Settings - - | -- |
| 29 | -default_bank_account |
- - Link | -- Default Bank Account - - | -- - - - -Account - - - - | -
| 30 | -default_cash_account |
- - Link | -- Default Cash Account - - | -- - - - -Account - - - - | -
| 31 | -default_receivable_account |
- - Link | -- Default Receivable Account - - | -- - - - -Account - - - - | -
| 32 | -round_off_account |
- - Link | -- Round Off Account - - | -- - - - -Account - - - - | -
| 33 | -write_off_account |
- - Link | -- Write Off Account - - | -- - - - -Account - - - - | -
| 34 | -exchange_gain_loss_account |
- - Link | -- Exchange Gain / Loss Account - - | -- - - - -Account - - - - | -
| 35 | -unrealized_exchange_gain_loss_account |
- - Link | -- Unrealized Exchange Gain/Loss Account - - | -- - - - -Account - - - - | -
| 36 | -column_break0 |
- - Column Break | -- - - | -- |
| 37 | -default_payable_account |
- - Link | -- Default Payable Account - - | -- - - - -Account - - - - | -
| 38 | -default_employee_advance_account |
- - Link | -- Default Employee Advance Account - - | -- - - - -Account - - - - | -
| 39 | -default_expense_account |
- - Link | -- Default Cost of Goods Sold Account - - | -- - - - -Account - - - - | -
| 40 | -default_income_account |
- - Link | -- Default Income Account - - | -- - - - -Account - - - - | -
| 41 | -default_deferred_revenue_account |
- - Link | -- Default Deferred Revenue Account - - | -- - - - -Account - - - - | -
| 42 | -default_payroll_payable_account |
- - Link | -- Default Payroll Payable Account - - | -- - - - -Account - - - - | -
| 43 | -round_off_cost_center |
- - Link | -- Round Off Cost Center - - | -- - - - -Cost Center - - - - | -
| 44 | -section_break_22 |
- - Section Break | -- - - | -- |
| 45 | -cost_center |
- - Link | -- Default Cost Center - - | -- - - - -Cost Center - - - - | -
| 46 | -column_break_26 |
- - Column Break | -- - - | -- |
| 47 | -credit_limit |
- - Currency | -- Credit Limit - - | -
- default_currency- |
-
| 48 | -payment_terms |
- - Link | -- Default Payment Terms Template - - | -- - - - -Payment Terms Template - - - - | -
| 49 | -auto_accounting_for_stock_settings |
- - Section Break | -- Stock Settings - - | -- |
| 50 | -enable_perpetual_inventory |
- - Check | -- Enable Perpetual Inventory - - | -- |
| 51 | -default_inventory_account |
- - Link | -- Default Inventory Account - - | -- - - - -Account - - - - | -
| 52 | -stock_adjustment_account |
- - Link | -- Stock Adjustment Account - - | -- - - - -Account - - - - | -
| 53 | -column_break_32 |
- - Column Break | -- - - | -- |
| 54 | -stock_received_but_not_billed |
- - Link | -- Stock Received But Not Billed - - | -- - - - -Account - - - - | -
| 55 | -expenses_included_in_valuation |
- - Link | -- Expenses Included In Valuation - - | -- - - - -Account - - - - | -
| 56 | -fixed_asset_depreciation_settings |
- - Section Break | -- Fixed Asset Depreciation Settings - - | -- |
| 57 | -accumulated_depreciation_account |
- - Link | -- Accumulated Depreciation Account - - | -- - - - -Account - - - - | -
| 58 | -depreciation_expense_account |
- - Link | -- Depreciation Expense Account - - | -- - - - -Account - - - - | -
| 59 | -series_for_depreciation_entry |
- - Data | -- Series for Asset Depreciation Entry (Journal Entry) - - | -- |
| 60 | -expenses_included_in_asset_valuation |
- - Link | -- Expenses Included In Asset Valuation - - | -- - - - -Account - - - - | -
| 61 | -column_break_40 |
- - Column Break | -- - - | -- |
| 62 | -disposal_account |
- - Link | -- Gain/Loss Account on Asset Disposal - - | -- - - - -Account - - - - | -
| 63 | -depreciation_cost_center |
- - Link | -- Asset Depreciation Cost Center - - | -- - - - -Cost Center - - - - | -
| 64 | -capital_work_in_progress_account |
- - Link | -- Capital Work In Progress Account - - | -- - - - -Account - - - - | -
| 65 | -asset_received_but_not_billed |
- - Link | -- Asset Received But Not Billed - - | -- - - - -Account - - - - | -
| 66 | -section_break_66 |
- - Section Break | -- Payroll Settings - - | -- |
| 67 | -hra_component |
- - Link | -- HRA Component - - | -- - - - -Salary Component - - - - | -
| 68 | -arrear_component |
- - Link | -- Arrear Component - - | -- - - - -Salary Component - - - - | -
| 69 | -company_info |
- - Section Break | -
- Company Info
- - For reference only. - |
- - |
| 70 | -date_of_incorporation |
- - Date | -- Date of Incorporation - - | -- |
| 71 | -address_html |
- - HTML | -- - - | -- |
| 72 | -column_break1 |
- - Column Break | -- - - | -- |
| 73 | -date_of_commencement |
- - Date | -- Date of Commencement - - | -- |
| 74 | -phone_no |
- - Data | -- Phone No - - | -
- Phone- |
-
| 75 | -fax |
- - Data | -- Fax - - | -
- Phone- |
-
| 76 | -email |
- - Data | -- Email - - | -
- |
-
| 77 | -website |
- - Data | -- Website - - | -- |
| 78 | -registration_info |
- - Section Break | -- - - | -- |
| 79 | -registration_details |
- - Code | -
- Registration Details
- - Company registration numbers for your reference. Tax numbers etc. - |
- - |
| 80 | -delete_company_transactions |
- - Button | -- Delete Company Transactions - - | -- |
| 81 | -company_logo |
- - Attach Image | -- Company Logo - - | -- |
| 82 | -lft |
- - Int | -- Lft - - | -- |
| 83 | -rgt |
- - Int | -- Rgt - - | -- |
| 84 | -old_parent |
- - Data | -- old_parent - - | -- |
Inherits from frappe.utils.nestedset.NestedSet - -
- - - _set_default_account - (self, fieldname, account_type) -
-No docs
-- - - abbreviate - (self) -
-No docs
-- - - after_rename - (self, olddn, newdn, merge=False) -
-No docs
-- - - check_country_change - (self) -
-No docs
-- - - check_if_transactions_exist - (self) -
-No docs
-- - - create_default_accounts - (self) -
-No docs
-- - - create_default_cost_center - (self) -
-No docs
-- - - create_default_tax_template - (self) -
-No docs
-- - - create_default_warehouses - (self) -
-No docs
-- - - on_trash - (self) -
- Trash accounts and cost centers for this company if no gl entry exists
-
-- - - on_update - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - set_default_accounts - (self) -
-No docs
-- - - set_mode_of_payment_account - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_abbr - (self) -
-No docs
-- - - validate_coa_input - (self) -
-No docs
-- - - validate_currency - (self) -
-No docs
-- - - validate_default_accounts - (self) -
-No docs
-- - - validate_perpetual_inventory - (self) -
-No docs
-Public API
- /api/method/erpnext.setup.doctype.company.company.add_node
-
- - - erpnext.setup.doctype.company.company.add_node - () -
-No docs
-- - - erpnext.setup.doctype.company.company.cache_companies_monthly_sales_history - () -
-No docs
-Public API
- /api/method/erpnext.setup.doctype.company.company.enqueue_replace_abbr
-
- - - erpnext.setup.doctype.company.company.enqueue_replace_abbr - (company, old, new) -
-No docs
-- - - erpnext.setup.doctype.company.company.get_all_transactions_annual_history - (company) -
-No docs
-Public API
- /api/method/erpnext.setup.doctype.company.company.get_children
-
- - - erpnext.setup.doctype.company.company.get_children - (doctype, parent=None, company=None, is_root=False) -
-No docs
-- - - erpnext.setup.doctype.company.company.get_name_with_abbr - (name, company) -
-No docs
-- - - erpnext.setup.doctype.company.company.get_timeline_data - (doctype, name) -
-returns timeline data based on linked records in dashboard
-- - - erpnext.setup.doctype.company.company.install_country_fixtures - (company) -
-No docs
-Public API
- /api/method/erpnext.setup.doctype.company.company.replace_abbr
-
- - - erpnext.setup.doctype.company.company.replace_abbr - (company, old, new) -
-No docs
-- - - erpnext.setup.doctype.company.company.update_company_current_month_sales - (company) -
-No docs
-- - - erpnext.setup.doctype.company.company.update_company_monthly_sales - (company) -
-Cache past year monthly sales of every company based on sales invoices
-- - - erpnext.setup.doctype.company.company.update_transactions_annual_history - (company, commit=False) -
-No docs
-Table Name: tabCurrency Exchange
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -date |
- - Date | -- Date - - | -- |
| 2 | -from_currency |
- - Link | -- From Currency - - | -- - - - -Currency - - - - | -
| 3 | -to_currency |
- - Link | -- To Currency - - | -- - - - -Currency - - - - | -
| 4 | -exchange_rate |
- - Float | -- Exchange Rate - - | -- |
| 5 | -column_break_5 |
- - Column Break | -- - - | -- |
| 6 | -for_buying |
- - Check | -- For Buying - - | -- |
| 7 | -for_selling |
- - Check | -- For Selling - - | -- |
Inherits from frappe.model.document.Document - -
- - - autoname - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabCustomer Group
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -customer_group_name |
- - Data | -- Customer Group Name - - | -- |
| 2 | -parent_customer_group |
- - Link | -- Parent Customer Group - - | -- - - - -Customer Group - - - - | -
| 3 | -is_group |
- - Check | -
- Is Group
- - Only leaf nodes are allowed in transaction - |
- - |
| 4 | -cb0 |
- - Column Break | -- - - | -- |
| 5 | -default_price_list |
- - Link | -- Default Price List - - | -- - - - -Price List - - - - | -
| 6 | -payment_terms |
- - Link | -- Default Payment Terms Template - - | -- - - - -Payment Terms Template - - - - | -
| 7 | -credit_limit |
- - Currency | -- Credit Limit - - | -- |
| 8 | -lft |
- - Int | -- lft - - | -- |
| 9 | -rgt |
- - Int | -- rgt - - | -- |
| 10 | -old_parent |
- - Link | -- old_parent - - | -- - - - -Customer Group - - - - | -
| 11 | -default_receivable_account |
- - Section Break | -- Default Receivable Account - - | -- |
| 12 | -accounts |
- - Table | -
- Accounts
- - Mention if non-standard receivable account applicable - |
- - - - - -Party Account - - - - | -
Inherits from frappe.utils.nestedset.NestedSet - -
- - - on_update - (self) -
-No docs
-- - - validate_name_with_customer - (self) -
-No docs
-- - - erpnext.setup.doctype.customer_group.customer_group.get_parent_customer_groups - (customer_group) -
-No docs
-- - - erpnext.setup.doctype.customer_group.customer_group.on_doctype_update - () -
-No docs
-Table Name: tabEmail Digest
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -settings |
- - Section Break | -- Email Digest Settings - - | -- |
| 2 | -column_break0 |
- - Column Break | -- - - | -- |
| 3 | -enabled |
- - Check | -- Enabled - - | -- |
| 4 | -company |
- - Link | -- For Company - - | -- - - - -Company - - - - | -
| 5 | -frequency |
- - Select | -- How frequently? - - | -
- Daily -Weekly -Monthly- |
-
| 6 | -next_send |
- - Data | -- Next email will be sent on: - - | -- |
| 7 | -column_break1 |
- - Column Break | -- - - | -- |
| 8 | -recipient_list |
- - Code | -
- Recipients
- - Note: Email will not be sent to disabled users - |
-
- |
-
| 9 | -addremove_recipients |
- - Button | -- Add/Remove Recipients - - | -- |
| 10 | -accounts |
- - Section Break | -- Accounts - - | -- |
| 11 | -accounts_module |
- - Column Break | -- Profit & Loss - - | -- |
| 12 | -income |
- - Check | -- New Income - - | -- |
| 13 | -expenses_booked |
- - Check | -- New Expenses - - | -- |
| 14 | -income_year_to_date |
- - Check | -- Annual Income - - | -- |
| 15 | -expense_year_to_date |
- - Check | -- Annual Expenses - - | -- |
| 16 | -column_break_16 |
- - Column Break | -- Balance Sheet - - | -- |
| 17 | -bank_balance |
- - Check | -- Bank Balance - - | -- |
| 18 | -credit_balance |
- - Check | -- Credit Balance - - | -- |
| 19 | -invoiced_amount |
- - Check | -- Receivables - - | -- |
| 20 | -payables |
- - Check | -- Payables - - | -- |
| 21 | -operation |
- - Section Break | -- Operations - - | -- |
| 22 | -column_break_21 |
- - Column Break | -- - - | -- |
| 23 | -sales_order |
- - Check | -- New Sales Orders - - | -- |
| 24 | -pending_sales_orders |
- - Check | -- Pending Sales Orders - - | -- |
| 25 | -purchase_order |
- - Check | -- New Purchase Orders - - | -- |
| 26 | -pending_purchase_orders |
- - Check | -- Pending Purchase Orders - - | -- |
| 27 | -column_break_operation |
- - Column Break | -- - - | -- |
| 28 | -new_quotations |
- - Check | -- New Quotations - - | -- |
| 29 | -pending_quotations |
- - Check | -- Pending Quotations - - | -- |
| 30 | -issue |
- - Check | -- Open Issues - - | -- |
| 31 | -project |
- - Check | -- Open Projects - - | -- |
| 32 | -other |
- - Section Break | -- Other - - | -- |
| 33 | -tools |
- - Column Break | -- Tools - - | -- |
| 34 | -calendar_events |
- - Check | -- Upcoming Calendar Events - - | -- |
| 35 | -todo_list |
- - Check | -- Open To Do - - | -- |
| 36 | -notifications |
- - Check | -- Open Notifications - - | -- |
| 37 | -column_break_32 |
- - Column Break | -- - - | -- |
| 38 | -add_quote |
- - Check | -- Add Quote - - | -- |
Inherits from frappe.model.document.Document - -
- - - __init__ - (self) -
-No docs
-- - - fmt_money - (self, value, absol=True) -
-No docs
-- - - get_bank_balance - (self) -
-No docs
-- - - get_calendar_events - (self) -
-Get calendar events for given user
-- - - get_credit_balance - (self) -
-No docs
-- - - get_expense_year_to_date - (self) -
-Get income to date
-- - - get_expenses_booked - (self) -
-No docs
-- - - get_from_to_date - (self) -
-No docs
-- - - get_income - (self) -
-Get income for given period
-- - - get_income_year_to_date - (self) -
-Get income to date
-- - - get_invoiced_amount - (self) -
-No docs
-- - - get_issue_count - (self) -
-Get count of Issue
-- - - get_issue_list - (self, user_id=None) -
-Get issue list
-- - - get_msg_html - (self) -
-Build email digest content
-- - - get_new_quotations - (self) -
-No docs
-- - - get_next_sending - (self) -
-No docs
-- - - get_notifications - (self) -
-Get notifications for user
-- - - get_payables - (self) -
-No docs
-- - - get_pending_purchase_orders - (self) -
-No docs
-- - - get_pending_quotations - (self) -
-No docs
-- - - get_pending_sales_orders - (self) -
-No docs
-- - - get_period_amounts - (self, accounts, fieldname) -
-Get amounts for current and past periods
-- - - get_project_count - (self) -
-Get count of Project
-- - - get_project_list - (self, user_id=None) -
-Get project list
-- - - get_purchase_order - (self) -
-No docs
-- - - get_root_type_accounts - (self, root_type) -
-No docs
-- - - get_sales_order - (self) -
-No docs
-- - - get_summary_of_doc - (self, doc_type, fieldname) -
-No docs
-- - - get_summary_of_pending - (self, doc_type, fieldname, getfield) -
-No docs
-- - - get_summary_of_pending_quotations - (self, fieldname) -
-No docs
-- - - get_todo_count - (self, user_id=None) -
-Get count of Todo
-- - - get_todo_list - (self, user_id=None) -
-Get to-do list
-- - - get_total_on - (self, doc_type, from_date, to_date) -
-No docs
-- - - get_type_balance - (self, fieldname, account_type, root_type=None) -
-No docs
-- - - get_users - (self) -
-get list of users
-- - - get_year_to_date_balance - (self, root_type, fieldname) -
-Get income to date
-- - - onload - (self) -
-No docs
-- - - send - (self) -
-No docs
-- - - set_accounting_cards - (self, context) -
-Create accounting cards if checked
-- - - set_dates - (self) -
-No docs
-- - - set_style - (self, context) -
-Set standard digest style
-- - - set_title - (self, context) -
-Set digest title
-Public API
- /api/method/erpnext.setup.doctype.email_digest.email_digest.get_digest_msg
-
- - - erpnext.setup.doctype.email_digest.email_digest.get_digest_msg - (name) -
-No docs
-- - - erpnext.setup.doctype.email_digest.email_digest.send - () -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -default_company |
- - Link | -- Default Company - - | -- - - - -Company - - - - | -
| 2 | -current_fiscal_year |
- - Link | -- Current Fiscal Year - - | -- - - - -Fiscal Year - - - - | -
| 3 | -country |
- - Link | -- Country - - | -- - - - -Country - - - - | -
| 4 | -column_break_8 |
- - Column Break | -- - - | -- |
| 5 | -default_currency |
- - Link | -- Default Currency - - | -- - - - -Currency - - - - | -
| 6 | -hide_currency_symbol |
- - Select | -
- Hide Currency Symbol
- - Do not show any symbol like $ etc next to currencies. - |
-
- -No -Yes- |
-
| 7 | -disable_rounded_total |
- - Check | -
- Disable Rounded Total
- - If disable, 'Rounded Total' field will not be visible in any transaction - |
- - |
| 8 | -disable_in_words |
- - Check | -
- Disable In Words
- - If disable, 'In Words' field will not be visible in any transaction - |
- - |
Inherits from frappe.model.document.Document - -
- - - get_defaults - (self) -
-No docs
-- - - on_update - (self) -
-update defaults
-- - - toggle_in_words - (self) -
-No docs
-- - - toggle_rounded_total - (self) -
-No docs
-Table Name: tabItem Group
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -gs |
- - Section Break | -- General Settings - - | -- |
| 2 | -item_group_name |
- - Data | -- Item Group Name - - | -- |
| 3 | -parent_item_group |
- - Link | -- Parent Item Group - - | -- - - - -Item Group - - - - | -
| 4 | -is_group |
- - Check | -
- Is Group
- - Only leaf nodes are allowed in transaction - |
- - |
| 5 | -column_break_5 |
- - Column Break | -- - - | -- |
| 6 | -default_income_account |
- - Link | -- Default Income Account - - | -- - - - -Account - - - - | -
| 7 | -default_expense_account |
- - Link | -- Default Expense Account - - | -- - - - -Account - - - - | -
| 8 | -default_cost_center |
- - Link | -- Default Cost Center - - | -- - - - -Cost Center - - - - | -
| 9 | -sb9 |
- - Section Break | -- Website Settings - - | -- |
| 10 | -show_in_website |
- - Check | -
- Show in Website
- - Check this if you want to show in website - |
- - |
| 11 | -route |
- - Data | -- Route - - | -- |
| 12 | -slideshow |
- - Link | -
- Slideshow
- - Show this slideshow at the top of the page - |
- - - - - -Website Slideshow - - - - | -
| 13 | -description |
- - Text Editor | -
- Description
- - HTML / Banner that will show on the top of product list. - |
- - |
| 14 | -website_specifications |
- - Table | -- Website Specifications - - | -- - - - -Item Website Specification - - - - | -
| 15 | -lft |
- - Int | -- lft - - | -- |
| 16 | -rgt |
- - Int | -- rgt - - | -- |
| 17 | -old_parent |
- - Link | -- old_parent - - | -- - - - -Item Group - - - - | -
Inherits from frappe.utils.nestedset.NestedSet, frappe.website.website_generator.WebsiteGenerator - -
- - - autoname - (self) -
-No docs
-- - - get_context - (self, context) -
-No docs
-- - - make_route - (self) -
-Make website route
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_name_with_item - (self) -
-No docs
-- - - erpnext.setup.doctype.item_group.item_group.adjust_qty_for_expired_items - (data) -
-No docs
-- - - erpnext.setup.doctype.item_group.item_group.get_child_groups - (item_group_name) -
-No docs
-- - - erpnext.setup.doctype.item_group.item_group.get_group_item_count - (item_group) -
-No docs
-- - - erpnext.setup.doctype.item_group.item_group.get_item_for_list_in_html - (context) -
-No docs
-- - - erpnext.setup.doctype.item_group.item_group.get_parent_item_groups - (item_group_name) -
-No docs
-Public API
- /api/method/erpnext.setup.doctype.item_group.item_group.get_product_list_for_group
-
- - - erpnext.setup.doctype.item_group.item_group.get_product_list_for_group - (product_group=None, start=0, limit=10, search=None) -
-No docs
-- - - erpnext.setup.doctype.item_group.item_group.invalidate_cache_for - (doc, item_group=None) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -setup_series |
- - Section Break | -
- Setup Series
- - Set prefix for numbering series on your transactions - |
- - |
| 2 | -select_doc_for_series |
- - Select | -- Select Transaction - - | -- |
| 3 | -help_html |
- - HTML | -- Help HTML - - | -- |
| 4 | -set_options |
- - Text | -- Series List for this Transaction - - | -- |
| 5 | -user_must_always_select |
- - Check | -
- User must always select
- - Check this if you want to force the user to select a series before saving. There will be no default if you check this. - |
- - |
| 6 | -update |
- - Button | -- Update - - | -- |
| 7 | -update_series |
- - Section Break | -
- Update Series
- - Change the starting / current sequence number of an existing series. - |
- - |
| 8 | -prefix |
- - Select | -- Prefix - - | -- |
| 9 | -current_value |
- - Int | -
- Current Value
- - This is the number of the last created transaction with this prefix - |
- - |
| 10 | -update_series_start |
- - Button | -- Update Series Number - - | -
- update_series_start- |
-
Inherits from frappe.model.document.Document - -
- - - check_duplicate - (self) -
-No docs
-- - - get_current - (self, arg=None) -
-get series current
-- - - get_options - (self, arg=None) -
-No docs
-- - - get_transactions - (self, arg=None) -
-No docs
-- - - insert_series - (self, series) -
-insert series if missing
-- - - parse_naming_series - (self) -
-No docs
-- - - scrub_options_list - (self, ol) -
-No docs
-- - - set_series_for - (self, doctype, ol) -
-No docs
-- - - update_series - (self, arg=None) -
-update series list
-- - - update_series_start - (self) -
-No docs
-- - - validate_series_name - (self, n) -
-No docs
-- - - validate_series_set - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.setup.doctype.naming_series.naming_series.get_default_naming_series - (doctype) -
-No docs
-- - - erpnext.setup.doctype.naming_series.naming_series.set_by_naming_series - (doctype, fieldname, naming_series, hide_name_field=True) -
-No docs
-Table Name: tabParty Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -party_type |
- - Link | -- Party Type - - | -- - - - -DocType - - - - | -
| 2 | -account_type |
- - Select | -- Account Type - - | -
- Payable -Receivable- |
-
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.setup.doctype.party_type.party_type.get_party_type
-
- - - erpnext.setup.doctype.party_type.party_type.get_party_type - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Table Name: tabPrint Heading
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -print_heading |
- - Data | -- Print Heading - - | -- |
| 2 | -description |
- - Small Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabQuotation Lost Reason
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -order_lost_reason |
- - Data | -- Quotation Lost Reason - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabSales Partner
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -partner_name |
- - Data | -- Sales Partner Name - - | -- |
| 2 | -partner_type |
- - Select | -- Partner Type - - | -
- -Channel Partner -Distributor -Dealer -Agent -Retailer -Implementation Partner -Reseller- |
-
| 3 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 4 | -column_break0 |
- - Column Break | -- - - | -- |
| 5 | -commission_rate |
- - Float | -- Commission Rate - - | -- |
| 6 | -address_contacts |
- - Section Break | -- Address & Contacts - - | -- |
| 7 | -address_desc |
- - HTML | -- Address Desc - - | -- |
| 8 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 9 | -column_break1 |
- - Column Break | -- - - | -- |
| 10 | -contact_desc |
- - HTML | -- Contact Desc - - | -- |
| 11 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
| 12 | -partner_target_details_section_break |
- - Section Break | -- Sales Partner Target - - | -- |
| 13 | -targets |
- - Table | -- Targets - - | -- - - - -Target Detail - - - - | -
| 14 | -distribution_id |
- - Link | -
- Target Distribution
- - Select Monthly Distribution to unevenly distribute targets across months. - |
- - - - - -Monthly Distribution - - - - | -
| 15 | -website |
- - Section Break | -- Website - - | -- |
| 16 | -show_in_website |
- - Check | -- Show In Website - - | -- |
| 17 | -section_break_17 |
- - Section Break | -- - - | -- |
| 18 | -route |
- - Data | -- Route - - | -- |
| 19 | -column_break_20 |
- - Column Break | -- - - | -- |
| 20 | -logo |
- - Attach | -- Logo - - | -- |
| 21 | -partner_website |
- - Data | -- Partner website - - | -- |
| 22 | -section_break_22 |
- - Section Break | -- - - | -- |
| 23 | -introduction |
- - Text | -- Introduction - - | -- |
| 24 | -description |
- - Text Editor | -- Description - - | -- |
Inherits from frappe.website.website_generator.WebsiteGenerator - -
- - - autoname - (self) -
-No docs
-- - - get_context - (self, context) -
-No docs
-- - - onload - (self) -
-Load address and contacts in __onload
- - - validate - (self) -
-No docs
-Table Name: tabSales Person
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -name_and_employee_id |
- - Section Break | -- Name and Employee ID - - | -
- icon-user- |
-
| 2 | -sales_person_name |
- - Data | -- Sales Person Name - - | -- |
| 3 | -parent_sales_person |
- - Link | -
- Parent Sales Person
- - Select company name first. - |
- - - - - -Sales Person - - - - | -
| 4 | -is_group |
- - Check | -- Is Group - - | -- |
| 5 | -enabled |
- - Check | -- Enabled - - | -- |
| 6 | -cb0 |
- - Column Break | -- - - | -- |
| 7 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 8 | -department |
- - Link | -- Department - - | -- - - - -Department - - - - | -
| 9 | -lft |
- - Int | -- lft - - | -- |
| 10 | -rgt |
- - Int | -- rgt - - | -- |
| 11 | -old_parent |
- - Data | -- old_parent - - | -- |
| 12 | -target_details_section_break |
- - Section Break | -
- Sales Person Targets
- - Set targets Item Group-wise for this Sales Person. - |
-
- icon-bullseye- |
-
| 13 | -targets |
- - Table | -- Targets - - | -- - - - -Target Detail - - - - | -
| 14 | -distribution_id |
- - Link | -
- Target Distribution
- - Select Monthly Distribution to unevenly distribute targets across months. - |
- - - - - -Monthly Distribution - - - - | -
Inherits from frappe.utils.nestedset.NestedSet - -
- - - get_email_id - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_employee_id - (self) -
-No docs
-- - - erpnext.setup.doctype.sales_person.sales_person.on_doctype_update - () -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -actions_sb |
- - Section Break | -- Actions - - | -- |
| 2 | -actions |
- - Table | -- Actions - - | -- - - - -Setup Progress Action - - - - | -
Inherits from frappe.model.document.Document - -
- - - erpnext.setup.doctype.setup_progress.setup_progress.get_action_completed_state - (action_name) -
-No docs
-- - - erpnext.setup.doctype.setup_progress.setup_progress.get_domain_actions_state - (domain) -
-No docs
-- - - erpnext.setup.doctype.setup_progress.setup_progress.get_setup_progress - () -
-No docs
-Public API
- /api/method/erpnext.setup.doctype.setup_progress.setup_progress.set_action_completed_state
-
- - - erpnext.setup.doctype.setup_progress.setup_progress.set_action_completed_state - (action_name) -
-No docs
-- - - erpnext.setup.doctype.setup_progress.setup_progress.update_action - (doc) -
-No docs
-- - - erpnext.setup.doctype.setup_progress.setup_progress.update_action_completed_state - (action_name) -
-No docs
-- - - erpnext.setup.doctype.setup_progress.setup_progress.update_domain_actions - (domain) -
-No docs
-Table Name: tabSetup Progress Action
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -action_name |
- - Data | -- Action Name - - | -- |
| 2 | -action_doctype |
- - Link | -- Action Doctype - - | -- - - - -DocType - - - - | -
| 3 | -action_document |
- - Dynamic Link | -- Action Document - - | -
- action_doctype- |
-
| 4 | -action_field |
- - Data | -- Action Field - - | -- |
| 5 | -min_doc_count |
- - Int | -- Min Doc Count - - | -- |
| 6 | -domains |
- - Code | -- Domains - - | -- |
| 7 | -is_completed |
- - Check | -- Is Completed - - | -- |
Table Name: tabSupplier Group
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -supplier_group_name |
- - Data | -- Supplier Group Name - - | -- |
| 2 | -parent_supplier_group |
- - Link | -- Parent Supplier Group - - | -- - - - -Supplier Group - - - - | -
| 3 | -is_group |
- - Check | -- Is Group - - | -- |
| 4 | -section_credit_limit |
- - Section Break | -- Credit Limit - - | -- |
| 5 | -payment_terms |
- - Link | -- Default Payment Terms Template - - | -- - - - -Payment Terms Template - - - - | -
| 6 | -default_payable_account |
- - Section Break | -- Default Payable Account - - | -- |
| 7 | -accounts |
- - Table | -
- Accounts
- - Mention if non-standard receivable account applicable - |
- - - - - -Party Account - - - - | -
| 8 | -lft |
- - Int | -- lft - - | -- |
| 9 | -rgt |
- - Int | -- rgt - - | -- |
| 10 | -old_parent |
- - Link | -- Old Parent - - | -- - - - -Supplier Group - - - - | -
Inherits from frappe.utils.nestedset.NestedSet - -
- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabTarget Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 2 | -fiscal_year |
- - Link | -- Fiscal Year - - | -- - - - -Fiscal Year - - - - | -
| 3 | -target_qty |
- - Float | -- Target Qty - - | -- |
| 4 | -target_amount |
- - Float | -- Target Amount - - | -- |
Table Name: tabTerms and Conditions
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -title |
- - Data | -- Title - - | -- |
| 2 | -disabled |
- - Check | -- Disabled - - | -- |
| 3 | -terms |
- - Text Editor | -- Terms and Conditions - - | -- |
| 4 | -terms_and_conditions_help |
- - HTML | -- Terms and Conditions Help - - | -- |
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.setup.doctype.terms_and_conditions.terms_and_conditions.get_terms_and_conditions
-
- - - erpnext.setup.doctype.terms_and_conditions.terms_and_conditions.get_terms_and_conditions - (template_name, doc) -
-No docs
-Table Name: tabTerritory
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -territory_name |
- - Data | -- Territory Name - - | -- |
| 2 | -parent_territory |
- - Link | -- Parent Territory - - | -- - - - -Territory - - - - | -
| 3 | -is_group |
- - Check | -- Is Group - - | -- |
| 4 | -cb0 |
- - Column Break | -- - - | -- |
| 5 | -territory_manager |
- - Link | -
- Territory Manager
- - For reference - |
- - - - - -Sales Person - - - - | -
| 6 | -lft |
- - Int | -- lft - - | -- |
| 7 | -rgt |
- - Int | -- rgt - - | -- |
| 8 | -old_parent |
- - Link | -- old_parent - - | -- - - - -Territory - - - - | -
| 9 | -target_details_section_break |
- - Section Break | -
- Territory Targets
- - Set Item Group-wise budgets on this Territory. You can also include seasonality by setting the Distribution. - |
- - |
| 10 | -targets |
- - Table | -- Targets - - | -- - - - -Target Detail - - - - | -
| 11 | -distribution_id |
- - Link | -
- Target Distribution
- - Select Monthly Distribution to unevenly distribute targets across months. - |
- - - - - -Monthly Distribution - - - - | -
Inherits from frappe.utils.nestedset.NestedSet - -
- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.setup.doctype.territory.territory.on_doctype_update - () -
-No docs
-Table Name: tabUOM
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -uom_name |
- - Data | -- UOM Name - - | -- |
| 2 | -must_be_whole_number |
- - Check | -
- Must be Whole Number
- - Check this to disallow fractions. (for Nos) - |
- - |
Inherits from frappe.model.document.Document - -
Table Name: tabUOM Conversion Factor
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -category |
- - Link | -- Category - - | -- - - - -UOM Category - - - - | -
| 2 | -section_break_2 |
- - Section Break | -- - - | -- |
| 3 | -from_uom |
- - Link | -- From - - | -- - - - -UOM - - - - | -
| 4 | -to_uom |
- - Link | -- To - - | -- - - - -UOM - - - - | -
| 5 | -value |
- - Float | -- Value - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabWebsite Item Group
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -enabled |
- - Check | -- Enable purchase of items via the website - - | -- |
| 2 | -display_settings |
- - Section Break | -- Display Settings - - | -- |
| 3 | -show_attachments |
- - Check | -- Show Public Attachments - - | -- |
| 4 | -show_price |
- - Check | -- Show Price - - | -- |
| 5 | -column_break_5 |
- - Column Break | -- - - | -- |
| 6 | -show_stock_availability |
- - Check | -- Show Stock Availability - - | -- |
| 7 | -show_quantity_in_website |
- - Check | -- Show Stock Quantity - - | -- |
| 8 | -section_break_2 |
- - Section Break | -- - - | -- |
| 9 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 10 | -price_list |
- - Link | -
- Price List
- - Prices will not be shown if Price List is not set - |
- - - - - -Price List - - - - | -
| 11 | -column_break_4 |
- - Column Break | -- - - | -- |
| 12 | -default_customer_group |
- - Link | -- Default Customer Group - - | -- - - - -Customer Group - - - - | -
| 13 | -quotation_series |
- - Select | -- Quotation Series - - | -- |
| 14 | -section_break_8 |
- - Section Break | -- Checkout Settings - - | -- |
| 15 | -enable_checkout |
- - Check | -- Enable Checkout - - | -- |
| 16 | -payment_success_url |
- - Select | -
- Payment Success Url
- - After payment completion redirect user to selected page. - |
-
- -Orders -Invoices -My Account- |
-
| 17 | -column_break_11 |
- - Column Break | -- - - | -- |
| 18 | -payment_gateway_account |
- - Link | -- Payment Gateway Account - - | -- - - - -Payment Gateway Account - - - - | -
Inherits from frappe.model.document.Document - -
- - - get_shipping_rules - (self, shipping_territory) -
-No docs
-- - - get_tax_master - (self, billing_territory) -
-No docs
-- - - onload - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_exchange_rates_exist - (self) -
-check if exchange rates exist for all Price List currencies (to company's currency)
-- - - validate_tax_rule - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.shopping_cart.doctype.shopping_cart_settings.shopping_cart_settings.check_shopping_cart_enabled - () -
-No docs
-- - - erpnext.shopping_cart.doctype.shopping_cart_settings.shopping_cart_settings.get_shopping_cart_settings - () -
-No docs
-- - - erpnext.shopping_cart.doctype.shopping_cart_settings.shopping_cart_settings.is_cart_enabled - () -
-No docs
-- - - erpnext.shopping_cart.doctype.shopping_cart_settings.shopping_cart_settings.show_attachments - () -
-No docs
-- - - erpnext.shopping_cart.doctype.shopping_cart_settings.shopping_cart_settings.show_quantity_in_website - () -
-No docs
-- - - erpnext.shopping_cart.doctype.shopping_cart_settings.shopping_cart_settings.validate_cart_settings - (doc, method) -
-No docs
-Table Name: tabBatch
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -batch_id |
- - Data | -- Batch ID - - | -- |
| 2 | -item |
- - Link | -- Item - - | -- - - - -Item - - - - | -
| 3 | -image |
- - Attach Image | -- image - - | -- |
| 4 | -parent_batch |
- - Link | -- Parent Batch - - | -- - - - -Batch - - - - | -
| 5 | -column_break_3 |
- - Column Break | -- - - | -- |
| 6 | -manufacturing_date |
- - Date | -- Manufacturing Date - - | -- |
| 7 | -expiry_date |
- - Date | -- Expiry Date - - | -- |
| 8 | -source |
- - Section Break | -- Source - - | -- |
| 9 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 10 | -column_break_9 |
- - Column Break | -- - - | -- |
| 11 | -reference_doctype |
- - Link | -- Source Document Type - - | -- - - - -DocType - - - - | -
| 12 | -reference_name |
- - Dynamic Link | -- Source Document Name - - | -
- reference_doctype- |
-
| 13 | -section_break_7 |
- - Section Break | -- - - | -- |
| 14 | -description |
- - Small Text | -- Batch Description - - | -- |
Inherits from frappe.model.document.Document - -
- - - after_delete - (self) -
-No docs
-- - - autoname - (self) -
-Generate random ID for batch if not specified
-- - - before_save - (self) -
-No docs
-- - - get_name_from_naming_series - (self) -
- Get a name generated for a Batch from the Batch's naming series.
- :return: The string that was generated.
-
-- - - item_has_batch_enabled - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.stock.doctype.batch.batch._get_batch_prefix - () -
-Get the naming series prefix set in Stock Settings.
-
-It does not do any sanity checks so make sure to use it after checking if the Batch
-is set to use naming series.
-:return: The naming series.
-
-- - - erpnext.stock.doctype.batch.batch._make_naming_series_key - (prefix) -
-Make naming series key for a Batch.
-
-Naming series key is in the format [prefix].[#####]
-
-
-Parameters:
- -prefix - Naming series prefix gotten from Stock Settings
:return: The derived key. If no prefix is given, an empty string is returned
- - - erpnext.stock.doctype.batch.batch.batch_uses_naming_series - () -
-Verify if the Batch is to be named using a naming series
-:return: bool
-
-- - - erpnext.stock.doctype.batch.batch.get_batch_naming_series - () -
-Get naming series key for a Batch.
-
-Naming series key is in the format [prefix].[#####]
-:return: The naming series or empty string if not available
-
-Public API
- /api/method/erpnext.stock.doctype.batch.batch.get_batch_no
-
- - - erpnext.stock.doctype.batch.batch.get_batch_no - (item_code, warehouse, qty=1, throw=False) -
-Get batch number using First Expiring First Out method.
-
-
-Parameters:
- -item_code - item_code of Item Documentwarehouse - name of Warehouse to checkqty - quantity of Items
:return: String represent batch number of batch with sufficient quantity else an empty String
Public API
- /api/method/erpnext.stock.doctype.batch.batch.get_batch_qty
-
- - - erpnext.stock.doctype.batch.batch.get_batch_qty - (batch_no=None, warehouse=None, item_code=None) -
-Returns batch actual qty if warehouse is passed, - or returns dict of qty by warehouse if warehouse is None
- -The user must pass either batch_no or batch_no + warehouse or item_code + warehouse
-
-
-Parameters:
- -batch_no - Optional - give qty for this batch nowarehouse - Optional - give qty for this warehouseitem_code - Optional - give qty for this item- - - erpnext.stock.doctype.batch.batch.get_batches - (item_code, warehouse, qty=1, throw=False) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.batch.batch.get_batches_by_oldest
-
- - - erpnext.stock.doctype.batch.batch.get_batches_by_oldest - (item_code, warehouse) -
-Returns the oldest batch and qty for the given item_code and warehouse
-- - - erpnext.stock.doctype.batch.batch.get_name_from_hash - () -
-Get a name for a Batch by generating a unique hash.
-:return: The hash that was generated.
-
-- - - erpnext.stock.doctype.batch.batch.set_batch_nos - (doc, warehouse_field, throw=False) -
-Automatically select batch_no for outgoing items in item table
Public API
- /api/method/erpnext.stock.doctype.batch.batch.split_batch
-
- - - erpnext.stock.doctype.batch.batch.split_batch - (batch_no, item_code, warehouse, qty, new_batch_id=None) -
-Split the batch into a new batch
-Table Name: tabBin
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 2 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 3 | -reserved_qty |
- - Float | -- Reserved Quantity - - | -- |
| 4 | -actual_qty |
- - Float | -- Actual Quantity - - | -- |
| 5 | -ordered_qty |
- - Float | -- Ordered Quantity - - | -- |
| 6 | -indented_qty |
- - Float | -- Requested Quantity - - | -- |
| 7 | -planned_qty |
- - Float | -- Planned Qty - - | -- |
| 8 | -projected_qty |
- - Float | -- Projected Qty - - | -- |
| 9 | -reserved_qty_for_production |
- - Float | -- Reserved Qty for Production - - | -- |
| 10 | -reserved_qty_for_sub_contract |
- - Float | -- Reserved Qty for sub contract - - | -- |
| 11 | -ma_rate |
- - Float | -- Moving Average Rate - - | -- |
| 12 | -stock_uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 13 | -fcfs_rate |
- - Float | -- FCFS Rate - - | -- |
| 14 | -valuation_rate |
- - Float | -- Valuation Rate - - | -- |
| 15 | -stock_value |
- - Float | -- Stock Value - - | -- |
Inherits from frappe.model.document.Document - -
- - - get_first_sle - (self) -
-No docs
-- - - set_projected_qty - (self) -
-No docs
-- - - update_qty - (self, args) -
-No docs
-- - - update_reserved_qty_for_production - (self) -
-Update qty reserved for production from Production Item tables - in open work orders
-- - - update_reserved_qty_for_sub_contracting - (self) -
-No docs
-- - - update_stock - (self, args, allow_negative_stock=False, via_landed_cost_voucher=False) -
-Called from erpnext.stock.utils.update_bin
-- - - validate - (self) -
-No docs
-- - - validate_mandatory - (self) -
-No docs
-- - - erpnext.stock.doctype.bin.bin.on_doctype_update - () -
-No docs
-Table Name: tabCustoms Tariff Number
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -tariff_number |
- - Data | -- Tariff Number - - | -- |
| 2 | -description |
- - Data | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabDelivery Note
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -delivery_to_section |
- - Section Break | -- Delivery To - - | -
- fa fa-user- |
-
| 2 | -column_break0 |
- - Column Break | -- - - | -- |
| 3 | -title |
- - Data | -- Title - - | -- |
| 4 | -naming_series |
- - Select | -- Series - - | -
- DN- -DN-RET-- |
-
| 5 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 6 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 7 | -column_break1 |
- - Column Break | -- - - | -- |
| 8 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Delivery Note - - - - | -
| 9 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 10 | -posting_date |
- - Date | -- Date - - | -- |
| 11 | -posting_time |
- - Time | -- Posting Time - - | -- |
| 12 | -set_posting_time |
- - Check | -- Edit Posting Date and Time - - | -- |
| 13 | -is_return |
- - Check | -- Is Return - - | -- |
| 14 | -return_against |
- - Link | -- Return Against Delivery Note - - | -- - - - -Delivery Note - - - - | -
| 15 | -customer_po_details |
- - Section Break | -- Customer PO Details - - | -- |
| 16 | -po_no |
- - Data | -- Customer's Purchase Order No - - | -- |
| 17 | -column_break_17 |
- - Column Break | -- - - | -- |
| 18 | -po_date |
- - Date | -- Customer's Purchase Order Date - - | -- |
| 19 | -contact_info |
- - Section Break | -- Address and Contact - - | -
- fa fa-bullhorn- |
-
| 20 | -shipping_address_name |
- - Link | -- Shipping Address - - | -- - - - -Address - - - - | -
| 21 | -shipping_address |
- - Small Text | -- Shipping Address - - | -- |
| 22 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 23 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 24 | -contact_mobile |
- - Small Text | -- Mobile No - - | -- |
| 25 | -contact_email |
- - Data | -- Contact Email - - | -
- |
-
| 26 | -col_break21 |
- - Column Break | -- - - | -- |
| 27 | -customer_address |
- - Link | -- Billing Address Name - - | -- - - - -Address - - - - | -
| 28 | -tax_id |
- - Data | -- Tax Id - - | -- |
| 29 | -address_display |
- - Small Text | -- Billing Address - - | -- |
| 30 | -company_address |
- - Link | -- Company Address Name - - | -- - - - -Address - - - - | -
| 31 | -company_address_display |
- - Small Text | -- Company Address - - | -- |
| 32 | -currency_and_price_list |
- - Section Break | -- Currency and Price List - - | -
- fa fa-tag- |
-
| 33 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 34 | -conversion_rate |
- - Float | -
- Exchange Rate
- - Rate at which customer's currency is converted to company's base currency - |
- - |
| 35 | -col_break23 |
- - Column Break | -- - - | -- |
| 36 | -selling_price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 37 | -price_list_currency |
- - Link | -- Price List Currency - - | -- - - - -Currency - - - - | -
| 38 | -plc_conversion_rate |
- - Float | -
- Price List Exchange Rate
- - Rate at which Price list currency is converted to company's base currency - |
- - |
| 39 | -ignore_pricing_rule |
- - Check | -- Ignore Pricing Rule - - | -- |
| 40 | -items_section |
- - Section Break | -- - - | -
- fa fa-shopping-cart- |
-
| 41 | -items |
- - Table | -- Items - - | -- - - - -Delivery Note Item - - - - | -
| 42 | -packing_list |
- - Section Break | -- Packing List - - | -
- fa fa-suitcase- |
-
| 43 | -packed_items |
- - Table | -- Packed Items - - | -- - - - -Packed Item - - - - | -
| 44 | -product_bundle_help |
- - HTML | -- Product Bundle Help - - | -- |
| 45 | -section_break_31 |
- - Section Break | -- - - | -- |
| 46 | -total_qty |
- - Float | -- Total Quantity - - | -- |
| 47 | -base_total |
- - Currency | -- Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 48 | -base_net_total |
- - Currency | -- Net Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 49 | -column_break_33 |
- - Column Break | -- - - | -- |
| 50 | -total |
- - Currency | -- Total - - | -
- currency- |
-
| 51 | -net_total |
- - Currency | -- Net Total - - | -
- currency- |
-
| 52 | -total_net_weight |
- - Float | -- Total Net Weight - - | -- |
| 53 | -taxes_section |
- - Section Break | -- Taxes and Charges - - | -
- fa fa-money- |
-
| 54 | -taxes_and_charges |
- - Link | -
- Taxes and Charges
- - If you have created a standard template in Sales Taxes and Charges Template, select one and click on the button below. - |
- - - - - -Sales Taxes and Charges Template - - - - | -
| 55 | -column_break_39 |
- - Column Break | -- - - | -- |
| 56 | -shipping_rule |
- - Link | -- Shipping Rule - - | -- - - - -Shipping Rule - - - - | -
| 57 | -section_break_41 |
- - Section Break | -- - - | -- |
| 58 | -taxes |
- - Table | -- Sales Taxes and Charges - - | -- - - - -Sales Taxes and Charges - - - - | -
| 59 | -sec_tax_breakup |
- - Section Break | -- Tax Breakup - - | -- |
| 60 | -other_charges_calculation |
- - Text | -- Taxes and Charges Calculation - - | -- |
| 61 | -section_break_44 |
- - Section Break | -- - - | -- |
| 62 | -base_total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges (Company Currency) - - | -
- Company:company:default_currency- |
-
| 63 | -column_break_47 |
- - Column Break | -- - - | -- |
| 64 | -total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges - - | -
- currency- |
-
| 65 | -section_break_49 |
- - Section Break | -- Additional Discount - - | -- |
| 66 | -apply_discount_on |
- - Select | -- Apply Additional Discount On - - | -
- -Grand Total -Net Total- |
-
| 67 | -base_discount_amount |
- - Currency | -- Additional Discount Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 68 | -column_break_51 |
- - Column Break | -- - - | -- |
| 69 | -additional_discount_percentage |
- - Float | -- Additional Discount Percentage - - | -- |
| 70 | -discount_amount |
- - Currency | -- Additional Discount Amount - - | -
- currency- |
-
| 71 | -totals |
- - Section Break | -- - - | -
- fa fa-money- |
-
| 72 | -base_grand_total |
- - Currency | -- Grand Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 73 | -base_rounding_adjustment |
- - Currency | -- Rounding Adjustment (Company Currency) - - | -
- Company:company:default_currency- |
-
| 74 | -base_rounded_total |
- - Currency | -- Rounded Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 75 | -base_in_words |
- - Data | -
- In Words (Company Currency)
- - In Words will be visible once you save the Delivery Note. - |
- - |
| 76 | -column_break3 |
- - Column Break | -- - - | -- |
| 77 | -grand_total |
- - Currency | -- Grand Total - - | -
- currency- |
-
| 78 | -rounding_adjustment |
- - Currency | -- Rounding Adjustment - - | -
- currency- |
-
| 79 | -rounded_total |
- - Currency | -- Rounded Total - - | -
- currency- |
-
| 80 | -in_words |
- - Data | -
- In Words
- - In Words (Export) will be visible once you save the Delivery Note. - |
- - |
| 81 | -terms_section_break |
- - Section Break | -- Terms and Conditions - - | -
- fa fa-legal- |
-
| 82 | -tc_name |
- - Link | -- Terms - - | -- - - - -Terms and Conditions - - - - | -
| 83 | -terms |
- - Text Editor | -- Terms and Conditions Details - - | -- |
| 84 | -transporter_info |
- - Section Break | -- Transporter Info - - | -
- fa fa-truck- |
-
| 85 | -transporter_name |
- - Data | -- Transporter Name - - | -- |
| 86 | -col_break34 |
- - Column Break | -- - - | -- |
| 87 | -lr_no |
- - Data | -- Vehicle No - - | -- |
| 88 | -lr_date |
- - Date | -- Vehicle Dispatch Date - - | -- |
| 89 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 90 | -project |
- - Link | -
- Project
- - Track this Delivery Note against any Project - |
- - - - - -Project - - - - | -
| 91 | -campaign |
- - Link | -- Campaign - - | -- - - - -Campaign - - - - | -
| 92 | -source |
- - Link | -- Source - - | -- - - - -Lead Source - - - - | -
| 93 | -column_break5 |
- - Column Break | -- - - | -- |
| 94 | -per_billed |
- - Percent | -- % Amount Billed - - | -- |
| 95 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 96 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 97 | -printing_details |
- - Section Break | -- Printing Details - - | -- |
| 98 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 99 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 100 | -language |
- - Data | -- Print Language - - | -- |
| 101 | -column_break_88 |
- - Column Break | -- - - | -- |
| 102 | -print_without_amount |
- - Check | -- Print Without Amount - - | -- |
| 103 | -group_same_items |
- - Check | -- Group same items - - | -- |
| 104 | -section_break_83 |
- - Section Break | -- Status - - | -- |
| 105 | -status |
- - Select | -- Status - - | -
- -Draft -To Bill -Completed -Cancelled -Closed- |
-
| 106 | -per_installed |
- - Percent | -
- % Installed
- - % of materials delivered against this Delivery Note - |
- - |
| 107 | -installation_status |
- - Select | -- Installation Status - - | -- |
| 108 | -column_break_89 |
- - Column Break | -- - - | -- |
| 109 | -to_warehouse |
- - Link | -
- To Warehouse
- - Required only for sample item. - |
- - - - - -Warehouse - - - - | -
| 110 | -excise_page |
- - Data | -- Excise Page Number - - | -- |
| 111 | -instructions |
- - Text | -- Instructions - - | -- |
| 112 | -subscription_section |
- - Section Break | -- Subscription Section - - | -- |
| 113 | -auto_repeat |
- - Link | -- Auto Repeat - - | -- - - - -Auto Repeat - - - - | -
| 114 | -sales_team_section_break |
- - Section Break | -- Commission - - | -
- fa fa-group- |
-
| 115 | -sales_partner |
- - Link | -- Sales Partner - - | -- - - - -Sales Partner - - - - | -
| 116 | -column_break7 |
- - Column Break | -- - - | -- |
| 117 | -commission_rate |
- - Float | -- Commission Rate (%) - - | -- |
| 118 | -total_commission |
- - Currency | -- Total Commission - - | -
- Company:company:default_currency- |
-
| 119 | -section_break1 |
- - Section Break | -- Sales Team - - | -- |
| 120 | -sales_team |
- - Table | -- Sales Team1 - - | -- - - - -Sales Team - - - - | -
Inherits from erpnext.controllers.selling_controller.SellingController - -
- - - __init__ - (self) -
-No docs
-- - - before_print - (self) -
-No docs
-- - - cancel_packing_slips - (self) -
- Cancel submitted packing slips related to this delivery note
-
-- - - check_credit_limit - (self) -
-No docs
-- - - check_next_docstatus - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - set_actual_qty - (self) -
-No docs
-- - - so_required - (self) -
-check in manage account if sales order required or not
-- - - update_billing_status - (self, update_modified=True) -
-No docs
-- - - update_current_stock - (self) -
-No docs
-- - - update_status - (self, status) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_for_items - (self) -
-No docs
-- - - validate_packed_qty - (self) -
- Validate that if packed qty exists, it should be equal to qty
-
-- - - validate_proj_cust - (self) -
-check for does customer belong to same project as entered..
-- - - validate_warehouse - (self) -
-No docs
-- - - validate_with_previous_doc - (self) -
-No docs
-- - - erpnext.stock.doctype.delivery_note.delivery_note.get_invoiced_qty_map - (delivery_note) -
-returns a map: {dndetail: invoicedqty}
-- - - erpnext.stock.doctype.delivery_note.delivery_note.get_list_context - (context=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.delivery_note.delivery_note.make_delivery_trip
-
- - - erpnext.stock.doctype.delivery_note.delivery_note.make_delivery_trip - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.delivery_note.delivery_note.make_installation_note
-
- - - erpnext.stock.doctype.delivery_note.delivery_note.make_installation_note - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.delivery_note.delivery_note.make_packing_slip
-
- - - erpnext.stock.doctype.delivery_note.delivery_note.make_packing_slip - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.delivery_note.delivery_note.make_sales_invoice
-
- - - erpnext.stock.doctype.delivery_note.delivery_note.make_sales_invoice - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.delivery_note.delivery_note.make_sales_return
-
- - - erpnext.stock.doctype.delivery_note.delivery_note.make_sales_return - (source_name, target_doc=None) -
-No docs
-- - - erpnext.stock.doctype.delivery_note.delivery_note.update_billed_amount_based_on_so - (so_detail, update_modified=True) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.delivery_note.delivery_note.update_delivery_note_status
-
- - - erpnext.stock.doctype.delivery_note.delivery_note.update_delivery_note_status - (docname, status) -
-No docs
-Table Name: tabDelivery Note Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -barcode |
- - Data | -- Barcode - - | -- |
| 2 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 3 | -item_name |
- - Data | -- Item Name - - | -- |
| 4 | -col_break1 |
- - Column Break | -- - - | -- |
| 5 | -customer_item_code |
- - Data | -- Customer's Item Code - - | -- |
| 6 | -section_break_6 |
- - Section Break | -- Description - - | -- |
| 7 | -description |
- - Text Editor | -- Description - - | -- |
| 8 | -column_break_8 |
- - Column Break | -- - - | -- |
| 9 | -image |
- - Attach | -- Image - - | -- |
| 10 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 11 | -quantity_and_rate |
- - Section Break | -- Quantity and Rate - - | -- |
| 12 | -qty |
- - Float | -- Quantity - - | -- |
| 13 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 14 | -col_break2 |
- - Column Break | -- - - | -- |
| 15 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 16 | -conversion_factor |
- - Float | -- UOM Conversion Factor - - | -- |
| 17 | -stock_qty |
- - Float | -- Qty as per Stock UOM - - | -- |
| 18 | -section_break_17 |
- - Section Break | -- - - | -- |
| 19 | -price_list_rate |
- - Currency | -- Price List Rate - - | -
- currency- |
-
| 20 | -base_price_list_rate |
- - Currency | -- Price List Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 21 | -discount_and_margin |
- - Section Break | -- Discount and Margin - - | -- |
| 22 | -margin_type |
- - Select | -- Margin Type - - | -
- -Percentage -Amount- |
-
| 23 | -margin_rate_or_amount |
- - Float | -- Margin Rate or Amount - - | -- |
| 24 | -rate_with_margin |
- - Currency | -- Rate With Margin - - | -
- currency- |
-
| 25 | -column_break_19 |
- - Column Break | -- - - | -- |
| 26 | -discount_percentage |
- - Float | -- Discount (%) on Price List Rate with Margin - - | -- |
| 27 | -base_rate_with_margin |
- - Currency | -- Rate With Margin (Company Currency) - - | -
- Company:company:default_currency- |
-
| 28 | -section_break_1 |
- - Section Break | -- - - | -- |
| 29 | -rate |
- - Currency | -- Rate - - | -
- currency- |
-
| 30 | -amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 31 | -col_break3 |
- - Column Break | -- - - | -- |
| 32 | -base_rate |
- - Currency | -- Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 33 | -base_amount |
- - Currency | -- Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 34 | -pricing_rule |
- - Link | -- Pricing Rule - - | -- - - - -Pricing Rule - - - - | -
| 35 | -section_break_25 |
- - Section Break | -- - - | -- |
| 36 | -net_rate |
- - Currency | -- Net Rate - - | -
- currency- |
-
| 37 | -net_amount |
- - Currency | -- Net Amount - - | -
- currency- |
-
| 38 | -column_break_28 |
- - Column Break | -- - - | -- |
| 39 | -base_net_rate |
- - Currency | -- Net Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 40 | -base_net_amount |
- - Currency | -- Net Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 41 | -item_weight_details |
- - Section Break | -- Item Weight Details - - | -- |
| 42 | -weight_per_unit |
- - Float | -- Weight Per Unit - - | -- |
| 43 | -total_weight |
- - Float | -- Total Weight - - | -- |
| 44 | -column_break_21 |
- - Column Break | -- - - | -- |
| 45 | -weight_uom |
- - Link | -- Weight UOM - - | -- - - - -UOM - - - - | -
| 46 | -warehouse_and_reference |
- - Section Break | -- Warehouse and Reference - - | -- |
| 47 | -warehouse |
- - Link | -- From Warehouse - - | -- - - - -Warehouse - - - - | -
| 48 | -target_warehouse |
- - Link | -- Customer Warehouse (Optional) - - | -- - - - -Warehouse - - - - | -
| 49 | -quality_inspection |
- - Link | -- Quality Inspection - - | -- - - - -Quality Inspection - - - - | -
| 50 | -section_break_40 |
- - Section Break | -- - - | -- |
| 51 | -batch_no |
- - Link | -- Batch No - - | -- - - - -Batch - - - - | -
| 52 | -actual_qty |
- - Float | -- Available Qty at From Warehouse - - | -- |
| 53 | -actual_batch_qty |
- - Float | -- Available Batch Qty at From Warehouse - - | -- |
| 54 | -serial_no |
- - Text | -- Serial No - - | -- |
| 55 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 56 | -brand |
- - Link | -- Brand Name - - | -- - - - -Brand - - - - | -
| 57 | -item_tax_rate |
- - Small Text | -- Item Tax Rate - - | -- |
| 58 | -col_break4 |
- - Column Break | -- - - | -- |
| 59 | -expense_account |
- - Link | -- Expense Account - - | -- - - - -Account - - - - | -
| 60 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 61 | -allow_zero_valuation_rate |
- - Check | -- Allow Zero Valuation Rate - - | -- |
| 62 | -against_sales_order |
- - Link | -- Against Sales Order - - | -- - - - -Sales Order - - - - | -
| 63 | -against_sales_invoice |
- - Link | -- Against Sales Invoice - - | -- - - - -Sales Invoice - - - - | -
| 64 | -so_detail |
- - Data | -- Against Sales Order Item - - | -- |
| 65 | -si_detail |
- - Data | -- Against Sales Invoice Item - - | -- |
| 66 | -installed_qty |
- - Float | -- Installed Qty - - | -- |
| 67 | -billed_amt |
- - Currency | -- Billed Amt - - | -
- currency- |
-
| 68 | -page_break |
- - Check | -- Page Break - - | -- |
Table Name: tabDelivery Stop
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 2 | -address |
- - Link | -- Address Name - - | -- - - - -Address - - - - | -
| 3 | -column_break_6 |
- - Column Break | -- - - | -- |
| 4 | -customer_address |
- - Small Text | -- Customer Address - - | -- |
| 5 | -section_break_7 |
- - Section Break | -- - - | -- |
| 6 | -contact |
- - Link | -- Contact Name - - | -- - - - -Contact - - - - | -
| 7 | -column_break_7 |
- - Column Break | -- - - | -- |
| 8 | -customer_contact |
- - Small Text | -- Customer Contact - - | -- |
| 9 | -section_break_9 |
- - Section Break | -- - - | -- |
| 10 | -estimated_arrival |
- - Time | -- Estimated Arrival - - | -- |
| 11 | -details |
- - Text Editor | -- Details - - | -- |
| 12 | -section_break_12 |
- - Section Break | -- - - | -- |
| 13 | -delivery_note |
- - Link | -- Delivery Note - - | -- - - - -Delivery Note - - - - | -
| 14 | -section_break_14 |
- - Section Break | -- - - | -- |
| 15 | -notified_by_email |
- - Check | -- Notified by Email - - | -- |
| 16 | -column_break_18 |
- - Column Break | -- - - | -- |
| 17 | -email_sent_to |
- - Data | -- Email sent to - - | -- |
Table Name: tabDelivery Trip
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- TOUR-.#####- |
-
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -column_break_2 |
- - Column Break | -- - - | -- |
| 4 | -email_notification_sent |
- - Check | -- Initial Email Notification Sent - - | -- |
| 5 | -section_break_3 |
- - Section Break | -- - - | -- |
| 6 | -date |
- - Date | -- Date - - | -- |
| 7 | -departure_time |
- - Time | -- Departure Time - - | -- |
| 8 | -column_break_4 |
- - Column Break | -- - - | -- |
| 9 | -driver |
- - Link | -- Driver - - | -- - - - -Driver - - - - | -
| 10 | -driver_name |
- - Data | -- Driver Name - - | -- |
| 11 | -vehicle |
- - Link | -- Vehicle - - | -- - - - -Vehicle - - - - | -
| 12 | -delivery_service_stops |
- - Section Break | -- Delivery Stops - - | -- |
| 13 | -delivery_stops |
- - Table | -- Delivery Stop - - | -- - - - -Delivery Stop - - - - | -
| 14 | -calculate_arrival_time |
- - Button | -- Calculate Estimated Arrival Times - - | -- |
| 15 | -section_break_13 |
- - Section Break | -- - - | -- |
| 16 | -delivery_notification |
- - Link | -- Delivery Notification - - | -- - - - -Email Template - - - - | -
| 17 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Delivery Trip - - - - | -
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.stock.doctype.delivery_trip.delivery_trip.calculate_time_matrix
-
- - - erpnext.stock.doctype.delivery_trip.delivery_trip.calculate_time_matrix - (name) -
-Calucation and round in closest 15 minutes, delivery stops
-Public API
- /api/method/erpnext.stock.doctype.delivery_trip.delivery_trip.get_contact_and_address
-
- - - erpnext.stock.doctype.delivery_trip.delivery_trip.get_contact_and_address - (name) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.delivery_trip.delivery_trip.get_contact_display
-
- - - erpnext.stock.doctype.delivery_trip.delivery_trip.get_contact_display - (contact) -
-No docs
-- - - erpnext.stock.doctype.delivery_trip.delivery_trip.get_default_address - (out, name) -
-No docs
-- - - erpnext.stock.doctype.delivery_trip.delivery_trip.get_default_contact - (out, name) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.delivery_trip.delivery_trip.notify_customers
-
- - - erpnext.stock.doctype.delivery_trip.delivery_trip.notify_customers - (docname, date, driver, vehicle, sender_email, delivery_notification) -
-No docs
-Table Name: tabItem
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -name_and_description_section |
- - Section Break | -- - - | -
- fa fa-flag- |
-
| 2 | -naming_series |
- - Select | -- Series - - | -
- ITEM-- |
-
| 3 | -item_code |
- - Data | -- Item Code - - | -- |
| 4 | -variant_of |
- - Link | -
- Variant Of
- - If item is a variant of another item then description, image, pricing, taxes etc will be set from the template unless explicitly specified - |
- - - - - -Item - - - - | -
| 5 | -item_name |
- - Data | -- Item Name - - | -- |
| 6 | -barcode |
- - Data | -- Barcode - - | -- |
| 7 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 8 | -is_item_from_hub |
- - Check | -- Is Item from Hub - - | -- |
| 9 | -stock_uom |
- - Link | -- Default Unit of Measure - - | -- - - - -UOM - - - - | -
| 10 | -column_break0 |
- - Column Break | -- - - | -- |
| 11 | -disabled |
- - Check | -- Disabled - - | -- |
| 12 | -allow_alternative_item |
- - Check | -- Allow Alternative Item - - | -- |
| 13 | -is_stock_item |
- - Check | -- Maintain Stock - - | -- |
| 14 | -is_fixed_asset |
- - Check | -- Is Fixed Asset - - | -- |
| 15 | -asset_category |
- - Link | -- Asset Category - - | -- - - - -Asset Category - - - - | -
| 16 | -asset_naming_series |
- - Select | -- Asset Naming Series - - | -- |
| 17 | -tolerance |
- - Float | -- Allow over delivery or receipt upto this percent - - | -- |
| 18 | -image |
- - Attach Image | -- Image - - | -
- image- |
-
| 19 | -section_break_11 |
- - Section Break | -- Description - - | -- |
| 20 | -brand |
- - Link | -- Brand - - | -- - - - -Brand - - - - | -
| 21 | -description |
- - Text Editor | -- Description - - | -- |
| 22 | -sb_barcodes |
- - Section Break | -- Barcodes - - | -- |
| 23 | -barcodes |
- - Table | -- Barcodes - - | -- - - - -Item Barcode - - - - | -
| 24 | -inventory |
- - Section Break | -- Inventory - - | -
- fa fa-truck- |
-
| 25 | -shelf_life_in_days |
- - Int | -- Shelf Life In Days - - | -- |
| 26 | -end_of_life |
- - Date | -- End of Life - - | -- |
| 27 | -default_material_request_type |
- - Select | -- Default Material Request Type - - | -
- Purchase -Material Transfer -Material Issue -Manufacture- |
-
| 28 | -valuation_method |
- - Select | -- Valuation Method - - | -
- -FIFO -Moving Average- |
-
| 29 | -column_break1 |
- - Column Break | -- - - | -- |
| 30 | -warranty_period |
- - Data | -- Warranty Period (in days) - - | -- |
| 31 | -weight_per_unit |
- - Float | -- Weight Per Unit - - | -- |
| 32 | -weight_uom |
- - Link | -- Weight UOM - - | -- - - - -UOM - - - - | -
| 33 | -reorder_section |
- - Section Break | -- Auto re-order - - | -
- fa fa-rss- |
-
| 34 | -reorder_levels |
- - Table | -
- Reorder level based on Warehouse
- - Will also apply for variants unless overrridden - |
- - - - - -Item Reorder - - - - | -
| 35 | -unit_of_measure_conversion |
- - Section Break | -- Units of Measure - - | -- |
| 36 | -uoms |
- - Table | -
- UOMs
- - Will also apply for variants - |
- - - - - -UOM Conversion Detail - - - - | -
| 37 | -serial_nos_and_batches |
- - Section Break | -- Serial Nos and Batches - - | -- |
| 38 | -has_batch_no |
- - Check | -- Has Batch No - - | -- |
| 39 | -create_new_batch |
- - Check | -- Automatically Create New Batch - - | -- |
| 40 | -batch_number_series |
- - Data | -
- Batch Number Series
- - Example: ABCD.#####. If series is set and Batch No is not mentioned in transactions, then automatic batch number will be created based on this series. If you always want to explicitly mention Batch No for this item, leave this blank. Note: this setting will take priority over the Naming Series Prefix in Stock Settings. - |
- - |
| 41 | -has_expiry_date |
- - Check | -- Has Expiry Date - - | -- |
| 42 | -retain_sample |
- - Check | -- Retain Sample - - | -- |
| 43 | -sample_quantity |
- - Int | -
- Max Sample Quantity
- - Maximum sample quantity that can be retained - |
- - |
| 44 | -column_break_37 |
- - Column Break | -- - - | -- |
| 45 | -has_serial_no |
- - Check | -- Has Serial No - - | -- |
| 46 | -serial_no_series |
- - Data | -
- Serial Number Series
- - Example: ABCD.##### -If series is set and Serial No is not mentioned in transactions, then automatic serial number will be created based on this series. If you always want to explicitly mention Serial Nos for this item. leave this blank. - |
- - |
| 47 | -variants_section |
- - Section Break | -- Variants - - | -- |
| 48 | -has_variants |
- - Check | -
- Has Variants
- - If this item has variants, then it cannot be selected in sales orders etc. - |
- - |
| 49 | -variant_based_on |
- - Select | -- Variant Based On - - | -
- Item Attribute -Manufacturer- |
-
| 50 | -attributes |
- - Table | -- Attributes - - | -- - - - -Item Variant Attribute - - - - | -
| 51 | -defaults |
- - Section Break | -- Defaults - - | -- |
| 52 | -item_defaults |
- - Table | -- Item Defaults - - | -- - - - -Item Default - - - - | -
| 53 | -purchase_details |
- - Section Break | -- Purchase Details - - | -
- fa fa-shopping-cart- |
-
| 54 | -is_purchase_item |
- - Check | -- Is Purchase Item - - | -- |
| 55 | -purchase_uom |
- - Link | -- Default Purchase Unit of Measure - - | -- - - - -UOM - - - - | -
| 56 | -min_order_qty |
- - Float | -- Minimum Order Qty - - | -- |
| 57 | -safety_stock |
- - Float | -- Safety Stock - - | -- |
| 58 | -purchase_details_cb |
- - Column Break | -- - - | -- |
| 59 | -lead_time_days |
- - Int | -
- Lead Time in days
- - Average time taken by the supplier to deliver - |
- - |
| 60 | -last_purchase_rate |
- - Float | -- Last Purchase Rate - - | -- |
| 61 | -supplier_details |
- - Section Break | -- Supplier Details - - | -- |
| 62 | -delivered_by_supplier |
- - Check | -- Delivered by Supplier (Drop Ship) - - | -- |
| 63 | -manufacturer |
- - Link | -- Manufacturer - - | -- - - - -Manufacturer - - - - | -
| 64 | -manufacturer_part_no |
- - Data | -- Manufacturer Part Number - - | -- |
| 65 | -column_break2 |
- - Column Break | -- Item Code for Suppliers - - | -- |
| 66 | -supplier_items |
- - Table | -- Supplier Items - - | -- - - - -Item Supplier - - - - | -
| 67 | -foreign_trade_details |
- - Section Break | -- Foreign Trade Details - - | -- |
| 68 | -country_of_origin |
- - Link | -- Country of Origin - - | -- - - - -Country - - - - | -
| 69 | -column_break_59 |
- - Column Break | -- - - | -- |
| 70 | -customs_tariff_number |
- - Link | -- Customs Tariff Number - - | -- - - - -Customs Tariff Number - - - - | -
| 71 | -sales_details |
- - Section Break | -- Sales Details - - | -
- fa fa-tag- |
-
| 72 | -sales_uom |
- - Link | -- Default Sales Unit of Measure - - | -- - - - -UOM - - - - | -
| 73 | -is_sales_item |
- - Check | -- Is Sales Item - - | -- |
| 74 | -column_break3 |
- - Column Break | -- - - | -- |
| 75 | -max_discount |
- - Float | -- Max Discount (%) - - | -- |
| 76 | -deferred_revenue |
- - Section Break | -- Deferred Revenue - - | -- |
| 77 | -enable_deferred_revenue |
- - Check | -- Enable Deferred Revenue - - | -- |
| 78 | -deferred_revenue_account |
- - Link | -- Deferred Revenue Account - - | -- - - - -Account - - - - | -
| 79 | -column_break_85 |
- - Column Break | -- - - | -- |
| 80 | -no_of_months |
- - Int | -- No of Months - - | -- |
| 81 | -customer_details |
- - Section Break | -- Customer Details - - | -- |
| 82 | -customer_items |
- - Table | -- Customer Items - - | -- - - - -Item Customer Detail - - - - | -
| 83 | -item_tax_section_break |
- - Section Break | -- Item Tax - - | -
- fa fa-money- |
-
| 84 | -taxes |
- - Table | -
- Taxes
- - Will also apply for variants - |
- - - - - -Item Tax - - - - | -
| 85 | -inspection_criteria |
- - Section Break | -- Inspection Criteria - - | -
- fa fa-search- |
-
| 86 | -inspection_required_before_purchase |
- - Check | -- Inspection Required before Purchase - - | -- |
| 87 | -inspection_required_before_delivery |
- - Check | -- Inspection Required before Delivery - - | -- |
| 88 | -quality_inspection_template |
- - Link | -- Quality Inspection Template - - | -- - - - -Quality Inspection Template - - - - | -
| 89 | -manufacturing |
- - Section Break | -- Manufacturing - - | -
- fa fa-cogs- |
-
| 90 | -default_bom |
- - Link | -- Default BOM - - | -- - - - -BOM - - - - | -
| 91 | -is_sub_contracted_item |
- - Check | -
- Supply Raw Materials for Purchase
- - If subcontracted to a vendor - |
- - |
| 92 | -column_break_74 |
- - Column Break | -- - - | -- |
| 93 | -customer_code |
- - Data | -- Customer Code - - | -- |
| 94 | -website_section |
- - Section Break | -- Website - - | -
- fa fa-globe- |
-
| 95 | -show_in_website |
- - Check | -- Show in Website - - | -- |
| 96 | -show_variant_in_website |
- - Check | -- Show in Website (Variant) - - | -- |
| 97 | -route |
- - Small Text | -- Route - - | -- |
| 98 | -weightage |
- - Int | -
- Weightage
- - Items with higher weightage will be shown higher - |
- - |
| 99 | -slideshow |
- - Link | -
- Slideshow
- - Show a slideshow at the top of the page - |
- - - - - -Website Slideshow - - - - | -
| 100 | -website_image |
- - Attach | -
- Image
- - Item Image (if not slideshow) - |
- - |
| 101 | -thumbnail |
- - Data | -- Thumbnail - - | -- |
| 102 | -cb72 |
- - Column Break | -- - - | -- |
| 103 | -website_warehouse |
- - Link | -
- Website Warehouse
- - Show "In Stock" or "Not in Stock" based on stock available in this warehouse. - |
- - - - - -Warehouse - - - - | -
| 104 | -website_item_groups |
- - Table | -
- Website Item Groups
- - List this Item in multiple groups on the website. - |
- - - - - -Website Item Group - - - - | -
| 105 | -sb72 |
- - Section Break | -- Website Specifications - - | -- |
| 106 | -copy_from_item_group |
- - Button | -- Copy From Item Group - - | -- |
| 107 | -website_specifications |
- - Table | -- Website Specifications - - | -- - - - -Item Website Specification - - - - | -
| 108 | -web_long_description |
- - Text Editor | -- Website Description - - | -- |
| 109 | -total_projected_qty |
- - Float | -- Total Projected Qty - - | -- |
| 110 | -hub_publishing_sb |
- - Section Break | -- Hub Publishing Details - - | -- |
| 111 | -publish_in_hub |
- - Check | -
- Publish in Hub
- - Publish Item to hub.erpnext.com - |
- - |
| 112 | -opening_stock |
- - Float | -- Opening Stock - - | -- |
| 113 | -valuation_rate |
- - Currency | -- Valuation Rate - - | -- |
| 114 | -standard_rate |
- - Currency | -- Standard Selling Rate - - | -- |
| 115 | -hub_category_to_publish |
- - Data | -- Hub Category to Publish - - | -- |
| 116 | -hub_warehouse |
- - Link | -
- Hub Warehouse
- - Publish "In Stock" or "Not in Stock" on Hub based on stock available in this warehouse. - |
- - - - - -Warehouse - - - - | -
| 117 | -synced_with_hub |
- - Check | -- Synced With Hub - - | -- |
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.website.website_generator.WebsiteGenerator - -
- - - add_default_uom_in_conversion_factor_table - (self) -
-No docs
-- - - add_price - (self, price_list=None) -
-Add a new price
-- - - after_insert - (self) -
-set opening stock and item price
-- - - after_rename - (self, old_name, new_name, merge) -
-No docs
-- - - autoname - (self) -
-No docs
-- - - before_insert - (self) -
-No docs
-- - - before_rename - (self, old_name, new_name, merge=False) -
-No docs
-- - - check_for_active_boms - (self) -
-No docs
-- - - check_item_tax - (self) -
-Check whether Tax Rate is not entered twice for same Tax Type
-- - - copy_specification_from_item_group - (self) -
-No docs
-- - - fill_customer_code - (self) -
-Append all the customer codes and insert into "customer_code" field of item table
-- - - get_context - (self, context) -
-No docs
-- - - make_route - (self) -
-No docs
-- - - make_thumbnail - (self) -
-Make a thumbnail of website_image
- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - recalculate_bin_qty - (self, new_name) -
-No docs
-- - - set_asset_naming_series - (self) -
-No docs
-- - - set_attribute_context - (self, context) -
-No docs
-- - - set_disabled_attributes - (self, context) -
-Disable selection options of attribute combinations that do not result in a variant
-- - - set_last_purchase_rate - (self, new_name) -
-No docs
-- - - set_opening_stock - (self) -
-set opening stock
-- - - set_variant_context - (self, context) -
-No docs
-- - - stock_ledger_created - (self) -
-No docs
-- - - update_bom_item_desc - (self) -
-No docs
-- - - update_item_price - (self) -
-No docs
-- - - update_template_item - (self) -
-Set Show in Website for Template Item if True for its Variant
-- - - update_template_tables - (self) -
-No docs
-- - - update_variants - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_attributes - (self) -
-No docs
-- - - validate_barcode - (self) -
-No docs
-- - - validate_conversion_factor - (self) -
-No docs
-- - - validate_description - (self) -
-Clean HTML description if set
-- - - validate_fixed_asset - (self) -
-No docs
-- - - validate_has_variants - (self) -
-No docs
-- - - validate_item_type - (self) -
-No docs
-- - - validate_name_with_item_group - (self) -
-No docs
-- - - validate_retain_sample - (self) -
-No docs
-- - - validate_stock_exists_for_template_item - (self) -
-No docs
-- - - validate_uom - (self) -
-No docs
-- - - validate_uom_conversion_factor - (self) -
-No docs
-- - - validate_variant_attributes - (self) -
-No docs
-- - - validate_warehouse_for_reorder - (self) -
-Validate Reorder level table for duplicate and conditional mandatory
-- - - validate_website_image - (self) -
-Validate if the website image is a public file
-Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.stock.doctype.item.item._msgprint - (msg, verbose) -
-No docs
-- - - erpnext.stock.doctype.item.item.check_stock_uom_with_bin - (item, stock_uom) -
-No docs
-- - - erpnext.stock.doctype.item.item.get_item_defaults - (item, company) -
-No docs
-- - - erpnext.stock.doctype.item.item.get_last_purchase_details - (item_code, doc_name=None, conversion_rate=1.0) -
-returns last purchase details in stock uom
-- - - erpnext.stock.doctype.item.item.get_timeline_data - (doctype, name) -
-returns timeline data based on stock ledger entry
-Public API
- /api/method/erpnext.stock.doctype.item.item.get_uom_conv_factor
-
- - - erpnext.stock.doctype.item.item.get_uom_conv_factor - (uom, stock_uom) -
-No docs
-- - - erpnext.stock.doctype.item.item.invalidate_cache_for_item - (doc) -
-No docs
-- - - erpnext.stock.doctype.item.item.validate_cancelled_item - (item_code, docstatus=None, verbose=1) -
-No docs
-- - - erpnext.stock.doctype.item.item.validate_end_of_life - (item_code, end_of_life=None, disabled=None, verbose=1) -
-No docs
-- - - erpnext.stock.doctype.item.item.validate_is_stock_item - (item_code, is_stock_item=None, verbose=1) -
-No docs
-Table Name: tabItem Alternative
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -alternative_item_code |
- - Link | -- Alternative Item Code - - | -- - - - -Item - - - - | -
| 3 | -two_way |
- - Check | -- Two-way - - | -- |
| 4 | -column_break_4 |
- - Column Break | -- - - | -- |
| 5 | -item_name |
- - Read Only | -- Item Name - - | -- |
| 6 | -alternative_item_name |
- - Read Only | -- Alternative Item Name - - | -- |
Inherits from frappe.model.document.Document - -
- - - has_alternative_item - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_alternative_item - (self) -
-No docs
-- - - validate_duplicate - (self) -
-No docs
-- - - erpnext.stock.doctype.item_alternative.item_alternative.get_alternative_items - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Table Name: tabItem Attribute
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -attribute_name |
- - Data | -- Attribute Name - - | -- |
| 2 | -numeric_values |
- - Check | -- Numeric Values - - | -- |
| 3 | -section_break_4 |
- - Section Break | -- - - | -- |
| 4 | -from_range |
- - Float | -- From Range - - | -- |
| 5 | -increment |
- - Float | -- Increment - - | -- |
| 6 | -column_break_8 |
- - Column Break | -- - - | -- |
| 7 | -to_range |
- - Float | -- To Range - - | -- |
| 8 | -section_break_5 |
- - Section Break | -- - - | -- |
| 9 | -item_attribute_values |
- - Table | -- Item Attribute Values - - | -- - - - -Item Attribute Value - - - - | -
Inherits from frappe.model.document.Document - -
- - - __setup__ - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_duplication - (self) -
-No docs
-- - - validate_exising_items - (self) -
-Validate that if there are existing items with attributes, they are valid
-- - - validate_numeric - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Table Name: tabItem Attribute Value
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -attribute_value |
- - Data | -- Attribute Value - - | -- |
| 2 | -abbr |
- - Data | -
- Abbreviation
- - This will be appended to the Item Code of the variant. For example, if your abbreviation is "SM", and the item code is "T-SHIRT", the item code of the variant will be "T-SHIRT-SM" - |
- - |
Table Name: tabItem Barcode
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -barcode |
- - Data | -- Barcode - - | -- |
| 2 | -barcode_type |
- - Select | -- Barcode Type - - | -
- -EAN -UPC-A- |
-
Table Name: tabItem Customer Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -customer_name |
- - Link | -- Customer Name - - | -- - - - -Customer - - - - | -
| 2 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 3 | -ref_code |
- - Data | -- Ref Code - - | -- |
Table Name: tabItem Default
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 2 | -default_warehouse |
- - Link | -- Default Warehouse - - | -- - - - -Warehouse - - - - | -
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -default_price_list |
- - Link | -- Default Price List - - | -- - - - -Price List - - - - | -
| 5 | -purchase_defaults |
- - Section Break | -- Purchase Defaults - - | -- |
| 6 | -buying_cost_center |
- - Link | -- Default Buying Cost Center - - | -- - - - -Cost Center - - - - | -
| 7 | -default_supplier |
- - Link | -- Default Supplier - - | -- - - - -Supplier - - - - | -
| 8 | -column_break_8 |
- - Column Break | -- - - | -- |
| 9 | -expense_account |
- - Link | -- Default Expense Account - - | -- - - - -Account - - - - | -
| 10 | -selling_defaults |
- - Section Break | -- Sales Defaults - - | -- |
| 11 | -selling_cost_center |
- - Link | -- Default Selling Cost Center - - | -- - - - -Cost Center - - - - | -
| 12 | -column_break_12 |
- - Column Break | -- - - | -- |
| 13 | -income_account |
- - Link | -- Default Income Account - - | -- - - - -Account - - - - | -
Table Name: tabItem Price
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -price_list_details |
- - Section Break | -- Price List - - | -
- fa fa-tags- |
-
| 2 | -price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 3 | -column_break_3 |
- - Column Break | -- - - | -- |
| 4 | -buying |
- - Check | -- Buying - - | -- |
| 5 | -selling |
- - Check | -- Selling - - | -- |
| 6 | -item_details |
- - Section Break | -- - - | -
- fa fa-tag- |
-
| 7 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 8 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 9 | -price_list_rate |
- - Currency | -- Rate - - | -
- currency- |
-
| 10 | -col_br_1 |
- - Column Break | -- - - | -- |
| 11 | -brand |
- - Read Only | -- Brand - - | -- |
| 12 | -item_name |
- - Data | -- Item Name - - | -- |
| 13 | -item_description |
- - Text | -- Item Description - - | -- |
Inherits from frappe.model.document.Document - -
- - - check_duplicate_item - (self) -
-No docs
-- - - update_item_details - (self) -
-No docs
-- - - update_price_list_details - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_item - (self) -
-No docs
-- - - validate_price_list - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Table Name: tabItem Quality Inspection Parameter
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -specification |
- - Data | -- Parameter - - | -- |
| 2 | -value |
- - Data | -- Acceptance Criteria - - | -- |
Table Name: tabItem Reorder
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -warehouse_group |
- - Link | -- Check in (group) - - | -- - - - -Warehouse - - - - | -
| 2 | -warehouse |
- - Link | -- Request for - - | -- - - - -Warehouse - - - - | -
| 3 | -warehouse_reorder_level |
- - Float | -- Re-order Level - - | -- |
| 4 | -warehouse_reorder_qty |
- - Float | -- Re-order Qty - - | -- |
| 5 | -material_request_type |
- - Select | -- Material Request Type - - | -
- Purchase -Transfer -Material Issue -Manufacture- |
-
Table Name: tabItem Supplier
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 2 | -supplier_part_no |
- - Data | -- Supplier Part Number - - | -- |
Table Name: tabItem Tax
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -tax_type |
- - Link | -- Tax - - | -- - - - -Account - - - - | -
| 2 | -tax_rate |
- - Float | -- Tax Rate - - | -- |
Table Name: tabItem Variant
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_attribute |
- - Link | -- Item Attribute - - | -- - - - -Item Attribute - - - - | -
| 2 | -item_attribute_value |
- - Data | -- Item Attribute Value - - | -- |
Table Name: tabItem Variant Attribute
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -attribute |
- - Link | -- Attribute - - | -- - - - -Item Attribute - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -attribute_value |
- - Data | -- Attribute Value - - | -- |
| 4 | -numeric_values |
- - Check | -- Numeric Values - - | -- |
| 5 | -section_break_4 |
- - Section Break | -- - - | -- |
| 6 | -from_range |
- - Float | -- From Range - - | -- |
| 7 | -increment |
- - Float | -- Increment - - | -- |
| 8 | -column_break_8 |
- - Column Break | -- - - | -- |
| 9 | -to_range |
- - Float | -- To Range - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -section_break_3 |
- - Section Break | -- - - | -- |
| 2 | -do_not_update_variants |
- - Check | -
- Do not update variants on save
- - Fields will be copied over only at time of creation. - |
- - |
| 3 | -allow_rename_attribute_value |
- - Check | -
- Allow Rename Attribute Value
- - Rename Attribute Value in Item Attribute. - |
- - |
| 4 | -copy_fields_to_variant |
- - Section Break | -- Copy Fields to Variant - - | -- |
| 5 | -fields |
- - Table | -- Fields - - | -- - - - -Variant Field - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabItem Website Specification
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -label |
- - Data | -- Label - - | -- |
| 2 | -description |
- - Text Editor | -- Description - - | -- |
Table Name: tabLanded Cost Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -description |
- - Text Editor | -- Description - - | -- |
| 3 | -receipt_document_type |
- - Select | -- Receipt Document Type - - | -
- Purchase Invoice -Purchase Receipt- |
-
| 4 | -receipt_document |
- - Dynamic Link | -- Receipt Document - - | -
- receipt_document_type- |
-
| 5 | -col_break2 |
- - Column Break | -- - - | -- |
| 6 | -qty |
- - Float | -- Qty - - | -- |
| 7 | -rate |
- - Currency | -- Rate - - | -
- Company:company:default_currency- |
-
| 8 | -amount |
- - Currency | -- Amount - - | -
- Company:company:default_currency- |
-
| 9 | -applicable_charges |
- - Currency | -- Applicable Charges - - | -
- Company:company:default_currency- |
-
| 10 | -purchase_receipt_item |
- - Data | -- Purchase Receipt Item - - | -- |
| 11 | -section_break_11 |
- - Section Break | -- - - | -- |
| 12 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
Table Name: tabLanded Cost Purchase Receipt
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -receipt_document_type |
- - Select | -- Receipt Document Type - - | -
- -Purchase Invoice -Purchase Receipt- |
-
| 2 | -receipt_document |
- - Dynamic Link | -- Receipt Document - - | -
- receipt_document_type- |
-
| 3 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 4 | -col_break1 |
- - Column Break | -- - - | -- |
| 5 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 6 | -grand_total |
- - Currency | -- Grand Total - - | -- |
Table Name: tabLanded Cost Taxes and Charges
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -description |
- - Small Text | -- Description - - | -- |
| 2 | -col_break3 |
- - Column Break | -- - - | -- |
| 3 | -amount |
- - Currency | -- Amount - - | -
- Company:company:default_currency- |
-
Table Name: tabLanded Cost Voucher
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- LCV- |
-
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -purchase_receipts |
- - Table | -- Purchase Receipts - - | -- - - - -Landed Cost Purchase Receipt - - - - | -
| 4 | -purchase_receipt_items |
- - Section Break | -- Purchase Receipt Items - - | -- |
| 5 | -get_items_from_purchase_receipts |
- - Button | -- Get Items From Purchase Receipts - - | -- |
| 6 | -items |
- - Table | -- Purchase Receipt Items - - | -- - - - -Landed Cost Item - - - - | -
| 7 | -sec_break1 |
- - Section Break | -- Additional Charges - - | -- |
| 8 | -taxes |
- - Table | -- Taxes and Charges - - | -- - - - -Landed Cost Taxes and Charges - - - - | -
| 9 | -section_break_9 |
- - Section Break | -- - - | -- |
| 10 | -total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges - - | -
- Company:company:default_currency- |
-
| 11 | -col_break1 |
- - Column Break | -- - - | -- |
| 12 | -distribute_charges_based_on |
- - Select | -- Distribute Charges Based On - - | -
- -Qty -Amount- |
-
| 13 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Landed Cost Voucher - - - - | -
| 14 | -sec_break2 |
- - Section Break | -- - - | -- |
| 15 | -landed_cost_help |
- - HTML | -- Landed Cost Help - - | -- |
Inherits from frappe.model.document.Document - -
- - - check_mandatory - (self) -
-No docs
-- - - get_items_from_purchase_receipts - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - set_total_taxes_and_charges - (self) -
-No docs
-- - - update_landed_cost - (self) -
-No docs
-- - - update_rate_in_serial_no - (self, receipt_document) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_applicable_charges_for_item - (self) -
-No docs
-- - - validate_purchase_receipts - (self) -
-No docs
-Table Name: tabManufacturer
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -short_name |
- - Data | -
- Short Name
- - Limited to 12 characters - |
- - |
| 2 | -full_name |
- - Data | -- Full Name - - | -- |
| 3 | -website |
- - Data | -- Website - - | -- |
| 4 | -country |
- - Link | -- Country - - | -- - - - -Country - - - - | -
| 5 | -logo |
- - Attach Image | -- Logo - - | -- |
| 6 | -notes |
- - Small Text | -- Notes - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabMaterial Request
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -type_section |
- - Section Break | -- - - | -
- fa fa-pushpin- |
-
| 2 | -naming_series |
- - Select | -- Series - - | -
- MREQ-- |
-
| 3 | -title |
- - Data | -- Title - - | -- |
| 4 | -material_request_type |
- - Select | -- Type - - | -
- Purchase -Material Transfer -Material Issue -Manufacture- |
-
| 5 | -column_break_2 |
- - Column Break | -- - - | -- |
| 6 | -schedule_date |
- - Date | -- Required Date - - | -- |
| 7 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 8 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Material Request - - - - | -
| 9 | -items_section |
- - Section Break | -- - - | -
- fa fa-shopping-cart- |
-
| 10 | -items |
- - Table | -- Items - - | -- - - - -Material Request Item - - - - | -
| 11 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 12 | -requested_by |
- - Data | -- Requested For - - | -- |
| 13 | -transaction_date |
- - Date | -- Transaction Date - - | -- |
| 14 | -column_break2 |
- - Column Break | -- - - | -- |
| 15 | -status |
- - Select | -- Status - - | -
- -Draft -Submitted -Stopped -Cancelled -Pending -Partially Ordered -Ordered -Issued -Transferred- |
-
| 16 | -per_ordered |
- - Percent | -- % Ordered - - | -- |
| 17 | -printing_details |
- - Section Break | -- Printing Details - - | -- |
| 18 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 19 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 20 | -terms_section_break |
- - Section Break | -- Terms and Conditions - - | -
- fa fa-legal- |
-
| 21 | -tc_name |
- - Link | -- Terms - - | -- - - - -Terms and Conditions - - - - | -
| 22 | -terms |
- - Text Editor | -- Terms and Conditions Content - - | -- |
| 23 | -reference |
- - Section Break | -- Reference - - | -- |
Inherits from erpnext.controllers.buying_controller.BuyingController - -
- - - before_cancel - (self) -
-No docs
-- - - before_save - (self) -
-No docs
-- - - before_submit - (self) -
-No docs
-- - - check_if_already_pulled - (self) -
-No docs
-- - - check_modified_date - (self) -
-No docs
-- - - get_feed - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - set_title - (self) -
-Set title as comma separated list of items
-- - - status_can_change - (self, status) -
- validates that `status` is acceptable for the present controller status
- and throws an Exception if otherwise.
-
-- - - update_completed_qty - (self, mr_items=None, update_modified=True) -
-No docs
-- - - update_requested_qty - (self, mr_item_rows=None) -
-update requested qty (before ordered_qty is updated)
-- - - update_requested_qty_in_production_plan - (self) -
-No docs
-- - - update_status - (self, status) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_qty_against_so - (self) -
-No docs
-- - - erpnext.stock.doctype.material_request.material_request.get_material_requests_based_on_supplier - (supplier) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.material_request.material_request.make_purchase_order
-
- - - erpnext.stock.doctype.material_request.material_request.make_purchase_order - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.material_request.material_request.make_purchase_order_based_on_supplier
-
- - - erpnext.stock.doctype.material_request.material_request.make_purchase_order_based_on_supplier - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.material_request.material_request.make_request_for_quotation
-
- - - erpnext.stock.doctype.material_request.material_request.make_request_for_quotation - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.material_request.material_request.make_stock_entry
-
- - - erpnext.stock.doctype.material_request.material_request.make_stock_entry - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.material_request.material_request.make_supplier_quotation
-
- - - erpnext.stock.doctype.material_request.material_request.make_supplier_quotation - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.material_request.material_request.raise_work_orders
-
- - - erpnext.stock.doctype.material_request.material_request.raise_work_orders - (material_request) -
-No docs
-- - - erpnext.stock.doctype.material_request.material_request.set_missing_values - (source, target_doc) -
-No docs
-- - - erpnext.stock.doctype.material_request.material_request.update_completed_and_requested_qty - (stock_entry, method) -
-No docs
-- - - erpnext.stock.doctype.material_request.material_request.update_item - (obj, target, source_parent) -
-No docs
-Table Name: tabMaterial Request Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -col_break1 |
- - Column Break | -- - - | -- |
| 3 | -item_name |
- - Data | -- Item Name - - | -- |
| 4 | -section_break_4 |
- - Section Break | -- Description - - | -- |
| 5 | -description |
- - Text Editor | -- Description - - | -- |
| 6 | -column_break_6 |
- - Column Break | -- - - | -- |
| 7 | -image |
- - Attach Image | -- Image - - | -- |
| 8 | -quantity_and_warehouse |
- - Section Break | -- Quantity and Warehouse - - | -- |
| 9 | -qty |
- - Float | -- Quantity - - | -- |
| 10 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 11 | -conversion_factor |
- - Float | -- UOM Conversion Factor - - | -- |
| 12 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 13 | -warehouse |
- - Link | -- For Warehouse - - | -- - - - -Warehouse - - - - | -
| 14 | -col_break2 |
- - Column Break | -- - - | -- |
| 15 | -schedule_date |
- - Date | -- Required Date - - | -- |
| 16 | -rate |
- - Currency | -- Rate - - | -- |
| 17 | -amount |
- - Currency | -- Amount - - | -- |
| 18 | -stock_qty |
- - Float | -- Stock Qty - - | -- |
| 19 | -more_info |
- - Section Break | -- More Information - - | -- |
| 20 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 21 | -brand |
- - Link | -- Brand - - | -- - - - -Brand - - - - | -
| 22 | -lead_time_date |
- - Date | -- Lead Time Date - - | -- |
| 23 | -sales_order |
- - Link | -- Sales Order - - | -- - - - -Sales Order - - - - | -
| 24 | -sales_order_item |
- - Data | -- Sales Order Item - - | -- |
| 25 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 26 | -production_plan |
- - Link | -- Production Plan - - | -- - - - -Production Plan - - - - | -
| 27 | -material_request_plan_item |
- - Data | -- Material Request Plan Item - - | -- |
| 28 | -col_break3 |
- - Column Break | -- - - | -- |
| 29 | -min_order_qty |
- - Float | -- Min Order Qty - - | -- |
| 30 | -projected_qty |
- - Float | -- Projected Qty - - | -- |
| 31 | -actual_qty |
- - Float | -- Actual Qty - - | -- |
| 32 | -ordered_qty |
- - Float | -- Completed Qty - - | -- |
| 33 | -page_break |
- - Check | -- Page Break - - | -- |
Table Name: tabPacked Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -parent_item |
- - Link | -- Parent Item - - | -- - - - -Item - - - - | -
| 2 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 3 | -item_name |
- - Data | -- Item Name - - | -- |
| 4 | -column_break_5 |
- - Column Break | -- - - | -- |
| 5 | -description |
- - Text Editor | -- Description - - | -- |
| 6 | -section_break_6 |
- - Section Break | -- - - | -- |
| 7 | -warehouse |
- - Link | -- From Warehouse - - | -- - - - -Warehouse - - - - | -
| 8 | -target_warehouse |
- - Link | -- To Warehouse (Optional) - - | -- - - - -Warehouse - - - - | -
| 9 | -column_break_9 |
- - Column Break | -- - - | -- |
| 10 | -qty |
- - Float | -- Qty - - | -- |
| 11 | -section_break_9 |
- - Section Break | -- - - | -- |
| 12 | -serial_no |
- - Text | -- Serial No - - | -- |
| 13 | -column_break_11 |
- - Column Break | -- - - | -- |
| 14 | -batch_no |
- - Link | -- Batch No - - | -- - - - -Batch - - - - | -
| 15 | -section_break_13 |
- - Section Break | -- - - | -- |
| 16 | -actual_qty |
- - Float | -- Actual Qty - - | -- |
| 17 | -projected_qty |
- - Float | -- Projected Qty - - | -- |
| 18 | -column_break_16 |
- - Column Break | -- - - | -- |
| 19 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 20 | -page_break |
- - Check | -- Page Break - - | -- |
| 21 | -prevdoc_doctype |
- - Data | -- Prevdoc DocType - - | -- |
| 22 | -parent_detail_docname |
- - Data | -- Parent Detail docname - - | -- |
Table Name: tabPacking Slip
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -packing_slip_details |
- - Section Break | -- - - | -- |
| 2 | -column_break0 |
- - Column Break | -- - - | -- |
| 3 | -delivery_note |
- - Link | -
- Delivery Note
- - Indicates that the package is a part of this delivery (Only Draft) - |
- - - - - -Delivery Note - - - - | -
| 4 | -column_break1 |
- - Column Break | -- - - | -- |
| 5 | -naming_series |
- - Select | -- Series - - | -
- PS-- |
-
| 6 | -section_break0 |
- - Section Break | -- - - | -- |
| 7 | -column_break2 |
- - Column Break | -- - - | -- |
| 8 | -from_case_no |
- - Data | -
- From Package No.
- - Identification of the package for the delivery (for print) - |
- - |
| 9 | -column_break3 |
- - Column Break | -- - - | -- |
| 10 | -to_case_no |
- - Data | -
- To Package No.
- - If more than one package of the same type (for print) - |
- - |
| 11 | -package_item_details |
- - Section Break | -- - - | -- |
| 12 | -get_items |
- - Button | -- Get Items - - | -- |
| 13 | -items |
- - Table | -- Items - - | -- - - - -Packing Slip Item - - - - | -
| 14 | -package_weight_details |
- - Section Break | -- Package Weight Details - - | -- |
| 15 | -net_weight_pkg |
- - Float | -
- Net Weight
- - The net weight of this package. (calculated automatically as sum of net weight of items) - |
- - |
| 16 | -net_weight_uom |
- - Link | -- Net Weight UOM - - | -- - - - -UOM - - - - | -
| 17 | -column_break4 |
- - Column Break | -- - - | -- |
| 18 | -gross_weight_pkg |
- - Float | -
- Gross Weight
- - The gross weight of the package. Usually net weight + packaging material weight. (for print) - |
- - |
| 19 | -gross_weight_uom |
- - Link | -- Gross Weight UOM - - | -- - - - -UOM - - - - | -
| 20 | -letter_head_details |
- - Section Break | -- Letter Head - - | -- |
| 21 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 22 | -misc_details |
- - Section Break | -- - - | -- |
| 23 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Packing Slip - - - - | -
Inherits from frappe.model.document.Document - -
- - - get_details_for_packing - (self) -
- Returns
- * 'Delivery Note Items' query result as a list of dict
- * Item Quantity dict of current packing slip doc
- * No. of Cases of this packing slip
-
-- - - get_items - (self) -
-No docs
-- - - get_recommended_case_no - (self) -
- Returns the next case no. for a new packing slip for a delivery
- note
-
-- - - recommend_new_qty - (self, item, ps_item_qty, no_of_cases) -
- Recommend a new quantity and raise a validation exception
-
-- - - update_item_details - (self) -
- Fill empty columns in Packing Slip Item
-
-- - - validate - (self) -
- * Validate existence of submitted Delivery Note
- * Case nos do not overlap
- * Check if packed qty doesn't exceed actual qty of delivery note
-
- It is necessary to validate case nos before checking quantity
-
-- - - validate_case_nos - (self) -
- Validate if case nos overlap. If they do, recommend next case no.
-
-- - - validate_delivery_note - (self) -
- Validates if delivery note has status as draft
-
-- - - validate_items_mandatory - (self) -
-No docs
-- - - validate_qty - (self) -
-Check packed qty across packing slips and delivery note
-- - - erpnext.stock.doctype.packing_slip.packing_slip.item_details - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Table Name: tabPacking Slip Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -column_break_2 |
- - Column Break | -- - - | -- |
| 3 | -item_name |
- - Data | -- Item Name - - | -
- item_code.item_name- |
-
| 4 | -batch_no |
- - Link | -- Batch No - - | -- - - - -Batch - - - - | -
| 5 | -desc_section |
- - Section Break | -- Description - - | -- |
| 6 | -description |
- - Text Editor | -- Description - - | -- |
| 7 | -quantity_section |
- - Section Break | -- Quantity - - | -- |
| 8 | -qty |
- - Float | -- Quantity - - | -- |
| 9 | -net_weight |
- - Float | -- Net Weight - - | -- |
| 10 | -column_break_10 |
- - Column Break | -- - - | -- |
| 11 | -stock_uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 12 | -weight_uom |
- - Link | -- Weight UOM - - | -- - - - -UOM - - - - | -
| 13 | -page_break |
- - Check | -- Page Break - - | -- |
| 14 | -dn_detail |
- - Data | -- DN Detail - - | -- |
Table Name: tabPrice List
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -enabled |
- - Check | -- Enabled - - | -- |
| 2 | -sb_1 |
- - Section Break | -- - - | -- |
| 3 | -price_list_name |
- - Data | -- Price List Name - - | -- |
| 4 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 5 | -buying |
- - Check | -- Buying - - | -- |
| 6 | -selling |
- - Check | -- Selling - - | -- |
| 7 | -price_not_uom_dependant |
- - Check | -- Price Not UOM Dependant - - | -- |
| 8 | -column_break_3 |
- - Column Break | -- - - | -- |
| 9 | -countries |
- - Table | -- Applicable for Countries - - | -- - - - -Price List Country - - - - | -
Inherits from frappe.model.document.Document - -
- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - set_default_if_missing - (self) -
-No docs
-- - - update_item_price - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Table Name: tabPrice List Country
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -country |
- - Link | -- Country - - | -- - - - -Country - - - - | -
Table Name: tabPurchase Receipt
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -supplier_section |
- - Section Break | -- - - | -
- fa fa-user- |
-
| 2 | -column_break0 |
- - Column Break | -- - - | -- |
| 3 | -title |
- - Data | -- Title - - | -- |
| 4 | -naming_series |
- - Select | -- Series - - | -
- PREC- -PREC-RET-- |
-
| 5 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 6 | -supplier_name |
- - Data | -- Supplier Name - - | -- |
| 7 | -supplier_delivery_note |
- - Data | -- Supplier Delivery Note - - | -- |
| 8 | -column_break1 |
- - Column Break | -- - - | -- |
| 9 | -posting_date |
- - Date | -- Date - - | -- |
| 10 | -posting_time |
- - Time | -
- Posting Time
- - Time at which materials were received - |
- - |
| 11 | -set_posting_time |
- - Check | -- Edit Posting Date and Time - - | -- |
| 12 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 13 | -is_return |
- - Check | -- Is Return - - | -- |
| 14 | -return_against |
- - Link | -- Return Against Purchase Receipt - - | -- - - - -Purchase Receipt - - - - | -
| 15 | -section_addresses |
- - Section Break | -- Address and Contact - - | -- |
| 16 | -supplier_address |
- - Link | -- Select Supplier Address - - | -- - - - -Address - - - - | -
| 17 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 18 | -address_display |
- - Small Text | -- Address - - | -- |
| 19 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 20 | -contact_mobile |
- - Small Text | -- Mobile No - - | -- |
| 21 | -contact_email |
- - Small Text | -- Contact Email - - | -- |
| 22 | -col_break_address |
- - Column Break | -- - - | -- |
| 23 | -shipping_address |
- - Link | -- Select Shipping Address - - | -- - - - -Address - - - - | -
| 24 | -shipping_address_display |
- - Small Text | -- Shipping Address - - | -- |
| 25 | -currency_and_price_list |
- - Section Break | -- Currency and Price List - - | -
- fa fa-tag- |
-
| 26 | -currency |
- - Link | -- Currency - - | -- - - - -Currency - - - - | -
| 27 | -conversion_rate |
- - Float | -
- Exchange Rate
- - Rate at which supplier's currency is converted to company's base currency - |
- - |
| 28 | -column_break2 |
- - Column Break | -- - - | -- |
| 29 | -buying_price_list |
- - Link | -- Price List - - | -- - - - -Price List - - - - | -
| 30 | -price_list_currency |
- - Link | -- Price List Currency - - | -- - - - -Currency - - - - | -
| 31 | -plc_conversion_rate |
- - Float | -- Price List Exchange Rate - - | -- |
| 32 | -ignore_pricing_rule |
- - Check | -- Ignore Pricing Rule - - | -- |
| 33 | -items_section |
- - Section Break | -- - - | -
- fa fa-shopping-cart- |
-
| 34 | -items |
- - Table | -- Items - - | -- - - - -Purchase Receipt Item - - - - | -
| 35 | -get_current_stock |
- - Button | -- Get current stock - - | -
- get_current_stock- |
-
| 36 | -section_break0 |
- - Section Break | -- - - | -- |
| 37 | -total_qty |
- - Float | -- Total Quantity - - | -- |
| 38 | -base_total |
- - Currency | -- Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 39 | -base_net_total |
- - Currency | -- Net Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 40 | -column_break_27 |
- - Column Break | -- - - | -- |
| 41 | -total |
- - Currency | -- Total - - | -
- currency- |
-
| 42 | -net_total |
- - Currency | -- Net Total - - | -
- currency- |
-
| 43 | -total_net_weight |
- - Float | -- Total Net Weight - - | -- |
| 44 | -taxes_charges_section |
- - Section Break | -
-
- - Add / Edit Taxes and Charges - |
-
- fa fa-money- |
-
| 45 | -taxes_and_charges |
- - Link | -- Taxes and Charges - - | -- - - - -Purchase Taxes and Charges Template - - - - | -
| 46 | -shipping_col |
- - Column Break | -- - - | -- |
| 47 | -shipping_rule |
- - Link | -- Shipping Rule - - | -- - - - -Shipping Rule - - - - | -
| 48 | -taxes_section |
- - Section Break | -- - - | -- |
| 49 | -taxes |
- - Table | -- Purchase Taxes and Charges - - | -- - - - -Purchase Taxes and Charges - - - - | -
| 50 | -sec_tax_breakup |
- - Section Break | -- Tax Breakup - - | -- |
| 51 | -other_charges_calculation |
- - Text | -- Taxes and Charges Calculation - - | -- |
| 52 | -totals |
- - Section Break | -- - - | -
- fa fa-money- |
-
| 53 | -base_taxes_and_charges_added |
- - Currency | -- Taxes and Charges Added (Company Currency) - - | -
- Company:company:default_currency- |
-
| 54 | -base_taxes_and_charges_deducted |
- - Currency | -- Taxes and Charges Deducted (Company Currency) - - | -
- Company:company:default_currency- |
-
| 55 | -base_total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges (Company Currency) - - | -
- Company:company:default_currency- |
-
| 56 | -column_break3 |
- - Column Break | -- - - | -- |
| 57 | -taxes_and_charges_added |
- - Currency | -- Taxes and Charges Added - - | -
- currency- |
-
| 58 | -taxes_and_charges_deducted |
- - Currency | -- Taxes and Charges Deducted - - | -
- currency- |
-
| 59 | -total_taxes_and_charges |
- - Currency | -- Total Taxes and Charges - - | -
- currency- |
-
| 60 | -section_break_42 |
- - Section Break | -- Additional Discount - - | -- |
| 61 | -apply_discount_on |
- - Select | -- Apply Additional Discount On - - | -
- -Grand Total -Net Total- |
-
| 62 | -base_discount_amount |
- - Currency | -- Additional Discount Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 63 | -column_break_44 |
- - Column Break | -- - - | -- |
| 64 | -additional_discount_percentage |
- - Float | -- Additional Discount Percentage - - | -- |
| 65 | -discount_amount |
- - Currency | -- Additional Discount Amount - - | -
- currency- |
-
| 66 | -section_break_46 |
- - Section Break | -- - - | -- |
| 67 | -base_grand_total |
- - Currency | -- Grand Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 68 | -base_rounding_adjustment |
- - Currency | -- Rounding Adjustment (Company Currency) - - | -
- Company:company:default_currency- |
-
| 69 | -base_in_words |
- - Data | -- In Words (Company Currency) - - | -- |
| 70 | -base_rounded_total |
- - Currency | -- Rounded Total (Company Currency) - - | -
- Company:company:default_currency- |
-
| 71 | -column_break_50 |
- - Column Break | -- - - | -- |
| 72 | -grand_total |
- - Currency | -- Grand Total - - | -
- currency- |
-
| 73 | -rounding_adjustment |
- - Currency | -- Rounding Adjustment - - | -
- currency- |
-
| 74 | -in_words |
- - Data | -- In Words - - | -- |
| 75 | -terms_section_break |
- - Section Break | -- Terms and Conditions - - | -
- fa fa-legal- |
-
| 76 | -tc_name |
- - Link | -- Terms - - | -- - - - -Terms and Conditions - - - - | -
| 77 | -terms |
- - Text Editor | -- Terms and Conditions - - | -- |
| 78 | -raw_material_details |
- - Section Break | -- Raw Materials Supplied - - | -
- fa fa-table- |
-
| 79 | -is_subcontracted |
- - Select | -- Raw Materials Supplied - - | -
- No -Yes- |
-
| 80 | -supplier_warehouse |
- - Link | -- Supplier Warehouse - - | -- - - - -Warehouse - - - - | -
| 81 | -supplied_items |
- - Table | -- Supplied Items - - | -- - - - -Purchase Receipt Item Supplied - - - - | -
| 82 | -bill_no |
- - Data | -- Bill No - - | -- |
| 83 | -bill_date |
- - Date | -- Bill Date - - | -- |
| 84 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 85 | -status |
- - Select | -- Status - - | -
- -Draft -To Bill -Completed -Cancelled -Closed- |
-
| 86 | -rejected_warehouse |
- - Link | -
- Rejected Warehouse
- - Warehouse where you are maintaining stock of rejected items - |
- - - - - -Warehouse - - - - | -
| 87 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Purchase Receipt - - - - | -
| 88 | -range |
- - Data | -- Range - - | -- |
| 89 | -column_break4 |
- - Column Break | -- - - | -- |
| 90 | -per_billed |
- - Percent | -- % Amount Billed - - | -- |
| 91 | -subscription_detail |
- - Section Break | -- Auto Repeat Detail - - | -- |
| 92 | -auto_repeat |
- - Link | -- Auto Repeat - - | -- - - - -Auto Repeat - - - - | -
| 93 | -printing_settings |
- - Section Break | -- Printing Settings - - | -- |
| 94 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 95 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 96 | -language |
- - Data | -- Print Language - - | -- |
| 97 | -group_same_items |
- - Check | -- Group same items - - | -- |
| 98 | -column_break_97 |
- - Column Break | -- - - | -- |
| 99 | -other_details |
- - HTML | -- Other Details - - | -- |
| 100 | -instructions |
- - Small Text | -- Instructions - - | -- |
| 101 | -remarks |
- - Small Text | -- Remarks - - | -- |
| 102 | -transporter_info |
- - Section Break | -- Transporter Details - - | -
- fa fa-truck- |
-
| 103 | -transporter_name |
- - Data | -- Transporter Name - - | -- |
| 104 | -column_break5 |
- - Column Break | -- - - | -- |
| 105 | -lr_no |
- - Data | -- Vehicle Number - - | -- |
| 106 | -lr_date |
- - Date | -- Vehicle Date - - | -- |
Inherits from erpnext.controllers.buying_controller.BuyingController - -
- - - __init__ - (self) -
-No docs
-- - - check_for_closed_status - (self) -
-No docs
-- - - check_next_docstatus - (self) -
-No docs
-- - - get_already_received_qty - (self, po, po_detail) -
-No docs
-- - - get_asset_gl_entry - (self, gl_entries) -
-No docs
-- - - get_current_stock - (self) -
-No docs
-- - - get_gl_entries - (self, warehouse_account=None) -
-No docs
-- - - get_po_qty_and_warehouse - (self, po_detail) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - po_required - (self) -
-No docs
-- - - update_billing_status - (self, update_modified=True) -
-No docs
-- - - update_status - (self, status) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_with_previous_doc - (self) -
-No docs
-- - - erpnext.stock.doctype.purchase_receipt.purchase_receipt.get_invoiced_qty_map - (purchase_receipt) -
-returns a map: {prdetail: invoicedqty}
-Public API
- /api/method/erpnext.stock.doctype.purchase_receipt.purchase_receipt.make_purchase_invoice
-
- - - erpnext.stock.doctype.purchase_receipt.purchase_receipt.make_purchase_invoice - (source_name, target_doc=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.purchase_receipt.purchase_receipt.make_purchase_return
-
- - - erpnext.stock.doctype.purchase_receipt.purchase_receipt.make_purchase_return - (source_name, target_doc=None) -
-No docs
-- - - erpnext.stock.doctype.purchase_receipt.purchase_receipt.update_billed_amount_based_on_po - (po_detail, update_modified=True) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.purchase_receipt.purchase_receipt.update_purchase_receipt_status
-
- - - erpnext.stock.doctype.purchase_receipt.purchase_receipt.update_purchase_receipt_status - (docname, status) -
-No docs
-Table Name: tabPurchase Receipt Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -barcode |
- - Data | -- Barcode - - | -- |
| 2 | -section_break_2 |
- - Section Break | -- - - | -- |
| 3 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 4 | -supplier_part_no |
- - Data | -- Supplier Part Number - - | -- |
| 5 | -column_break_2 |
- - Column Break | -- - - | -- |
| 6 | -item_name |
- - Data | -- Item Name - - | -- |
| 7 | -section_break_4 |
- - Section Break | -- Description - - | -- |
| 8 | -description |
- - Text Editor | -- Description - - | -- |
| 9 | -col_break1 |
- - Column Break | -- - - | -- |
| 10 | -image |
- - Attach | -- Image - - | -- |
| 11 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 12 | -received_and_accepted |
- - Section Break | -- Received and Accepted - - | -- |
| 13 | -received_qty |
- - Float | -- Recd Quantity - - | -- |
| 14 | -qty |
- - Float | -- Accepted Quantity - - | -- |
| 15 | -rejected_qty |
- - Float | -- Rejected Quantity - - | -- |
| 16 | -col_break2 |
- - Column Break | -- - - | -- |
| 17 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 18 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 19 | -conversion_factor |
- - Float | -- Conversion Factor - - | -- |
| 20 | -retain_sample |
- - Check | -- Retain Sample - - | -- |
| 21 | -sample_quantity |
- - Int | -- Sample Quantity - - | -- |
| 22 | -rate_and_amount |
- - Section Break | -- Rate and Amount - - | -- |
| 23 | -price_list_rate |
- - Currency | -- Price List Rate - - | -
- currency- |
-
| 24 | -discount_percentage |
- - Percent | -- Discount on Price List Rate (%) - - | -- |
| 25 | -col_break3 |
- - Column Break | -- - - | -- |
| 26 | -base_price_list_rate |
- - Currency | -- Price List Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 27 | -sec_break1 |
- - Section Break | -- - - | -- |
| 28 | -rate |
- - Currency | -- Rate - - | -
- currency- |
-
| 29 | -amount |
- - Currency | -- Amount - - | -
- currency- |
-
| 30 | -col_break4 |
- - Column Break | -- - - | -- |
| 31 | -base_rate |
- - Currency | -- Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 32 | -base_amount |
- - Currency | -- Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 33 | -pricing_rule |
- - Link | -- Pricing Rule - - | -- - - - -Pricing Rule - - - - | -
| 34 | -section_break_29 |
- - Section Break | -- - - | -- |
| 35 | -net_rate |
- - Currency | -- Net Rate - - | -
- currency- |
-
| 36 | -net_amount |
- - Currency | -- Net Amount - - | -
- currency- |
-
| 37 | -column_break_32 |
- - Column Break | -- - - | -- |
| 38 | -base_net_rate |
- - Currency | -- Net Rate (Company Currency) - - | -
- Company:company:default_currency- |
-
| 39 | -base_net_amount |
- - Currency | -- Net Amount (Company Currency) - - | -
- Company:company:default_currency- |
-
| 40 | -item_weight_details |
- - Section Break | -- Item Weight Details - - | -- |
| 41 | -weight_per_unit |
- - Float | -- Weight Per Unit - - | -- |
| 42 | -total_weight |
- - Float | -- Total Weight - - | -- |
| 43 | -column_break_41 |
- - Column Break | -- - - | -- |
| 44 | -weight_uom |
- - Link | -- Weight UOM - - | -- - - - -UOM - - - - | -
| 45 | -warehouse_and_reference |
- - Section Break | -- Warehouse and Reference - - | -- |
| 46 | -warehouse |
- - Link | -- Accepted Warehouse - - | -- - - - -Warehouse - - - - | -
| 47 | -rejected_warehouse |
- - Link | -- Rejected Warehouse - - | -- - - - -Warehouse - - - - | -
| 48 | -quality_inspection |
- - Link | -- Quality Inspection - - | -- - - - -Quality Inspection - - - - | -
| 49 | -column_break_40 |
- - Column Break | -- - - | -- |
| 50 | -is_fixed_asset |
- - Check | -- Is Fixed Asset - - | -- |
| 51 | -asset |
- - Link | -- Asset - - | -- - - - -Asset - - - - | -
| 52 | -asset_location |
- - Link | -- Asset Location - - | -- - - - -Location - - - - | -
| 53 | -purchase_order |
- - Link | -- Purchase Order - - | -- - - - -Purchase Order - - - - | -
| 54 | -schedule_date |
- - Date | -- Required By - - | -- |
| 55 | -stock_qty |
- - Float | -- Qty as per Stock UOM - - | -- |
| 56 | -section_break_45 |
- - Section Break | -- - - | -- |
| 57 | -serial_no |
- - Small Text | -- Serial No - - | -- |
| 58 | -batch_no |
- - Link | -- Batch No - - | -- - - - -Batch - - - - | -
| 59 | -column_break_48 |
- - Column Break | -- - - | -- |
| 60 | -rejected_serial_no |
- - Small Text | -- Rejected Serial No - - | -- |
| 61 | -section_break_50 |
- - Section Break | -- - - | -- |
| 62 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 63 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 64 | -purchase_order_item |
- - Data | -- Purchase Order Item - - | -- |
| 65 | -col_break5 |
- - Column Break | -- - - | -- |
| 66 | -allow_zero_valuation_rate |
- - Check | -- Allow Zero Valuation Rate - - | -- |
| 67 | -bom |
- - Link | -- BOM - - | -- - - - -BOM - - - - | -
| 68 | -include_exploded_items |
- - Check | -- Include Exploded Items - - | -- |
| 69 | -billed_amt |
- - Currency | -- Billed Amt - - | -- |
| 70 | -landed_cost_voucher_amount |
- - Currency | -- Landed Cost Voucher Amount - - | -- |
| 71 | -brand |
- - Link | -- Brand - - | -- - - - -Brand - - - - | -
| 72 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 73 | -rm_supp_cost |
- - Currency | -- Raw Materials Supplied Cost - - | -
- Company:company:default_currency- |
-
| 74 | -item_tax_amount |
- - Currency | -- Item Tax Amount - - | -
- Company:company:default_currency- |
-
| 75 | -valuation_rate |
- - Currency | -- Valuation Rate - - | -
- Company:company:default_currency- |
-
| 76 | -item_tax_rate |
- - Code | -
- Item Tax Rate
- - Tax detail table fetched from item master as a string and stored in this field. -Used for Taxes and Charges - |
- - |
| 77 | -page_break |
- - Check | -- Page Break - - | -- |
Table Name: tabQuality Inspection
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- QI-- |
-
| 2 | -report_date |
- - Date | -- Report Date - - | -- |
| 3 | -column_break_4 |
- - Column Break | -- - - | -- |
| 4 | -inspection_type |
- - Select | -- Inspection Type - - | -
- -Incoming -Outgoing -In Process- |
-
| 5 | -reference_type |
- - Select | -- Reference Type - - | -
- -Purchase Receipt -Purchase Invoice -Delivery Note -Sales Invoice -Stock Entry- |
-
| 6 | -reference_name |
- - Dynamic Link | -- Reference Name - - | -
- reference_type- |
-
| 7 | -section_break_7 |
- - Section Break | -- - - | -- |
| 8 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 9 | -item_serial_no |
- - Link | -- Item Serial No - - | -- - - - -Serial No - - - - | -
| 10 | -batch_no |
- - Link | -- Batch No - - | -- - - - -Batch - - - - | -
| 11 | -sample_size |
- - Float | -- Sample Size - - | -- |
| 12 | -column_break1 |
- - Column Break | -- - - | -- |
| 13 | -item_name |
- - Data | -- Item Name - - | -- |
| 14 | -description |
- - Small Text | -- Description - - | -- |
| 15 | -section_break_14 |
- - Section Break | -- - - | -- |
| 16 | -inspected_by |
- - Link | -- Inspected By - - | -- - - - -User - - - - | -
| 17 | -verified_by |
- - Data | -- Verified By - - | -- |
| 18 | -bom_no |
- - Link | -- BOM No - - | -- - - - -BOM - - - - | -
| 19 | -column_break_17 |
- - Column Break | -- - - | -- |
| 20 | -remarks |
- - Text | -- Remarks - - | -- |
| 21 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Quality Inspection - - - - | -
| 22 | -specification_details |
- - Section Break | -- - - | -
- Simple- |
-
| 23 | -quality_inspection_template |
- - Link | -- Quality Inspection Template - - | -- - - - -Quality Inspection Template - - - - | -
| 24 | -readings |
- - Table | -- Readings - - | -- - - - -Quality Inspection Reading - - - - | -
Inherits from frappe.model.document.Document - -
- - - get_item_specification_details - (self) -
-No docs
-- - - get_quality_inspection_template - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - update_qc_reference - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.stock.doctype.quality_inspection.quality_inspection.item_query - (doctype, txt, searchfield, start, page_len, filters) -
-No docs
-Table Name: tabQuality Inspection Reading
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -specification |
- - Data | -- Parameter - - | -- |
| 2 | -value |
- - Data | -- Acceptance Criteria - - | -- |
| 3 | -reading_1 |
- - Data | -- Reading 1 - - | -- |
| 4 | -reading_2 |
- - Data | -- Reading 2 - - | -- |
| 5 | -reading_3 |
- - Data | -- Reading 3 - - | -- |
| 6 | -reading_4 |
- - Data | -- Reading 4 - - | -- |
| 7 | -reading_5 |
- - Data | -- Reading 5 - - | -- |
| 8 | -reading_6 |
- - Data | -- Reading 6 - - | -- |
| 9 | -reading_7 |
- - Data | -- Reading 7 - - | -- |
| 10 | -reading_8 |
- - Data | -- Reading 8 - - | -- |
| 11 | -reading_9 |
- - Data | -- Reading 9 - - | -- |
| 12 | -reading_10 |
- - Data | -- Reading 10 - - | -- |
| 13 | -status |
- - Select | -- Status - - | -
- Accepted -Rejected- |
-
Table Name: tabQuality Inspection Template
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -quality_inspection_template_name |
- - Data | -- Quality Inspection Template Name - - | -- |
| 2 | -item_quality_inspection_parameter |
- - Table | -- Item Quality Inspection Parameter - - | -- - - - -Item Quality Inspection Parameter - - - - | -
Inherits from frappe.model.document.Document - -
- - - erpnext.stock.doctype.quality_inspection_template.quality_inspection_template.get_template_details - (template) -
-No docs
-Table Name: tabSerial No
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -details |
- - Section Break | -- - - | -- |
| 2 | -column_break0 |
- - Column Break | -- - - | -- |
| 3 | -serial_no |
- - Data | -- Serial No - - | -- |
| 4 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 5 | -warehouse |
- - Link | -
- Warehouse
- - Warehouse can only be changed via Stock Entry / Delivery Note / Purchase Receipt - |
- - - - - -Warehouse - - - - | -
| 6 | -batch_no |
- - Data | -- Batch No - - | -- |
| 7 | -column_break1 |
- - Column Break | -- - - | -- |
| 8 | -item_name |
- - Data | -- Item Name - - | -- |
| 9 | -description |
- - Text | -- Description - - | -- |
| 10 | -item_group |
- - Link | -- Item Group - - | -- - - - -Item Group - - - - | -
| 11 | -brand |
- - Link | -- Brand - - | -- - - - -Brand - - - - | -
| 12 | -purchase_details |
- - Section Break | -- Purchase / Manufacture Details - - | -- |
| 13 | -column_break2 |
- - Column Break | -- - - | -- |
| 14 | -purchase_document_type |
- - Link | -- Creation Document Type - - | -- - - - -DocType - - - - | -
| 15 | -purchase_document_no |
- - Dynamic Link | -- Creation Document No - - | -
- purchase_document_type- |
-
| 16 | -purchase_date |
- - Date | -- Creation Date - - | -- |
| 17 | -purchase_time |
- - Time | -- Creation Time - - | -- |
| 18 | -purchase_rate |
- - Currency | -- Incoming Rate - - | -
- Company:company:default_currency- |
-
| 19 | -column_break3 |
- - Column Break | -- - - | -- |
| 20 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 21 | -supplier_name |
- - Data | -- Supplier Name - - | -- |
| 22 | -asset_details |
- - Section Break | -- Asset Details - - | -- |
| 23 | -asset |
- - Link | -- Asset - - | -- - - - -Asset - - - - | -
| 24 | -asset_status |
- - Select | -- Asset Status - - | -
- -Issue -Receipt -Transfer- |
-
| 25 | -column_break_24 |
- - Column Break | -- - - | -- |
| 26 | -location |
- - Link | -- Location - - | -- - - - -Location - - - - | -
| 27 | -employee |
- - Link | -- Employee - - | -- - - - -Employee - - - - | -
| 28 | -delivery_details |
- - Section Break | -- Delivery Details - - | -- |
| 29 | -delivery_document_type |
- - Link | -- Delivery Document Type - - | -- - - - -DocType - - - - | -
| 30 | -delivery_document_no |
- - Dynamic Link | -- Delivery Document No - - | -
- delivery_document_type- |
-
| 31 | -delivery_date |
- - Date | -- Delivery Date - - | -- |
| 32 | -delivery_time |
- - Time | -- Delivery Time - - | -- |
| 33 | -is_cancelled |
- - Select | -- Is Cancelled - - | -
- -Yes -No- |
-
| 34 | -column_break5 |
- - Column Break | -- - - | -- |
| 35 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 36 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 37 | -invoice_details |
- - Section Break | -- Invoice Details - - | -- |
| 38 | -sales_invoice |
- - Link | -- Sales Invoice - - | -- - - - -Sales Invoice - - - - | -
| 39 | -warranty_amc_details |
- - Section Break | -- Warranty / AMC Details - - | -- |
| 40 | -column_break6 |
- - Column Break | -- - - | -- |
| 41 | -maintenance_status |
- - Select | -- Maintenance Status - - | -
- -Under Warranty -Out of Warranty -Under AMC -Out of AMC- |
-
| 42 | -warranty_period |
- - Int | -- Warranty Period (Days) - - | -- |
| 43 | -column_break7 |
- - Column Break | -- - - | -- |
| 44 | -warranty_expiry_date |
- - Date | -- Warranty Expiry Date - - | -- |
| 45 | -amc_expiry_date |
- - Date | -- AMC Expiry Date - - | -- |
| 46 | -more_info |
- - Section Break | -- More Information - - | -- |
| 47 | -serial_no_details |
- - Text Editor | -- Serial No Details - - | -- |
| 48 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
Inherits from erpnext.controllers.stock_controller.StockController - -
- - - __init__ - (self) -
-No docs
-- - - after_rename - (self, old, new, merge=False) -
-rename serial_no text fields
-- - - before_rename - (self, old, new, merge=False) -
-No docs
-- - - get_last_sle - (self) -
-No docs
-- - - get_stock_ledger_entries - (self) -
-No docs
-- - - on_stock_ledger_entry - (self) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - set_maintenance_status - (self) -
-No docs
-- - - set_purchase_details - (self, purchase_sle) -
-No docs
-- - - set_sales_details - (self, delivery_sle) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_item - (self) -
- Validate whether serial no is required for this item
-
-- - - validate_warehouse - (self) -
-No docs
-Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
- - - erpnext.stock.doctype.serial_no.serial_no.allow_serial_nos_with_different_item - (sle_serial_no, sle) -
- Allows same serial nos for raw materials and finished goods
- in Manufacture / Repack type Stock Entry
-
-- - - erpnext.stock.doctype.serial_no.serial_no.auto_make_serial_nos - (args) -
-No docs
-- - - erpnext.stock.doctype.serial_no.serial_no.get_auto_serial_nos - (serial_no_series, qty) -
-No docs
-- - - erpnext.stock.doctype.serial_no.serial_no.get_delivery_note_serial_no - (item_code, qty, delivery_note) -
-No docs
-- - - erpnext.stock.doctype.serial_no.serial_no.get_item_details - (item_code) -
-No docs
-- - - erpnext.stock.doctype.serial_no.serial_no.get_serial_nos - (serial_no) -
-No docs
-- - - erpnext.stock.doctype.serial_no.serial_no.has_duplicate_serial_no - (sn, sle) -
-No docs
-- - - erpnext.stock.doctype.serial_no.serial_no.make_serial_no - (serial_no, args) -
-No docs
-- - - erpnext.stock.doctype.serial_no.serial_no.process_serial_no - (sle) -
-No docs
-- - - erpnext.stock.doctype.serial_no.serial_no.update_maintenance_status - () -
-No docs
-- - - erpnext.stock.doctype.serial_no.serial_no.update_serial_nos - (sle, item_det) -
-No docs
-- - - erpnext.stock.doctype.serial_no.serial_no.update_serial_nos_after_submit - (controller, parentfield) -
-No docs
-- - - erpnext.stock.doctype.serial_no.serial_no.validate_serial_no - (sle, item_det) -
-No docs
-Table Name: tabStock Entry
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -items_section |
- - Section Break | -- - - | -- |
| 2 | -title |
- - Data | -- Title - - | -- |
| 3 | -naming_series |
- - Select | -- Series - - | -
- STE-- |
-
| 4 | -purpose |
- - Select | -- Purpose - - | -
- Material Issue -Material Receipt -Material Transfer -Material Transfer for Manufacture -Material Consumption for Manufacture -Manufacture -Repack -Subcontract- |
-
| 5 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 6 | -work_order |
- - Link | -- Work Order - - | -- - - - -Work Order - - - - | -
| 7 | -purchase_order |
- - Link | -- Purchase Order - - | -- - - - -Purchase Order - - - - | -
| 8 | -delivery_note_no |
- - Link | -- Delivery Note No - - | -- - - - -Delivery Note - - - - | -
| 9 | -sales_invoice_no |
- - Link | -- Sales Invoice No - - | -- - - - -Sales Invoice - - - - | -
| 10 | -purchase_receipt_no |
- - Link | -- Purchase Receipt No - - | -- - - - -Purchase Receipt - - - - | -
| 11 | -from_bom |
- - Check | -- From BOM - - | -- |
| 12 | -inspection_required |
- - Check | -- Inspection Required - - | -- |
| 13 | -col2 |
- - Column Break | -- - - | -- |
| 14 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 15 | -posting_time |
- - Time | -- Posting Time - - | -- |
| 16 | -set_posting_time |
- - Check | -- Edit Posting Date and Time - - | -- |
| 17 | -sb1 |
- - Section Break | -- - - | -- |
| 18 | -bom_no |
- - Link | -- BOM No - - | -- - - - -BOM - - - - | -
| 19 | -fg_completed_qty |
- - Float | -
- For Quantity
- - As per Stock UOM - |
- - |
| 20 | -cb1 |
- - Column Break | -- - - | -- |
| 21 | -use_multi_level_bom |
- - Check | -
- Use Multi-Level BOM
- - Including items for sub assemblies - |
- - |
| 22 | -get_items |
- - Button | -- Get Items - - | -- |
| 23 | -section_break_12 |
- - Section Break | -- - - | -- |
| 24 | -from_warehouse |
- - Link | -- Default Source Warehouse - - | -- - - - -Warehouse - - - - | -
| 25 | -source_warehouse_address |
- - Link | -- Source Warehouse Address - - | -- - - - -Address - - - - | -
| 26 | -source_address_display |
- - Small Text | -- Source Warehouse Address - - | -- |
| 27 | -cb0 |
- - Column Break | -- - - | -- |
| 28 | -to_warehouse |
- - Link | -- Default Target Warehouse - - | -- - - - -Warehouse - - - - | -
| 29 | -target_warehouse_address |
- - Link | -- Target Warehouse Name - - | -- - - - -Address - - - - | -
| 30 | -target_address_display |
- - Small Text | -- Target Warehouse Address - - | -- |
| 31 | -sb0 |
- - Section Break | -- - - | -
- Simple- |
-
| 32 | -items |
- - Table | -- Items - - | -- - - - -Stock Entry Detail - - - - | -
| 33 | -get_stock_and_rate |
- - Button | -- Update Rate and Availability - - | -
- get_stock_and_rate- |
-
| 34 | -section_break_19 |
- - Section Break | -- - - | -- |
| 35 | -total_incoming_value |
- - Currency | -- Total Incoming Value - - | -
- Company:company:default_currency- |
-
| 36 | -column_break_22 |
- - Column Break | -- - - | -- |
| 37 | -total_outgoing_value |
- - Currency | -- Total Outgoing Value - - | -
- Company:company:default_currency- |
-
| 38 | -value_difference |
- - Currency | -- Total Value Difference (Out - In) - - | -
- Company:company:default_currency- |
-
| 39 | -additional_costs_section |
- - Section Break | -- Additional Costs - - | -- |
| 40 | -additional_costs |
- - Table | -- Additional Costs - - | -- - - - -Landed Cost Taxes and Charges - - - - | -
| 41 | -total_additional_costs |
- - Currency | -- Total Additional Costs - - | -
- Company:company:default_currency- |
-
| 42 | -contact_section |
- - Section Break | -- Customer or Supplier Details - - | -- |
| 43 | -supplier |
- - Link | -- Supplier - - | -- - - - -Supplier - - - - | -
| 44 | -supplier_name |
- - Data | -- Supplier Name - - | -- |
| 45 | -supplier_address |
- - Link | -- Supplier Address - - | -- - - - -Address - - - - | -
| 46 | -address_display |
- - Small Text | -- Address - - | -- |
| 47 | -column_break_39 |
- - Column Break | -- - - | -- |
| 48 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 49 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 50 | -customer_address |
- - Small Text | -- Customer Address - - | -- |
| 51 | -printing_settings |
- - Section Break | -- Printing Settings - - | -- |
| 52 | -select_print_heading |
- - Link | -- Print Heading - - | -- - - - -Print Heading - - - - | -
| 53 | -letter_head |
- - Link | -- Letter Head - - | -- - - - -Letter Head - - - - | -
| 54 | -more_info |
- - Section Break | -- More Information - - | -- |
| 55 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 56 | -remarks |
- - Text | -- Remarks - - | -- |
| 57 | -col5 |
- - Column Break | -- - - | -- |
| 58 | -total_amount |
- - Currency | -- Total Amount - - | -
- Company:company:default_currency- |
-
| 59 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Stock Entry - - - - | -
| 60 | -credit_note |
- - Link | -- Credit Note - - | -- - - - -Journal Entry - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from erpnext.controllers.stock_controller.StockController - -
- - - add_to_stock_entry_detail - (self, item_dict, bom_no=None) -
-No docs
-- - - calculate_rate_and_amount - (self, force=False, update_finished_item_rate=True, raise_error_if_no_rate=True) -
-No docs
-- - - check_duplicate_entry_for_work_order - (self) -
-No docs
-- - - check_if_operations_completed - (self) -
-Check if Time Sheets are completed against before manufacturing to capture operating costs.
-- - - distribute_additional_costs - (self) -
-No docs
-- - - get_args_for_incoming_rate - (self, item) -
-No docs
-- - - get_bom_raw_materials - (self, qty) -
-No docs
-- - - get_bom_scrap_material - (self, qty) -
-No docs
-- - - get_feed - (self) -
-No docs
-- - - get_gl_entries - (self, warehouse_account) -
-No docs
-- - - get_item_details - (self, args=None, for_update=False) -
-No docs
-- - - get_items - (self) -
-No docs
-- - - get_pending_raw_materials - (self) -
- issue (item quantity) that is pending to issue or desire to transfer,
- whichever is less
-
-- - - get_pro_order_required_items - (self) -
-No docs
-- - - get_stock_and_rate - (self) -
-No docs
-- - - get_transfered_raw_materials - (self) -
-No docs
-- - - get_unconsumed_raw_materials - (self) -
-No docs
-- - - load_items_from_bom - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - onload - (self) -
-No docs
-- - - set_actual_qty - (self) -
-No docs
-- - - set_basic_rate - (self, force=False, update_finished_item_rate=True, raise_error_if_no_rate=True) -
-get stock and incoming rate on posting date
-- - - set_basic_rate_for_finished_goods - (self, raw_material_cost, scrap_material_cost) -
-No docs
-- - - set_incoming_rate - (self) -
-No docs
-- - - set_serial_nos - (self, work_order) -
-No docs
-- - - set_total_amount - (self) -
-No docs
-- - - set_total_incoming_outgoing_value - (self) -
-No docs
-- - - set_transfer_qty - (self) -
-No docs
-- - - set_work_order_details - (self) -
-No docs
-- - - update_cost_in_project - (self) -
-No docs
-- - - update_purchase_order_supplied_items - (self) -
-No docs
-- - - update_stock_ledger - (self) -
-No docs
-- - - update_valuation_rate - (self) -
-No docs
-- - - update_work_order - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_batch - (self) -
-No docs
-- - - validate_bom - (self) -
-No docs
-- - - validate_finished_goods - (self) -
-validation: finished good quantity should be same as manufacturing quantity
-- - - validate_item - (self) -
-No docs
-- - - validate_purchase_order - (self) -
-Throw exception if more raw material is transferred against Purchase Order than in - the raw materials supplied table
-- - - validate_purpose - (self) -
-No docs
-- - - validate_qty - (self) -
-No docs
-- - - validate_warehouse - (self) -
-perform various (sometimes conditional) validations on warehouse
-- - - validate_with_material_request - (self) -
-No docs
-- - - validate_work_order - (self) -
-No docs
-- - - validate_work_order_status - (self) -
-No docs
-- - - erpnext.stock.doctype.stock_entry.stock_entry.get_additional_costs - (work_order=None, bom_no=None, fg_qty=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.stock_entry.stock_entry.get_expired_batch_items
-
- - - erpnext.stock.doctype.stock_entry.stock_entry.get_expired_batch_items - () -
-No docs
-- - - erpnext.stock.doctype.stock_entry.stock_entry.get_operating_cost_per_unit - (work_order=None, bom_no=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.stock_entry.stock_entry.get_uom_details
-
- - - erpnext.stock.doctype.stock_entry.stock_entry.get_uom_details - (item_code, uom, qty) -
-Returns dict {"conversion_factor": [value], "transfer_qty": qty * [value]}
Parameters:
- -args - dict with item_code, uom and qty- - - erpnext.stock.doctype.stock_entry.stock_entry.get_used_alternative_items - (purchase_order=None, work_order=None) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.stock_entry.stock_entry.get_warehouse_details
-
- - - erpnext.stock.doctype.stock_entry.stock_entry.get_warehouse_details - (args) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.stock_entry.stock_entry.get_work_order_details
-
- - - erpnext.stock.doctype.stock_entry.stock_entry.get_work_order_details - (work_order) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.stock_entry.stock_entry.move_sample_to_retention_warehouse
-
- - - erpnext.stock.doctype.stock_entry.stock_entry.move_sample_to_retention_warehouse - (company, items) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.stock_entry.stock_entry.validate_sample_quantity
-
- - - erpnext.stock.doctype.stock_entry.stock_entry.validate_sample_quantity - (item_code, sample_quantity, qty, batch_no=None) -
-No docs
-Table Name: tabStock Entry Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -barcode |
- - Data | -- Barcode - - | -- |
| 2 | -section_break_2 |
- - Section Break | -- - - | -- |
| 3 | -s_warehouse |
- - Link | -- Source Warehouse - - | -- - - - -Warehouse - - - - | -
| 4 | -col_break1 |
- - Column Break | -- - - | -- |
| 5 | -t_warehouse |
- - Link | -- Target Warehouse - - | -- - - - -Warehouse - - - - | -
| 6 | -sec_break1 |
- - Section Break | -- - - | -- |
| 7 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 8 | -col_break2 |
- - Column Break | -- - - | -- |
| 9 | -item_name |
- - Data | -- Item Name - - | -- |
| 10 | -section_break_8 |
- - Section Break | -- Description - - | -- |
| 11 | -description |
- - Text Editor | -- Description - - | -- |
| 12 | -column_break_10 |
- - Column Break | -- - - | -- |
| 13 | -image |
- - Attach | -- Image - - | -- |
| 14 | -image_view |
- - Image | -- Image View - - | -
- image- |
-
| 15 | -quantity_and_rate |
- - Section Break | -- Quantity and Rate - - | -- |
| 16 | -qty |
- - Float | -- Qty - - | -- |
| 17 | -basic_rate |
- - Currency | -- Basic Rate (as per Stock UOM) - - | -
- Company:company:default_currency- |
-
| 18 | -basic_amount |
- - Currency | -- Basic Amount - - | -
- Company:company:default_currency- |
-
| 19 | -additional_cost |
- - Currency | -- Additional Cost - - | -
- Company:company:default_currency- |
-
| 20 | -amount |
- - Currency | -- Amount - - | -
- Company:company:default_currency- |
-
| 21 | -valuation_rate |
- - Currency | -- Valuation Rate - - | -
- Company:company:default_currency- |
-
| 22 | -col_break3 |
- - Column Break | -- - - | -- |
| 23 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 24 | -conversion_factor |
- - Float | -- Conversion Factor - - | -- |
| 25 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 26 | -transfer_qty |
- - Float | -- Qty as per Stock UOM - - | -- |
| 27 | -retain_sample |
- - Check | -- Retain Sample - - | -- |
| 28 | -sample_quantity |
- - Int | -- Sample Quantity - - | -- |
| 29 | -serial_no_batch |
- - Section Break | -- Serial No / Batch - - | -- |
| 30 | -serial_no |
- - Small Text | -- Serial No - - | -- |
| 31 | -col_break4 |
- - Column Break | -- - - | -- |
| 32 | -batch_no |
- - Link | -- Batch No - - | -- - - - -Batch - - - - | -
| 33 | -quality_inspection |
- - Link | -- Quality Inspection - - | -- - - - -Quality Inspection - - - - | -
| 34 | -accounting |
- - Section Break | -- Accounting - - | -- |
| 35 | -expense_account |
- - Link | -- Difference Account - - | -- - - - -Account - - - - | -
| 36 | -col_break5 |
- - Column Break | -- - - | -- |
| 37 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 38 | -more_info |
- - Section Break | -- More Information - - | -- |
| 39 | -allow_zero_valuation_rate |
- - Check | -- Allow Zero Valuation Rate - - | -- |
| 40 | -actual_qty |
- - Float | -- Actual Qty (at source/target) - - | -- |
| 41 | -bom_no |
- - Link | -
- BOM No
- - BOM No. for a Finished Good Item - |
- - - - - -BOM - - - - | -
| 42 | -allow_alternative_item |
- - Check | -- Allow Alternative Item - - | -- |
| 43 | -col_break6 |
- - Column Break | -- - - | -- |
| 44 | -material_request |
- - Link | -
- Material Request
- - Material Request used to make this Stock Entry - |
- - - - - -Material Request - - - - | -
| 45 | -material_request_item |
- - Link | -- Material Request Item - - | -- - - - -Material Request Item - - - - | -
| 46 | -original_item |
- - Link | -- Original Item - - | -- - - - -Item - - - - | -
| 47 | -subcontracted_item |
- - Link | -- Subcontracted Item - - | -- - - - -Item - - - - | -
Table Name: tabStock Ledger Entry
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 2 | -serial_no |
- - Text | -- Serial No - - | -- |
| 3 | -batch_no |
- - Data | -- Batch No - - | -- |
| 4 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 5 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 6 | -posting_time |
- - Time | -- Posting Time - - | -- |
| 7 | -voucher_type |
- - Link | -- Voucher Type - - | -- - - - -DocType - - - - | -
| 8 | -voucher_no |
- - Dynamic Link | -- Voucher No - - | -
- voucher_type- |
-
| 9 | -voucher_detail_no |
- - Data | -- Voucher Detail No - - | -- |
| 10 | -actual_qty |
- - Float | -- Actual Quantity - - | -- |
| 11 | -incoming_rate |
- - Currency | -- Incoming Rate - - | -
- Company:company:default_currency- |
-
| 12 | -outgoing_rate |
- - Currency | -- Outgoing Rate - - | -
- Company:company:default_currency- |
-
| 13 | -stock_uom |
- - Link | -- Stock UOM - - | -- - - - -UOM - - - - | -
| 14 | -qty_after_transaction |
- - Float | -- Actual Qty After Transaction - - | -- |
| 15 | -valuation_rate |
- - Currency | -- Valuation Rate - - | -
- Company:company:default_currency- |
-
| 16 | -stock_value |
- - Currency | -- Stock Value - - | -
- Company:company:default_currency- |
-
| 17 | -stock_value_difference |
- - Currency | -- Stock Value Difference - - | -
- Company:company:default_currency- |
-
| 18 | -stock_queue |
- - Text | -- Stock Queue (FIFO) - - | -- |
| 19 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 20 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 21 | -fiscal_year |
- - Data | -- Fiscal Year - - | -- |
| 22 | -is_cancelled |
- - Select | -- Is Cancelled - - | -
- -No -Yes- |
-
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.model.document.Document - -
- - - actual_amt_check - (self) -
-No docs
-- - - block_transactions_against_group_warehouse - (self) -
-No docs
-- - - check_stock_frozen_date - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - scrub_posting_time - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_and_set_fiscal_year - (self) -
-No docs
-- - - validate_batch - (self) -
-No docs
-- - - validate_item - (self) -
-No docs
-- - - validate_mandatory - (self) -
-No docs
-- - - erpnext.stock.doctype.stock_ledger_entry.stock_ledger_entry.on_doctype_update - () -
-No docs
-Table Name: tabStock Reconciliation
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- SR/- |
-
| 2 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 3 | -purpose |
- - Select | -- Purpose - - | -
- Opening Stock -Stock Reconciliation- |
-
| 4 | -col1 |
- - Column Break | -- - - | -- |
| 5 | -posting_date |
- - Date | -- Posting Date - - | -- |
| 6 | -posting_time |
- - Time | -- Posting Time - - | -- |
| 7 | -set_posting_time |
- - Check | -- Edit Posting Date and Time - - | -- |
| 8 | -sb9 |
- - Section Break | -- - - | -- |
| 9 | -items |
- - Table | -- Items - - | -- - - - -Stock Reconciliation Item - - - - | -
| 10 | -section_break_9 |
- - Section Break | -- - - | -- |
| 11 | -expense_account |
- - Link | -- Difference Account - - | -- - - - -Account - - - - | -
| 12 | -cost_center |
- - Link | -- Cost Center - - | -- - - - -Cost Center - - - - | -
| 13 | -reconciliation_json |
- - Long Text | -- Reconciliation JSON - - | -- |
| 14 | -column_break_13 |
- - Column Break | -- - - | -- |
| 15 | -difference_amount |
- - Currency | -- Difference Amount - - | -
- Company:company:default_currency- |
-
| 16 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Stock Reconciliation - - - - | -
Inherits from frappe.exceptions.ValidationError - -
Inherits from frappe.exceptions.ValidationError - -
Inherits from erpnext.controllers.stock_controller.StockController - -
- - - __init__ - (self) -
-No docs
-- - - cancel - (self) -
-No docs
-- - - delete_and_repost_sle - (self) -
-Delete Stock Ledger Entries related to this voucher
- and repost future Stock Ledger Entries
-
-- - - get_gl_entries - (self, warehouse_account=None) -
-No docs
-- - - get_items_for - (self, warehouse) -
-No docs
-- - - insert_entries - (self, row) -
-Insert Stock Ledger Entries
-- - - on_cancel - (self) -
-No docs
-- - - on_submit - (self) -
-No docs
-- - - remove_items_with_no_change - (self) -
-Remove items if qty or rate is not changed
-- - - set_total_qty_and_amount - (self) -
-No docs
-- - - submit - (self) -
-No docs
-- - - update_stock_ledger - (self) -
-find difference between current and expected entries
- and create stock ledger entries based on the difference
-
-- - - validate - (self) -
-No docs
-- - - validate_data - (self) -
-No docs
-- - - validate_expense_account - (self) -
-No docs
-- - - validate_item - (self, item_code, row_num) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.stock_reconciliation.stock_reconciliation.get_difference_account
-
- - - erpnext.stock.doctype.stock_reconciliation.stock_reconciliation.get_difference_account - (purpose, company) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.stock_reconciliation.stock_reconciliation.get_items
-
- - - erpnext.stock.doctype.stock_reconciliation.stock_reconciliation.get_items - (warehouse, posting_date, posting_time, company) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.stock_reconciliation.stock_reconciliation.get_stock_balance_for
-
- - - erpnext.stock.doctype.stock_reconciliation.stock_reconciliation.get_stock_balance_for - (item_code, warehouse, posting_date, posting_time) -
-No docs
-Table Name: tabStock Reconciliation Item
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -barcode |
- - Data | -- Barcode - - | -- |
| 2 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 3 | -item_name |
- - Data | -- Item Name - - | -- |
| 4 | -warehouse |
- - Link | -- Warehouse - - | -- - - - -Warehouse - - - - | -
| 5 | -column_break_6 |
- - Column Break | -- - - | -- |
| 6 | -qty |
- - Float | -- Quantity - - | -- |
| 7 | -valuation_rate |
- - Currency | -- Valuation Rate - - | -
- Company:company:default_currency- |
-
| 8 | -amount |
- - Currency | -- Amount - - | -
- Company:company:default_currency- |
-
| 9 | -section_break_3 |
- - Section Break | -- Before reconciliation - - | -- |
| 10 | -current_qty |
- - Float | -- Current Qty - - | -- |
| 11 | -column_break_9 |
- - Column Break | -- - - | -- |
| 12 | -current_valuation_rate |
- - Currency | -- Current Valuation Rate - - | -
- Company:company:default_currency- |
-
| 13 | -current_amount |
- - Currency | -- Current Amount - - | -
- Company:company:default_currency- |
-
| 14 | -section_break_14 |
- - Section Break | -- - - | -- |
| 15 | -quantity_difference |
- - Read Only | -- Quantity Difference - - | -- |
| 16 | -column_break_16 |
- - Column Break | -- - - | -- |
| 17 | -amount_difference |
- - Currency | -- Amount Difference - - | -
- Company:company:default_currency- |
-
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -item_naming_by |
- - Select | -- Item Naming By - - | -
- Item Code -Naming Series- |
-
| 2 | -item_group |
- - Link | -- Default Item Group - - | -- - - - -Item Group - - - - | -
| 3 | -stock_uom |
- - Link | -- Default Stock UOM - - | -- - - - -UOM - - - - | -
| 4 | -default_warehouse |
- - Link | -- Default Warehouse - - | -- - - - -Warehouse - - - - | -
| 5 | -sample_retention_warehouse |
- - Link | -- Sample Retention Warehouse - - | -- - - - -Warehouse - - - - | -
| 6 | -column_break_4 |
- - Column Break | -- - - | -- |
| 7 | -valuation_method |
- - Select | -- Default Valuation Method - - | -
- FIFO -Moving Average- |
-
| 8 | -tolerance |
- - Float | -
- Limit Percent
- - Percentage you are allowed to receive or deliver more against the quantity ordered. For example: If you have ordered 100 units. and your Allowance is 10% then you are allowed to receive 110 units. - |
- - |
| 9 | -show_barcode_field |
- - Check | -- Show Barcode Field - - | -- |
| 10 | -clean_description_html |
- - Check | -- Convert Item Description to Clean HTML - - | -- |
| 11 | -section_break_7 |
- - Section Break | -- - - | -- |
| 12 | -auto_insert_price_list_rate_if_missing |
- - Check | -- Auto insert Price List rate if missing - - | -- |
| 13 | -allow_negative_stock |
- - Check | -- Allow Negative Stock - - | -- |
| 14 | -column_break_10 |
- - Column Break | -- - - | -- |
| 15 | -automatically_set_serial_nos_based_on_fifo |
- - Check | -- Automatically Set Serial Nos based on FIFO - - | -- |
| 16 | -set_qty_in_transactions_based_on_serial_no_input |
- - Check | -- Set Qty in Transactions based on Serial No Input - - | -- |
| 17 | -auto_material_request |
- - Section Break | -- Auto Material Request - - | -- |
| 18 | -auto_indent |
- - Check | -- Raise Material Request when stock reaches re-order level - - | -- |
| 19 | -reorder_email_notify |
- - Check | -- Notify by Email on creation of automatic Material Request - - | -- |
| 20 | -freeze_stock_entries |
- - Section Break | -- Freeze Stock Entries - - | -- |
| 21 | -stock_frozen_upto |
- - Date | -- Stock Frozen Upto - - | -- |
| 22 | -stock_frozen_upto_days |
- - Int | -- Freeze Stocks Older Than [Days] - - | -- |
| 23 | -stock_auth_role |
- - Link | -- Role Allowed to edit frozen stock - - | -- - - - -Role - - - - | -
| 24 | -batch_id_sb |
- - Section Break | -- Batch Identification - - | -- |
| 25 | -use_naming_series |
- - Check | -- Use Naming Series - - | -- |
| 26 | -naming_series_prefix |
- - Data | -- Naming Series Prefix - - | -- |
Inherits from frappe.model.document.Document - -
- - - cant_change_valuation_method - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - validate_clean_description_html - (self) -
-No docs
-- - - erpnext.stock.doctype.stock_settings.stock_settings.clean_all_descriptions - () -
-No docs
-Table Name: tabUOM Category
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -category_name |
- - Data | -- Category Name - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabUOM Conversion Detail
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -uom |
- - Link | -- UOM - - | -- - - - -UOM - - - - | -
| 2 | -conversion_factor |
- - Float | -- Conversion Factor - - | -- |
Table Name: tabVariant Field
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -field_name |
- - Select | -- Field Name - - | -- |
Table Name: tabWarehouse
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -warehouse_detail |
- - Section Break | -- Warehouse Detail - - | -- |
| 2 | -warehouse_name |
- - Data | -- Warehouse Name - - | -- |
| 3 | -is_group |
- - Check | -- Is Group - - | -- |
| 4 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 5 | -disabled |
- - Check | -- Disabled - - | -- |
| 6 | -column_break_4 |
- - Column Break | -- - - | -- |
| 7 | -account |
- - Link | -- Account - - | -- - - - -Account - - - - | -
| 8 | -address_and_contact |
- - Section Break | -- Address and Contact - - | -- |
| 9 | -address_html |
- - HTML | -- Address HTML - - | -- |
| 10 | -column_break_10 |
- - Column Break | -- - - | -- |
| 11 | -contact_html |
- - HTML | -- Contact HTML - - | -- |
| 12 | -warehouse_contact_info |
- - Section Break | -- Warehouse Contact Info - - | -- |
| 13 | -email_id |
- - Data | -- Email Address - - | -- |
| 14 | -phone_no |
- - Data | -- Phone No - - | -
- Phone- |
-
| 15 | -mobile_no |
- - Data | -- Mobile No - - | -
- Phone- |
-
| 16 | -column_break0 |
- - Column Break | -- - - | -- |
| 17 | -address_line_1 |
- - Data | -- Address Line 1 - - | -- |
| 18 | -address_line_2 |
- - Data | -- Address Line 2 - - | -- |
| 19 | -city |
- - Data | -- City - - | -- |
| 20 | -state |
- - Data | -- State - - | -- |
| 21 | -pin |
- - Data | -- PIN - - | -- |
| 22 | -tree_details |
- - Section Break | -- Tree Details - - | -- |
| 23 | -parent_warehouse |
- - Link | -- Parent Warehouse - - | -- - - - -Warehouse - - - - | -
| 24 | -lft |
- - Int | -- lft - - | -- |
| 25 | -rgt |
- - Int | -- rgt - - | -- |
| 26 | -old_parent |
- - Link | -- Old Parent - - | -- - - - -Warehouse - - - - | -
Inherits from frappe.utils.nestedset.NestedSet - -
- - - after_rename - (self, old_name, new_name, merge=False) -
-No docs
-- - - autoname - (self) -
-No docs
-- - - before_rename - (self, old_name, new_name, merge=False) -
-No docs
-- - - check_if_child_exists - (self) -
-No docs
-- - - check_if_sle_exists - (self) -
-No docs
-- - - convert_to_group - (self) -
-No docs
-- - - convert_to_group_or_ledger - (self) -
-No docs
-- - - convert_to_ledger - (self) -
-No docs
-- - - get_new_warehouse_name_without_abbr - (self, name) -
-No docs
-- - - on_trash - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - onload - (self) -
-load account name for General Ledger Report
-- - - recalculate_bin_qty - (self, new_name) -
-No docs
-- - - update_nsm_model - (self) -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.warehouse.warehouse.add_node
-
- - - erpnext.stock.doctype.warehouse.warehouse.add_node - () -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.warehouse.warehouse.convert_to_group_or_ledger
-
- - - erpnext.stock.doctype.warehouse.warehouse.convert_to_group_or_ledger - () -
-No docs
-Public API
- /api/method/erpnext.stock.doctype.warehouse.warehouse.get_children
-
- - - erpnext.stock.doctype.warehouse.warehouse.get_children - (doctype, parent=None, company=None, is_root=False) -
-No docs
-Table Name: tabIssue
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -subject_section |
- - Section Break | -- Subject - - | -
- fa fa-flag- |
-
| 2 | -naming_series |
- - Select | -- Series - - | -
- ISS-- |
-
| 3 | -subject |
- - Data | -- Subject - - | -- |
| 4 | -issue_type |
- - Link | -- Issue Type - - | -- - - - -Issue Type - - - - | -
| 5 | -cb00 |
- - Column Break | -- - - | -- |
| 6 | -status |
- - Select | -- Status - - | -
- Open -Replied -Hold -Closed- |
-
| 7 | -raised_by |
- - Data | -- Raised By (Email) - - | -
- |
-
| 8 | -email_account |
- - Link | -- Email Account - - | -- - - - -Email Account - - - - | -
| 9 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 10 | -section_break_7 |
- - Section Break | -- Details - - | -- |
| 11 | -description |
- - Text Editor | -- Description - - | -- |
| 12 | -response |
- - Section Break | -- Response - - | -- |
| 13 | -mins_to_first_response |
- - Float | -- Mins to First Response - - | -- |
| 14 | -first_responded_on |
- - Datetime | -- First Responded On - - | -- |
| 15 | -additional_info |
- - Section Break | -- Reference - - | -
- fa fa-pushpin- |
-
| 16 | -lead |
- - Link | -- Lead - - | -- - - - -Lead - - - - | -
| 17 | -contact |
- - Link | -- Contact - - | -- - - - -Contact - - - - | -
| 18 | -column_break_16 |
- - Column Break | -- - - | -- |
| 19 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 20 | -project |
- - Link | -- Project - - | -- - - - -Project - - - - | -
| 21 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 22 | -section_break_19 |
- - Section Break | -- Resolution - - | -- |
| 23 | -resolution_details |
- - Text Editor | -- Resolution Details - - | -- |
| 24 | -column_break1 |
- - Column Break | -- - - | -- |
| 25 | -opening_date |
- - Date | -- Opening Date - - | -- |
| 26 | -opening_time |
- - Time | -- Opening Time - - | -- |
| 27 | -resolution_date |
- - Datetime | -- Resolution Date - - | -- |
| 28 | -content_type |
- - Data | -- Content Type - - | -- |
| 29 | -attachment |
- - Attach | -- Attachment - - | -- |
| 30 | -via_customer_portal |
- - Check | -- Via Customer Portal - - | -- |
Inherits from frappe.model.document.Document - -
- - - create_communication - (self) -
-No docs
-- - - get_feed - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - set_lead_contact - (self, email_id) -
-No docs
-- - - update_status - (self) -
-No docs
-- - - validate - (self) -
-No docs
-- - - erpnext.support.doctype.issue.issue.auto_close_tickets - () -
-auto close the replied support tickets after 7 days
-- - - erpnext.support.doctype.issue.issue.get_issue_list - (doctype, txt, filters, limit_start, limit_page_length=20, order_by=None) -
-No docs
-- - - erpnext.support.doctype.issue.issue.get_list_context - (context=None) -
-No docs
-- - - erpnext.support.doctype.issue.issue.has_website_permission - (doc, ptype, user, verbose=False) -
-No docs
-Public API
- /api/method/erpnext.support.doctype.issue.issue.set_multiple_status
-
- - - erpnext.support.doctype.issue.issue.set_multiple_status - (names, status) -
-No docs
-Public API
- /api/method/erpnext.support.doctype.issue.issue.set_status
-
- - - erpnext.support.doctype.issue.issue.set_status - (name, status) -
-No docs
-Table Name: tabIssue Type
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -description |
- - Small Text | -- Description - - | -- |
Inherits from frappe.model.document.Document - -
Table Name: tabSupport Search Source
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -source_name |
- - Data | -- Source Name - - | -- |
| 2 | -source_type |
- - Select | -- Source Type - - | -
- API -Link- |
-
| 3 | -api_sb |
- - Section Break | -- API - - | -- |
| 4 | -base_url |
- - Data | -- Base URL - - | -- |
| 5 | -query_options_sb |
- - Section Break | -- Query Options - - | -- |
| 6 | -query_route |
- - Data | -- Query Route String - - | -- |
| 7 | -cb_1 |
- - Column Break | -- - - | -- |
| 8 | -search_term_param_name |
- - Data | -- Search Term Param Name - - | -- |
| 9 | -response_options_sb |
- - Section Break | -- Response Options - - | -- |
| 10 | -response_result_key_path |
- - Data | -- Response Result Key Path - - | -- |
| 11 | -post_route |
- - Data | -- Post Route String - - | -- |
| 12 | -post_route_key_list |
- - Data | -- Post Route Key List - - | -- |
| 13 | -response_post_cb |
- - Column Break | -- - - | -- |
| 14 | -post_title_key |
- - Data | -- Post Title Key - - | -- |
| 15 | -post_description_key |
- - Data | -- Post Description Key - - | -- |
| 16 | -link_options_sb |
- - Section Break | -- Link Options - - | -- |
| 17 | -source_doctype |
- - Link | -- Source DocType - - | -- - - - -DocType - - - - | -
| 18 | -result_title_field |
- - Data | -- Result Title Field - - | -- |
| 19 | -result_preview_field |
- - Data | -- Result Preview Field - - | -- |
| 20 | -result_route_field |
- - Data | -- Result Route Field - - | -- |
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -issues_sb |
- - Section Break | -- Issues - - | -- |
| 2 | -close_issue_after_days |
- - Int | -
- Close Issue After Days
- - Auto close Issue after 7 days - |
- - |
| 3 | -portal_sb |
- - Section Break | -- Support Portal - - | -- |
| 4 | -get_started_sections |
- - Code | -- Get Started Sections - - | -- |
| 5 | -show_latest_forum_posts |
- - Check | -- Show Latest Forum Posts - - | -- |
| 6 | -forum_sb |
- - Section Break | -- Forum Posts - - | -- |
| 7 | -forum_url |
- - Data | -- Forum URL - - | -- |
| 8 | -get_latest_query |
- - Data | -- Get Latest Query - - | -- |
| 9 | -response_key_list |
- - Data | -- Response Key List - - | -- |
| 10 | -column_break_10 |
- - Column Break | -- - - | -- |
| 11 | -post_title_key |
- - Data | -- Post Title Key - - | -- |
| 12 | -post_description_key |
- - Data | -- Post Description Key - - | -- |
| 13 | -post_route_key |
- - Data | -- Post Route Key - - | -- |
| 14 | -post_route_string |
- - Data | -- Post Route String - - | -- |
| 15 | -search_apis_sb |
- - Section Break | -- Search APIs - - | -- |
| 16 | -search_apis |
- - Table | -- Search APIs - - | -- - - - -Support Search Source - - - - | -
Inherits from frappe.model.document.Document - -
Table Name: tabWarranty Claim
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -naming_series |
- - Select | -- Series - - | -
- CI-- |
-
| 2 | -status |
- - Select | -- Status - - | -
- -Open -Closed -Work In Progress -Cancelled- |
-
| 3 | -complaint_date |
- - Date | -- Issue Date - - | -- |
| 4 | -column_break0 |
- - Column Break | -- - - | -- |
| 5 | -serial_no |
- - Link | -- Serial No - - | -- - - - -Serial No - - - - | -
| 6 | -customer |
- - Link | -- Customer - - | -- - - - -Customer - - - - | -
| 7 | -section_break_7 |
- - Section Break | -- - - | -- |
| 8 | -complaint |
- - Text Editor | -- Issue - - | -- |
| 9 | -issue_details |
- - Section Break | -- Item and Warranty Details - - | -
- fa fa-ticket- |
-
| 10 | -item_code |
- - Link | -- Item Code - - | -- - - - -Item - - - - | -
| 11 | -item_name |
- - Data | -- Item Name - - | -- |
| 12 | -description |
- - Small Text | -- Description - - | -- |
| 13 | -column_break1 |
- - Column Break | -- - - | -- |
| 14 | -warranty_amc_status |
- - Select | -- Warranty / AMC Status - - | -
- -Under Warranty -Out of Warranty -Under AMC -Out of AMC- |
-
| 15 | -warranty_expiry_date |
- - Date | -- Warranty Expiry Date - - | -- |
| 16 | -amc_expiry_date |
- - Date | -- AMC Expiry Date - - | -- |
| 17 | -resolution_section |
- - Section Break | -- Resolution - - | -
- fa fa-thumbs-up- |
-
| 18 | -resolution_date |
- - Datetime | -- Resolution Date - - | -- |
| 19 | -resolved_by |
- - Link | -- Resolved By - - | -- - - - -User - - - - | -
| 20 | -resolution_details |
- - Text | -- Resolution Details - - | -- |
| 21 | -contact_info |
- - Section Break | -- Customer Details - - | -
- fa fa-bullhorn- |
-
| 22 | -customer_name |
- - Data | -- Customer Name - - | -- |
| 23 | -contact_person |
- - Link | -- Contact Person - - | -- - - - -Contact - - - - | -
| 24 | -contact_display |
- - Small Text | -- Contact - - | -- |
| 25 | -contact_mobile |
- - Data | -- Mobile No - - | -- |
| 26 | -contact_email |
- - Data | -- Contact Email - - | -- |
| 27 | -territory |
- - Link | -- Territory - - | -- - - - -Territory - - - - | -
| 28 | -customer_group |
- - Link | -- Customer Group - - | -- - - - -Customer Group - - - - | -
| 29 | -col_break4 |
- - Column Break | -- - - | -- |
| 30 | -customer_address |
- - Link | -- Customer Address - - | -- - - - -Address - - - - | -
| 31 | -address_display |
- - Small Text | -- Address - - | -- |
| 32 | -service_address |
- - Small Text | -
- Service Address
- - If different than customer address - |
- - |
| 33 | -more_info |
- - Section Break | -- More Information - - | -
- fa fa-file-text- |
-
| 34 | -company |
- - Link | -- Company - - | -- - - - -Company - - - - | -
| 35 | -col_break6 |
- - Column Break | -- - - | -- |
| 36 | -complaint_raised_by |
- - Data | -- Raised By - - | -- |
| 37 | -from_company |
- - Data | -- From Company - - | -- |
| 38 | -amended_from |
- - Link | -- Amended From - - | -- - - - -Warranty Claim - - - - | -
Inherits from erpnext.utilities.transaction_base.TransactionBase - -
- - - get_feed - (self) -
-No docs
-- - - on_cancel - (self) -
-No docs
-- - - on_update - (self) -
-No docs
-- - - validate - (self) -
-No docs
-Public API
- /api/method/erpnext.support.doctype.warranty_claim.warranty_claim.make_maintenance_visit
-
- - - erpnext.support.doctype.warranty_claim.warranty_claim.make_maintenance_visit - (source_name, target_doc=None) -
-No docs
-| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -select_doctype |
- - Select | -
- Select DocType
- - Type of document to rename. - |
- - |
| 2 | -file_to_rename |
- - Attach | -
- File to Rename
- - Attach .csv file with two columns, one for the old name and one for the new name - |
- - |
| 3 | -rename_log |
- - HTML | -- Rename Log - - | -- |
Inherits from frappe.model.document.Document - -
Public API
- /api/method/erpnext.utilities.doctype.rename_tool.rename_tool.get_doctypes
-
- - - erpnext.utilities.doctype.rename_tool.rename_tool.get_doctypes - () -
-No docs
-Public API
- /api/method/erpnext.utilities.doctype.rename_tool.rename_tool.upload
-
- - - erpnext.utilities.doctype.rename_tool.rename_tool.upload - (select_doctype=None, rows=None) -
-No docs
-Table Name: tabSMS Log
| Sr | -Fieldname | -Type | -Label | -Options | -
|---|---|---|---|---|
| 1 | -sender_name |
- - Data | -- Sender Name - - | -- |
| 2 | -sent_on |
- - Date | -- Sent On - - | -- |
| 3 | -column_break0 |
- - Column Break | -- - - | -- |
| 4 | -message |
- - Small Text | -- Message - - | -- |
| 5 | -sec_break1 |
- - Section Break | -- - - | -
- Simple- |
-
| 6 | -no_of_requested_sms |
- - Int | -- No of Requested SMS - - | -- |
| 7 | -requested_numbers |
- - Code | -- Requested Numbers - - | -- |
| 8 | -column_break1 |
- - Column Break | -- - - | -- |
| 9 | -no_of_sent_sms |
- - Int | -- No of Sent SMS - - | -- |
| 10 | -sent_to |
- - Code | -- Sent To - - | -- |
Inherits from frappe.model.document.Document - -