Asset Amendment (POST)

Initiate and execute the amendment of a quote or an order.

Considerations

For usage products, creating an order directly by setting outputRecordType to Order is currently not supported. The direct-to-order flow can create Order Products without required related Rate Card Entry records, which can cause order activation to fail.

When you amend usage assets, use a two-step flow.

Create an amendment quote by calling initiateAmendment with outputRecordType set to Quote.
Create an order from that amendment quote.

Special Access Rules

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

Resource

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

Resource Example

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

Available Version

62.0

HTTP Methods

POST

Request Body for POST

JSON Example

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

Properties

Name	Type	Description	Required or Optional	Available Version
`assetIds`	String[]	IDs of the assets that you want to add to the amendment record.	Required	62.0
`amendmentStartDate`	String	Start date of the amendment.	Required	62.0
`contractId`	String	ID of the Contract record that you want to sync with the amendment quote.	Optional	62.0
`opportunityId`	String	ID of the Opportunity record that you want to sync with the amendment quote.	Optional	62.0
`outputRecordId`	String	ID of the quote or order record that you want to add the assets to.	Optional	62.0
`outputRecordType`	String	Type of amendment record that you want to create. For usage products, set this value to `Quote`. The usage-related records (`QuoteLineItemUseResourceGrant`, `QuoteLineItemUsageResourcePolicy`, and `QuoteLineRateCardEntry`) are copied in the quote action flow, not in the amend order flow.	Required	62.0
`quantityChange`	Double	Quantity to add to or reduce from the asset’s existing quantity.	Required	62.0

Response Body for POST

Amendment