• contract_line_id Many2one → contract.line
  index=True string='Contract Line' args: 'contract.line'

No public methods.

• active Boolean
  default=True
• code Char
  string='Reference'
• commercial_partner_id Many2one → res.partner
  compute_sudo=True index=True related='partner_id.commercial_partner_id' store=True string='Commercial Entity' args: 'res.partner'
• contract_line_fixed_ids One2many → contract.line
  comodel_name='contract.line' context={'active_test': False} inverse_name='contract_id' string='Contract lines (fixed)'
• contract_line_ids One2many → contract.line
  comodel_name='contract.line' context={'active_test': False} copy=True inverse_name='contract_id' string='Contract lines'
• contract_template_id Many2one → contract.template
  comodel_name='contract.template' string='Contract Template'
• create_invoice_visibility Boolean
  compute='_compute_create_invoice_visibility'
• currency_id Many2one → res.currency
  comodel_name='res.currency' compute='_compute_currency_id' inverse='_inverse_currency_id' string='Currency'
• date_end Date
  compute='_compute_date_end' readonly=False store=True
• fiscal_position_id Many2one → account.fiscal.position
  comodel_name='account.fiscal.position' ondelete='restrict' string='Fiscal Position'
• group_id Many2one → account.analytic.account
  comodel_name='account.analytic.account' compute='_compute_group_id' ondelete='restrict' readonly=False store=True string='Group'
• invoice_count Integer
  compute='_compute_invoice_count'
• invoice_partner_id Many2one → res.partner
  comodel_name='res.partner' domain="['|',('id', 'parent_of', partner_id), ('id', 'child_of', partner_id)]" ondelete='restrict' string='Invoicing contact'
• manual_currency_id Many2one → res.currency
  comodel_name='res.currency' readonly=True
• modification_ids One2many → contract.modification
  comodel_name='contract.modification' inverse_name='contract_id' string='Modifications'
• name Char
• note Text
  string='Notes'
• partner_id Many2one → res.partner
  comodel_name='res.partner' inverse='_inverse_partner_id' required=True
• payment_term_id Many2one → account.payment.term
  comodel_name='account.payment.term' index=True string='Payment Terms'
• tag_ids Many2many → contract.tag
  comodel_name='contract.tag' string='Tags'
• user_id Many2one → res.users
  comodel_name='res.users' default=<expr> index=True string='Responsible'

• action_contract_send(self)
• action_preview(self)
  Invoked when 'Preview' button in contract form view is clicked.
• action_show_invoices(self)
• create(self, vals_list)
  @api.model_create_multi
• cron_recurring_create_invoice(self, date_ref=None)
  @api.model
• get_formview_id(self, access_uid=None)
• recurring_create_invoice(self)
  Button action This method triggers the creation of the next invoices of the contracts even if their next invoicing date is in the future.
• write(self, vals)

• active Boolean
  readonly=True related='contract_id.active' store=True string='Active'
• contract_id Many2one → contract.contract
  auto_join=True comodel_name='contract.contract' index=True ondelete='cascade' required=True string='Contract'
• create_invoice_visibility Boolean
  compute='_compute_create_invoice_visibility'
• currency_id Many2one
  related='contract_id.currency_id'
• monthly_recurring Monetary
  compute='_compute_monthly_recurring' currency_field='currency_id' store=True
• partner_id Many2one
  store=True
• product_id Many2one
  index=True
• sequence Integer

• get_view(self, view_id=None, view_type='form', **options)
  @api.model

• contract_to_invoice_count Integer
  compute='_compute_contract_to_invoice_ids'
• contract_to_invoice_ids Many2many → contract.contract
  comodel_name='contract.contract' compute='_compute_contract_to_invoice_ids'
• contract_type Selection
  default='sale' required=True selection=[('sale', 'Customer'), ('purchase', 'Supplier')]
• invoice_date Date
  required=True

• action_show_contract_to_invoice(self)
• create_invoice(self)

• contract_id Many2one → contract.contract
  comodel_name='contract.contract' index=True ondelete='cascade' required=True string='Contract'
• date Date
  required=True
• description Text
  required=True
• sent Boolean

• check_modification_ids_need_sent(self)
• create(self, vals_list)
  @api.model_create_multi
• write(self, vals)

• date_end Date
  help='Optional contract termination date (limits recurrence)' index=True
• date_start Date
  default=<expr> help='Contract activation date (first recurrence starts here)' index=True
• last_date_invoiced Date
  copy=False readonly=True
• next_period_date_end Date
  compute='_compute_next_period_date_end' string='Next Period End'
• next_period_date_start Date
  compute='_compute_next_period_date_start' string='Next Period Start'
• recurring_interval Integer
  default=1 help='Invoice every (Days/Week/Month/Year)' string='Invoice Every'
• recurring_invoicing_offset Integer
  compute='_compute_recurring_invoicing_offset' help='Number of days to offset the invoice from the period end date (in post-paid mode) or start date (in pre-paid mode).' string='Invoicing offset'
• recurring_invoicing_type Selection
  default='pre-paid' help='Specify if the invoice must be generated at the beginning (pre-paid) or end (post-paid) of the period.' string='Invoicing type' args: [('pre-paid', 'Pre-paid'), ('post-paid', 'Post-paid')]
• recurring_next_date Date
  compute='_compute_recurring_next_date' copy=True readonly=False store=True string='Date of Next Invoice'
• recurring_rule_type Selection
  default='monthly' help='Specify interval for automatic invoice generation.' string='Recurrence' args: [('daily', 'Day(s)'), ('weekly', 'Week(s)'), ('monthly', 'Month(s)'), ('monthlylastday', 'Month(s) last day'), ('quarterly', 'Quarter(s)'), ('semesterly', 'Semester(s)'), ('yearly', 'Year(s)')]

• get_next_invoice_date(self, next_period_date_start, recurring_invoicing_type, recurring_invoicing_offset, recurring_rule_type, recurring_interval, max_date_end)
  @api.model
  Compute the date of the next invoice based on all parameters.
