UpdateAccountDetails

The UpdateAccountDetails 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 update 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. information for existing CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. Accounts.

In order to update the Account details, 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 Account Number along with the relevant information to be updated.

Users are able to update individual attributes of the Account details as per the Edit Account panel. Invalid requests are rejected with an error message.

The Update Account Details Response returns a failure response if:

The Hardware Account belongs to one of the Account Types specified in the Maintain Account Type table
The Hardware Credit Limit entered is blank or zero

UpdateAccountDetails Request

The UpdateAccountDetails tag instructs the Account Service to update Account details. 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
AccountNumber	Integer 0-99999999	The number automatically allocated to the Account upon creation in CMP.	Mandatory
UpdateAccountBasic	Container	See UpdateAccountBasic Request Container for details.	Optional
UpdateAccountTypeAndUsage	Container	See UpdateAccountTypeAndUsage Request Container for details.	Optional
UpdateCustomerDetails	Container	See UpdateCustomerDetails Request Container for details.	Optional
UpdateCreditControl	Container	See UpdateCreditControl Request Container for details.	Optional
UpdateSubscription InvoiceControl	Container	See UpdateSubscriptionInvoiceControl Request Container for details.	Optional
UpdateNonSubscription InvoiceControl	Container	See UpdateNonSubscriptionInvoiceControl Request Container for details.	Optional
UpdateAutoPayments	Container	See UpdateAutoPayments Request Container for details.	Optional

UpdateAccountBasic Request Container

The UpdateAccountBasic request container has the following elements:

Element Name	Content Type	Description	Required?
AddressNumber	Integer8	The Account level delivery address number which is one of the several delivery addresses available in the system.	Optional
PaymentTerms	String3	The agreed terms of payment, e.g. within 14 days of invoice date.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

UpdateAccountTypeAndUsage Request Container

The UpdateAccountTypeAndUsage request container has the following elements:

Element Name	Content Type	Description	Required?
AccountType	String6	Account Types indicate the type of Account to which Subscriptions belong, for example, 001 = VIP, 002 = Bad Debt. This is a classification of the Account. If not supplied, the value that is defaulted in comes from the Account Default Parms Maint. The field is ADVSalesPersonCode.. Value provided must be a valid Account Type.	Optional
SubLedgerCode	String6	This is used if the business is involved in Internet, gas, mobile, etc. This references an extra level of detail in the General Ledger and can link to external financials software. The code is used to enable direct debits to be claimed from the bank account. If not supplied, the value that is defaulted in comes from the Subledger field in Account Default Parms Maint. Value must be a valid Sub Ledger Code.	Optional
AccountUsage	String1	This indicator controls what the Account can be used for. If no value is supplied then this defaults to SubscriptionAndSales/Both. Valid values are Subscription, SubscriptionAndSales and Sales. These appear in AgentView as Subscription = Subscription SubscriptionAndSales = Both Sales = Sales Order Subscriptions cannot be added to an account when usage is Sales (usually referred to as a Hardware account). It is possible to add Subscriptions to a Subscription or to a SubscriptionAndSales (Both).	Optional
CorrespondingAccount	Integer8	The number of an associated Account, e.g. equipment only. Usage Accounts can be linked to an equipment Account and vice versa. There is a find facility to locate alternative addresses.	Optional
AccountServiceAgreement	Integer8	This is used to enter the number of an active Account's services agreement. A single agreement from within the same structure as the account is required to control the billing pattern of all of an account's services.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

UpdateCustomerDetails Request Container

The UpdateCustomerDetails request container has the following elements:

Element Name	Content Type	Description	Required?
AccountPassword	String20	This is used for security purposes if it is necessary to control caller access. This password can work instead of, or in conjunction with, a subscription password.	Optional
AccountPIN	Integer4	System generated unique personal identification number. Could become active if Interactive Voice Recognition (IVR) is introduced.	Optional
ForAttnOfName	String30	This details of the name that appears on statements, copy invoices, etc.	Optional
AccountContactName	String30	This details of a personal contact within the customer's organisation.	Optional
Comments	String30	An entry can be made to inform the CSA user about the customer, previous contacts or any other pertinent points in respect of credit scoring.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

UpdateCreditControl Request Container

The UpdateCreditControl request container has the following elements:

