CreateDiscount
The CreateDiscount web service
XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to create a CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Discount Scheme against a Subscription A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription, Account In the Cloud Monetisation Platform, a billing entity that can be used to manage payments on one or more subscriptions or payments for services. An account can hold details such as payments or invoices. or Agreement In the Cloud Monetisation Platform, the entity that holds the instructions for generating the bills for one or more subscriptions. including the addresses and how often the bill is generated..
The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must pass in a valid CMP Discount Scheme Code, Subscription, Account or Agreement number and an Effective Date for the Discount Scheme.
The appropriate Discount Scheme parameters for adding a Normal, Cumulative, or Favourite Number Discount is pre-determined by reference data set up. However, it is possible to specify a Favourite Number, Call Class Group, Invoice Volume or Cross Product, or Discount Service as part of the Create Discount request.
Submitting invalid data in the request will result in an error message.
CreateDiscount Request
The CreateDiscount request instructs the Billing Service to create a Discount. This web service contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
| ExternalReference |
String69 |
||
|
The client may use this identifier to correlate the request and the response. |
Optional |
||
|
CommonDiscountData |
Container |
See CommonDiscountData Request Container for details. |
Mandatory |
|
The user has the choice of the next five containers. Only one container can be specified in the request. |
|||
|
NormalDiscountData |
Container |
See NormalDiscountData Request Container for details. |
Mandatory |
CommonDiscountDataRequest Container
The CommonDiscountData request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
TargetIdentifier |
Container - Choice |
Choice of the following elements:
|
Mandatory |
|
DiscountSchemeCode |
String6 |
This details the Name attributed to the Discount Scheme. |
Mandatory |
|
EffectiveDate |
Date |
This details the Effective Date of the Discount Scheme. YYYY-MM-DDZ |
Optional |
|
ExpiryDate |
Date |
This details the date that a Discount Scheme expires. YYYY-MM-DDZ |
Optional |
|
SequenceNumber |
Integer3 |
Indicates the sequence in which Discounts are used. The sequence number determines the order in which Discounts are applied during Invoice Production. The lowest numbered sequence is effective first. |
Optional |
|
Stop |
Boolean |
When set to True, the next sequential Discount after this one will not be used. If set to False, the next Discount in the sequence following this one can be used. |
Optional |
NormalDiscountData Request Container
The NormalDiscountData request container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Services |
Container |
See Service Request Container for details. |
Optional |
Services Request Container
The Services request container contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
Service |
Container |
See Service Request Container for details. |
Optional |
Service Request Container
The Service request container contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ServiceCode |
String6 |
This details the code attributed to the Service as it appears on the invoice. |
Mandatory |
|
EffectiveDate |
Date |
YYYY-MM-DDZ |
Mandatory |
|
BandType |
String - Enumeration |
One of:
|
Mandatory |
|
BasedOnValue |
String - Enumeration |
One of:
|
Mandatory |
|
BasedOnVolume |
Boolean |
When set to True, the discount is based on volume rather than value. |
Optional |
CreateDiscount Response
The CreateDiscount response is the response to the CreateDiscount Request. This contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |