Query Account Type and Usage Response Container

The AccountTypeAndUsage response container is the response to the 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._TYPE_AND_USAGE dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
AccountType	String6	Account Types indicate the type of account to which Subscriptions belong. 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.	Optional
SubLedgerCode	String6	This references an extra level of detail in the General Ledger and links to the external financials software. The main use of this code is 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.	Optional
AccountUsage	String - Enumeration	This indicator controls what the account can be used for. Possible values are: Subscription Sales SubscriptionAndSales (default) 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	String20	The number of an associated Account, e.g. equipment only. Usage accounts can be linked to an equipment account and vice versa.	Optional
AccountServiceAgreement	Integer8	The Account's service agreement number.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

AccountSerialNumbers Response Container

The AccountSerialNumbers response container is the response to the ACCOUNT_SERIAL_NUMBERS dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
SerialNumberId	Range 1-999	The serial number identification number.	Mandatory
SerialNumberValue	String25	The actual serial number value for example 07712345678.	Mandatory
EffectiveDate	Date	The date from which the serial number becomes effective. YYYY-MM-DDZ	Optional
SerialStatus	String	The serial number status. Possible values are: CHANGING CURRENT SUPERSEDED	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

CustomerDetails Response Container

The CustomerDetails response container is the response to the 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._DETAILS dataset when specified in the QueryAccount request. It 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. Active if Interactive Voice Recognition (IVR) is introduced.	Optional
ForAttnOfName	String30	Details of the name that appears on statements, copy invoices, etc.	Optional
AccountContactName	String30	Details of a personal contact within the customer's organisation.	Optional
CustomerCostCentre	String20	Codes are used to allocate responsibility of charges to different areas within an organisation. The customer purchase ledger cost centre can be entered here to be printed on all invoices. New cost centres can be added to the list at Agreement level.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

SubscriptionInvoiceControl Response Container

The SubscriptionInvoiceControl response container is the response to the 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_INVOICE dataset when specified in the QueryAccount request. It 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
PrintStatement	Boolean	If set to True, statements for non-subscription related services are issued. Otherwise they are included within the usage invoice.	Optional
BillingMediaCode	String6	Account = Non-subs invoicing (Adjustments / Orders etc)	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

NonSubscriptionInvoiceControl Response Container

The NonSubscriptionInvoiceControl response container is the response to the NON_SUBSCRIPTION_INVOICE dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
PrintStatement	Boolean	If set to True, statements for Non-Subscription related Services are issued. Otherwise they are included within the usage invoice.	Optional
PrintStatementBillingMediaCode	String6	This indicates the medium used to issue Non-Subscription Statements.	Optional
ConsolidateInvoice	Boolean	When Invoice Print is run, if ConsolidateInvoice is set to True, the relevant invoices are consolidated to Account level.	Optional
ConsolidateInvoiceBillingMediaCode	String6	This indicates the medium used to issue Non-Subscription consolidated Invoices.	Optional
FirstInvoice	Date	The date on which the first invoice was produced. YYYY-MM-DDZ	Optional
LastInvoice	Date	The date on which the previous invoice was produced. YYYY-MM-DDZ	Optional
NextExpectedInvoice	Date	The date of the next expected Invoice (as per billing cycle). YYYY-MM-DDZ	Optional
SubsequentInvoiceFrequency	Container	Choice of: SubsequentInvoiceFrequencyDays SubsequentInvoiceFrequencyMonths See SubsequentInvoiceFrequency Response Container Response for further information.	Optional
DelayToCycle	Integer	A Non-Subscription invoice can be aligned to be produced on the same day as the usage invoice. This element indicates if a Non-Subscription invoice is produced at the same time as the usage invoice.	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

Integer

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

Services Response Container

The Services response container is the response to the SERVICES dataset specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
Service	Container	See Service Response Container for details.	Optional

Service Response Container

The Service response container has 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
PackageCode	String6	The unique code within a company used to identify which Package the scheme is attached to.	Optional
Description	String30	This details the descriptive text (30-characters) attributed to the Service as it appears on the invoice.	Optional
ServicePrice	Currency (Decimal)	The price of the Service. Min Inclusive: 0.01 Max Inclusive: 999999999.99	Optional
EffectiveDate	Date	This is the date from which the Service becomes effective. YYYY-MM-DDZ	Optional
ExpiryDate	Date	This is the date on which the Service is set to expire. YYYY-MM-DDZ	Optional
IncdInTermCostCalc	Boolean	This indicates if a particular Service is included in the termination cost calculation.	Optional
PriceConsolidationService		Applicable to Subscription Services only. This enables the chosen Service to become part of one consolidated Service, which is several chargeable Subscription Services grouped together to appear on the Subscription invoice as one Service with one charge or price against it.	Optional
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ	Optional

A Service container is returned for each active Account Service.

Card Response Container

The Card response container is the response to the CREDIT_DEBIT_CARDS dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
SubscriptionNumber	Integer8	The unique system generated Reference Number for the Subscription.	Optional
NetworkSerialNumber	String25	Network Serial Number associated with CMP Subscription Number.	Optional
PaymentType	String6	The type of credit / debit card to be used (for example VISA).	Mandatory
Status	String	One of the following: OneOffPayment – Indicates that the card is for one off payments Active – Indicates that the card is for recurring payments.	Mandatory
CardReference	String20	The tokenised string representing the card.	Mandatory
CardNumber	String4	The last four digits of card number.	Optional
NameOnCard	String20	The name that appears on the card.	Optional
StartYear	String2	Start year on the card.	Optional
StartMonth	String2	Start month on the card.	Optional
ExpiryYear	String2	Expiry year on the card.	Optional
ExpiryMonth	String2	Expiry month on the card.	Optional

