Coupons & Loyalty

No new fields.

No public methods.

• active Boolean
  default=True
• code Char
  default=<expr> required=True
• company_id Many2one
  precompute=True related='program_id.company_id' store=True
• currency_id Many2one
  related='program_id.currency_id'
• expiration_date Date
• history_ids One2many → loyalty.history
  comodel_name='loyalty.history' inverse_name='card_id' readonly=True
• partner_id Many2one → res.partner
  comodel_name='res.partner' index=True
• point_name Char
  readonly=True related='program_id.portal_point_name'
• points Float
  tracking=True
• points_display Char
  compute='_compute_points_display'
• program_id Many2one → loyalty.program
  comodel_name='loyalty.program' default=<expr> index='btree_not_null' ondelete='restrict'
• program_type Selection
  related='program_id.program_type'
• use_count Integer
  compute='_compute_use_count'

• action_coupon_send(self)
  Open a window to compose an email, with the default template returned by `_get_default_template` message loaded by default
• action_loyalty_update_balance(self)
• create(self, vals_list)
  @api.model_create_multi
• write(self, vals)

• card_id Many2one → loyalty.card
  comodel_name='loyalty.card' readonly=True required=True
• description Char
  required=True
• new_balance Float
• old_balance Float
  related='card_id.points'

• action_update_card_point(self)

• confirmation_message Char
  compute='_compute_confirmation_message'
• coupon_qty Integer
  compute='_compute_coupon_qty' readonly=False store=True args: 'Quantity'
• customer_ids Many2many → res.partner
  string='Customers' args: 'res.partner'
• customer_tag_ids Many2many → res.partner.category
  string='Customer Tags' args: 'res.partner.category'
• description Text
  string='Description'
• mode Selection
  default='anonymous' required=True string='For' args: [('anonymous', 'Anonymous Customers'), ('selected', 'Selected Customers')]
• points_granted Float
  default=1 required=True args: 'Grant'
• points_name Char
  readonly=True related='program_id.portal_point_name'
• program_id Many2one → loyalty.program
  default=<expr> required=True args: 'loyalty.program'
• program_type Selection
  related='program_id.program_type'
• valid_until Date
• will_send_mail Boolean
  compute='_compute_will_send_mail'

• generate_coupons(self)

• card_id Many2one → loyalty.card
  comodel_name='loyalty.card' index=True ondelete='cascade' required=True
• company_id Many2one
  related='card_id.company_id'
• description Text
  required=True
• issued Float
• order_id Many2oneReference
  model_field='order_model' readonly=True
• order_model Char
  readonly=True
• used Float

No public methods.

• active Boolean
  default=True
• mail_template_id Many2one → mail.template
  comodel_name='mail.template' domain=[('model', '=', 'loyalty.card')] ondelete='cascade' required=True string='Email Template'
• points Float
• program_id Many2one → loyalty.program
  comodel_name='loyalty.program' index=True ondelete='cascade' required=True
• trigger Selection
  required=True selection=[('create', 'At Creation'), ('points_reach', 'When Reaching')] string='When'

No public methods.

• active Boolean
  default=True
• applies_on Selection
  compute='_compute_from_program_type' default='current' readonly=False required=True selection=[('current', 'Current order'), ('future', 'Future orders'), ('both', 'Current & Future orders')] store=True
• available_on Boolean
  help='Manage where your program should be available for use.' store=False string='Available On'
• communication_plan_ids One2many → loyalty.mail
  comodel_name='loyalty.mail' compute='_compute_from_program_type' copy=True inverse_name='program_id' readonly=False store=True
• company_id Many2one → res.company
  comodel_name='res.company' default=<expr> string='Company'
• coupon_count Integer
  compute='_compute_coupon_count'
• coupon_count_display Char
  compute='_compute_coupon_count_display' string='Items'
• coupon_ids One2many → loyalty.card
  comodel_name='loyalty.card' inverse_name='program_id'
• currency_id Many2one → res.currency
  comodel_name='res.currency' compute='_compute_currency_id' precompute=True readonly=False required=True store=True string='Currency'
