ERPNext DocType Inspector

DocField

Module: Core

Export API Coming Soon

Total Fields

Required Fields

Read-only Fields

Link Fields

DocType Properties

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

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

Fields (59)

Field Name	Label	Type	Options	Properties	Default
`label`	Label	Data	-		-
`fieldtype`	Type	Select	Autocomplete Attach Attach Image +40 more	Required	Data
`fieldname`	Name	Data	-		-
`precision`	Precision	Select	0 1 +8 more		-
`length`	Length	Int	-		-
`non_negative`	Non Negative	Check	-		0
`hide_days`	Hide Days	Check	-		0
`hide_seconds`	Hide Seconds	Check	-		0
`reqd`	Mandatory	Check	-		0
`is_virtual`	Virtual	Check	-		0
`search_index`	Index	Check	-		0
`not_nullable`	Not Nullable	Check	-		0
`options`	Options	Small Text	-		-
`sort_options`	Sort Options	Check	-		0
`show_dashboard`	Show Dashboard	Check	-		0
`link_filters`	Link Filters	JSON	-		-
`default`	Default	Small Text	-		-
`fetch_from`	Fetch From	Small Text	-		-
`fetch_if_empty`	Fetch on Save if Empty	Check	-		0
`hidden`	Hidden	Check	-		0
`show_on_timeline`	Show on Timeline	Check	-		0
`bold`	Bold	Check	-		0
`allow_in_quick_entry`	Allow in Quick Entry	Check	-		0
`translatable`	Translatable	Check	-		0
`print_hide`	Print Hide	Check	-		0
`print_hide_if_no_value`	Print Hide If No Value	Check	-		0
`report_hide`	Report Hide	Check	-		0
`depends_on`	Display Depends On (JS)	Code	JS		-
`collapsible`	Collapsible	Check	-		0
`collapsible_depends_on`	Collapsible Depends On (JS)	Code	JS		-
`hide_border`	Hide Border	Check	-		0
`in_list_view`	In List View	Check	-		0
`in_standard_filter`	In List Filter	Check	-		0
`in_preview`	In Preview	Check	-		0
`sticky`	Sticky	Check	-		0
`in_filter`	In Filter	Check	-		0
`in_global_search`	In Global Search	Check	-		0
`read_only`	Read Only	Check	-		0
`allow_on_submit`	Allow on Submit	Check	-		0
`ignore_user_permissions`	Ignore User Permissions	Check	-		0
`allow_bulk_edit`	Allow Bulk Edit	Check	-		0
`make_attachment_public`	Make Attachment Public (by default)	Check	-		0
`permlevel`	Perm Level	Int	-		0
`ignore_xss_filter`	Ignore XSS Filter	Check	-		0
`unique`	Unique	Check	-		0
`no_copy`	No Copy	Check	-		0
`set_only_once`	Set only once	Check	-		0
`remember_last_selected_value`	Remember Last Selected Value	Check	-		0
`mandatory_depends_on`	Mandatory Depends On (JS)	Code	JS		-
`read_only_depends_on`	Read Only Depends On (JS)	Code	JS		-
`print_width`	Print Width	Data	-		-
`width`	Width	Data	-		-
`max_height`	Max Height	Data	-		-
`columns`	Columns	Int	-		-
`description`	Description	Small Text	-		-
`documentation_url`	Documentation URL	Data	URL		-
`placeholder`	Placeholder	Data	-		-
`oldfieldname`	-	Data	-	Hidden	-
`oldfieldtype`	-	Data	-	Hidden	-

Raw DocType Data

export enum FieldtypeEnum { 'Autocomplete', 'Attach', 'Attach Image', 'Barcode', 'Button', 'Check', 'Code', 'Color', 'Column Break', 'Currency', 'Data', 'Date', 'Datetime', 'Duration', 'Dynamic Link', 'Float', 'Fold', 'Geolocation', 'Heading', 'HTML', 'HTML Editor', 'Icon', 'Image', 'Int', 'JSON', 'Link', 'Long Text', 'Markdown Editor', 'Password', 'Percent', 'Phone', 'Read Only', 'Rating', 'Section Break', 'Select', 'Signature', 'Small Text', 'Tab Break', 'Table', 'Table MultiSelect', 'Text', 'Text Editor', 'Time' }

