Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

download

Renew Assets

You can invoke this API to renew assets.

API

Signature

renewAssets

WebService static Apttus_CPQApi.CPQAsset.RenewAssetsResponseDO renewAssets(Apttus_CPQApi.CPQAsset.RenewAssetsRequestDO request)

Parameters

Name

Type

Description

request Apttus_CPQApi.CPQAsset.RenewAssetsRequestDO

Request object passed by the invoker method.

Request Data Object - Apttus_CPQApi.CPQAsset.RenewAssetsRequestDO

Name

Type

Description

RenewEndDate Date

Asset end date for renewal.

FarthestAssetEndDate Boolean

Setting this value to true renews assets using the farthest end date.

RenewTerm Integer

Renewal term for an asset.

AssetIds List<ID>

List of asset IDs to be renewed.

CartId ID

ID of the cart for which an asset is being renewed.

Response Data Object - Apttus_CPQApi.CPQAsset.RenewAssetsResponseDO

Field

Type

Description

LineItemMap List<LineItemEntryDO>

Line items that are renewed.

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 renew assets based on the renewal date, farthest asset end date, or renewal term.

Public Apttus_CPQApi.CPQAsset.RenewAssetsResponseDO renewAssets() { // create and populate request object Apttus_CPQApi.CPQAsset.RenewAssetsRequestDO request = new Apttus_CPQApi.CPQAsset.RenewAssetsRequestDO(); request.CartId = 'a1I6C000000k6lmUAA'; // list of primary asset ids to be renewed request.AssetIds = new List<ID> {'a0e6C000001uATS'}; request.renewenddate = Date.newInstance(YYYY, MM, DD); // call renewAssets API Apttus_CPQApi.CPQAsset.RenewAssetsResponseDO response = Apttus_CPQApi.CPQAssetWebService.renewAssets(request); return response; }