AttributeGroup Response Container

The AttributeGroup response container is the response to the ATTRIBUTES dataset when specified in the QueryAccount request. It returns the following processing results:

Element Name	Content Type	Description	Required?
AttributeGroupID	String6	A unique ID for the Attribute Group. For example, 03A. Each account can have only a single effective Attribute Group at any one time	Mandatory
EffectiveDate	dateTime	The date from which the Attribute Group becomes effective. YYYY-MM-DDThh:mm:ssZ	Optional
Attribute	Container	Attributes are a configurable list of values that can be associated with entities such as Price Plans and Packages to provide more information on it. See Attribute Response Container for details.	Mandatory

Attribute Response Container

The Attribute response container has the following elements:

Element Name	Content Type	Description	Required?
AttributeID	Integer2	A unique ID for the Attribute. For example, 01. This is chosen from a list of Attributes configured against the chosen Attribute Group in CMP diseMP Back Office configuration.	Mandatory
AttributeValue	String120	A full Description of the Attribute. For example, Dedicated Lease Line Connection.	Optional
EffectiveDate	dateTime	The date on which the Attribute becomes effective. YYYY-MM-DDThh:mm:ssZ	Optional

TerminationFee Response Container

The TerminationFee response container is the response to the TERMINATION_FEE dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
TerminationFee	Currency (Decimal)	Monetary value that will be charged if a subscriber decides to leave their contract early.	Optional

RewardEntitlement Response Container

The RewardEntitlement response container is the response to the REWARD_ENTITLEMENTS dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
RewardIdentifier	Integer9	The code which identifies the Reward that can be claimed.	Mandatory
RewardType	String	The type of reward that can be claimed for example Port-In Reward.	Mandatory
RewardTypeDescription	String	A full Description of the Reward Type.	Mandatory
RewardLevel	Integer3	The level of reward within the Reward Type that customer qualified for.	Mandatory
RewardLevelDescription	String	A full Description of the level of reward.	Mandatory
RewardCategory	String	A Category of reward (e.g. minutes, text, data, money).	Mandatory
RewardCategoryDescription	String	A full Description of the Reward Category.	Mandatory
AwardedOnDate	dateTime	The date and time that the reward is awarded. YYYY-MM-DDThh:mm:ssZ	Mandatory
ExpiresOnDate	dateTime	This indicates if the reward has a defined period in which it can be claimed. YYYY-MM-DDThh:mm:ssZ	Mandatory
LastAmendedDate	dateTime	The date and time that reward was last amended. YYYY-MM-DDThh:mm:ssZ	Optional

DLPPorts Response Container

The DLPPorts response container is the response to the DLP_PORT dataset when specified in the QueryAccount request. It has the following elements:

Element Name	Content Type	Description	Required?
SubscriptionNumber	Integer8	The Subscription Number that has port in information associated with it. Each Subscription may have more than one Port-in returned (if for instance a pending Port-in was cancelled and then initiated again).	Mandatory
PACCode	String9	Standard PAC format.	Mandatory
PACExpiryDate	Date	The date that the PAC expires.	Mandatory
PACCreationDate	Date	The date on which the PAC was created on.	Mandatory
RNO	String2	The Recipient Network Operator. This is the code that comes from Syniverse.	Optional
DNO	String2	The Donor Network Operator. This is the code that comes from Syniverse.	Mandatory
RSP	String3	The Recipient Service Provider. This is the code that comes from Syniverse.	Optional
DSP	String	The Donor Service Provider. This is the code that comes from Syniverse.	Mandatory
PortDate	Date	YYYY-MM-DDZ The date on which the number is scheduled to Port-in.	Optional
PortStatus	Enumeration	The current status of the Port-in. Possible values for PortStatus are as follows: CLOSED - This is the status of the port after the customer has agreed to Port-in but prior to porting. The Port-in will retain this status until between 18:00 and22:00 on the day before. LOCKED – This is the PAC status between 18:00 and 21:00 on the day before. This status will only be displayed in the Online Portal if an agent queries Syniverse between 18:00 and 21:00, and the customer subsequently looks at the Port ins on the Online Portal. The web service does not query Syniverse unless an agent explicitly does so, the CLOSED status will be returned. IN_PROGRESS – This is the status in which the Port-in will be from 22:00 on the day before the Port-in until the Port-in event is completed. COMPLETE - This is the status when Port-in commands have been sent to the network and CMP has received a successful response. CANCELLED – Indicates a Port-in request was cancelled. ERROR - This is the status of the Port-in once the Port-in has been completed but CMP has received an error.	Mandatory
Cancellable	Boolean	This indicates whether or not it is possible to cancel a CLOSED PAC (an in progress Port-in). This only affects online Port-ins. Changes will still be allowed via AgentView until rejected by Syniverse.	Optional
NumberBeingPortedIn	String25	The mobile number being ported in.	Mandatory
NumberBeingReplaced	String25	The mobile number that is being replaced. This is not available when the PortStatus = COMPLETE.	Optional