• get_next_period_date_end(self, next_period_date_start, recurring_rule_type, recurring_interval, max_date_end, next_invoice_date=False, recurring_invoicing_type=False, recurring_invoicing_offset=False)
  @api.model
  Compute the end date for the next period.
• get_relative_delta(self, recurring_rule_type, interval)
  @api.model
  Return a relativedelta for one period based on rule type.

• color Integer
  default=0 args: 'Color Index'
• company_id Many2one → res.company
  default=<expr> string='Company' args: 'res.company'
• name Char
  required=True

No public methods.

• company_id Many2one → res.company
  comodel_name='res.company' default=<expr> required=True string='Company'
• contract_line_ids One2many → contract.template.line
  comodel_name='contract.template.line' copy=True inverse_name='contract_id' string='Contract template lines'
• contract_type Selection
  default='sale' index=True selection=[('sale', 'Customer'), ('purchase', 'Supplier')]
• generation_type Selection
  default=<expr> help='Defines what document is automatically generated by the cron.' selection=[('invoice', 'Invoice')]
• journal_id Many2one → account.journal
  check_company=True comodel_name='account.journal' compute='_compute_journal_id' domain="[('type', '=', contract_type)]" index=True readonly=False store=True string='Journal'
• line_recurrence Boolean
  help='Check this if you want to control recurrence at the line level instead of for the whole contract.' string='Recurrence at line level?'
• name Char
  required=True
• partner_id Many2one → res.partner
  comodel_name='res.partner' index=True string='Partner'
• pricelist_id Many2one → product.pricelist
  comodel_name='product.pricelist' string='Pricelist'

No public methods.

• automatic_price Boolean
  compute='_compute_automatic_price' help='If checked, the price will be taken from the pricelist. Otherwise, it must be set manually.' readonly=False store=True string='Auto-price?'
• company_id Many2one
  readonly=True related='contract_id.company_id' store=True
• contract_id Many2one → contract.template
  comodel_name='contract.template' ondelete='cascade' required=True string='Contract'
• currency_id Many2one → res.currency
  args: 'res.currency'
• date_start Date
  compute='_compute_date_start' copy=True readonly=False store=True
• discount Float
  digits='Discount' help='Discount to apply on generated invoices. Must be ≤ 100.' string='Discount (%)'
• display_type Selection
  default=False help='Technical field for UX purposes.' selection=[('line_section', 'Section'), ('line_note', 'Note')]
• is_canceled Boolean
  default=False string='Canceled'
• is_recurring_note Boolean
  compute='_compute_is_recurring_note' string='Recurring Note'
• name Text
  compute='_compute_name' readonly=False required=True store=True string='Description'
• note_invoicing_mode Selection
  default='with_previous_line' help='When to invoice this note line relative to others.' selection=[('with_previous_line', 'With previous line'), ('with_next_line', 'With next line'), ('custom', 'Custom')]
• partner_id Many2one → res.partner
  comodel_name='res.partner' related='contract_id.partner_id'
• price_subtotal Monetary
  compute='_compute_price_subtotal' string='Sub Total'
• price_unit Float
  compute='_compute_price_unit' inverse='_inverse_price_unit' string='Unit Price'
• product_id Many2one → product.product
  string='Product' args: 'product.product'
• product_uom_category_id Many2one → uom.category
  comodel_name='uom.category' readonly=True related='product_id.uom_id.category_id'
• quantity Float
  default=1.0 required=True
• recurring_interval Integer
  compute='_compute_recurring_interval' copy=True readonly=False required=True store=True
• recurring_invoicing_type Selection
  compute='_compute_recurring_invoicing_type' copy=True readonly=False required=True store=True
• recurring_rule_type Selection
  compute='_compute_recurring_rule_type' copy=True readonly=False required=True store=True
• sequence Integer
  default=10 help='Defines line ordering in the contract.'
• specific_price Float
• uom_id Many2one → uom.uom
  comodel_name='uom.uom' compute='_compute_uom_id' domain="[('category_id', '=', product_uom_category_id)]" readonly=False store=True string='Unit of Measure'

No public methods.

• contract_ids One2many → contract.contract
  comodel_name='contract.contract' inverse_name='partner_id' string='Contracts'
• purchase_contract_count Integer
  compute='_compute_contract_count' string='Purchase Contracts'
• sale_contract_count Integer
  compute='_compute_contract_count' string='Sale Contracts'

• act_show_contract(self)
  This opens contract view @return: the contract view

• old_contract_id Many2one → contract.contract
  args: 'contract.contract'

No public methods.

• contract_line_id Many2one → contract.line
  index=True string='Contract Line' args: 'contract.line'

No public methods.

• company_id Many2one → res.company
  default=<expr> required=True string='Company' args: 'res.company'
• contract_type Selection
  default='sale' index=True selection=[('sale', 'Customer'), ('purchase', 'Supplier')]
• generation_type Selection
  default=<expr> help='Choose the document that will be automatically generated by cron.' selection=[('invoice', 'Invoice')]
• journal_id Many2one → account.journal
  check_company=True comodel_name='account.journal' compute='_compute_journal_id' domain="[('type', '=', contract_type)]" index=True readonly=False store=True string='Journal'
• line_recurrence Boolean
  help='Mark this check if you want to control recurrrence at line level instead of all together for the whole contract.' string='Recurrence at line level?'
• name Char
  required=True
• partner_id Many2one → res.partner
  comodel_name='res.partner' index=True string='Partner'
• pricelist_id Many2one → product.pricelist
  comodel_name='product.pricelist' string='Pricelist'

No public methods.

• auto_renew_interval Integer
  default=1 help='Renew every (Days/Week/Month/Year)' string='Renew Every'
• auto_renew_rule_type Selection
  default='yearly' help='Specify Interval for automatic renewal.' string='Renewal type' args: [('daily', 'Day(s)'), ('weekly', 'Week(s)'), ('monthly', 'Month(s)'), ('yearly', 'Year(s)')]
• automatic_price Boolean
  help='If this is marked, the price will be obtained automatically applying the pricelist to the product. If not, you will be able to introduce a manual price' string='Auto-price?'
• company_id Many2one
  related='contract_id.company_id' store=True
