QueryBillableAssets
The QueryBillableAssets tag instructs the Billing Service to query Billable Assets. This 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. returns a list of all Billable Assets on an 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..
QueryBillableAssets Request
The QueryBillableAssets 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 |
|
TargetIdentifier |
Container |
This contains AccountIdentifier (Integer8) which is the Account Number to check for Billable Assets. |
Mandatory |
|
BillableAssetFilterType |
String - Enumeration |
One of:
|
Mandatory |
QueryBillableAssets Response
The QueryBillableAssets response is the response to the QueryBillableAssets Request. This response 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 |
|
TargetIdentifier |
Integer8 |
This contains AccountIdentifier (Integer8) which is the Account Number to check for Billable Assets. |
Mandatory |
|
QueryLimitExceeded |
Boolean |
Set to True if the maximum number of records that may be returned as defined in the configuration, was exceeded. |
Mandatory |
|
BillableAssets |
Container |
See BillableAsset Response Container for details. |
Optional |
BillableAssets Response Container
The BillableAssets response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
BillableAsset |
Container |
See BillableAsset Response Container for details. |
Optional |
BillableAsset Response Container
The BillableAsset response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
BillableAssetCode |
String6 |
Billable Asset Type Code. |
Mandatory |
|
BillableAsset Description |
String6 |
Billable Asset Type Description. |
Mandatory |
|
ActiveBillableAssetLineCount |
Integer |
The number of active lines included in the Billable Asset. |
Mandatory |
|
AllBillableAssetLineCount |
Integer |
The number of lines included in the Billable Asset. |
Mandatory |