ERPNext DocType Inspector

Pricing Rule

Module: Accounts

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 (62)

Field Name	Label	Type	Options	Properties	Default
`naming_series`	Naming Series	Select	PRLE-.####		PRLE-.####
`title`	Title	Data	-	Required	-
`disable`	Disable	Check	-		0
`apply_on`	Apply On	Select	Item Code Item Group +2 more	Required	Item Code
`price_or_product_discount`	Price or Product Discount	Select	Price Product	Required	-
`warehouse`	Warehouse	Link	Warehouse		-
`items`	Apply Rule On Item Code	Table	Pricing Rule Item Code		-
`item_groups`	Apply Rule On Item Group	Table	Pricing Rule Item Group		-
`brands`	Apply Rule On Brand	Table	Pricing Rule Brand		-
`mixed_conditions`	Mixed Conditions	Check	-		0
`is_cumulative`	Is Cumulative	Check	-		0
`coupon_code_based`	Coupon Code Based	Check	-		0
`apply_rule_on_other`	Apply Rule On Other	Select	Item Code Item Group +1 more		-
`other_item_code`	Item Code	Link	Item		-
`other_item_group`	Item Group	Link	Item Group		-
`other_brand`	Brand	Link	Brand		-
`selling`	Selling	Check	-		0
`buying`	Buying	Check	-		0
`applicable_for`	Applicable For	Select	Customer Customer Group +5 more		-
`customer`	Customer	Link	Customer		-
`customer_group`	Customer Group	Link	Customer Group		-
`territory`	Territory	Link	Territory		-
`sales_partner`	Sales Partner	Link	Sales Partner		-
`campaign`	Campaign	Link	UTM Campaign		-
`supplier`	Supplier	Link	Supplier		-
`supplier_group`	Supplier Group	Link	Supplier Group		-
`min_qty`	Min Qty (As Per Stock UOM)	Float	-		-
`max_qty`	Max Qty (As Per Stock UOM)	Float	-		-
`min_amt`	Min Amt	Currency	currency		0
`max_amt`	Max Amt	Currency	currency		0
`same_item`	Same Item	Check	-		0
`free_item`	Free Item	Link	Item		-
`free_qty`	Qty	Float	-		0
`free_item_rate`	Free Item Rate	Currency	-		-
`free_item_uom`	UOM	Link	UOM		-
`round_free_qty`	Round Free Qty	Check	-		0
`dont_enforce_free_item_qty`	Don't Enforce Free Item Qty	Check	-		0
`is_recursive`	Is Recursive	Check	-		0
`recurse_for`	Recurse Every (As Per Transaction UOM)	Float	-		-
`apply_recursion_over`	Apply Recursion Over (As Per Transaction UOM)	Float	-		0
`valid_from`	Valid From	Date	-		Today
`valid_upto`	Valid Up To	Date	-		-
`company`	Company	Link	Company		-
`currency`	Currency	Link	Currency	Required	-
`margin_type`	Margin Type	Select	Percentage Amount		Percentage
`margin_rate_or_amount`	Margin Rate or Amount	Float	-		0
`rate_or_discount`	Rate or Discount	Select	Rate Discount Percentage +1 more		Discount Percentage
`apply_discount_on`	Apply Discount On	Select	Grand Total Net Total		Grand Total
`rate`	Rate	Currency	currency		0
`discount_amount`	Discount Amount	Currency	currency		0
`discount_percentage`	Discount Percentage	Float	-		-
`for_price_list`	For Price List	Link	Price List		-
`condition`	Condition	Code	PythonExpression		-
`apply_multiple_pricing_rules`	Apply Multiple Pricing Rules	Check	-		0
`apply_discount_on_rate`	Apply Discount on Discounted Rate	Check	-		0
`threshold_percentage`	Threshold for Suggestion (In Percentage)	Percent	-		-
`validate_applied_rule`	Validate Applied Rule	Check	-		0
`rule_description`	Rule Description	Small Text	-		-
`has_priority`	Has Priority	Check	-		0
`priority`	Priority	Select	1 2 +18 more		-
`promotional_scheme_id`	Promotional Scheme Id	Data	-	Read-only Hidden	-
`promotional_scheme`	Promotional Scheme	Link	Promotional Scheme	Read-only	-