• contract_id Many2one → contract.abstract.contract
  comodel_name='contract.abstract.contract' ondelete='cascade' required=True string='Contract'
• currency_id Many2one → res.currency
  args: 'res.currency'
• date_start Date
  compute='_compute_date_start' copy=True readonly=False store=True
• discount Float
  digits='Discount' help='Discount that is applied in generated invoices. It should be less or equal to 100' string='Discount (%)'
• display_type Selection
  default=False help='Technical field for UX purpose.' selection=[('line_section', 'Section'), ('line_note', 'Note')]
• is_auto_renew Boolean
  default=False string='Auto Renew'
• is_canceled Boolean
  default=False string='Canceled'
• is_recurring_note Boolean
  compute='_compute_is_recurring_note'
• last_date_invoiced Date
• name Text
  required=True string='Description'
• note_invoicing_mode Selection
  default='with_previous_line' help='Defines when the Note is invoiced:\n- With previous line: If the previous line can be invoiced.\n- With next line: If the next line can be invoiced.\n- Custom: Depending on the recurrence to be define.' selection=[('with_previous_line', 'With previous line'), ('with_next_line', 'With next line'), ('custom', 'Custom')]
• partner_id Many2one → res.partner
  comodel_name='res.partner' related='contract_id.partner_id'
• price_subtotal Monetary
  compute='_compute_price_subtotal' string='Sub Total'
• price_unit Float
  compute='_compute_price_unit' inverse='_inverse_price_unit' string='Unit Price'
• product_id Many2one → product.product
  string='Product' args: 'product.product'
• product_uom_category_id Many2one → uom.category
  comodel_name='uom.category' related='product_id.uom_id.category_id'
• quantity Float
  default=1.0 required=True
• recurring_interval Integer
  compute='_compute_recurring_interval' copy=True readonly=False required=True store=True
• recurring_invoicing_type Selection
  compute='_compute_recurring_invoicing_type' copy=True readonly=False required=True store=True
• recurring_rule_type Selection
  compute='_compute_recurring_rule_type' copy=True readonly=False required=True store=True
• sequence Integer
  default=10 help='Sequence of the contract line when displaying contracts'
• specific_price Float
• termination_notice_interval Integer
  default=1 string='Termination Notice Before'
• termination_notice_rule_type Selection
  default='monthly' string='Termination Notice type' args: [('daily', 'Day(s)'), ('weekly', 'Week(s)'), ('monthly', 'Month(s)')]
• uom_id Many2one → uom.uom
  comodel_name='uom.uom' domain="[('category_id', '=', product_uom_category_id)]" string='Unit of Measure'

No public methods.

• active Boolean
  default=True
• code Char
  string='Reference'
• commercial_partner_id Many2one → res.partner
  compute_sudo=True index=True related='partner_id.commercial_partner_id' store=True string='Commercial Entity' args: 'res.partner'
• contract_line_fixed_ids One2many → contract.line
  comodel_name='contract.line' context={'active_test': False} inverse_name='contract_id' string='Contract lines (fixed)'
• contract_line_ids One2many → contract.line
  comodel_name='contract.line' context={'active_test': False} copy=True inverse_name='contract_id' string='Contract lines'
• contract_template_id Many2one → contract.template
  comodel_name='contract.template' string='Contract Template'
• create_invoice_visibility Boolean
  compute='_compute_create_invoice_visibility'
• currency_id Many2one → res.currency
  comodel_name='res.currency' compute='_compute_currency_id' inverse='_inverse_currency_id' string='Currency'
• date_end Date
  compute='_compute_date_end' readonly=False store=True
• fiscal_position_id Many2one → account.fiscal.position
  comodel_name='account.fiscal.position' ondelete='restrict' string='Fiscal Position'
• group_id Many2one → account.analytic.account
  comodel_name='account.analytic.account' compute='_compute_group_id' ondelete='restrict' readonly=False store=True string='Group'
• invoice_count Integer
  compute='_compute_invoice_count'
• invoice_partner_id Many2one → res.partner
  comodel_name='res.partner' domain="['|',('id', 'parent_of', partner_id), ('id', 'child_of', partner_id)]" ondelete='restrict' string='Invoicing contact'
• is_terminated Boolean
  copy=False readonly=True string='Terminated'
• manual_currency_id Many2one → res.currency
  comodel_name='res.currency' readonly=True
• modification_ids One2many → contract.modification
  comodel_name='contract.modification' inverse_name='contract_id' string='Modifications'
• note Text
  string='Notes'
• partner_id Many2one → res.partner
  comodel_name='res.partner' inverse='_inverse_partner_id' required=True
• payment_term_id Many2one → account.payment.term
  comodel_name='account.payment.term' index=True string='Payment Terms'
• tag_ids Many2many → contract.tag
  comodel_name='contract.tag' string='Tags'
• terminate_comment Text
  copy=False readonly=True string='Termination Comment' tracking=True
• terminate_date Date
  copy=False readonly=True string='Termination Date' tracking=True
• terminate_reason_id Many2one → contract.terminate.reason
  comodel_name='contract.terminate.reason' copy=False ondelete='restrict' readonly=True string='Termination Reason' tracking=True
• user_id Many2one → res.users
  comodel_name='res.users' default=<expr> index=True string='Responsible'

• action_cancel_contract_termination(self)
• action_contract_send(self)
• action_preview(self)
  Invoked when 'Preview' button in contract form view is clicked.
• action_show_invoices(self)
• action_terminate_contract(self)
• create(self, vals_list)
  @api.model_create_multi
• cron_recurring_create_invoice(self, date_ref=None)
  @api.model
• get_formview_id(self, access_uid=None)
• recurring_create_invoice(self)
  This method triggers the creation of the next invoices of the contracts even if their next invoicing date is in the future.
• write(self, vals)

• contract_id Many2one → contract.contract
  comodel_name='contract.contract' ondelete='cascade' required=True string='Contract'
• terminate_comment Text
  string='Termination Comment'
• terminate_comment_required Boolean
  related='terminate_reason_id.terminate_comment_required'
• terminate_date Date
  required=True string='Termination Date'
• terminate_reason_id Many2one → contract.terminate.reason
  comodel_name='contract.terminate.reason' ondelete='cascade' required=True string='Termination Reason'