• currency_symbol Char
  related='currency_id.symbol'
• date_from Date
  help='The start date is included in the validity period of this program' string='Start Date'
• date_to Date
  help='The end date is included in the validity period of this program' string='End date'
• is_nominative Boolean
  compute='_compute_is_nominative'
• is_payment_program Boolean
  compute='_compute_is_payment_program'
• limit_usage Boolean
  string='Limit Usage'
• mail_template_id Many2one → mail.template
  comodel_name='mail.template' compute='_compute_mail_template_id' inverse='_inverse_mail_template_id' readonly=False string='Email template'
• max_usage Integer
• name Char
  required=True string='Program Name' translate=True
• payment_program_discount_product_id Many2one → product.product
  comodel_name='product.product' compute='_compute_payment_program_discount_product_id' help='Product used in the sales order to apply the discount.' readonly=True string='Discount Product'
• portal_point_name Char
  compute='_compute_portal_point_name' default='Points' readonly=False store=True translate=True
• portal_visible Boolean
  default=False help='\n Show in web portal, PoS customer ticket, eCommerce checkout, the number of points available\n and used by reward.\n '
• pricelist_ids Many2many → product.pricelist
  comodel_name='product.pricelist' domain="[('currency_id', '=', currency_id)]" help='This program is specific to this pricelist set.' string='Pricelist'
• program_type Selection
  default='promotion' required=True selection=[('coupons', 'Coupons'), ('gift_card', 'Gift Card'), ('loyalty', 'Loyalty Cards'), ('promotion', 'Promotions'), ('ewallet', 'eWallet'), ('promo_code', 'Discount Code'), ('buy_x_get_y', 'Buy X Get Y'), ('next_order_coupons', 'Next Order Coupons')]
• reward_ids One2many → loyalty.reward
  comodel_name='loyalty.reward' compute='_compute_from_program_type' copy=True inverse_name='program_id' readonly=False store=True string='Rewards'
• rule_ids One2many → loyalty.rule
  comodel_name='loyalty.rule' compute='_compute_from_program_type' copy=True inverse_name='program_id' readonly=False store=True string='Conditional rules'
• sequence Integer
  copy=False
• total_order_count Integer
  compute='_compute_total_order_count' string='Total Order Count'
• trigger Selection
  compute='_compute_from_program_type' help='\n Automatic: Customers will be eligible for a reward automatically in their cart.\n Use a code: Customers will be eligible for a reward if they enter a code.\n ' readonly=False selection=[('auto', 'Automatic'), ('with_code', 'Use a code')] store=True
• trigger_product_ids Many2many
  readonly=False related='rule_ids.product_ids'

• action_open_loyalty_cards(self)
• create(self, vals_list)
  @api.model_create_multi
  trigger_product_ids will overwrite product ids defined in a loyalty rule in certain instances. Thus, it should be explicitly removed from an incoming vals dict unless, of course, it was actually a visible field.
• create_from_template(self, template_id)
  @api.model
  Creates the program from the template id defined in `get_program_templates`. Returns an action leading to that new record.
• default_get(self, fields)
  @api.model
• get_program_templates(self)
  @api.model
  Returns the templates to be used for promotional programs.
• write(self, vals)

• active Boolean
  default=True
• all_discount_product_ids Many2many → product.product
  comodel_name='product.product' compute='_compute_all_discount_product_ids'
• clear_wallet Boolean
  default=False
• company_id Many2one
  related='program_id.company_id' store=True
• currency_id Many2one
  related='program_id.currency_id'
• description Char
  compute='_compute_description' precompute=True readonly=False required=True store=True translate=True
• discount Float
  default=10 string='Discount'
• discount_applicability Selection
  default='order' selection=[('order', 'Order'), ('cheapest', 'Cheapest Product'), ('specific', 'Specific Products')]
• discount_line_product_id Many2one → product.product
  comodel_name='product.product' copy=False help='Product used in the sales order to apply the discount. Each reward has its own product for reporting purpose' ondelete='restrict'
