ERPNext DocType Inspector

Custom Field

Module: Custom

Export API Coming Soon

Total Fields

Required Fields

Read-only Fields

Link Fields

Description

Adds a custom field to a DocType

DocType Properties

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

Custom: No
Naming Series: Not set
Search By: dt,label,fieldtype,options

Fields (51)

Field Name	Label	Type	Options	Properties	Default
`is_system_generated`	Is System Generated	Check	-	Read-only	0
`dt`	DocType	Link	DocType	Required	-
`module`	Module (for export)	Link	Module Def		-
`label`	Label	Data	-		-
`placeholder`	Placeholder	Data	-		-
`fieldname`	Fieldname	Data	-	Read-only	-
`insert_after`	Insert After	Select	-		-
`length`	Length	Int	-		-
`link_filters`	Link Filters	JSON	-	Hidden	-
`fieldtype`	Field Type	Select	Autocomplete Attach Attach Image +40 more	Required	Data
`precision`	Precision	Select	0 1 +8 more		-
`hide_seconds`	Hide Seconds	Check	-		0
`hide_days`	Hide Days	Check	-		0
`options`	Options	Small Text	-		-
`sort_options`	Sort Options	Check	-		0
`fetch_from`	Fetch From	Small Text	-		-
`fetch_if_empty`	Fetch on Save if Empty	Check	-		0
`collapsible`	Collapsible	Check	-		0
`collapsible_depends_on`	Collapsible Depends On	Code	-		-
`default`	Default Value	Text	-		-
`depends_on`	Depends On	Code	-		-
`mandatory_depends_on`	Mandatory Depends On	Code	-		-
`read_only_depends_on`	Read Only Depends On	Code	-		-
`non_negative`	Non Negative	Check	-		0
`reqd`	Is Mandatory Field	Check	-		0
`unique`	Unique	Check	-		0
`is_virtual`	Is Virtual	Check	-		0
`read_only`	Read Only	Check	-		0
`ignore_user_permissions`	Ignore User Permissions	Check	-		0
`hidden`	Hidden	Check	-		0
`print_hide`	Print Hide	Check	-		0
`print_hide_if_no_value`	Print Hide If No Value	Check	-		0
`print_width`	Print Width	Data	-	Hidden	-
`no_copy`	No Copy	Check	-		0
`allow_on_submit`	Allow on Submit	Check	-		0
`in_list_view`	In List View	Check	-		0
`in_standard_filter`	In Standard Filter	Check	-		0
`in_global_search`	In Global Search	Check	-		0
`in_preview`	In Preview	Check	-		0
`bold`	Bold	Check	-		0
`report_hide`	Report Hide	Check	-		0
`search_index`	Index	Check	-	Hidden	0
`allow_in_quick_entry`	Allow in Quick Entry	Check	-		0
`ignore_xss_filter`	Ignore XSS Filter	Check	-		0
`translatable`	Translatable	Check	-		0
`hide_border`	Hide Border	Check	-		0
`show_dashboard`	Show Dashboard	Check	-		0
`description`	Field Description	Text	-		-
`permlevel`	Permission Level	Int	-		0
`width`	Width	Data	-		-
`columns`	Columns	Int	-		-

Raw DocType Data

export enum Is_system_generatedEnum { 0, 1 }

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 Hide_secondsEnum { 0, 1 }

export enum Hide_daysEnum { 0, 1 }

export enum Sort_optionsEnum { 0, 1 }

export enum Fetch_if_emptyEnum { 0, 1 }

export enum CollapsibleEnum { 0, 1 }

export enum Non_negativeEnum { 0, 1 }

export enum ReqdEnum { 0, 1 }

export enum UniqueEnum { 0, 1 }

export enum Is_virtualEnum { 0, 1 }

export enum Read_onlyEnum { 0, 1 }

export enum Ignore_user_permissionsEnum { 0, 1 }

export enum HiddenEnum { 0, 1 }

export enum Print_hideEnum { 0, 1 }

export enum Print_hide_if_no_valueEnum { 0, 1 }

export enum No_copyEnum { 0, 1 }

export enum Allow_on_submitEnum { 0, 1 }

export enum In_list_viewEnum { 0, 1 }

export enum In_standard_filterEnum { 0, 1 }

export enum In_global_searchEnum { 0, 1 }

export enum In_previewEnum { 0, 1 }

export enum BoldEnum { 0, 1 }

export enum Report_hideEnum { 0, 1 }

export enum Search_indexEnum { 0, 1 }

export enum Allow_in_quick_entryEnum { 0, 1 }

export enum Ignore_xss_filterEnum { 0, 1 }

export enum TranslatableEnum { 0, 1 }

export enum Hide_borderEnum { 0, 1 }

export enum Show_dashboardEnum { 0, 1 }

export interface Custom FieldSchema {
  is_system_generated?: Is_system_generatedEnum;
  dt: string;
  module?: string;
  label?: string;
  placeholder?: string;
  fieldname?: string;
  insert_after?: string;
  length?: number;
  link_filters?: Record;
  fieldtype: FieldtypeEnum;
  precision?: PrecisionEnum;
  hide_seconds?: Hide_secondsEnum;
  hide_days?: Hide_daysEnum;
  options?: string;
  sort_options?: Sort_optionsEnum;
  fetch_from?: string;
  fetch_if_empty?: Fetch_if_emptyEnum;
  collapsible?: CollapsibleEnum;
  collapsible_depends_on?: string;
  default?: string;
  depends_on?: string;
  mandatory_depends_on?: string;
  read_only_depends_on?: string;
  non_negative?: Non_negativeEnum;
  reqd?: ReqdEnum;
  unique?: UniqueEnum;
  is_virtual?: Is_virtualEnum;
  read_only?: Read_onlyEnum;
  ignore_user_permissions?: Ignore_user_permissionsEnum;
  hidden?: HiddenEnum;
  print_hide?: Print_hideEnum;
  print_hide_if_no_value?: Print_hide_if_no_valueEnum;
  print_width?: string;
  no_copy?: No_copyEnum;
  allow_on_submit?: Allow_on_submitEnum;
  in_list_view?: In_list_viewEnum;
  in_standard_filter?: In_standard_filterEnum;
  in_global_search?: In_global_searchEnum;
  in_preview?: In_previewEnum;
  bold?: BoldEnum;
  report_hide?: Report_hideEnum;
  search_index?: Search_indexEnum;
  allow_in_quick_entry?: Allow_in_quick_entryEnum;
  ignore_xss_filter?: Ignore_xss_filterEnum;
  translatable?: TranslatableEnum;
  hide_border?: Hide_borderEnum;
  show_dashboard?: Show_dashboardEnum;
  description?: string;
  permlevel?: number;
  width?: string;
  columns?: number;
}