• terminate_with_last_date_invoiced Boolean
  help='Terminate the contract lines with the last invoiced date if they cannot be terminated with the date reported in the wizard.' string='Terminate lines with last date invoiced'

• terminate_contract(self)

• active Boolean
  readonly=True related='contract_id.active' store=True string='Active'
• contract_id Many2one → contract.contract
  auto_join=True comodel_name='contract.contract' index=True ondelete='cascade' required=True string='Contract'
• create_invoice_visibility Boolean
  compute='_compute_create_invoice_visibility'
• currency_id Many2one
  related='contract_id.currency_id'
• date_end Date
  compute='_compute_date_end' readonly=False store=True
• date_start Date
  required=True
• is_cancel_allowed Boolean
  compute='_compute_allowed' string='Cancel allowed?'
• is_plan_successor_allowed Boolean
  compute='_compute_allowed' string='Plan successor allowed?'
• is_stop_allowed Boolean
  compute='_compute_allowed' string='Stop allowed?'
• is_stop_plan_successor_allowed Boolean
  compute='_compute_allowed' string='Stop/Plan successor allowed?'
• is_un_cancel_allowed Boolean
  compute='_compute_allowed' string='Un-Cancel allowed?'
• manual_renew_needed Boolean
  default=False help='This flag is used to make a difference between a definitive stopand temporary one for which a user is not able to plan asuccessor in advance'
• partner_id Many2one
  store=True
• predecessor_contract_line_id Many2one → contract.line
  comodel_name='contract.line' copy=False help='Contract Line origin of this one.' index=True readonly=True required=False string='Predecessor Contract Line'
• sequence Integer
• state Selection
  compute='_compute_state' search='_search_state' selection=[('upcoming', 'Upcoming'), ('in-progress', 'In-progress'), ('to-renew', 'To renew'), ('upcoming-close', 'Upcoming Close'), ('closed', 'Closed'), ('canceled', 'Canceled')]
• successor_contract_line_id Many2one → contract.line
  comodel_name='contract.line' copy=False help='In case of restart after suspension, this field contain the new contract line created.' index=True readonly=True required=False string='Successor Contract Line'
• termination_notice_date Date
  compute='_compute_termination_notice_date' copy=False store=True

• action_plan_successor(self)
• action_stop(self)
• action_stop_plan_successor(self)
• action_uncancel(self)
• cancel(self)
• cron_renew_contract_line(self)
  @api.model
• get_view(self, view_id=None, view_type='form', **options)
  @api.model
• plan_successor(self, date_start, date_end, is_auto_renew, recurring_next_date=False, post_message=True)
  Create a copy of a contract line in a new interval :param date_start: date_start for the successor_contract_line :param date_end: date_end for the successor_contract_line :param is_auto_renew: is_auto_renew option for successor_contract_line :param recurring_next_date: recurring_next_date for the successor_contract_line :return: successor_contract_line
• renew(self)
• stop(self, date_end, manual_renew_needed=False, post_message=True)
  Put date_end on contract line We don't consider contract lines that end's before the new end date :param date_end: new date end for contract line :return: True
• stop_plan_successor(self, date_start, date_end, is_auto_renew)
  Stop a contract line for a defined period and start it later Cases to consider: * contract line end's before the suspension period: -> apply stop * contract line start before the suspension period and end in it -> apply stop at suspension start date -> apply plan successor: - date_start: suspension.date_end - date_end: date_end + (contract_line.date_end - suspension.date_start) * contract line start before the suspension period and end after it -> apply stop at suspension start date -> apply plan successor: - date_start: suspension.date_end - date_end: date_end + (suspension.date_end - suspension.date_start) * contract line start and end's in the suspension period -> apply delay - delay: suspension.date_end - contract_line.date_start * contract line start in the suspension period and end after it -> apply delay - delay: suspension.date_end - contract_line.date_start * contract line start and end after the suspension period -> apply delay - delay: suspension.date_end - suspension.start_date :param date_start: suspension start date :param date_end: suspension end date :param is_auto_renew: is the new line is set to auto_renew :return: created contract line
• uncancel(self, recurring_next_date)
• unlink(self)
  stop unlink uncnacled lines

• contract_line_id Many2one → contract.line
  comodel_name='contract.line' index=True ondelete='cascade' required=True string='Contract Line'
• date_end Date
• date_start Date
• is_auto_renew Boolean
  default=False
• manual_renew_needed Boolean
  default=False help='This flag is used to make a difference between a definitive stopand temporary one for which a user is not able to plan asuccessor in advance'
• recurring_next_date Date
  string='Next Invoice Date'

• plan_successor(self)
• stop(self)
• stop_plan_successor(self)
• uncancel(self)

• contract_to_invoice_count Integer
  compute='_compute_contract_to_invoice_ids'
• contract_to_invoice_ids Many2many → contract.contract
  comodel_name='contract.contract' compute='_compute_contract_to_invoice_ids'
• contract_type Selection
  default='sale' required=True selection=[('sale', 'Customer'), ('purchase', 'Supplier')]
• invoice_date Date
  required=True

• action_show_contract_to_invoice(self)
• create_invoice(self)

• contract_id Many2one → contract.contract
  comodel_name='contract.contract' index=True ondelete='cascade' required=True string='Contract'
• date Date
  required=True
• description Text
  required=True
• sent Boolean

• check_modification_ids_need_sent(self)
• create(self, vals_list)
  @api.model_create_multi
• write(self, vals)

• date_start Date
• recurring_interval Integer
  default=1 help='Invoice every (Days/Week/Month/Year)' string='Invoice Every'
• recurring_invoicing_offset Integer
  compute='_compute_recurring_invoicing_offset' help='Number of days to offset the invoice from the period end date (in post-paid mode) or start date (in pre-paid mode).' string='Invoicing offset'
• recurring_invoicing_type Selection
  default='pre-paid' help='Specify if the invoice must be generated at the beginning (pre-paid) or end (post-paid) of the period.' string='Invoicing type' args: [('pre-paid', 'Pre-paid'), ('post-paid', 'Post-paid')]
