CreateAgreement

The CreateAgreement 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 an 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. within CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. and assign it to a specified level of an existing CMP structure.

Standard CMP rules associated with creating an Agreement govern which values are mandatory or optional for the request. The user A person with the capability to log in to the CMP GUI software, such as a customer service advisor or agent. must specify the hierarchy level the Agreement should be logged at within the web service request (for example, 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., Corporate or Group).

The web service returns the newly created Agreement Number.

Submitting invalid data in the request will result in an error message.

CreateAgreement Request

The CreateAgreement tag instructs the Agreement Service to create an Agreement. 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
AgreementData	Container	A container tag for the low level agreement information. See AgreementData Request Container for details.	Mandatory

Element Name

Content Type

Description

Required?

ExternalReference

String69

The client may use this identifier to correlate the request and the response.

Optional

AgreementData

Container

A container tag for the low level agreement information.

See AgreementData Request Container for details.

Mandatory

AgreementData Request Container

The AgreementData request container has the following elements:

Element Name	Content Type	Description	Required?
BillingCycle	Integer	Range 1-31 (Day of the month)	Optional
InvoiceConsolidatioLevel	String - Enumeration	Enumeration of: Group Corporate Account Subscription	Optional
InvoiceReceiptAddress	String - Enumeration	Enumeration of: Group Corporate Account Subscription In AgentView this field is "Send Invoice To" Valid values: If Invoice Consolidation = Corporate, valid values are Agreement and Corporate If Invoice Consolidation = Account, valid values are Account and Agreement If Invoice Consolidation = Subscription, valid values are Subscription, Account and Agreement. If Invoice Consolidation = Group, valid values are Agreement and Group (if a group exists in the structure).	Optional
NextExpectedInvoiceDate	Date	Defaults to the current billing cycle in the next month. YYYY-MM-DDZ	Optional
CorporateCode	String6	The Corporate to which the Agreement will be added. If not specified, the Agreement will not be associated with any Corporate. Either Corporate Code, Group Code and Account Code has to be supplied.	Optional
GroupCode	String6	The Group to which the Agreement will be added. If not specified, the Agreement will not be associated with any Group. Either Corporate Code, Group Code and Account Code has to be supplied.	Optional
AccountCode	Integer8	The Account to which the Agreement will be added. If not specified, the Agreement will not be associated with any Account. Either Corporate Code, Group Code and Account Code has to be supplied.	Optional
Billing Media	String6	Billing Media must be a valid Billing media code that has been set up.	Optional
Price Plan Code	String6	The unique CMP alphanumeric code for the price plan associated with the agreement.	Optional

CreateAgreement Response

The CreateAgreement response is the response to the CreateAgreement 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.	Conditional
AgreementNumber	Integer8	The unique system generated reference number for the agreement.	Mandatory