export enum PrecisionEnum { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9' }

export enum Non_negativeEnum { 0, 1 }

export enum Hide_daysEnum { 0, 1 }

export enum Hide_secondsEnum { 0, 1 }

export enum ReqdEnum { 0, 1 }

export enum Is_virtualEnum { 0, 1 }

export enum Search_indexEnum { 0, 1 }

export enum Not_nullableEnum { 0, 1 }

export enum Sort_optionsEnum { 0, 1 }

export enum Show_dashboardEnum { 0, 1 }

export enum Fetch_if_emptyEnum { 0, 1 }

export enum HiddenEnum { 0, 1 }

export enum Show_on_timelineEnum { 0, 1 }

export enum BoldEnum { 0, 1 }

export enum Allow_in_quick_entryEnum { 0, 1 }

export enum TranslatableEnum { 0, 1 }

export enum Print_hideEnum { 0, 1 }

export enum Print_hide_if_no_valueEnum { 0, 1 }

export enum Report_hideEnum { 0, 1 }

export enum CollapsibleEnum { 0, 1 }

export enum Hide_borderEnum { 0, 1 }

export enum In_list_viewEnum { 0, 1 }

export enum In_standard_filterEnum { 0, 1 }

export enum In_previewEnum { 0, 1 }

export enum StickyEnum { 0, 1 }

export enum In_filterEnum { 0, 1 }

export enum In_global_searchEnum { 0, 1 }

export enum Read_onlyEnum { 0, 1 }

export enum Allow_on_submitEnum { 0, 1 }

export enum Ignore_user_permissionsEnum { 0, 1 }

export enum Allow_bulk_editEnum { 0, 1 }

export enum Make_attachment_publicEnum { 0, 1 }

export enum Ignore_xss_filterEnum { 0, 1 }

export enum UniqueEnum { 0, 1 }

export enum No_copyEnum { 0, 1 }

export enum Set_only_onceEnum { 0, 1 }

export enum Remember_last_selected_valueEnum { 0, 1 }

export interface DocFieldSchema {
  label?: string;
  fieldtype: FieldtypeEnum;
  fieldname?: string;
  precision?: PrecisionEnum;
  length?: number;
  non_negative?: Non_negativeEnum;
  hide_days?: Hide_daysEnum;
  hide_seconds?: Hide_secondsEnum;
  reqd?: ReqdEnum;
  is_virtual?: Is_virtualEnum;
  search_index?: Search_indexEnum;
  not_nullable?: Not_nullableEnum;
  options?: string;
  sort_options?: Sort_optionsEnum;
  show_dashboard?: Show_dashboardEnum;
  link_filters?: Record;
  default?: string;
  fetch_from?: string;
  fetch_if_empty?: Fetch_if_emptyEnum;
  hidden?: HiddenEnum;
  show_on_timeline?: Show_on_timelineEnum;
  bold?: BoldEnum;
  allow_in_quick_entry?: Allow_in_quick_entryEnum;
  translatable?: TranslatableEnum;
  print_hide?: Print_hideEnum;
  print_hide_if_no_value?: Print_hide_if_no_valueEnum;
  report_hide?: Report_hideEnum;
  depends_on?: string;
  collapsible?: CollapsibleEnum;
  collapsible_depends_on?: string;
  hide_border?: Hide_borderEnum;
  in_list_view?: In_list_viewEnum;
  in_standard_filter?: In_standard_filterEnum;
  in_preview?: In_previewEnum;
  sticky?: StickyEnum;
  in_filter?: In_filterEnum;
  in_global_search?: In_global_searchEnum;
  read_only?: Read_onlyEnum;
  allow_on_submit?: Allow_on_submitEnum;
  ignore_user_permissions?: Ignore_user_permissionsEnum;
  allow_bulk_edit?: Allow_bulk_editEnum;
  make_attachment_public?: Make_attachment_publicEnum;
  permlevel?: number;
  ignore_xss_filter?: Ignore_xss_filterEnum;
  unique?: UniqueEnum;
  no_copy?: No_copyEnum;
  set_only_once?: Set_only_onceEnum;
  remember_last_selected_value?: Remember_last_selected_valueEnum;
  mandatory_depends_on?: string;
  read_only_depends_on?: string;
  print_width?: string;
  width?: string;
  max_height?: string;
  columns?: number;
  description?: string;
  documentation_url?: string;
  placeholder?: string;
  oldfieldname?: string;
  oldfieldtype?: string;
}