• recurring_next_date Date
  string='Date of Next Invoice'
• recurring_rule_type Selection
  default='monthly' help='Specify Interval for automatic invoice generation.' string='Recurrence' args: [('daily', 'Day(s)'), ('weekly', 'Week(s)'), ('monthly', 'Month(s)'), ('monthlylastday', 'Month(s) last day'), ('quarterly', 'Quarter(s)'), ('semesterly', 'Semester(s)'), ('yearly', 'Year(s)')]

No public methods.

• date_end Date
  index=True
• date_start Date
  default=<expr>
• last_date_invoiced Date
  copy=False readonly=True
• next_period_date_end Date
  compute='_compute_next_period_date_end' string='Next Period End'
• next_period_date_start Date
  compute='_compute_next_period_date_start' string='Next Period Start'
• recurring_next_date Date
  compute='_compute_recurring_next_date' copy=True readonly=False store=True

• get_next_invoice_date(self, next_period_date_start, recurring_invoicing_type, recurring_invoicing_offset, recurring_rule_type, recurring_interval, max_date_end)
  @api.model
• get_next_period_date_end(self, next_period_date_start, recurring_rule_type, recurring_interval, max_date_end, next_invoice_date=False, recurring_invoicing_type=False, recurring_invoicing_offset=False)
  @api.model
  Compute the end date for the next period. The next period normally depends on recurrence options only. It is however possible to provide it a next invoice date, in which case this method can adjust the next period based on that too. In that scenario it required the invoicing type and offset arguments.
• get_relative_delta(self, recurring_rule_type, interval)
  @api.model
  Return a relativedelta for one period. When added to the first day of the period, it gives the first day of the next period.

• color Integer
  default=0 args: 'Color Index'
• company_id Many2one → res.company
  default=<expr> string='Company' args: 'res.company'
• name Char
  required=True

No public methods.

• contract_line_ids One2many → contract.template.line
  comodel_name='contract.template.line' copy=True inverse_name='contract_id' string='Contract template lines'

No public methods.

• contract_id Many2one → contract.template
  comodel_name='contract.template' ondelete='cascade' required=True string='Contract'

No public methods.

• name Char
  required=True
• terminate_comment_required Boolean
  default=True string='Require a termination comment'

No public methods.

• create_new_line_at_contract_line_renew Boolean
  help='If checked, a new line will be generated at contract line renew and linked to the original one as successor. The default behavior is to extend the end date of the contract by a new subscription period'

No public methods.

• create_new_line_at_contract_line_renew Boolean
  help='If checked, a new line will be generated at contract line renew and linked to the original one as successor. The default behavior is to extend the end date of the contract by a new subscription period' readonly=False related='company_id.create_new_line_at_contract_line_renew' string='Create New Line At Contract Line Renew'

No public methods.

• contract_ids One2many → contract.contract
  comodel_name='contract.contract' inverse_name='partner_id' string='Contracts'
• purchase_contract_count Integer
  compute='_compute_contract_count' string='Purchase Contracts'
• sale_contract_count Integer
  compute='_compute_contract_count' string='Sale Contracts'

• act_show_contract(self)
  This opens contract view @return: the contract view

• old_contract_id Many2one → contract.contract
  args: 'contract.contract'

No public methods.

• contract_line_id Many2one → contract.line
  index=True string='Contract Line' args: 'contract.line'

No public methods.

• company_id Many2one → res.company
  default=<expr> required=True string='Company' args: 'res.company'
• contract_type Selection
  default='sale' index=True selection=[('sale', 'Customer'), ('purchase', 'Supplier')]
• generation_type Selection
  default=<expr> help='Choose the document that will be automatically generated by cron.' selection=[('invoice', 'Invoice')]
• journal_id Many2one → account.journal
  check_company=True comodel_name='account.journal' compute='_compute_journal_id' domain="[('type', '=', contract_type)]" index=True readonly=False store=True string='Journal'
• line_recurrence Boolean
  help='Mark this check if you want to control recurrrence at line level instead of all together for the whole contract.' string='Recurrence at line level?'
• name Char
  required=True
• partner_id Many2one → res.partner
  comodel_name='res.partner' index=True string='Partner'
• pricelist_id Many2one → product.pricelist
  comodel_name='product.pricelist' string='Pricelist'

No public methods.

• auto_renew_interval Integer
  default=1 help='Renew every (Days/Week/Month/Year)' string='Renew Every'
• auto_renew_rule_type Selection
  default='yearly' help='Specify Interval for automatic renewal.' string='Renewal type' args: [('daily', 'Day(s)'), ('weekly', 'Week(s)'), ('monthly', 'Month(s)'), ('yearly', 'Year(s)')]
• automatic_price Boolean
  help='If this is marked, the price will be obtained automatically applying the pricelist to the product. If not, you will be able to introduce a manual price' string='Auto-price?'
• company_id Many2one
  related='contract_id.company_id' store=True
• contract_id Many2one → contract.abstract.contract
  comodel_name='contract.abstract.contract' ondelete='cascade' required=True string='Contract'
• currency_id Many2one → res.currency
  args: 'res.currency'
• date_start Date
  compute='_compute_date_start' copy=True readonly=False store=True
• discount Float
  digits='Discount' help='Discount that is applied in generated invoices. It should be less or equal to 100' string='Discount (%)'
• display_type Selection
  default=False help='Technical field for UX purpose.' selection=[('line_section', 'Section'), ('line_note', 'Note')]
• is_auto_renew Boolean
  default=False string='Auto Renew'
• is_canceled Boolean
  default=False string='Canceled'
• is_recurring_note Boolean
  compute='_compute_is_recurring_note'
• last_date_invoiced Date
• name Text
  required=True string='Description'
• note_invoicing_mode Selection
  default='with_previous_line' help='Defines when the Note is invoiced:\n- With previous line: If the previous line can be invoiced.\n- With next line: If the next line can be invoiced.\n- Custom: Depending on the recurrence to be define.' selection=[('with_previous_line', 'With previous line'), ('with_next_line', 'With next line'), ('custom', 'Custom')]
• partner_id Many2one → res.partner
  comodel_name='res.partner' related='contract_id.partner_id'
