Asset Cancellation (POST)

Initiate and execute the cancellation of an asset.

Special Access Rules

To use this API, you need the InitiateCancellation API permission set.

Resource

1/connect/revenue-management/assets/actions/cancel

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/revenue-management/assets/actions/cancel

Available Version

62.0

HTTP Methods

POST

Request Body for POST

JSON Example

1{
2  "assetIds": [
3    "02iSG0000003NMhYAM",
4    "02iSG0000006DvSYAU"
5  ],
6  "cancellationDate": "2023-10-04T00:00:00",
7  "contractId": "800SG00000CFpepYAD",
8  "opportunityId": "006SG000004W5tVYAS",
9  "outputRecordId": "801SG00000DX1jWYAT",
10  "outputRecordType": "Quote"
11}

Properties

Name	Type	Description	Required or Optional	Available Version
`assetIds`	String[]	IDs of the assets that you want to cancel. All assets in a request must belong to the same price book.	Required	62.0
`cancellationDate`	String	Effective date of the cancellation.	Required	62.0
`contractId`	String	ID of the Contract record that you want to sync with the cancellation quote.	Optional	62.0
`opportunityId`	String	ID of the Opportunity record that you want to sync with the cancellation quote.	Optional	62.0
`outputRecordId`	String	ID of the quote or order that you want to cancel.	Optional	62.0
`outputRecordType`	String	Type of cancellation record that you want to create.	Required	62.0

Response Body for POST

Cancellation