Open APIs

Expand all | Collapse all

Security Deposit Get (lis) API: which OpenAPI would be best suitable for this

  • 1.  Security Deposit Get (lis) API: which OpenAPI would be best suitable for this

    TM Forum Member
    Posted Jun 18, 2021 13:52
    Hello team,

    My team has to build REST API to retrieve (get) a list of deposits for specific account (From-To date are not mandatory and they are missed , APi should retrieve ALL deposits such account had/has).

    We treated such API as Billing transactions one.

    We were asked to think "may consider a proposal to model the CES "deposit" as an extension of the AccountBalance sub-resource (eg. under BillingAccount, PartyAccount), with a balanceType specific to the CES deposit entity (eg. "security deposit"). "

    In short, it raised the questions :

    1.  Does it look right place to add such as extension in Account Managment  TMF (666) ?
    2.  If some doubt then where such  OpenAPI would be best suitable for?

    Thanks in advance!
    Gregory Sidorok
    TELUS

    ------------------------------
    Gregory Sidorok
    TELUS
    ------------------------------


  • 2.  RE: Security Deposit Get (lis) API: which OpenAPI would be best suitable for this

    TM Forum Member
    Posted Jun 28, 2021 08:27
    Hi Gregory
    I do apologize for the time you had to wait for this reply.
    Deposit is an example of a financial transaction. Managing deposits is a complex functional area, including capabilities such as:
    • Care/Commerce scope: deciding when deposit is need and for which entity (customer, order, product)
    • Calculating the required amount for a deposit
    • Creating a deposit based on received payment and invoicing it properly on a dedicated invoice item
    • Possibly blocking order process until deposit payment
    • Marking the deposit as a held (paid) deposit
    • Refunding part or all of a deposit, or increasing the deposit amount
    • Cancelling the deposit
    • Releasing and optionally applying part or all of a deposit to cover other debts
    • Adjusting the overall deposit balance based on activities done on the specific deposit
    This touches multiple domains, including the balance on Billing Account.

    We at Amdocs believe that Open APIs need to be defined for managing financial transactions, including deposits, and we have started to work on this in the context of our new billing and financial products.

    Specifically for your query, you can certainly have a balance of type Deposit in Billing Account (and you don't need to extend since you already have the field balanceType). But this represents only the total of all deposits. Deposit would need to be a new entity in a dedicated API, as I wrote before.

    Hope it helps

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------