• price_subtotal Monetary
  compute='_compute_price_subtotal' string='Sub Total'
• price_unit Monetary
  compute='_compute_price_unit' inverse='_inverse_price_unit' string='Unit Price'
• product_id Many2one → product.product
  string='Product' args: 'product.product'
• product_uom_category_id Many2one → uom.category
  comodel_name='uom.category' related='product_id.uom_id.category_id'
• quantity Float
  default=1.0 required=True
• recurring_interval Integer
  compute='_compute_recurring_interval' copy=True readonly=False required=True store=True
• recurring_invoicing_type Selection
  compute='_compute_recurring_invoicing_type' copy=True readonly=False required=True store=True
• recurring_rule_type Selection
  compute='_compute_recurring_rule_type' copy=True readonly=False required=True store=True
• sequence Integer
  default=10 help='Sequence of the contract line when displaying contracts'
• specific_price Monetary
• termination_notice_interval Integer
  default=1 string='Termination Notice Before'
• termination_notice_rule_type Selection
  default='monthly' string='Termination Notice type' args: [('daily', 'Day(s)'), ('weekly', 'Week(s)'), ('monthly', 'Month(s)')]
• uom_id Many2one → uom.uom
  comodel_name='uom.uom' domain="[('category_id', '=', product_uom_category_id)]" string='Unit of Measure'

No public methods.

• active Boolean
  default=True
• code Char
  string='Reference'
• commercial_partner_id Many2one → res.partner
  compute_sudo=True index=True related='partner_id.commercial_partner_id' store=True string='Commercial Entity' args: 'res.partner'
• contract_line_fixed_ids One2many → contract.line
  comodel_name='contract.line' context={'active_test': False} inverse_name='contract_id' string='Contract lines (fixed)'
• contract_line_ids One2many → contract.line
  comodel_name='contract.line' context={'active_test': False} copy=True inverse_name='contract_id' string='Contract lines'
• contract_template_id Many2one → contract.template
  comodel_name='contract.template' string='Contract Template'
• create_invoice_visibility Boolean
  compute='_compute_create_invoice_visibility'
• currency_id Many2one → res.currency
  comodel_name='res.currency' compute='_compute_currency_id' inverse='_inverse_currency_id' string='Currency'
• date_end Date
  compute='_compute_date_end' readonly=False store=True
• fiscal_position_id Many2one → account.fiscal.position
  comodel_name='account.fiscal.position' ondelete='restrict' string='Fiscal Position'
• group_id Many2one → account.analytic.account
  comodel_name='account.analytic.account' ondelete='restrict' string='Group'
• invoice_count Integer
  compute='_compute_invoice_count'
• invoice_partner_id Many2one → res.partner
  comodel_name='res.partner' domain="['|',('id', 'parent_of', partner_id), ('id', 'child_of', partner_id)]" ondelete='restrict' string='Invoicing contact'
• is_terminated Boolean
  copy=False readonly=True string='Terminated'
• manual_currency_id Many2one → res.currency
  comodel_name='res.currency' readonly=True
• modification_ids One2many → contract.modification
  comodel_name='contract.modification' inverse_name='contract_id' string='Modifications'
• note Text
  string='Notes'
• partner_id Many2one → res.partner
  comodel_name='res.partner' inverse='_inverse_partner_id' required=True
• payment_term_id Many2one → account.payment.term
  comodel_name='account.payment.term' index=True string='Payment Terms'
• tag_ids Many2many → contract.tag
  comodel_name='contract.tag' string='Tags'
• terminate_comment Text
  copy=False readonly=True string='Termination Comment' tracking=True
• terminate_date Date
  copy=False readonly=True string='Termination Date' tracking=True
• terminate_reason_id Many2one → contract.terminate.reason
  comodel_name='contract.terminate.reason' copy=False ondelete='restrict' readonly=True string='Termination Reason' tracking=True
• user_id Many2one → res.users
  comodel_name='res.users' default=<expr> index=True string='Responsible'

• action_cancel_contract_termination(self)
• action_contract_send(self)
• action_preview(self)
  Invoked when 'Preview' button in contract form view is clicked.
• action_show_invoices(self)
• action_terminate_contract(self)
• create(self, vals_list)
  @api.model_create_multi
• cron_recurring_create_invoice(self, date_ref=None)
  @api.model
• get_formview_id(self, access_uid=None)
• recurring_create_invoice(self)
  This method triggers the creation of the next invoices of the contracts even if their next invoicing date is in the future.
• write(self, vals)

• contract_id Many2one → contract.contract
  comodel_name='contract.contract' ondelete='cascade' required=True string='Contract'
• terminate_comment Text
  string='Termination Comment'
• terminate_comment_required Boolean
  related='terminate_reason_id.terminate_comment_required'
• terminate_date Date
  required=True string='Termination Date'
• terminate_reason_id Many2one → contract.terminate.reason
  comodel_name='contract.terminate.reason' ondelete='cascade' required=True string='Termination Reason'

• terminate_contract(self)

• active Boolean
  readonly=True related='contract_id.active' store=True string='Active'
• company_id Many2one
  related='contract_id.company_id'
• contract_id Many2one → contract.contract
  auto_join=True comodel_name='contract.contract' index=True ondelete='cascade' required=True string='Contract'
• create_invoice_visibility Boolean
  compute='_compute_create_invoice_visibility'
• currency_id Many2one
  related='contract_id.currency_id'
• date_end Date
  compute='_compute_date_end' readonly=False store=True
• date_start Date
  required=True
• is_cancel_allowed Boolean
  compute='_compute_allowed' string='Cancel allowed?'
• is_plan_successor_allowed Boolean
  compute='_compute_allowed' string='Plan successor allowed?'
• is_stop_allowed Boolean
  compute='_compute_allowed' string='Stop allowed?'
• is_stop_plan_successor_allowed Boolean
  compute='_compute_allowed' string='Stop/Plan successor allowed?'
• is_un_cancel_allowed Boolean
  compute='_compute_allowed' string='Un-Cancel allowed?'
• manual_renew_needed Boolean
  default=False help='This flag is used to make a difference between a definitive stopand temporary one for which a user is not able to plan asuccessor in advance'