Raw DocType Data

export enum Naming_seriesEnum { 'PRLE-.####' }

export enum DisableEnum { 0, 1 }

export enum Apply_onEnum { 'Item Code', 'Item Group', 'Brand', 'Transaction' }

export enum Price_or_product_discountEnum { 'Price', 'Product' }

export enum Mixed_conditionsEnum { 0, 1 }

export enum Is_cumulativeEnum { 0, 1 }

export enum Coupon_code_basedEnum { 0, 1 }

export enum Apply_rule_on_otherEnum { 'Item Code', 'Item Group', 'Brand' }

export enum SellingEnum { 0, 1 }

export enum BuyingEnum { 0, 1 }

export enum Applicable_forEnum { 'Customer', 'Customer Group', 'Territory', 'Sales Partner', 'Campaign', 'Supplier', 'Supplier Group' }

export enum Same_itemEnum { 0, 1 }

export enum Round_free_qtyEnum { 0, 1 }

export enum Dont_enforce_free_item_qtyEnum { 0, 1 }

export enum Is_recursiveEnum { 0, 1 }

export enum Margin_typeEnum { 'Percentage', 'Amount' }

export enum Rate_or_discountEnum { 'Rate', 'Discount Percentage', 'Discount Amount' }

export enum Apply_discount_onEnum { 'Grand Total', 'Net Total' }

export enum Apply_multiple_pricing_rulesEnum { 0, 1 }

export enum Apply_discount_on_rateEnum { 0, 1 }

export enum Validate_applied_ruleEnum { 0, 1 }

export enum Has_priorityEnum { 0, 1 }

export enum PriorityEnum { '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20' }

export interface Pricing RuleSchema {
  naming_series?: Naming_seriesEnum;
  title: string;
  disable?: DisableEnum;
  apply_on: Apply_onEnum;
  price_or_product_discount: Price_or_product_discountEnum;
  warehouse?: string;
  items?: Record[];
  item_groups?: Record[];
  brands?: Record[];
  mixed_conditions?: Mixed_conditionsEnum;
  is_cumulative?: Is_cumulativeEnum;
  coupon_code_based?: Coupon_code_basedEnum;
  apply_rule_on_other?: Apply_rule_on_otherEnum;
  other_item_code?: string;
  other_item_group?: string;
  other_brand?: string;
  selling?: SellingEnum;
  buying?: BuyingEnum;
  applicable_for?: Applicable_forEnum;
  customer?: string;
  customer_group?: string;
  territory?: string;
  sales_partner?: string;
  campaign?: string;
  supplier?: string;
  supplier_group?: string;
  min_qty?: number;
  max_qty?: number;
  min_amt?: number;
  max_amt?: number;
  same_item?: Same_itemEnum;
  free_item?: string;
  free_qty?: number;
  free_item_rate?: number;
  free_item_uom?: string;
  round_free_qty?: Round_free_qtyEnum;
  dont_enforce_free_item_qty?: Dont_enforce_free_item_qtyEnum;
  is_recursive?: Is_recursiveEnum;
  recurse_for?: number;
  apply_recursion_over?: number;
  valid_from?: string;
  valid_upto?: string;
  company?: string;
  currency: string;
  margin_type?: Margin_typeEnum;
  margin_rate_or_amount?: number;
  rate_or_discount?: Rate_or_discountEnum;
  apply_discount_on?: Apply_discount_onEnum;
  rate?: number;
  discount_amount?: number;
  discount_percentage?: number;
  for_price_list?: string;
  condition?: string;
  apply_multiple_pricing_rules?: Apply_multiple_pricing_rulesEnum;
  apply_discount_on_rate?: Apply_discount_on_rateEnum;
  threshold_percentage?: number;
  validate_applied_rule?: Validate_applied_ruleEnum;
  rule_description?: string;
  has_priority?: Has_priorityEnum;
  priority?: PriorityEnum;
  promotional_scheme_id?: string;
  promotional_scheme?: string;
}