ERPNext DocType Inspector

DocType

Module: Core

Export API Coming Soon

Total Fields

Required Fields

Read-only Fields

Link Fields

Description

DocType is a Table / Form in the application.

DocType Properties

Is Submittable: No
Is Tree: No
Track Changes: Yes

Custom: No
Naming Series: Not set
Search By: module

Fields (70)

Field Name	Label	Type	Options	Properties	Default
`permissions`	Permissions	Table	DocPerm		-
`restrict_to_domain`	Restrict To Domain	Link	Domain		-
`read_only`	User Cannot Search	Check	-		0
`in_create`	User Cannot Create	Check	-		0
`protect_attached_files`	Protect Attached Files	Check	-		0
`naming_rule`	Naming Rule	Select	Set by user Autoincrement +7 more		-
`autoname`	Auto Name	Data	-		-
`title_field`	Title Field	Data	-		-
`allow_rename`	Allow Rename	Check	-		1
`module`	Module	Link	Module Def	Required	-
`is_submittable`	Is Submittable	Check	-		0
`istable`	Is Child Table	Check	-		0
`issingle`	Is Single	Check	-		0
`is_tree`	Is Tree	Check	-		0
`is_calendar_and_gantt`	Is Calendar and Gantt	Check	-		0
`editable_grid`	Editable Grid	Check	-		1
`quick_entry`	Quick Entry	Check	-		0
`grid_page_length`	Grid Page Length	Int	-		50
`rows_threshold_for_grid_search`	Rows Threshold for Grid Search	Int	-		0
`track_changes`	Track Changes	Check	-		0
`track_seen`	Track Seen	Check	-		0
`track_views`	Track Views	Check	-		0
`custom`	Custom?	Check	-		0
`beta`	Beta	Check	-		0
`is_virtual`	Is Virtual	Check	-		0
`queue_in_background`	Queue in Background (BETA)	Check	-		0
`description`	Description	Small Text	-		-
`image_field`	Image Field	Data	-		-
`timeline_field`	Timeline Field	Data	-		-
`nsm_parent_field`	Parent Field (Tree)	Data	-		-
`max_attachments`	Max Attachments	Int	-		-
`documentation`	Documentation Link	Data	-		-
`hide_toolbar`	Hide Sidebar, Menu, and Comments	Check	-		0
`allow_copy`	Hide Copy	Check	-		0
`allow_import`	Allow Import (via Data Import Tool)	Check	-		0
`allow_events_in_timeline`	Allow events in timeline	Check	-		0
`allow_auto_repeat`	Allow Auto Repeat	Check	-		0
`make_attachments_public`	Make Attachments Public by Default	Check	-		0
`show_title_field_in_link`	Show Title in Link Fields	Check	-		0
`translated_doctype`	Translate Link Fields	Check	-		0
`search_fields`	Search Fields	Data	-		-
`default_print_format`	Default Print Format	Data	-		-
`sort_field`	Default Sort Field	Data	-		creation
`sort_order`	Default Sort Order	Select	ASC DESC		DESC
`default_view`	Default View	Select	-		-
`force_re_route_to_default_view`	Force Re-route to Default View	Check	-		0
`document_type`	Show in Module Section	Select	Document Setup +2 more		-
`icon`	Icon	Data	-		-
`color`	Color	Data	-		-
`show_preview_popup`	Show Preview Popup	Check	-		0
`show_name_in_global_search`	Make "name" searchable in Global Search	Check	-		0
`default_email_template`	Default Email Template	Link	Email Template		-
`email_append_to`	Allow document creation via Email	Check	-		0
`sender_field`	Sender Email Field	Data	-		-
`sender_name_field`	Sender Name Field	Data	-		-
`recipient_account_field`	Recipient Account Field	Data	-		-
`subject_field`	Subject Field	Data	-		-
`fields`	Fields	Table	DocField		-
`actions`	Document Actions	Table	DocType Action		-
`links`	Document Links	Table	DocType Link		-
`states`	Document States	Table	DocType State		-
`has_web_view`	Has Web View	Check	-		0
`allow_guest_to_view`	Allow Guest to View	Check	-		0
`index_web_pages_for_search`	Index Web Pages for Search	Check	-		1
`route`	Route	Data	-		-
`is_published_field`	Is Published Field	Data	-		-
`website_search_field`	Website Search Field	Data	-		-
`engine`	Database Engine	Select	InnoDB MyISAM		InnoDB
`migration_hash`	-	Data	-	Hidden	-
`row_format`	Row Format	Select	Dynamic Compressed	Hidden	Dynamic

Raw DocType Data

export enum Read_onlyEnum { 0, 1 }

export enum In_createEnum { 0, 1 }

export enum Protect_attached_filesEnum { 0, 1 }

export enum Naming_ruleEnum { 'Set by user', 'Autoincrement', 'By fieldname', 'By "Naming Series" field', 'Expression', 'Expression (old style)', 'Random', 'UUID', 'By script' }

