Initiate Rollback on Last Action

Initiate the reversal of the last action on an asset to rectify any transactional errors or to meet changing business requirements.

Use this action to revert the last amendment or renewal on a particular asset, restoring the asset to its previous state. This action creates a quote or an order based on the specified output type. Use the created reversal quote to verify the reversal and convert the quote into an order.

Keep these considerations in mind when you use this action.

  • You can roll back only future dated transactions.
  • Rollback action isn’t supported for legacy assets.
  • The rollback operation is supported for amendment and renewal only.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods 

URI: /services/data/v68.0/actions/standard/initiateRollBackLastAction

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs 

InputTypeDescription
assetIdsstringRequired. List of asset IDs to include in the last action rollback.
outputTypestringRequired. The type of record to create for reversal. Valid values are Quote—Creates a reversal quote or Order—Creates a reversal order.

Outputs 

OutputTypeDescription
recordIdidThe ID of the created quote or order.

Example 

POST

This example shows a sample request that initiates the rollback action on an asset and converts it into a quote.

1{
2  "inputs": [
3    {
4      "assetIds": [
5        "02iDU0000006UisYAE"
6      ],
7      "outputType": "Quote"
8    }
9  ]
10}

This example shows a sample successful response.

1{
2  "actionName": "initiateRollBackLastAction",
3  "errors": null,
4  "isSuccess": true,
5  "outputValues": {
6    "recordId": "0Q0xx0000004NsSCAU"
7  },
8  "version": 1
9}