{"id":399022,"date":"2023-09-15T12:24:58","date_gmt":"2023-09-15T12:24:58","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=399022"},"modified":"2023-09-15T12:29:59","modified_gmt":"2023-09-15T12:29:59","slug":"how-to-create-doctypes-in-erpnext","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/","title":{"rendered":"How to create Doctypes in ERPNext"},"content":{"rendered":"\n

In this blog, we will learn how to create new doctypes in ERPNext.<\/p>\n\n\n\n

DocType is similar to a Model in other frameworks (like odoo).<\/p>\n\n\n\n

When we create doctypes in ERPNext, then database table with the same name gets created (with tab prefix)<\/p>\n\n\n\n

e.g – If the doctype name is Library -> the db table name will be tabLibrary<\/p>\n\n\n\n

The directory structure for doctypes<\/strong>:-<\/p>\n\n\n\n

library_management\/library_management\/doctype\/__init__.py\n\n    library_management\/library_management\/doctype\/library\/__init__.py\n\n    library_management\/library_management\/doctype\/library\/library.js\n\n    library_management\/library_management\/doctype\/library\/library.json\n\n    library_management\/library_management\/doctype\/library\/library.py\n\n    library_management\/library_management\/doctype\/library\/test_library.py<\/pre>\n\n\n\n
library.json:- JSON file that defines the doctype attributes and fields(table columns)<\/p>\n\n\n\n
library.js:- Client-side controller for the Form view<\/p>\n\n\n\n
library.py:- Python controller (server side) for library doctype<\/p>\n\n\n\n
test_library.py:- Python Unit Test boilerplate for writing tests<\/p>\n\n\n\n
library.json<\/strong><\/p>\n\n\n\n
** (This file creates the doctype) **<\/p>\n\n\n\n
{\n  "autoname": "format: PS-{####}",\n  "doctype": "DocType",\n  "fields": [\n    {\n      "fieldname": "section1",\n      "fieldtype": "Section Break",\n      "label": "Section 1"\n  },\n  {\n   "fieldname": "field_1",\n   "fieldtype": "Data",\n   "in_list_view": 1,\n   "label": "Field 1 Label",\n   "reqd": 1\n  },\n  {\n   "fieldname": "column_break1",\n   "fieldtype": "Column Break",\n   "label": ""\n  },\n  {\n   "fieldname": "field_2",\n   "fieldtype": "Select",\n   "in_list_view": 1,\n   "label": "Field 2 Label",\n   "options": "option1\\option2",\n   "reqd": 1\n  }\n ],\n "module": "library_management",\n "name": "Doctype Name",\n "owner": "Administrator",\n "permissions": [\n  {\n   "amend": 0,\n   "cancel": 0,\n   "create": 1,\n   "delete": 1,\n   "email": 1,\n   "export": 1,\n   "if_owner": 0,\n   "import": 0,\n   "permlevel": 0,\n   "print": 1,\n   "read": 1,\n   "report": 1,\n   "role": "System Manager",\n   "set_user_permissions": 0,\n   "share": 1,\n   "submit": 0,\n   "write": 1\n  },\n  {\n    "amend": 0,\n    "cancel": 0,\n    "create": 1,\n    "delete": 0,\n    "email": 0,\n    "export": 0,\n    "if_owner": 0,\n    "import": 0,\n    "permlevel": 0,\n    "print": 0,\n    "read": 1,\n    "report": 0,\n    "role": "All",\n    "set_user_permissions": 0,\n    "share": 0,\n    "submit": 0,\n    "write": 1\n   }\n ],\n "quick_entry": 1,\n "show_name_in_global_search": 1,\n "sort_field": "field1",\n "sort_order": "DESC",\n "title_field": "field1",\n "track_changes": 1,\n "track_seen": 1,\n "track_views": 1\n}<\/pre>\n\n\n\n
library.py<\/strong><\/p>\n\n\n\n
** (This file contains business logic for particular doctype) **<\/p>\n\n\n\n
import frappe\n\nfrom frappe.model.document import Document\n\nclass Library(Document):\n\n    def before_save(self):\n\n        # code to execute before saving a library record #<\/pre>\n\n\n\n
library.js<\/strong><\/p>\n\n\n\n
** (This file contains the js code for the form view) **<\/p>\n\n\n\n
frappe.ui.form.on('Library', {\n\n    refresh: function(frm) {                 \n\n        \/\/ refresh method will run every time a form is refreshed\n\n        \/\/ frm if the form object\n\n    }\n\n});<\/pre>\n\n\n\n
Read how to create a new app in ERPNext- App Creation and App installation process in ERPNext<\/a><\/p>\n\n\n\n
Single doctypes<\/strong> in ERPNext<\/h2>\n\n\n\n
When a DocType has Is Single enabled, it becomes a Single DocType.<\/p>\n\n\n\n
It does not create a new database table. All single values stored in the tabSingles table. You can use it for storing global settings.<\/p>\n\n\n\n
We will use `frappe.db.get_single_value(doctype_name, field_name)` method to get the value of a field from the single doctype.<\/p>\n\n\n\n
NEED HELP?<\/strong><\/h2>\n\n\n\n
Hope you find the guide helpful! Please feel free to share your feedback in the comments below.<\/p>\n\n\n\n
If you still have any issues\/queries regarding the same, please raise a ticket at https:\/\/webkul.uvdesk.com\/en\/customer\/create-ticket\/<\/a>.<\/p>\n\n\n\n
Also, please explore our Odoo development services<\/a> & an extensive range of quality Odoo Apps<\/a>.<\/em><\/p>\n\n\n\n
For any doubt, contact us at support@webkul.com<\/a>.<\/p>\n\n\n\n
Thanks for paying attention!!<\/p>\n","protected":false},"excerpt":{"rendered":"
In this blog, we will learn how to create new doctypes in ERPNext. DocType is similar to a Model in other frameworks (like odoo). When we create doctypes in ERPNext, then database table with the same name gets created (with tab prefix) e.g – If the doctype name is Library -> the db table name […]<\/a><\/p>\n","protected":false},"author":537,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[14734,14730,14732],"class_list":["post-399022","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-doctypes","tag-erpnext","tag-frappe"],"yoast_head":"\nHow to create Doctypes in ERPNext - Webkul Blog<\/title>\n<meta name=\"description\" content=\"In this blog, we will learn how to create new doctypes in ERPNext.DocType is similar to a Model in other frameworks (like odoo).\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to create Doctypes in ERPNext - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"In this blog, we will learn how to create new doctypes in ERPNext.DocType is similar to a Model in other frameworks (like odoo).\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2023-09-15T12:24:58+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2023-09-15T12:29:59+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-og.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1200\" \/>\n\t<meta property=\"og:image:height\" content=\"630\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Sachin Chaudhary\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Sachin Chaudhary\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/\"},\"author\":{\"name\":\"Sachin Chaudhary\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/4b726ebe4732781356b6fb075467aea2\"},\"headline\":\"How to create Doctypes in ERPNext\",\"datePublished\":\"2023-09-15T12:24:58+00:00\",\"dateModified\":\"2023-09-15T12:29:59+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/\"},\"wordCount\":295,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"keywords\":[\"Doctypes\",\"ERPNext\",\"Frappe\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/\",\"url\":\"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/\",\"name\":\"How to create Doctypes in ERPNext - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"datePublished\":\"2023-09-15T12:24:58+00:00\",\"dateModified\":\"2023-09-15T12:29:59+00:00\",\"description\":\"In this blog, we will learn how to create new doctypes in ERPNext.DocType is similar to a Model in other frameworks (like odoo).\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to create Doctypes in ERPNext\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/4b726ebe4732781356b6fb075467aea2\",\"name\":\"Sachin Chaudhary\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/09b025f95758f10b8464ed643dc37ddbbff3e35c25d92e8712ae1aebce5cc885?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/09b025f95758f10b8464ed643dc37ddbbff3e35c25d92e8712ae1aebce5cc885?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"caption\":\"Sachin Chaudhary\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/sachin-odoo179\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"How to create Doctypes in ERPNext - Webkul Blog","description":"In this blog, we will learn how to create new doctypes in ERPNext.DocType is similar to a Model in other frameworks (like odoo).","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/","og_locale":"en_US","og_type":"article","og_title":"How to create Doctypes in ERPNext - Webkul Blog","og_description":"In this blog, we will learn how to create new doctypes in ERPNext.DocType is similar to a Model in other frameworks (like odoo).","og_url":"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2023-09-15T12:24:58+00:00","article_modified_time":"2023-09-15T12:29:59+00:00","og_image":[{"width":1200,"height":630,"url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-og.png","type":"image\/png"}],"author":"Sachin Chaudhary","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Sachin Chaudhary","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/"},"author":{"name":"Sachin Chaudhary","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/4b726ebe4732781356b6fb075467aea2"},"headline":"How to create Doctypes in ERPNext","datePublished":"2023-09-15T12:24:58+00:00","dateModified":"2023-09-15T12:29:59+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/"},"wordCount":295,"commentCount":0,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"keywords":["Doctypes","ERPNext","Frappe"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/","url":"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/","name":"How to create Doctypes in ERPNext - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"datePublished":"2023-09-15T12:24:58+00:00","dateModified":"2023-09-15T12:29:59+00:00","description":"In this blog, we will learn how to create new doctypes in ERPNext.DocType is similar to a Model in other frameworks (like odoo).","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/how-to-create-doctypes-in-erpnext\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"How to create Doctypes in ERPNext"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/4b726ebe4732781356b6fb075467aea2","name":"Sachin Chaudhary","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/09b025f95758f10b8464ed643dc37ddbbff3e35c25d92e8712ae1aebce5cc885?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/09b025f95758f10b8464ed643dc37ddbbff3e35c25d92e8712ae1aebce5cc885?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","caption":"Sachin Chaudhary"},"url":"https:\/\/webkul.com\/blog\/author\/sachin-odoo179\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/399022","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/537"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=399022"}],"version-history":[{"count":16,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/399022\/revisions"}],"predecessor-version":[{"id":400538,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/399022\/revisions\/400538"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=399022"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=399022"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=399022"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}