Open APIs

 View Only
  • 1.  Post Object "FinancialAccount" in Customer Account API swagger

    TM Forum Member
    Posted Aug 24, 2018 07:20
    Hi

    Where might we find the API command that creates the FinnancialAccount instance used in the Customer Account API?  There are several GET Financial Account calls, but this presupposed the existence of the object.

    Is it in another API?

    There are multiples of this pattern in the code for other objects, and we feel a bit of clarity might render the swagger code more consumable.

    Thanks

    ------------------------------
    Hugo Vaughan
    Crowd Frame Consulting Limited.
    ------------------------------


  • 2.  RE: Post Object "FinancialAccount" in Customer Account API swagger

    TM Forum Member
    Posted Aug 26, 2018 03:33
    Hi Hugo
    To best of my knowledge, there is no "Customer Account" API. There is a Customer Management API, where the Customer resource can include multiple Accounts via AccountRef. Account is an abstract resource described in Account Management API, and can be either a Financial Account (has balance but cannot receive payments) or a Party Account (has balance and can receive payments).
    In general, the Open API has a pattern RefOrValue, which is used to allow specification of a referred entity contents in a single API call. Thus ProductOrder has a reference to Product, which is annotated as RefOrValue so that an order can be updated with contents of a Product that may not exist in the Product Inventory.
    To best of my knowledge, this pattern is not used in Customer Management, and it would perhaps be a useful enhancement. I suggest you reach out to @mariano belaunde, the leader for this API, to see if this is feasible.​​
    Hope it helps

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------