export enum Allow_renameEnum { 0, 1 }

export enum Is_submittableEnum { 0, 1 }

export enum IstableEnum { 0, 1 }

export enum IssingleEnum { 0, 1 }

export enum Is_treeEnum { 0, 1 }

export enum Is_calendar_and_ganttEnum { 0, 1 }

export enum Editable_gridEnum { 0, 1 }

export enum Quick_entryEnum { 0, 1 }

export enum Track_changesEnum { 0, 1 }

export enum Track_seenEnum { 0, 1 }

export enum Track_viewsEnum { 0, 1 }

export enum CustomEnum { 0, 1 }

export enum BetaEnum { 0, 1 }

export enum Is_virtualEnum { 0, 1 }

export enum Queue_in_backgroundEnum { 0, 1 }

export enum Hide_toolbarEnum { 0, 1 }

export enum Allow_copyEnum { 0, 1 }

export enum Allow_importEnum { 0, 1 }

export enum Allow_events_in_timelineEnum { 0, 1 }

export enum Allow_auto_repeatEnum { 0, 1 }

export enum Make_attachments_publicEnum { 0, 1 }

export enum Show_title_field_in_linkEnum { 0, 1 }

export enum Translated_doctypeEnum { 0, 1 }

export enum Sort_orderEnum { 'ASC', 'DESC' }

export enum Force_re_route_to_default_viewEnum { 0, 1 }

export enum Document_typeEnum { 'Document', 'Setup', 'System', 'Other' }

export enum Show_preview_popupEnum { 0, 1 }

export enum Show_name_in_global_searchEnum { 0, 1 }

export enum Email_append_toEnum { 0, 1 }

export enum Has_web_viewEnum { 0, 1 }

export enum Allow_guest_to_viewEnum { 0, 1 }

export enum Index_web_pages_for_searchEnum { 0, 1 }

export enum EngineEnum { 'InnoDB', 'MyISAM' }

export enum Row_formatEnum { 'Dynamic', 'Compressed' }

export interface DocTypeSchema {
  permissions?: Record[];
  restrict_to_domain?: string;
  read_only?: Read_onlyEnum;
  in_create?: In_createEnum;
  protect_attached_files?: Protect_attached_filesEnum;
  naming_rule?: Naming_ruleEnum;
  autoname?: string;
  title_field?: string;
  allow_rename?: Allow_renameEnum;
  module: string;
  is_submittable?: Is_submittableEnum;
  istable?: IstableEnum;
  issingle?: IssingleEnum;
  is_tree?: Is_treeEnum;
  is_calendar_and_gantt?: Is_calendar_and_ganttEnum;
  editable_grid?: Editable_gridEnum;
  quick_entry?: Quick_entryEnum;
  grid_page_length?: number;
  rows_threshold_for_grid_search?: number;
  track_changes?: Track_changesEnum;
  track_seen?: Track_seenEnum;
  track_views?: Track_viewsEnum;
  custom?: CustomEnum;
  beta?: BetaEnum;
  is_virtual?: Is_virtualEnum;
  queue_in_background?: Queue_in_backgroundEnum;
  description?: string;
  image_field?: string;
  timeline_field?: string;
  nsm_parent_field?: string;
  max_attachments?: number;
  documentation?: string;
  hide_toolbar?: Hide_toolbarEnum;
  allow_copy?: Allow_copyEnum;
  allow_import?: Allow_importEnum;
  allow_events_in_timeline?: Allow_events_in_timelineEnum;
  allow_auto_repeat?: Allow_auto_repeatEnum;
  make_attachments_public?: Make_attachments_publicEnum;
  show_title_field_in_link?: Show_title_field_in_linkEnum;
  translated_doctype?: Translated_doctypeEnum;
  search_fields?: string;
  default_print_format?: string;
  sort_field?: string;
  sort_order?: Sort_orderEnum;
  default_view?: string;
  force_re_route_to_default_view?: Force_re_route_to_default_viewEnum;
  document_type?: Document_typeEnum;
  icon?: string;
  color?: string;
  show_preview_popup?: Show_preview_popupEnum;
  show_name_in_global_search?: Show_name_in_global_searchEnum;
  default_email_template?: string;
  email_append_to?: Email_append_toEnum;
  sender_field?: string;
  sender_name_field?: string;
  recipient_account_field?: string;
  subject_field?: string;
  fields?: Record[];
  actions?: Record[];
  links?: Record[];
  states?: Record[];
  has_web_view?: Has_web_viewEnum;
  allow_guest_to_view?: Allow_guest_to_viewEnum;
  index_web_pages_for_search?: Index_web_pages_for_searchEnum;
  route?: string;
  is_published_field?: string;
  website_search_field?: string;
  engine?: EngineEnum;
  migration_hash?: string;
  row_format?: Row_formatEnum;
}