• discount_max_amount Monetary
  help='This is the max amount this reward may discount, leave to 0 for no limit.' string='Max Discount'
• discount_mode Selection
  default='percent' required=True selection=_get_discount_mode_select
• discount_product_category_id Many2one → product.category
  comodel_name='product.category' string='Discounted Prod. Categories'
• discount_product_domain Char
  default='[]'
• discount_product_ids Many2many → product.product
  comodel_name='product.product' string='Discounted Products'
• discount_product_tag_id Many2one → product.tag
  comodel_name='product.tag' string='Discounted Prod. Tag'
• is_global_discount Boolean
  compute='_compute_is_global_discount'
• multi_product Boolean
  compute='_compute_multi_product'
• point_name Char
  readonly=True related='program_id.portal_point_name'
• program_id Many2one → loyalty.program
  comodel_name='loyalty.program' index=True ondelete='cascade' required=True
• program_type Selection
  related='program_id.program_type'
• required_points Float
  default=1 string='Points needed'
• reward_product_domain Char
  compute='_compute_reward_product_domain' store=False
• reward_product_id Many2one → product.product
  comodel_name='product.product' domain=[('type', '!=', 'combo')] string='Product'
• reward_product_ids Many2many → product.product
  comodel_name='product.product' compute='_compute_multi_product' help='These are the products that can be claimed with this rule.' search='_search_reward_product_ids' string='Reward Products'
• reward_product_qty Integer
  default=1
• reward_product_tag_id Many2one → product.tag
  comodel_name='product.tag' string='Product Tag'
• reward_product_uom_id Many2one → uom.uom
  comodel_name='uom.uom' compute='_compute_reward_product_uom_id'
• reward_type Selection
  default='discount' required=True selection=[('product', 'Free Product'), ('discount', 'Discount')]
• user_has_debug Boolean
  compute='_compute_user_has_debug'

• create(self, vals_list)
  @api.model_create_multi
• default_get(self, fields)
  @api.model
• unlink(self)
• update_field_translations(self, field_name, translations, source_lang='')
• write(self, vals)

• active Boolean
  default=True
• code Char
  compute='_compute_code' readonly=False store=True string='Discount code'
• company_id Many2one
  related='program_id.company_id' store=True
• currency_id Many2one
  related='program_id.currency_id'
• minimum_amount Monetary
  string='Minimum Purchase'
• minimum_amount_tax_mode Selection
  default='incl' required=True selection=[('incl', 'tax included'), ('excl', 'tax excluded')]
• minimum_qty Integer
  default=1 string='Minimum Quantity'
• mode Selection
  compute='_compute_mode' readonly=False selection=[('auto', 'Automatic'), ('with_code', 'With a promotion code')] store=True string='Application'
• product_category_id Many2one → product.category
  comodel_name='product.category' string='Categories'
• product_domain Char
  default='[]'
• product_ids Many2many → product.product
  comodel_name='product.product' string='Products'
• product_tag_id Many2one → product.tag
  comodel_name='product.tag' string='Product Tag'
• program_id Many2one → loyalty.program
  comodel_name='loyalty.program' index=True ondelete='cascade' required=True
• program_type Selection
  related='program_id.program_type'
• reward_point_amount Float
  default=1 string='Reward'
• reward_point_mode Selection
  default='order' required=True selection=_get_reward_point_mode_selection
• reward_point_name Char
  readonly=True related='program_id.portal_point_name'
• reward_point_split Boolean
  default=False help="Whether to separate reward coupons per matched unit, only applies to 'future' programs and trigger mode per money spent or unit paid..." string='Split per unit'
• user_has_debug Boolean
  compute='_compute_user_has_debug'

• default_get(self, fields)
  @api.model

No new fields.

• action_archive(self)

No new fields.

• write(self, vals)

No new fields.

• create(self, vals_list)
  @api.model_create_multi
  Override of `product` to set a default image for gift cards.

• loyalty_card_count Integer
  compute='_compute_count_active_cards' compute_sudo=True groups='base.group_user' string='Active loyalty cards'

• action_view_loyalty_cards(self)