Open APIs

 View Only
  • 1.  Can 648 support MACD quotation

    TM Forum Member
    Posted Aug 28, 2024 20:09

    Hello,

    Has anyone used 648 API for MACD quotation?. 

    For example, Modify, we will need to generate the previous and new quote items and all the pricing/commercial changes (e.g. iremove/add promotion, penalty or incentives if breaching some contract term).

    Dor Disconnect, we will need to show Early Termination Charges or any pending charges in the quotation to show the customer and get their approval/signature.

    Thanks and best regards

    Steven



    ------------------------------
    Steven Tandil
    NCS Pte Ltd
    ------------------------------


  • 2.  RE: Can 648 support MACD quotation

    TM Forum Member
    Posted Aug 29, 2024 05:04
    The information you're seeking should be available in the API documentation.
     
    For MACD operations, you will need:
    • A relationship to the Product entity.
    • An action attribute at the line item level.
     
    Keep in mind:
    - This API does not perform calculations such as pricing, penalties, or adding/removing items.
    - A Quote, Cart, or Order serves merely as a container for products and prices.
    - Processes like eligibility checks and charge/discount/termination fee calculations are handled by other APIs that your quote service consumes.
     
    I recommend reviewing IG1228, which provides several use cases illustrating how various APIs and ODA components can be utilized in end-to-end flows.
     
    Note:
    - Be cautious about using the Quote API; it's outdated and appears unmaintained. Version 5 was drafted but hasn't been updated since September 2022, and its release date remains TBD.
    - Consider using the Shopping Cart API instead. Quotes and carts are essentially the same, and the Shopping Cart API supports a polymorphism mechanism (refer to TMF630 for details), allowing you to treat a quote as a subclass of a cart.
     
    Hope this clarifies your concerns!


    ------------------------------
    Kind regards,

    Matthieu Hattab
    Lyse Platform
    ------------------------------



  • 3.  RE: Can 648 support MACD quotation

    TM Forum Member
    Posted Aug 30, 2024 01:33

    Hi Matthieu,

    Thanks for your response. Will look at the Shopping Cart API.

    In a related question, should we consider a quote/shopping cart API or document management API if we need to generate a PDF/HTML quote to send to the customer?

    Steven



    ------------------------------
    Steven Tandil
    NCS Pte Ltd
    ------------------------------



  • 4.  RE: Can 648 support MACD quotation

    TM Forum Member
    Posted Aug 30, 2024 04:41

    I don't know what a document management API does, but I understand we generate PDF out of our BSS like this:

    • Ingest and Validate the JSON structure (provided by your Cart/quote/order API)
    • Map JSON Content to a PDF Template: Apply predefined rules to map JSON elements such as attributes in resources or array to the corresponding fields/tables in the PDF template.
    • Generate and Validate the PDF File

    but maybe other approaches exist.



    ------------------------------
    Kind regards,

    Matthieu Hattab
    Lyse Platform
    ------------------------------



  • 5.  RE: Can 648 support MACD quotation

    TM Forum Member
    Posted Sep 03, 2024 11:01

    Hi Matthieu,

    Thanks for the prompt response.

    I am referring to TMF 667 Document Management API for quote or agreement docs generation. It need to includes all the Clause/T&C, appendix etc

    Best regards

    Steven



    ------------------------------
    Steven Tandil
    NCS Pte Ltd
    ------------------------------



  • 6.  RE: Can 648 support MACD quotation

    TM Forum Member
    Posted Sep 04, 2024 03:08

    Hi,

    The API for Quote management should be 648, for the Product Configuration it is 760 / for the cart items it is 663. For MACD operations, as Mathieu suggested, the action (ADD, DEL etc.) attribute at the line item level should be used. You can define this in the quote or even in the catalog against every item in the catalog, depending on your Architecture pattern.

    The document management is for a different purpose and if the Quote summary is to be stored as a document in the document server or elsewhere, the 667 can be used to post this document. But for quotation management it is 648 and 760 and/or 663 depending on the nature of your operations. For recommendations there  is another API.

    Regards,

    Jag



    ------------------------------
    Jag Baddukonda
    Deutsche Telekom AG
    ------------------------------



  • 7.  RE: Can 648 support MACD quotation

    TM Forum Member
    Posted Sep 06, 2024 03:49

    Hi Jag,

    Thanks for the response. In our project, we need to send the customer a PDF version of the quote pack for review. The PDF must include the quote, standard legal T&C, relevant product and rate information, etc. We are contemplating using 667 for the PDF generation, taking information from 648 (quote), 620 (rate), and 667 (product marketing and legalese stuff). Alternatively, we need to extend 648 to include non-quote items.

    Any thought?

    Steven



    ------------------------------
    Steven Tandil
    NCS Pte Ltd
    ------------------------------



  • 8.  RE: Can 648 support MACD quotation

    TM Forum Member
    Posted Sep 09, 2024 03:08
    Edited by Jag Baddukonda Sep 09, 2024 03:11

    Hi Steven,

    Broadly, that is the right approach. Just some rewording. 

    The Quote object created and managed via API 648, the Product Configuration + pricing and Cart management (Configuration and Cart Objects) managed via APIs 760 and 663 are your data sources. 

    API 620 manages the master data in the Catalog.
    But the price in the quote during the product and cart configuration may be different due to some customer specific negotiation. Hence when you generate the Quote summary, your Quote, Cart objects are your sources.

    However, you can use the catalog to populate the generic terms and conditions applicable to all customers, into your quote summary. But these should ideally be populated into the Product Config and pricing for that customer. 

    And for the Quote summary to be a binding legal contract, there is another component in ODA with it's API i.e. Agreement. You may consider using the agreement component with it's API where the agreement will reside. Your Quote summary will then map to this Agreement with it's API. 

    Regards,

    Jag 



    ------------------------------
    Jag Baddukonda
    Deutsche Telekom AG
    ------------------------------