QueryBillableAsset

The QueryBillableAsset request instructs the Billing Service to query a Billable Asset. It then returns a list of all Billable Asset lines for the chosen Billable Asset.

QueryBillableAsset Request

This QueryBillableAsset 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.	Mandatory
TargetIdentifier	Container	This contains AccountIdentifier (Integer8) which is the Account Number to check for Billable Assets.	Mandatory
BillableAssetCode	String6	The unique system generated code for the Billable Asset.	Mandatory
Datasets	Dataset	See Datasets Request Container for details.	Mandatory

Datasets

The Datasets request container contains one or more repetitions of the following elements:

Element Name	Content Type	Description	Required?
Dataset	Integer 15	LINES must be specified in order to retrieve all of the Billable Asset lines for the Account Identifier specified.	Mandatory

QueryBillableAsset Response

The QueryBillableAsset response is the response to the QueryBillableAsset Request. This response contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response.	Mandatory
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
BillableAssetLines	Container	Contains zero or more instances of BillableAssetLine, see BillableAssetLine Response Container for details.	Optional

BillableAssetLine Response Container

The BillableAssetLines response container has the following elements:

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

BillableAssetLine Response Container

The BillableAssetLine response container has the following elements:

Element Name	Content Type	Description	Required?
BillableAssetLineIdentifier	Integer15	Unique number to identify the individual Billable Asset line.	Mandatory
EffectiveDate	Date	The default effective date. YYYY-MM-DDZ	Mandatory
ExpiryDate	Date	The date that Billable Asset expires. YYYY-MM-DDZ	Optional
Reference1	String30	Free text field.	Optional
Reference2	String30	Free text field.	Optional
InvoiceThisLine	Boolean	If selected, the Billable Asset will appear on the subscriber's invoice.	Mandatory
BilledUpToDate	Date	YYYY-MM-DDZ	Optional
Price	Currency (Decimal)	The price of the asset. Min inclusive: 0.00 Max Inclusive: 999999999.99	Mandatory
LastAmendedDate	dateTime	YYYY-MM-DDThh:mm:ssZ To identify last change date of the record.	Mandatory