Element Name	Content Type	Description	Required?
CreditLimit	Integer9	The customers spending limit. This includes billed charges and can work independently, or in conjunction with the value of unbilled usage. However, the procedure is not related to Credit Management as recovery may begin earlier than a scheduled Credit Management procedure.	Optional
HardwareCreditLimit	Integer9	Hardware Only Credit Limit.	Optional
CreditScore	Integer	The rating given to the customer by the Credit Reference Agency during the credit checking process.	Optional
IgnoreCreditControl	Boolean	This cancels the whole Credit Control process up to a specified date.	Optional
IgnoreCreditControlUpToDate	Date	The date until which Credit Control is ignored. Works in conjunction with the Ignore Credit Control field. Choice of: <Value> <Clear> YYYY-MM-DDZ	Optional
IgnoreUsageLimits	Boolean	If true, this means the customer is not notified when either their lower or upper usage limit is reached, and no auto response is triggered. This affects all Subscriptions linked to the Account.	Optional
AccountInQuery	Boolean	If true, this indicates that an element of the balance outstanding is being held out from recovery procedures while a customer query is addressed.	Optional
CreditControlAddressNumber	Integer 0-99999999	The unique number associated with this type of address, which is one of several delivery addresses available in CMP.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Mandatory

UpdateSubscriptionInvoiceControl Request Container

The UpdateSubscriptionInvoiceControl request container has the following elements:

Element Name	Content Type	Description	Required?
GenericText	Boolean	This allows standard text messages to appear on the invoice. If set to true, any company notices, instructions, warnings, etc. appear on all invoices produced.	Optional
OverrideTaxCode	Boolean	If set to True, the tax code on specific services is ignored. Instead the tax code from the Account level within the external finance package customer file is used.	Optional
PrintStatementSubscription	Boolean	If set to True, statements for non-subscription related services are issued. Otherwise they are included within the usage invoice.	Optional
PrintStatementSubscriptionFormat	String30	This indicates the medium used to issue non-subscription statements (e.g. A4 with two columns).	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

UpdateNonSubscriptionInvoiceControl Request Container

The UpdateNonSubscriptionInvoiceControl request container has the following elements:

Element Name	Content Type	Description	Required?
PrintStatementInvoice	Boolean	If set to True, statements for Non-Subscription related services are issued. Otherwise they are included within the usage invoice.	Optional
PrintStatementInvoiceFormat	String30	This indicates the medium/format used to issue Non-Subscription statements (e.g. A4 with two columns).	Optional
StatementFormatInvoiceFormat	String30	This indicates the medium/format used for Non-Subscription invoices (e.g. A4 with two columns).	Optional
FirstInvoice	Date	The date on which the first invoice was produced. YYYY-MM-DDZ	Optional
SubsequentInvoiceFrequency	Container	Choice of: SubsequentInvoiceFrequencyDays SubsequentInvoiceFrequencyMonths See the SubsequentInvoiceFrequency Response Container response container for further information.	Optional
DelayToCycle	Integer	Any Non-Subscription invoice can be aligned to be produced on the same day as the usage invoice.	Optional
ConsolidationNonSubscriptionInvoice	Boolean	When Invoice Print is run, if the Consolidate Non Subscription Invoice is set to True, the relevant invoices are consolidated to Account level.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

SubsequentInvoiceFrequency Response Container

The SubsequentInvoiceFrequency response container has the following elements:

Element Name	Content Type	Description	Required?
SubsequentInvoiceFrequencyDays	Inter	This indicates the number of days between each invoice date: Min Inclusive: 1 Max Inclusive: 31	Optional
SubsequentInvoiceFrequencyMonths	Token	This indicates the number of months between each invoice date: [0] [1-9] [1] [0-2]	Optional

Element Name

Content Type

Description

Required?

SubsequentInvoiceFrequencyDays

Inter

This indicates the number of days between each invoice date:

Min Inclusive: 1
Max Inclusive: 31

Optional

SubsequentInvoiceFrequencyMonths

Token

This indicates the number of months between each invoice date:

[0] [1-9]
[1] [0-2]

Optional

UpdateAutoPayments Request Container

The UpdateAutoPayments request container has the following elements:

Element Name	Content Type	Description	Required?
AutoPaymentCalcMethod	String	There are two options for this field which refers to direct debit/automatic account withdrawals only. CHILD (Child balance) PARENT (Parent balance). If set to CHILD, only payments corresponding to the account being changed are pulled. If set to PARENT, payments are pulled from all accounts linked to the parent of the account being viewed.	Optional
SuspendFromAutoPayment	Boolean	Once flagged the auto payment is suspended.	Optional
SuspendUpToDueDate	Date	The date entered relates to the start of the period during which auto payments are suspended. Choice of: <Value> <Clear> YYYY-MM-DDZ	Optional
SuspendDueDateUntil	Date	The date entered relates to the end of the period during which auto payments are suspended. Choice of: <Value> <Clear> YYYY-MM-DDZ	Optional
SuspensionReason	String90	The reason why the account is suspended from auto payment.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Mandatory

UpdateAccountDetails Response

The UpdateAccountDetails response is the response to the UpdateAccountDetails 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