Framework Agreement

• available_quantity Integer
  compute='_get_available_qty' default=0 readonly=True store=True string='Available quantity'
• clauses Html
  args: 'Clauses'
• company_id Many2one → res.company
  readonly=True related='portfolio_id.company_id' args: 'res.company', 'Company'
• delay Integer
  args: 'Lead time in days'
• delivery_remark Text
  args: 'Delivery Remarks'
• draft Boolean
  args: 'Is draft'
• end_date Date
  args: 'End of Agreement'
• framework_agreement_pricelist_ids One2many → framework.agreement.pricelist
  args: 'framework.agreement.pricelist', 'framework_agreement_id', 'Price lists'
• incoterm_address Char
  args: 'Incoterm Address'
• incoterm_id Many2one → stock.incoterms
  help='International Commercial Terms are a series of predefined commercial terms used in international transactions.' args: 'stock.incoterms', 'Incoterm'
• name Char
  readonly=True args: 'Number'
• origin Char
  args: 'Origin'
• payment_term_id Many2one → account.payment.term
  args: 'account.payment.term', 'Payment Term'
• portfolio_id Many2one → framework.agreement.portfolio
  required=True args: 'framework.agreement.portfolio', 'Portfolio'
• product_id Many2one → product.product
  required=True args: 'product.product', 'Product'
• purchase_line_ids One2many → purchase.order.line
  comodel_name='purchase.order.line' inverse_name='framework_agreement_id'
• quantity Integer
  required=True args: 'Negociated quantity'
• shipment_origin_id Many2one → res.partner
  args: 'res.partner', 'Shipment Origin'
• start_date Date
  args: 'Begin of Agreement'
• state Selection
  compute='_get_state' search='_search_state' selection=[('draft', 'Draft'), ('future', 'Future'), ('running', 'Running'), ('consumed', 'Consumed'), ('closed', 'Closed')] string='State'
• supplier_id Many2one → res.partner
  readonly=True related='portfolio_id.supplier_id' args: 'res.partner', 'Supplier'

• check_overlap(self)
  @api.one@api.constrains('supplier_id', 'product_id', 'start_date', 'end_date', 'company_id', 'incoterm_id', 'incoterm_address')
  Check that there are no similar agreements at the same time. Depending on the one_agreement_per_product flag on the company, agreements from different companies are tolerated or not.
• create(self, vals)
  @api.model@api.returns('self', <expr>)
  We want to have increment sequence only at creation When set by a default in a o2m form default consume sequence. But we do not want to use no_gap sequence
• get_agreement_domain(self, product_id, qty, portfolio_id=None, date_planned=None, incoterm_id=None, incoterm_address=None)
  @api.model
• get_all_product_agreements(self, product_id, lookup_dt, qty=None)
  @api.model
  Get the all the active agreement of a given product at a given date :param product_id: product id of the product :param lookup_dt: date string of the lookup date :param qty: quantity that should be available if parameter is passed and qty is insuffisant no agreement would be returned :returns: a list of corresponding agreements or None
• get_cheapest_agreement_for_qty(self, product_id, date, qty, currency=None)
  @api.model
  Return the cheapest agreement that has enough available qty. If not enough quantity fallback on the cheapest agreement available for quantity. :param product_id: id of the product :param date: lookup date :param qty: lookup qty :param currency: currency record to make price convertion :return: cheapest agreement and qty state :rtype: namedtuple('Cheapest', ['cheapest_agreement', 'enough'])
• get_price(self, qty=0, currency=None)
  @api.multi
  Return price negociated for quantity :param currency: currency record :param qty: qty to lookup :returns: price float
• get_product_agreement(self, product_id, supplier_id, lookup_dt, qty=None)
  @api.model
  Get the matching agreement for a given product/supplier at date :param product_id: id of the product :param supplier_id: supplier to look for agreement :param lookup_dt: date string of the lookup date :param qty: quantity that should be available if parameter is passed and qty is insuffisant no aggrement would be returned :returns: a corresponding agreement or None
• has_currency(self, currency)
  @api.multi
  Predicate that check that agreement has a given currency pricelist :returns: boolean (True if a price list in given currency is present)
• open_agreement(self, strict=True)
  @api.multi
  Open agreement Agreement goes from state draft to X

• framework_agreement_pricelist_id Many2one → framework.agreement.pricelist
  required=True args: 'framework.agreement.pricelist', 'Price list'
• price Float
  digits=dp.get_precision('Product Price') required=True string='Negociated price'
• quantity Integer
  required=True args: 'Quantity'

No public methods.

• agreement_ids One2many → framework.agreement
  args: 'framework.agreement', 'portfolio_id', 'Agreements'
• company_id Many2one → res.company
  default=_company_get args: 'res.company', 'Company'
• name Char
  required=True args: 'Name'
• supplier_id Many2one → res.partner
  required=True args: 'res.partner', 'Supplier'

• get_from_supplier(self, supplier)
  @api.returns('self')@api.model

• currency_id Many2one → res.currency
  required=True args: 'res.currency', 'Currency'
• framework_agreement_id Many2one → framework.agreement
  required=True args: 'framework.agreement', 'Agreement'
• framework_agreement_line_ids One2many → framework.agreement.line
  required=True args: 'framework.agreement.line', 'framework_agreement_pricelist_id', 'Price lines'

No public methods.

No new fields.

• price_get(self, cr, uid, ids, prod_id, qty, partner=None, context=None)
  Override of price retrieval function in order to support framework agreement. If it is a supplier price list, agreement will be taken in account and use the price of the agreement if required. If there is not enough available qty on agreement, standard price will be used. This is maybe a faulty design and we should use on_change override

• framework_agreement_ids One2many → framework.agreement
  comodel_name='framework.agreement' copy=False inverse_name='product_id' string='Framework Agreements (LTA)'

No public methods.

• portfolio_id Many2one → framework.agreement.portfolio
  domain="[('supplier_id', '=', partner_id)]" args: 'framework.agreement.portfolio', 'Portfolio'

• onchange_partner_id(self, partner_id)
  @api.multi
  Prevent changes to the supplier if the portfolio is set. We use web_context_tunnel in order to keep the original signature.
• update_agreements_in_lines(self)
  @api.onchange('portfolio_id', 'pricelist_id', 'date_order', 'incoterm_id')
• update_currency_from_pricelist(self)
  @api.onchange('pricelist_id')
  Reproduce the old_api onchange_pricelist from the purchase module. We need new-style onchanges to be able to modify agreements on order lines, and we cannot have new-style and old-style onchanges at the same time.

• framework_agreement_id Many2one → framework.agreement
  domain=[('portfolio_id', '=', 'order_id.portfolio_id')] args: 'framework.agreement', 'Agreement'
• portfolio_id Many2one → framework.agreement.portfolio
  readonly=True related='order_id.portfolio_id' args: 'framework.agreement.portfolio', 'Portfolio'

• onchange_agreement(self)
  @api.onchange('framework_agreement_id')
• onchange_price_unit(self)
  @api.onchange('price_unit')
• onchange_product_id(self, pricelist_id, product_id, qty, uom_id, partner_id, date_order=False, fiscal_position_id=False, date_planned=False, name=False, price_unit=False, state='draft')
  @api.multi

• one_agreement_per_product Boolean
  help='If checked you can have only one framework agreement per product at the same time.' args: 'One agreement per product'

No public methods.