• monthly_recurring Monetary
  compute='_compute_monthly_recurring' currency_field='currency_id' store=True
• predecessor_contract_line_id Many2one → contract.line
  comodel_name='contract.line' copy=False help='Contract Line origin of this one.' index=True readonly=True required=False string='Predecessor Contract Line'
• sequence Integer
• state Selection
  compute='_compute_state' search='_search_state' selection=[('upcoming', 'Upcoming'), ('in-progress', 'In-progress'), ('to-renew', 'To renew'), ('upcoming-close', 'Upcoming Close'), ('closed', 'Closed'), ('canceled', 'Canceled')]
• successor_contract_line_id Many2one → contract.line
  comodel_name='contract.line' copy=False help='In case of restart after suspension, this field contain the new contract line created.' index=True readonly=True required=False string='Successor Contract Line'
• termination_notice_date Date
  compute='_compute_termination_notice_date' copy=False store=True

• action_plan_successor(self)
• action_stop(self)
• action_stop_plan_successor(self)
• action_uncancel(self)
• cancel(self)
• cron_renew_contract_line(self)
  @api.model
• get_view(self, view_id=None, view_type='form', **options)
  @api.model
• plan_successor(self, date_start, date_end, is_auto_renew, recurring_next_date=False, post_message=True)
  Create a copy of a contract line in a new interval :param date_start: date_start for the successor_contract_line :param date_end: date_end for the successor_contract_line :param is_auto_renew: is_auto_renew option for successor_contract_line :param recurring_next_date: recurring_next_date for the successor_contract_line :return: successor_contract_line
• renew(self)
• stop(self, date_end, manual_renew_needed=False, post_message=True)
  Put date_end on contract line We don't consider contract lines that end's before the new end date :param date_end: new date end for contract line :return: True
• stop_plan_successor(self, date_start, date_end, is_auto_renew)
  Stop a contract line for a defined period and start it later Cases to consider: * contract line end's before the suspension period: -> apply stop * contract line start before the suspension period and end in it -> apply stop at suspension start date -> apply plan successor: - date_start: suspension.date_end - date_end: date_end + (contract_line.date_end - suspension.date_start) * contract line start before the suspension period and end after it -> apply stop at suspension start date -> apply plan successor: - date_start: suspension.date_end - date_end: date_end + (suspension.date_end - suspension.date_start) * contract line start and end's in the suspension period -> apply delay - delay: suspension.date_end - contract_line.date_start * contract line start in the suspension period and end after it -> apply delay - delay: suspension.date_end - contract_line.date_start * contract line start and end after the suspension period -> apply delay - delay: suspension.date_end - suspension.start_date :param date_start: suspension start date :param date_end: suspension end date :param is_auto_renew: is the new line is set to auto_renew :return: created contract line
• uncancel(self, recurring_next_date)
• unlink(self)
  stop unlink uncnacled lines

• contract_line_id Many2one → contract.line
  comodel_name='contract.line' index=True ondelete='cascade' required=True string='Contract Line'
• date_end Date
• date_start Date
• is_auto_renew Boolean
  default=False
• manual_renew_needed Boolean
  default=False help='This flag is used to make a difference between a definitive stopand temporary one for which a user is not able to plan asuccessor in advance'
• recurring_next_date Date
  string='Next Invoice Date'

• plan_successor(self)
• stop(self)
• stop_plan_successor(self)
• uncancel(self)

• contract_to_invoice_count Integer
  compute='_compute_contract_to_invoice_ids'
• contract_to_invoice_ids Many2many → contract.contract
  comodel_name='contract.contract' compute='_compute_contract_to_invoice_ids'
• contract_type Selection
  default='sale' required=True selection=[('sale', 'Customer'), ('purchase', 'Supplier')]
• invoice_date Date
  required=True

• action_show_contract_to_invoice(self)
• create_invoice(self)

• contract_id Many2one → contract.contract
  comodel_name='contract.contract' index=True ondelete='cascade' required=True string='Contract'
• date Date
  required=True
• description Text
  required=True
• sent Boolean

• check_modification_ids_need_sent(self)
• create(self, vals_list)
  @api.model_create_multi
• write(self, vals)

• date_start Date
• recurring_interval Integer
  default=1 help='Invoice every (Days/Week/Month/Year)' string='Invoice Every'
• recurring_invoicing_offset Integer
  compute='_compute_recurring_invoicing_offset' help='Number of days to offset the invoice from the period end date (in post-paid mode) or start date (in pre-paid mode).' string='Invoicing offset'
• recurring_invoicing_type Selection
  default='pre-paid' help='Specify if the invoice must be generated at the beginning (pre-paid) or end (post-paid) of the period.' string='Invoicing type' args: [('pre-paid', 'Pre-paid'), ('post-paid', 'Post-paid')]
• recurring_next_date Date
  string='Date of Next Invoice'
• recurring_rule_type Selection
  default='monthly' help='Specify Interval for automatic invoice generation.' string='Recurrence' args: [('daily', 'Day(s)'), ('weekly', 'Week(s)'), ('monthly', 'Month(s)'), ('monthlylastday', 'Month(s) last day'), ('quarterly', 'Quarter(s)'), ('semesterly', 'Semester(s)'), ('yearly', 'Year(s)')]

No public methods.

• date_end Date
  index=True
• date_start Date
  default=<expr>
• last_date_invoiced Date
  copy=False readonly=True
• next_period_date_end Date
  compute='_compute_next_period_date_end' string='Next Period End'
• next_period_date_start Date
  compute='_compute_next_period_date_start' string='Next Period Start'
• recurring_next_date Date
  compute='_compute_recurring_next_date' copy=True readonly=False store=True

• get_next_invoice_date(self, next_period_date_start, recurring_invoicing_type, recurring_invoicing_offset, recurring_rule_type, recurring_interval, max_date_end)
  @api.model
• get_next_period_date_end(self, next_period_date_start, recurring_rule_type, recurring_interval, max_date_end, next_invoice_date=False, recurring_invoicing_type=False, recurring_invoicing_offset=False)
  @api.model
  Compute the end date for the next period. The next period normally depends on recurrence options only. It is however possible to provide it a next invoice date, in which case this method can adjust the next period based on that too. In that scenario it required the invoicing type and offset arguments.
