QueryAgreementByCustomerLevel
The QueryAgreementByCustomerLevel 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 retrieve a list of Agreements associated with a customer
In the context of the Cloud Monetisation Platform, an individual or organisation who has signed an agreement to take goods and services from a service provider. A customer receives a bill associated with one or more subscriptions, and can be a single end user or a large company with many subscriptions assigned to one agreement.'s CMP
Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. 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. and the levels above that Account within the related structure (Corporate and Group).
The user
A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. passes in a valid CMP Account Number in order to retrieve a list of all Agreements applicable to that level and the associated levels above, within the billing structure.
For each 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. identified, the following information is returned:
- Agreement number
- Invoice logged at Customer Level
- Invoice logged at Customer Reference
- Invoice Consolidation Level
- Invoice Address Level
Submitting invalid data in the request will result in an error message.
QueryAgreementsByCustomerLevel Request
The QueryAgreementByCustomerLevel request instructs the Agreement Service to query an Agreement by Account. This request 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 |
|
AccountIdentifier |
Integer8 |
The CMP automatically generated Account Number. |
Mandatory |
QueryAgreementsByCustomerLevel Response
The QueryAgreementsByCustomerLevel response is the response to the QueryAgreementsByCustomerLevel 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. Contains zero or more repetitions of Agreement. |
Optional |
|
Agreement |
Container |
See Agreement Response Container for details. |
Mandatory |
Agreement Response Container
The Agreement response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
AgreementNumber |
Integer8 |
The unique system generated reference number for the agreement. |
Mandatory |
|
InvoiceLoggedAt |
Container |
Choice of:
|
Optional |
|
InvoiceConsolidationLevel |
String |
A single consolidated invoice can be produced at a chosen level within the billing hierarchy (i.e. Group, Corporate, Account, Subscription). |
Optional |
|
InvoiceAddress |
String |
This indicates to which address invoices are sent. |
Optional |