Customer Bill Management Biz API icon

Customer Bill Management Biz API

1.0.x
(0 reviews)
Channel: Selfcare-APP

Brief Description

The following document is the specification of the REST API for customer bill management.

This API allows to find and retrieve one or several customer bills (also called invoices) produced for a customer. A customer bill is an electronic or paper document produced at the end of the billing process. The customer bill gathers and displays different items (applied customer billing rates generated during the rating and billing processes) to be charged to a customer. It represents a total amount due for all the products during the billing period and all significant information like dates, bill reference. This API provides also operations to find and retrieve the details of applied customer billing rates presented on a customer bill.

The API model support the needs for the three basic billing types : postpaid periodical bill, postpaid real-time bill and prepaid real-time bill. This API also provides operations to find and retrieve the details of applied customer billing rates presented on a customer bill.

Resources:

  • Customer Bill Resource : The billing account receives all charges (recurring, one time and usage) of the offers and products assigned to it during order process. Periodically according to billing cycle specifications attached to the billing account or as a result of an event, a customer bill (aka invoice) is produced. This customer bill concerns different related parties which play a role on it: for example, a customer bill is produced by an operator, is sent to a bill receiver and has to be paid by a payer.
  • Applied Customer Billing Rate Resource A customer bill displays applied billing rates created before or during the billing process.
  • Customer Bill on demand Resource : This resource is used to manage the creation request of a customer bill in real-time (on demand).
  • Notification Resource Models: 4 notifications are defined for this API.
  • CustomerBillStateChangeNotification
  • CustomerBillCreationNotification
  • CustomerBillOnDemandCreationNotification
  • CustomerBillOnDemandStateChangeNotification

Customer Bill Management exposes following operations/methods:

  • Customer Bill
    • List Customer Bill
    • Retrieve Customer Bill
    • Patch Customer Bill
  • Applied Customer Billing Rate
    • List Applied Customer Billing Rate
    • Retrieve Applied Customer Billing Rate
  • Customer Bill On Demand
    • Retrieve Customer Bill On Demand
    • Retrieve Customer Bill On Demand on Id
    • Create Customer Bill On Demand

Criticality

Medium

Layer/Category

Process

API Current State

Testing Phase

Usage

TBD

Base URI Summary of Methods

  1. Development
  2. Test
  3. Pre-Prod
  4. Prod

Transport Protocol(s)

  • HTTP
  • HTTPS

3 Layer architecture flow diagram

Sequence Diagram

TBD

Quality of Service (QoS)

TBD

Avg. Response Time (Secs)

TBD

Avg. Payload Size (KB/MB)

TBD

Max Payload Size (KB/MB)

TBD

Avg. Volumes (per day)

TBD

Peak Volumes

TBD

Peak Volumes Timespan

TBD

Availability

High Availability

Service Level Agreement

N/A

Policies

N/A

GDPR

TBD

Constraints

There are no constraints applicable to this API.

Assumptions

Average/Peak Response time depends on the size of payload and speed and other network and processing factors.

Reference documents

Reviews