• get_relative_delta(self, recurring_rule_type, interval)
  @api.model
  Return a relativedelta for one period. When added to the first day of the period, it gives the first day of the next period.

• color Integer
  default=0 args: 'Color Index'
• company_id Many2one → res.company
  default=<expr> string='Company' args: 'res.company'
• name Char
  required=True

No public methods.

• contract_line_ids One2many → contract.template.line
  comodel_name='contract.template.line' copy=True inverse_name='contract_id' string='Contract template lines'

No public methods.

• contract_id Many2one → contract.template
  comodel_name='contract.template' ondelete='cascade' required=True string='Contract'

No public methods.

• name Char
  required=True
• terminate_comment_required Boolean
  default=True string='Require a termination comment'

No public methods.

• create_new_line_at_contract_line_renew Boolean
  help='If checked, a new line will be generated at contract line renew and linked to the original one as successor. The default behavior is to extend the end date of the contract by a new subscription period'

No public methods.

• create_new_line_at_contract_line_renew Boolean
  help='If checked, a new line will be generated at contract line renew and linked to the original one as successor. The default behavior is to extend the end date of the contract by a new subscription period' readonly=False related='company_id.create_new_line_at_contract_line_renew' string='Create New Line At Contract Line Renew'

No public methods.

• contract_ids One2many → contract.contract
  comodel_name='contract.contract' inverse_name='partner_id' string='Contracts'
• purchase_contract_count Integer
  compute='_compute_contract_count' string='Purchase Contracts'
• sale_contract_count Integer
  compute='_compute_contract_count' string='Sale Contracts'

• act_show_contract(self)
  This opens contract view @return: the contract view

• old_contract_id Many2one → contract.contract
  args: 'contract.contract'

No public methods.

• contract_line_id Many2one → contract.line
  index=True string='Contract Line' args: 'contract.line'

No public methods.

• company_id Many2one → res.company
  default=<expr> required=True string='Company' args: 'res.company'
• contract_type Selection
  default='sale' index=True selection=[('sale', 'Customer'), ('purchase', 'Supplier')]
• generation_type Selection
  default=<expr> help='Choose the document that will be automatically generated by cron.' selection=<expr>
• journal_id Many2one → account.journal
  comodel_name='account.journal' compute='_compute_journal_id' domain="[('type', '=', contract_type),('company_id', '=', company_id)]" index=True readonly=False store=True string='Journal'
• line_recurrence Boolean
  help='Mark this check if you want to control recurrrence at line level instead of all together for the whole contract.' string='Recurrence at line level?'
• name Char
  required=True
• partner_id Many2one → res.partner
  comodel_name='res.partner' index=True string='Partner'
• pricelist_id Many2one → product.pricelist
  comodel_name='product.pricelist' string='Pricelist'

No public methods.

• auto_renew_interval Integer
  default=1 help='Renew every (Days/Week/Month/Year)' string='Renew Every'
• auto_renew_rule_type Selection
  default='yearly' help='Specify Interval for automatic renewal.' string='Renewal type' args: [('daily', 'Day(s)'), ('weekly', 'Week(s)'), ('monthly', 'Month(s)'), ('yearly', 'Year(s)')]
• automatic_price Boolean
  help='If this is marked, the price will be obtained automatically applying the pricelist to the product. If not, you will be able to introduce a manual price' string='Auto-price?'
• company_id Many2one
  related='contract_id.company_id' store=True
• contract_id Many2one → contract.abstract.contract
  comodel_name='contract.abstract.contract' ondelete='cascade' required=True string='Contract'
• date_start Date
  compute='_compute_date_start' copy=True readonly=False store=True
• discount Float
  digits='Discount' help='Discount that is applied in generated invoices. It should be less or equal to 100' string='Discount (%)'
• display_type Selection
  default=False help='Technical field for UX purpose.' selection=[('line_section', 'Section'), ('line_note', 'Note')]
• is_auto_renew Boolean
  default=False string='Auto Renew'
• is_canceled Boolean
  default=False string='Canceled'
• is_recurring_note Boolean
  compute='_compute_is_recurring_note'
• last_date_invoiced Date
• name Text
  required=True string='Description'
• note_invoicing_mode Selection
  default='with_previous_line' help='Defines when the Note is invoiced:\n- With previous line: If the previous line can be invoiced.\n- With next line: If the next line can be invoiced.\n- Custom: Depending on the recurrence to be define.' selection=[('with_previous_line', 'With previous line'), ('with_next_line', 'With next line'), ('custom', 'Custom')]
• partner_id Many2one → res.partner
  comodel_name='res.partner' related='contract_id.partner_id'
• price_subtotal Float
  compute='_compute_price_subtotal' digits='Account' string='Sub Total'
• price_unit Float
  compute='_compute_price_unit' inverse='_inverse_price_unit' string='Unit Price'
• product_id Many2one → product.product
  string='Product' args: 'product.product'
• product_uom_category_id Many2one → uom.category
  comodel_name='uom.category' related='product_id.uom_id.category_id'
• quantity Float
  default=1.0 required=True
• recurring_interval Integer
  compute='_compute_recurring_interval' copy=True readonly=False required=True store=True
• recurring_invoicing_type Selection
  compute='_compute_recurring_invoicing_type' copy=True readonly=False required=True store=True
• recurring_rule_type Selection
  compute='_compute_recurring_rule_type' copy=True readonly=False required=True store=True
• sequence Integer
  default=10 help='Sequence of the contract line when displaying contracts'
• specific_price Float
• termination_notice_interval Integer
  default=1 string='Termination Notice Before'
• termination_notice_rule_type Selection
  default='monthly' string='Termination Notice type' args: [('daily', 'Day(s)'), ('weekly', 'Week(s)'), ('monthly', 'Month(s)')]
• uom_id Many2one → uom.uom
  comodel_name='uom.uom' domain="[('category_id', '=', product_uom_category_id)]" string='Unit of Measure'

No public methods.