Terminate Assets
You can invoke this API to terminate or cancel assets.
|
API |
Signature |
|---|---|
| cancelAssets |
WebService static Apttus_CPQApi.CPQAsset.CancelAssetsResponseDO cancelAssets(Apttus_CPQApi.CPQAsset.CancelAssetsRequestDO request) |
|
Parameters |
||
|---|---|---|
|
Name |
Type |
Description |
| request | Apttus_CPQApi.CPQAsset.CancelAssetsRequestDO |
Request object passed by the invoker method. |
|
Request Data Object - Apttus_CPQApi.CPQAsset.CancelAssetsRequestDO |
||
|---|---|---|
|
Name |
Type |
Description |
| CancelDate | Date |
The termination date of an asset. |
| AssetIds | List<ID> |
List of asset IDs to be terminated. |
| CartId | ID |
ID of the cart for which an asset is being terminated. |
|
Response Data Object - Apttus_CPQApi.CPQAsset.CancelAssetsResponseDO |
||
|---|---|---|
|
Field |
Type |
Description |
| LineItemMap | List<LineItemEntryDO> |
Line items that are terminated. |
| Errors | List<String> |
List of error messages if any error occurred. |
|
LineItemEntryDO |
||
|---|---|---|
|
Name |
Type |
Description |
| LineItemId | ID |
Lineitem ID |
| LineItemSO | Apttus_Config2__LineItem__c |
LineItem SObject |
Code Sample
The following code sample helps you terminate assets.
Public Apttus_CPQApi.CPQAsset.CancelAssetsResponseDO cancelAssets()
{
// create and populate request object
Apttus_CPQApi.CPQAsset.CancelAssetsRequestDO request = new Apttus_CPQApi.CPQAsset.CancelAssetsRequestDO();
request.CartId = 'a1I6C000000ju66';
// list of primary asset ids
request.AssetIds = new List<ID> {'a0e6C000001tWxA', 'a0e6C000001wVWB'};
request.CancelDate = Date.newInstance(YYYY, MM, DD);
// call cancelAssets API
Apttus_CPQApi.CPQAsset.CancelAssetsResponseDO response = Apttus_CPQApi.CPQAssetWebService.cancelAssets(request);
return response;
}