QueryAccountServices Request
The QueryAccountServices tag instructs 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. Service to query for 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 |
Integer8 |
The unique system generated reference number for the Account. |
Mandatory |
|
StatusFilter |
String |
Possible Values
|
Mandatory |
QueryAccountServices Response
The QueryAccountServices response is the response to the QueryAccountServices 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 |
|
AccountServices |
Container |
Contains zero or more Account Service elements. See AccountServices Response Container for details. |
Mandatory |
|
QueryLimitExceeded |
Boolean |
Set to True if the maximum number of records that may be returned as defined in the configuration, was exceeded. |
Mandatory |
AccountServices Response Container
The AccountServices response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ServiceCode |
String6 |
Unique ID for the Service configured in CMP. |
Mandatory |
|
EffectiveDate |
Date |
The Date from which the Service becomes effective. YYYY-MM-DD |
Mandatory |
|
ExpiryDate |
Date |
The Date on which the Service will expire. YYYY-MM-DD |
Optional |
|
ServiceDescription |
String30 |
A description of the Service linked to the Subscription. |
Optional |
|
Price |
Decimal9,2 |
The Price at which the Service is charged. |
Optional |
|
NominalCode |
String30 |
The Nominal Code to which the Account Service is charged. |
Optional |
|
InvoiceThisService |
Boolean |
True if the Account Service is valid for invoicing. |
Optional |
|
LongDescription |
String120 |
This details a longer descriptive text attributed to the Service (120-characters). |
Optional |
|
PackageCode |
String6 |
Unique ID for the package used to add the Account Service. |
Optional |
| PackageDescription | String30 | The descriptive name for the package used to add the Account Servuce | Optional |
|
PricePeriodCoverage |
Container |
See PricePeriodCoverage Response Container for details. |
Optional |
|
SalesAccountNumber |
Integer8 |
Sales Account Number of the salesperson who introduced the customer to the Service. |
Optional |
|
BillingOffset |
Integer2 |
The period by which Service is billed in advance. |
Optional |
|
AddingEvent |
Integer9 |
Account Services can be added by Workflow Events. This element contains the ID of the Workflow Event that added this Service. |
Optional |
|
NetworkConfirmed |
Boolean |
Set to True if the Account request has been confirmed at Network level. |
|
|
Migrated |
Boolean |
Set to True if the Account has been migrated between Tariffs. |
Optional |
|
RecurringCharge |
Boolean |
Set to True if a recurring Service Charge is to be applied to the Account. |
Optional |
|
PerBill |
Boolean |
Set to True if the Service is charged on each bill. Set to False for a one-off payment. |
Optional |
|
BilledUntil |
Date |
YYYY-MM-DD The last date on which the customer was billed for the Service. |
Optional |
|
ServiceBarred |
Boolean |
Set to True if the Service is barred. |
Optional |
|
ContractService |
Boolean |
The value to be retrieved from the Service Code set up. |
Optional |
|
ContractDuration |
Integer3 |
The value to be retrieved from the Service Code set up. |
Optional |
|
SuppressRemainingContractCharge |
Boolean |
This is a Yes/No option which is used by Invoice Production to determine whether or not to apply the Contract Expiry Charge to the subscriber as part of generating the invoice. |
Optional |
|
ContractReference |
String12 |
A 12-character reference ID that can be assigned to the Service contract. This field is displayed for Contract Services only. |
Optional |
|
Last Amended Date |
Date |
YYYY-MM-DD |
Optional |
PricePeriodCoverage Response Container
The PricePeriodCoverage response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
CoverageType |
String |
Enumeration:
|
Mandatory |
|
CoverageValue |
Integer3 |
The value of the coverage during the selected period. |
Mandatory |