To login with your TM Forum account please click on the Login button below

Don't have an account? You can register by clicking here:

The following document is the specification of the REST API for Customer Management. It includes the model definition as well as all available operations.
It provides a standardized mechanism for customer and customer account management such as creation, update, retrieval, deletion and notification of events.
Customer can be a person, an organization or another service provider who buys products from an enterprise. Customer management API allows management of identification and financial information about him.
Customer management API manages the following data resources:

  • Customer
    • Customer represents a person or organization that buys products and services from the enterprise or receives free offers or services. Customers can also be other service providers who resell the enterprises products, other service providers that lease the enterprise's resources for utilization by the other service provider's products and services, and so forth.
    • Customer resource contains information about the customer. Main attributes are its identifier, name, status and validity, description, characteristics, contact medium, related customer account, related party, customer credit profile information
  • Customer Account
    • Customer account represents a financial entity. It records all customer accounting events (payment and invoices amounts)
    • Customer account main attributes are its identifier, name, account type, status, description, credit limit, receivable balance, tax exemption, relationships, contacts, balance, payment plan and payment mean
  • Payment Mean
    • Payment mean represents how the customer will pay the invoice or payment

Customer management API performs the following operation on customer, customer account or payment mean

  • Retrieval of a customer, customer account, payment mean or of a collection of them or depending on filter criteria
  • Full update of a customer, customer account or payment mean
  • Partial update of a customer, customer account or payment mean
  • Creation of a customer, customer account or payment mean
  • Deletion of a customer, customer account or payment mean
  • Notification of events:
    • Customer create
    • Customer update
    • Customer delete
    • Customer Account create
    • Customer Account update
    • Customer Account delete
    • Payment Mean create
    • Payment Mean update
    • Payment Mean delete


Notes:

  • Business Interactions are put out of scope of this Customer API. They can be handled and retrieved through specific tasks (an example of task for order retrieval is detailed at the end of this document)
  • For the moment, we assume that a customerAccount cannot be shared between multiple customers
  • Payment plans may be created during ordering process: this case is not covered yet.
 

© TM Forum 2015. All Rights Reserved.